Logic relay queue: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(New logic entity from Mapbase)
 
m (Substituted IO templates)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{mapbase point|logic_relay_queue|sprite=1}} It is a variant of {{ent|logic_relay}} which allows blocked <code>Trigger</code> inputs to "queue" when waiting for the relay to re-enable, or when waiting for the relay's delayed outputs to finish firing. When the relay is ready to refire, the queued <code>Trigger</code> inputs will fire automatically.
{{CD|CLogicRelayQueue|base=CLogicalEntity|file1=[https://github.com/mapbase-source/source-sdk-2013/blob/471a840ed98c7206237cb579671a6d6fda9fd4f9/sp/src/game/server/logicrelay.cpp#L239 logicrelay.cpp]|nolink=1}}
{{this is a|point entity|name=logic_relay_queue|sprite=1|game=Mapbase|game1=Strata Source}} It is a variant of {{ent|logic_relay}} which allows blocked <code>Trigger</code> inputs to "queue" when waiting for the relay to re-enable, or when waiting for the relay's delayed outputs to finish firing. When the relay is ready to refire, the queued <code>Trigger</code> inputs will fire automatically.
 


This entity is also available in {{P2CE}}.


==Keyvalues==
==Keyvalues==
{{KV Targetname}}
{{KV|Maximum Items|intn=SetMaxQueueItems|integer|The maximum number of <code>Trigger</code> and <code>TriggerWithParameter</code> inputs allowed in the queue. Any others received while this value is full will be discarded. This does not count the I/O chain currently being handled.}}
{{KV|Maximum Items|intn=SetMaxQueueItems|integer|The maximum number of <code>Trigger</code> and <code>TriggerWithParameter</code> inputs allowed in the queue. Any others received while this value is full will be discarded. This does not count the I/O chain currently being handled.}}
{{KV|Don't queue when disabled|intn=DontQueueWhenDisabled|boolean|Prevents the relay from queuing inputs when disabled. This means inputs will only be queued when the relay is enabled and still handling its current I/O connections.}}
{{KV|Don't queue when disabled|intn=DontQueueWhenDisabled|boolean|Prevents the relay from queuing inputs when disabled. This means inputs will only be queued when the relay is enabled and still handling its current I/O connections.}}
{{KV EnableDisable}}
{{KV EnableDisable}}
{{KV BaseEntity|mapbase=1}}


==Inputs==
==Inputs==
{{IO|Trigger|Trigger the relay, causing its OnTrigger output to fire if it is enabled.}}
{{I|Trigger|Trigger the relay, causing its OnTrigger output to fire if it is enabled.}}
{{IO|EnableRefire|Automatically fired on a relay after any delayed outputs finish firing, allowing it to fire again.}}
{{I|EnableRefire|Automatically fired on a relay after any delayed outputs finish firing, allowing it to fire again.}}
{{IO|TriggerWithParameter|param=string|Triggers the relay with a parameter, causing its OnTriggerParameter output to fire if it is enabled.}}
{{I|TriggerWithParameter|param=string|Triggers the relay with a parameter, causing its OnTriggerParameter output to fire if it is enabled.}}
{{I EnableDisable}}
{{I EnableDisable}}
{{I Toggle}}
{{I Toggle}}
{{I BaseEntity|mapbase=1}}


==Outputs==
==Outputs==
{{IO|OnTrigger|Fired when the relay is triggered. If the relay is set to only trigger once, it will delete itself after firing this output.}}
{{O|OnTrigger|Fired when the relay is triggered. If the relay is set to only trigger once, it will delete itself after firing this output.}}
{{IO|OnTriggerParameter|param=string|Fired when the relay is triggered with a parameter. If the relay is set to only trigger once, it will delete itself after firing this output.}}
{{O|OnTriggerParameter|param=string|Fired when the relay is triggered with a parameter. If the relay is set to only trigger once, it will delete itself after firing this output.}}
{{O BaseEntity|mapbase=1}}

Latest revision as of 11:08, 21 April 2025

C++ Class hierarchy
CLogicRelayQueue
↳CLogicalEntity
↳CServerOnlyEntity
↳CBaseEntity
C++ logicrelay.cpp
Logic relay queue.png

logic_relay_queue is a point entity available in Mapbase Mapbase and Strata Source Strata Source. It is a variant of logic_relay which allows blocked Trigger inputs to "queue" when waiting for the relay to re-enable, or when waiting for the relay's delayed outputs to finish firing. When the relay is ready to refire, the queued Trigger inputs will fire automatically.


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

Maximum Items (SetMaxQueueItems) <integer>
The maximum number of Trigger and TriggerWithParameter inputs allowed in the queue. Any others received while this value is full will be discarded. This does not count the I/O chain currently being handled.
Don't queue when disabled (DontQueueWhenDisabled) <boolean>
Prevents the relay from queuing inputs when disabled. This means inputs will only be queued when the relay is enabled and still handling its current I/O connections.
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Inputs

Trigger
Trigger the relay, causing its OnTrigger output to fire if it is enabled.
EnableRefire
Automatically fired on a relay after any delayed outputs finish firing, allowing it to fire again.
TriggerWithParameter <stringRedirectInput/string>
Triggers the relay with a parameter, causing its OnTriggerParameter output to fire if it is enabled.

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
Toggle:
Toggle
Toggle the enabled/disabled status of this entity.

Outputs

OnTrigger
Fired when the relay is triggered. If the relay is set to only trigger once, it will delete itself after firing this output.
OnTriggerParameter <stringRedirectOutput/string>
Fired when the relay is triggered with a parameter. If the relay is set to only trigger once, it will delete itself after firing this output.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Logic_relay_queue&oldid=472527"