logic_relay_queue
logic_relay_queue is a point entity available
with any version of Mapbase.A special variant of logic_relay designed to queue trigger inputs. If the relay is still handling its I/O connections after being triggered, additional Trigger inputs will be queued and automatically fire when the relay is able to be re-fired. Activator, output ID, and parameter are all kept and saved. Inputs are added to the queue each time Trigger or TriggerWithParameter are received while the relay is disabled or still handling its current I/O connections. The first one in the queue will trigger the moment an opportunity becomes available and the next one in the queue will wait for that one.
This is useful for when you don’t want something to happen multiple times at once, but don’t want to discard further requests either.
KeyValues
- 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. Keep in mind this does not count the I/O chain currently being handled.
The maximum number of Trigger and TriggerWithParameter inputs allowed in the queue. Any others received while this value is full will be discarded. Keep in mind this does not count the I/O chain currently being handled.
- Don't queue when disabled (DontQueueWhenDisabled) <choices>
Prevents the relay from queuing inputs when disabled. This means inputs will only be queued when enabled and still handling its current I/O connections.
Prevents the relay from queuing inputs when disabled. This means inputs will only be queued when enabled and still handling its current I/O connections.
Inputs
- Trigger
<void>
Triggers the relay, causing its OnTrigger output to fire if it is enabled.
Triggers the relay, causing its OnTrigger output to fire if it is enabled.
- TriggerWithParameter
<string>
Triggers the relay with a parameter, causing its OnTriggerParameter output to fire if it is enabled.
Triggers the relay with a parameter, causing its OnTriggerParameter output to fire if it is enabled.
- Toggle
<void>
Toggle the relay between enabled and disabled.
Toggle the relay between enabled and disabled.
- EnableRefire
<void>
If fast retrigger is disabled, the relay will not be able to fire again until its most delayed output has been fired. This input allows the relay to fire again early if it is in this state.
If fast retrigger is disabled, the relay will not be able to fire again until its most delayed output has been fired. This input allows the relay to fire again early if it is in this state.
- ClearQueue
<void>
Clears the input queue.
Clears the input queue.
- SetMaxQueueItems
<integer>
Sets the maximum queue items.
Sets the maximum queue items.
Outputs
- OnTrigger
<void>
Fired when the relay is triggered.
Fired when the relay is triggered.
- OnTriggerParameter
<string>
Fired when the relay is triggered with a parameter.
Fired when the relay is triggered with a parameter.