Trigger relay (Half-Life: Source): Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(→‎Keyvalues: stray semicolon)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{tabsBar|main=hls|base=trigger relay}}
{{TabsBar|main=hls|base=trigger relay}}
{{CD|CTriggerRelay|base=CBaseEntity|file1=hl1_ents.cpp}}
{{CD|CTriggerRelay|base=CBaseEntity|file1=hl1_ents.cpp}}
{{obsolete|entity=1|replacement=[[logic_relay]]}}
{{Obsolete|entity=1|replacement = [[logic_relay]] and [[logic_timer]]}}
{{this is a|point entity|name=trigger_relay|game=Half-Life: Source|sprite=1}}
{{This is a|logical entity|name=trigger_relay|game=Half-Life: Source|sprite=1}}


{{important|This entity counts as an [[edict]]! Use [[logic_relay]] instead.}}
{{important|This entity counts as an [[edict]]! Use {{ent|logic_relay}} or {{ent|logic_timer}} instead.}}


== Keyvalues ==
== Keyvalues ==
{{kv|Refire interval|intn=repeatinterval|float|}}
{{KV Targetname}}
{{kv|Refire duration|intn=repeatduration|float|}}
{{KV|Refire interval|intn=repeatinterval|float|After the Use input the OnTrigger output will be fired repeatedly with this interval if Fire Once flag is not set.}}
{{KV|Trigger State|intn=triggerstate|integer choices|deprecated=1|3=Unused leftover from GoldSrc; use the appropriate entity's inputs instead.<ol start=0><li>Off<li>On<li>Toggle</ol>}}
{{KV|Refire duration|intn=repeatduration|float|Duration after which this entity is killed after being used.}}
{{KV|Trigger State|intn=triggerstate|integer choices|deprecated=1|3=Unused leftover from GoldSrc; use the appropriate inputs instead.}}


== Inputs ==
== Inputs ==
Line 15: Line 16:


== Outputs ==
== Outputs ==
{{O|OnTrigger|activator = activator of {{mono|Use}} input, on refires it's this entity|Fired when this entity receives the [[Use]] input.}}
{{O|OnTrigger|param=void|activator = activator of {{mono|Use}} input, on refires it's this entity|Fired when this entity receives the [[Use]] input.}}


== Flags ==
== Flags ==
{{fl|1|Fire Once|[[Kill]] this entity after it fires its outputs.}}
{{fl|1|Fire Once|[[Kill]] this entity immediately after it fires the OnTrigger output.}}

Latest revision as of 08:05, 13 May 2025

C++ Class hierarchy
CTriggerRelay
CBaseEntity
C++ hl1_ents.cpp
Obsolete-notext.png
This entity is obsolete. Its use is discouraged. It may only exist/function in older engine branches.
It has since been deprecated by: logic_relay and logic_timer.
Trigger relay.png

trigger_relay is a logical entity available in Half-Life: Source Half-Life: Source.

Icon-Important.pngImportant:This entity counts as an edict! Use logic_relay or logic_timer instead.

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

Refire interval (repeatinterval) <float>
After the Use input the OnTrigger output will be fired repeatedly with this interval if Fire Once flag is not set.
Refire duration (repeatduration) <float>
Duration after which this entity is killed after being used.
Trigger State (triggerstate) <integer choices> Obsolete
Deprecated.
Unused leftover from GoldSrc; use the appropriate inputs instead.

Inputs

Use <void>
Fire this entity's outputs.

Outputs

OnTrigger <void>
!activator = activator of Use input, on refires it's this entity
!caller = this entity
Fired when this entity receives the Use input.

Flags

Fire Once : [1]
Kill this entity immediately after it fires the OnTrigger output.