Difference between revisions of "ObjectType:script"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | == | + | == Overview == |
| − | {{ObjectType-Vitals|script|[[LavishScript]]|none|TRUE|none|no| | + | {{ObjectType-Vitals|script|[[LavishScript]]|none|TRUE|none|no|void *}} |
| + | A script object provides access to a running LavishScript script. | ||
== Members == | == Members == | ||
| Line 42: | Line 43: | ||
== See Also == | == See Also == | ||
| − | + | {{LavishScript:ObjectType}} | |
| − | |||
| − | |||
| − | |||
Revision as of 16:29, 8 July 2018
Contents
Overview
| script | |
| Defined By | LavishScript |
| Inherits | none |
| Reduces To | TRUE |
| Variable Object Type | none |
| Uses Sub-Types | no |
| C/C++ Type | void * |
A script object provides access to a running LavishScript 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
- 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.
See Also
LavishScript Object Types
- Text
- string - mutablestring - unistring
- Numbers
- byte - float - float64 - int - uint - int64
- Boolean (TRUE/FALSE)
- bool
- Pointers
- boolptr - byteptr - floatptr - float64ptr - intptr - uintptr - int64ptr - rgbptr - stringptr
- Containers
- objectcontainer - array - index - collection - queue - stack - set - variablescope
- JSON
- jsonobject - jsonarray - jsonvaluecontainer - jsonvalue
- Iteration
- iterator - jsoniterator
- Date/Time
- time
- File Handling
- filepath - file - filelist - filelistentry
- Tasks
- lavishmachine - Accessed via the Top-Level Object LMAC
- task - tasklibrary - taskmanager - tasktype - taskpulseargs - elmactaskstate
