Logic branch: Difference between revisions
Jump to navigation
Jump to search
Note:Values greater than 1 are treated as 0.
Gatelych83 (talk | contribs) m (→Keyvalues) |
(-added class hierarchy, cleanup) |
||
| Line 1: | Line 1: | ||
[[File:logic_branch.png|left|link=]] | |||
{{CD|CLogicBranch|file1=logicentities.cpp}} | |||
{{base point|logic_branch}} | {{base point|logic_branch}} | ||
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.}} | {{note|Values greater than 1 are treated as 0.}} | ||
== Keyvalues == | == Keyvalues == | ||
| Line 16: | Line 17: | ||
{{IO|ToggleTest|Toggle the boolean value and tests it, firing OnTrue or OnFalse based on the new value.}} | {{IO|ToggleTest|Toggle the boolean value and tests it, firing OnTrue or OnFalse based on the new value.}} | ||
{{IO|Test|Test the input value and fire OnTrue or OnFalse based on the value.}} | {{IO|Test|Test the input value and fire OnTrue or OnFalse based on the value.}} | ||
== Outputs == | == Outputs == | ||
{{IO|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.}} | {{IO|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.}} | ||
{{IO|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.}} | {{IO|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 == | == See also == | ||
Revision as of 15:46, 6 November 2022
 Class hierarchy
|
|---|
| CLogicBranch |
| logicentities.cpp
|
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
- Initial value (InitialValue) <integer>
- Initial value for the boolean value (0 or 1).
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
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.