Skip to content
OpenTS Manual

37 — Local is clear...

Satisfied while the named local variable is clear.

Editor data
Numeric ID
37
Engine ID
TEVENT_LOCAL_CLEAR
Editor name
Local is clear...
Need token
NEED_LOCAL
Parameters
  1. Local variablelocal-variable
Attachment
general
INI example
[Events]
<TriggerID>=1,37,0,<Local variable>

Valid values

  • A local variable number from 0 to 49. The map declares its locals in [VariableNames], each with a name and an optional starting state.
  • A number outside 0 to 49 gives an unpredictable result. The event may or may not be satisfied.
Caveats
  • A local the map declares with a starting state of 0 is clear from the first frame, so a trigger built only on this event fires on the first frame.
  • Locals are not reset when a new scenario starts. A local with no starting state in the map, including one the map does not declare, keeps the value it had at the end of the previous scenario played in the same session. It can therefore already be set when a later campaign mission starts. Give every local this event tests a starting state.
  • The event is satisfied for as long as the local stays clear. On a persistent tag, the trigger fires every frame over that time.
  • A change in the local's value restarts the countdown of every trigger with an event that names that local. Setting a local that is already set, or clearing one that is already clear, restarts nothing. Pair this event with [Elapsed Time...](/mapping/events/tevent-time/) to fire a set delay after the local changes.
  • A semi-persistent tag fires only while exactly one object or map cell holds it, and this event attaches the tag to neither. Use a volatile or a persistent tag.