Triggers/Category Trigger

From SC2Mapster Wiki
Jump to: navigation, search

Action Queue

Add Actions To Action Queue

  • Action. Adds the specified actions to the Action Queue. Unless the Action Queue has been paused, the Action Queue will immediately begin running through its actions as soon as it has some. If there are already actions running in the queue, then new actions added to the queue will wait their turn, and the current trigger will be paused until the actions it added to the queue have executed.

Clear Action Queue

  • Action. Clears all actions currently in the action queue.

Action Queue Is Empty

  • Action. Returns true if the action queue is empty.

Pause/Unpause Action Queue

  • Action. Pauses or unpauses the Action Queue. Pausing the Action Queue does not pause an action in the queue that is currently running, but will prevent subsequent actions from running until the queue is unpaused.

Basic

Turn Trigger On/Off

  • Action. Turning a trigger off will prevent it from responding to events. A turned off trigger can still be run directly via a "Run Trigger" action.

Evaluate Trigger Conditions

  • Function. Tests a trigger's conditions and returns true if they passed. This does not actually run the actions of the trigger. Note that the trigger's event is not actually firing, so functions that normally respond to events, such as "Triggering Unit", will not be meaningful in the context of using this function to testing a trigger's conditions.

Run Trigger

  • Function. Executes the specified trigger. If Trigger A calls "Run Trigger" to execute Trigger B, then Trigger A will not continue execution until either Trigger B returns, reaches the end of its actions, or reaches a "Wait" action. If Trigger B has a "Wait" action, and the Wait parameter of "Run Trigger" was set to Don't Wait, then Trigger A will resume execution. If the Wait parameter was set to Wait, then Trigger A will not resume execution until Trigger B has completed or returned.

Current Trigger

  • Function. Returns the trigger that calls this action.

Trigger Evaluation Count

  • Function. Returns the number of times the specified trigger has had its conditions evaluated.

Trigger Execution Count

  • Function. Returns the number of times the specified trigger has been executed.

Trigger Is On

  • Function. Returns true if a trigger is turned on. Use the "Turn Trigger On/Off" action to turn a trigger on or off.

Allow Trigger To Be Skipped

  • Action. Allows the current trigger to be skipped when the Required Count number of players hit the escape key.

Stop Trigger

  • Action. Kills all instances of the specified trigger that are currently running.

Wait For Trigger

  • Action. Waits until the specified trigger begins executing, and optionally waits until it has completed as well.