Logic branch: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (links)
(Cleanup)
Line 1: Line 1:
{{wrongtitle|title=logic_branch}}
{{base point|logic_branch}}
{{base_point}}


==Entity Description==
==Entity Description==
[[Image:logic_branch.png|left]]
[[File:logic_branch.png|left]]
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.
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.}}
{{clr}}
{{clr}}


==Keyvalues==
== Keyvalues ==
{{KV|Initial value|integer|Initial value for the boolean value (0 or 1).}}
{{KV Targetname}}


* {{KV Targetname}}
== Inputs ==
{{IO|SetValue|Set the boolean value without performing the comparison. Use this to hold a value for a future test.|param=bool}}
{{IO|SetValueTest|Set the boolean value and test it, firing OnTrue or OnFalse based on the new value.|param=bool}}
{{IO|Toggle|Toggle the boolean value between true and false.}}
{{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.}}
{{I Targetname}}


* '''initialvalue'''
== Outputs ==
: {{boolean}}
{{IO|OnTrue|Fired when the input value is true (nonzero). {{activator|activator}}|param=bool}}
 
{{IO|OnFalse|Fired when the input value is false (zero). {{activator|activator}}|param=bool}}
==Inputs==
{{O Targetname}}
 
* {{I Targetname}}
* '''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==
 
* {{O Targetname}}
* '''OnTrue {{boolean}}'''
: Fired when the input value is true (nonzero). {{activator|activator}}
 
* '''OnFalse {{boolean}}'''
: Fired when the input value is false (zero). {{activator|activator}}

Revision as of 22:58, 8 June 2011

Template:Base point

Entity Description

Logic branch.png

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.pngNote:Values greater than 1 are treated as 0.

Keyvalues

Initial value ([todo internal name (i)]) <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. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

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 <booleanRedirectInput/boolean>
Fired when the input value is true (nonzero). (!activator is the activator)
OnFalse <booleanRedirectInput/boolean>
Fired when the input value is false (zero). (!activator is the activator)
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Logic_branch&oldid=152475"