ObjectType:script

Members

• string Filename: Filename of this script
• variable Variable[name]: A given script-scope variable
• int RunningTime: Number of milliseconds since this script began
• filepath CurrentDirectory: Current working directory for this script
• bool Paused: Scripts current paused state
• bool Profiling: Profiling status true/false. Debugging must be allowed for profiling to be on.
• bool AllowDebug: If debugging is allowed

Methods

• End: Ends execution of this script
• QueueCommand[command]: Inserts a command in the script's command queue
• Squelch: Squelches most output from this script (excluding most errors and generally excluding Echo)
• Unsquelch: Unsquelches
• Pause: Pauses this script
• Resume: Resumes this script
• ExecuteAtom[name,...]: Executes an atom in script-scope with the given name. Any extra parameters are passed as parameters to the atom.
• EnableProfiling: Enables script profiling. Debugging must be turned on to enable.
• DisableProfiling: Disables script profiling.
• DisableDebugging: Disables debugging.
• DumpStack: Dumps the current stack into the console.
• DumpProfiling: Dumps the entire script into the console.

Returns

TRUE

Examples

Display if a script is running

• echo ${Script[VentriloHUD](exists)}

Output

TRUE

End a script

• Script[VentriloHUD]:End
• Script:End

Note: When used as a command within a script will end the script

Set a variable inside a currently running script

• Script[KillCount].Variable[TotalKills]:Set[0] - Will set the variable called TotalKills in the currently running script called KillCount to zero.

Operates On

CScript *

This is an internal data type

See Also

• Data Types