Logic branch

Class hierarchy
CLogicBranch ↳CLogicalEntity ↳CServerOnlyEntity ↳CBaseEntity
logicentities.cpp

logic_branch is a logical entity available in all Source games. It 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.

Note:Values greater than 1 are treated as 0.

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

Initial value (InitialValue) <boolean>

Initial value for the boolean value (0 or 1).

Inputs

SetValue <booleanRedirectInput/boolean>

Set the boolean value without performing the comparison. Use this to hold a value for a future test.

SetValueTest <booleanRedirectInput/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

!activator = activator of the input causing this to fire
!caller = this entity
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

!activator = activator of the input causing this to fire
!caller = this entity
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

• logic_branch_listener
• Logic gate