Logic relay

From Valve Developer Community
Revision as of 22:38, 6 July 2005 by Demented (talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Entity Description

Entity Name: logic_relay

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.


Entity Values

Keys

  • Name targetname <target_source>
    • The name that other entities refer to this entity by.
  • Start Disabled StartDisabled <choices>
    • If Yes, this entity starts disabled.


Inputs

  • Kill
    • Removes this entity from the world.
  • KillHierarchy
    • Removes this entity and all its children from the world.
  • AddOutput <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>
    • Adds an entity I/O connection to this entity. Very dangerous, use with care
  • FireUser1
    • Causes this entity's OnUser1 output to be fired.
  • FireUser2
    • Causes this entity's OnUser2 output to be fired.
  • FireUser3
    • Causes this entity's OnUser3 output to be fired.
  • FireUser4
    • Causes this entity's OnUser4 output to be fired.
  • Enable
    • Enable this entity.
  • Disable
    • Disable this entity.
  • 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

  • OnUser1
    • Fired in response to FireUser1 input.
  • OnUser2
    • Fired in response to FireUser2 input.
  • OnUser3
    • Fired in response to FireUser3 input.
  • OnUser4
    • Fired in response to FireUser4 input.
  • OnTrigger
    • Fired when the relay is triggered.


Flags

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