Logic case: Difference between revisions

Latest revision as of 10:59, 8 May 2025

Class hierarchy
CLogicCase ↳CLogicalEntity ↳CServerOnlyEntity ↳CBaseEntity
`logicentities.cpp`

logic_case is a logical entity available in all Source games. It compares an input to up to 16 configured values, firing a corresponding output if there is a match (on InValue), or fires a random output (on PickRandom). Use logic_random_outputs for a weighted random output.

Important:This entity stores values as strings, so if you specify one of the case as "1.50", then when you try to compare float it will not match, because the float will be "1.5", and not "1.50".

Tip:Use with logic_timer for extremely random events.

Keyvalues

Name (targetname) <string>[ Edit ]: The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report. See also: Generic Keyvalues, Inputs and Outputs available to all entities

Case 01 (Case01) to Case 16 (Case16) <string>: The values to test against.

Inputs

InValue <variantRedirectInput/variant>: Compares the Input value converted to string to the case values, and fires the appropriate output, if any.

PickRandom <void>: Fires a random OnCase output with at least one connection.

PickRandomShuffle <void>: Fires a random OnCase output with at least one connection, with no repeats until all cases have been picked, at which point the shuffle starts over.

Outputs

OnCase01 to OnCase16 <void>: !activator = activator of the input causing this
!caller = this entity
Fired when the input value equals the corresponding Case value.

OnDefault <variantRedirectOutput/variant>: !activator = activator of InValue input
!caller = this entity
Fired when the input value does not equal any of the Case values.

OnUsed <variantRedirectOutput/variant> (only in ): !activator = activator of InValue input
!caller = this entity
Fired when an input value is received, regardless of whether it matches a case. Outputs the same parameter type as was inputted with InValue input (i.e. if it was float this output will be of type float, the same applies to OnDefault output in )

@@ Line 1: / Line 1: @@
-{{wrongtitle|title=logic_case}}
+{{LanguageBar}}
-{{base_point}}
+{{TabsBar|main=s2|base=logic_case}}
+{{CD|CLogicCase|file1=logicentities.cpp}}
-== Entity description ==
+{{this is a|logical entity|name=logic_case|sprite=1}} It compares an input to up to 16 configured values, firing a corresponding output if there is a match (on <code>InValue</code>), or fires a random output (on <code>PickRandom</code>). Use [[logic_random_outputs]] for a weighted random output.
-[[Image:logic_case.png|right]]
+{{Important|This entity stores values as '''strings''', so if you specify one of the case as "1.50", then when you try to compare [[float]] it will not match, because the float will be "1.5", and not "1.50".}}
-Compares an input to up to 16 preset values. If the input value is the same as any of the preset values, an output corresponding to that value is fired.
-For example: If ''Case01'' is set to <code>2</code> and ''Case02'' is set to <code>5</code>, and the input value is <code>5</code>, the ''OnCase02'' output will be fired.
-This entity can also be used to select from a number of random targets via the ''PickRandom'' input. One of the ''OnCase'' outputs that is connected to another entity will be picked at random and fired.
-{{note|This entity with not recognize float values ending in <code>0</code> (like <code>0.50</code> or <code>1.00</code>). Simply remove these.}}
-* The ideal entity for randomized events.
-* Use with [[logic_timer]] for extremely random events.
+{{tip|Use with [[logic_timer]] for extremely random events.}}
+__NOTOC__
 == Keyvalues ==
-* {{kv targetname}}
+{{KV Targetname}}
+{{KV|Case 01|to=Case 16|intn=Case01|intn2=Case16|string|The values to test against.}}
-* '''Case''(01-16)'''''
-: <string>
 == Inputs ==
-* {{i targetname}}
+{{I|InValue|Compares the Input value converted to string to the case values, and fires the appropriate output, if any.|param=variant}}
+{{I|PickRandom|param=void|Fires a random OnCase output with at least one connection.}}
-* '''InValue <string>'''
+{{I|PickRandomShuffle|param=void|Fires a random OnCase output with at least one connection, with no repeats until all cases have been picked, at which point the shuffle starts over.}}
-: Compare the Input value to the case values, and fire the appropriate output, if any.
-* '''PickRandom'''
-: Fire a random OnCase output with at least one connection.
-* '''{{ep1 add|PickRandomShuffle}}'''
-: Fires a random OnCase output with at least one connection, with no repeats until all cases have been picked, at which point the shuffle starts over.
 == Outputs ==
-* {{o targetname}}
+{{O|OnCase01|to=OnCase16|param=void|activator = activator of the input causing this|Fired when the input value equals the corresponding Case value.}}
+{{O|OnDefault|param=variant|activator = activator of InValue input|Fired when the input value does not equal any of the Case values.}}
-* '''OnCase''(01-16)'''''
+{{O|OnUsed|param=variant|activator = activator of InValue input|Fired when an input value is received, regardless of whether it matches a case. Outputs the same parameter type as was inputted with InValue input (i.e. if it was float this output will be of type float, the same applies to OnDefault output in {{mapbase}})|only={{mapbase}}}}
-: Fired when the input value equals the Case''(01-16)'' value. {{activator|activator}}
-* '''OnDefault <string>'''
+== See Also ==
-: Fired when the input value does not equal any of the Case values. {{activator|activator}}
+* {{ent|logic_timer}}
+* {{ent|logic_relay}}
+* {{ent|math_counter}}
+[[Category:IO System]]

Logic case: Difference between revisions

Latest revision as of 10:59, 8 May 2025

Keyvalues

Inputs

Outputs

See Also

Navigation menu

Search