logic_branch

From Valve Developer Community
Jump to: navigation, search
English (en)
... Icon-Important.png
logic_branch
Logic branch.png
TypePoint entity
EngineSource Source
AvailabilityIn all games
 

tests a boolean value and fires an output based on whether the value is true (one) or false (zero). Use this entity to branch between two potential sets of events.

class hierarchy
CLogicBranch defined in logicentities.cpp
CLogicalEntity
CServerOnlyEntity
CBaseEntity
Note.pngNote:Values greater than 1 are treated as 0.

Keyvalues


Targetname:
Name (targetname) <string>
The targetname that other entities refer to this entity by.
Initial value (InitialValue) <integer>
Initial value for the boolean value (0 or 1).

Inputs

SetValue <boolean>
Set the boolean value without performing the comparison. Use this to hold a value for a future test.
SetValueTest <boolean>
Set the boolean value and test it, firing OnTrue or OnFalse based on the new value.
Toggle
Toggle the boolean value between true and false.
ToggleTest
Toggle the boolean value and tests it, firing OnTrue or OnFalse based on the new value.
Test
Test the input value and fire OnTrue or OnFalse based on the value.

Outputs

OnTrue
This Output fires when the stored boolean value is true (1) and the Test input is fired or when the stored boolean value is set to true (1) by either the SetValueTest or ToggleTest inputs with parameter value 1.
OnFalse
This Output fires when the stored boolean value is false (0) and the Test input is fired or when the stored boolean value is set to false (0) by either the SetValueTest or ToggleTest inputs with parameter value 0.

See also