ScriptWait

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Delays the processing of the script code immediately following this function call, in the current BEGIN block. While waiting, the script will skip processing the waiting BEGIN block (the rest of the script will be processed normally); When the time expires, the script will continue from the wait point.

  • The waitTime is represented in 1 wait unit = 1 processing cycle, which is once every frame (60 times/second) for Object-type scripts, and determined by the Script Processing Delay setting for Quest-type scripts.
  • Any running script may only have one active waiting block at one time; calling this function from a BEGIN block while another block is waiting will stop the latter from waiting.
  • This function cannot be used in Effect-type scripts, UDF scripts, or result scripts.

Syntax

[help]
ScriptWait waitTime:int

Example

BEGIN <BlockType>

	<code>

	ScriptWait 10

	<delayed code>

END

BEGIN <BlockType>

	<code>

END

(...)

See Also