Logic relay: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
m (Robot: fixing template case.)
Line 29: Line 29:


== Outputs ==
== Outputs ==
* {{o targetname}}
* {{O Targetname}}
* '''OnTrigger'''
* '''OnTrigger'''
: Fired when the relay is triggered. {{activator|activator}}
: Fired when the relay is triggered. {{activator|activator}}
* '''{{EP1 add|OnSpawn}}'''
* '''{{EP1 add|OnSpawn}}'''
: Fired when the relay is spawned. If the relay is set to only trigger once, it will delete itself after firing this output.
: Fired when the relay is spawned. If the relay is set to only trigger once, it will delete itself after firing this output.

Revision as of 20:07, 19 January 2009

Template:Wrongtitle Template:Base point

Entity description

Logic relay.png

A message forwarder. Fires an OnTrigger output when triggered, and can be disabled to prevent forwarding outputs.

Useful as an intermediary between one entity and another for turning on or off an I/O connection, or as a container for holding a set of outputs that can be triggered from multiple places. Additionally, its Enabled/Disabled state can be used for conditional logic ("if, then" style logic).

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

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Flags

  • 1 : Only trigger once (Default Checked)
If checked, this entity starts on.
  • 2 : Allow fast retrigger (Default Unchecked)
Allows fast retriggering.

Inputs

  • EnableDisable:
Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
  • Trigger
Trigger the relay, causing its OnTrigger output to fire if it is enabled.
  • Toggle
Toggle the relay between enabled and disabled.
  • CancelPending
Cancel any events fired by this relay that are currently pending in the I/O event queue.

Outputs

  • OnTrigger
Fired when the relay is triggered. (!activator is the activator)
  • OnSpawn (in all games since Half-Life 2: Episode One)
Fired when the relay is spawned. If the relay is set to only trigger once, it will delete itself after firing this output.