Difference between revisions of "ObjectType:script"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
| + | {{ObjectType-Vitals|script|[[LavishScript]]|none|TRUE|none|no|internal}} | ||
== Members == | == Members == | ||
| − | *[[ | + | *[[ObjectType:string|string]] '''Filename''': Filename of this script |
| − | *[[ | + | *[[ObjectType:variable|variable]] '''Variable['''name''']''': A given script-scope variable |
| − | *[[ | + | *[[ObjectType:int|int]] '''RunningTime''': Number of milliseconds since this script began |
| − | *[[ | + | *[[ObjectType:filepath|filepath]] '''CurrentDirectory''': Current working directory for this script |
| − | *[[ | + | *[[ObjectType:bool|bool]] '''Paused''': Scripts current paused state |
| − | *[[ | + | *[[ObjectType:bool|bool]] '''Profiling''': Profiling status true/false. Debugging must be allowed for profiling to be on. |
| − | *[[ | + | *[[ObjectType:bool|bool]] '''AllowDebug''': If debugging is allowed |
| − | *[[ | + | *[[ObjectType:string|string]] '''ExecuteAtom['''name''','''...''']''': Executes an atom in script-scope with the given name. Any extra parameters are passed as parameters to the atom. If the atom returns a value, the value is given. |
*[[ObjectType:variablescope|variablescope]] '''VariableScope''': The script's variable scope | *[[ObjectType:variablescope|variablescope]] '''VariableScope''': The script's variable scope | ||
| Line 25: | Line 26: | ||
*'''DumpStack''': Dumps the current stack into the console. | *'''DumpStack''': Dumps the current stack into the console. | ||
*'''DumpProfiling''': Dumps the entire script into the console. | *'''DumpProfiling''': Dumps the entire script into the console. | ||
| − | + | *'''EnableDebugLogging'''['''filename''']''': Enables full debug logging to file | |
| − | + | *'''DisableDebugLogging''': Disables full debug logging | |
== Examples == | == Examples == | ||
| Line 38: | Line 39: | ||
:'''Note:''' When used as a command within a script will end the script | :'''Note:''' When used as a command within a script will end the script | ||
===Set a variable inside a currently running script=== | ===Set a variable inside a currently running script=== | ||
| − | *Script[KillCount]. | + | *Script[KillCount].VariableScope.TotalKills:Set[0] - Will set the variable called TotalKills in the currently running script called KillCount to zero. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== See Also == | == See Also == | ||
| − | * [[LavishScript: | + | * [[LavishScript:Object Types|Object Types]] |
[[Category:LavishScript]] | [[Category:LavishScript]] | ||
| − | [[Category:LavishScript | + | [[Category:LavishScript Object Types]] |
Revision as of 04:54, 16 May 2006
Contents
Description
| script | |
| Defined By | LavishScript |
| Inherits | none |
| Reduces To | TRUE |
| Variable Object Type | none |
| Uses Sub-Types | no |
| C/C++ Type | internal |
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
- string ExecuteAtom[name,...]: Executes an atom in script-scope with the given name. Any extra parameters are passed as parameters to the atom. If the atom returns a value, the value is given.
- variablescope VariableScope: The script's variable scope
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.
- EnableDebugLogging[filename]: Enables full debug logging to file
- DisableDebugLogging: Disables full debug logging
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].VariableScope.TotalKills:Set[0] - Will set the variable called TotalKills in the currently running script called KillCount to zero.
