Difference between revisions of "ObjectType:script"
Jump to navigation
Jump to search
| Line 17: | Line 17: | ||
== Examples == | == Examples == | ||
| − | * | + | ===Display if a script is running=== |
| − | *Script:End | + | *echo ${Script[VentriloHUD](exists)} |
| − | *Script[ | + | ;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. | ||
== See Also == | == See Also == | ||
Revision as of 21:20, 26 August 2005
Contents
Description
Members
- string Filename: Filename of this script
- variable Variable[name]: A given script-scope variable
- int RunningTime: Number of milliseconds since this script began
- string CurrentDirectory: Current working directory for this script
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
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.
