ObjectType:lavishscript
Jump to navigation
Jump to search
Contents
Description
Members
- string Version: LavishScript version number (e.g. 1.07)
- filepath CurrentDirectory: Current directory according to LavishScript
- filepath Executable: Executable filename for the current process
- string ExecuteAtom[name,...]: Executes an atom with the given name in global- or script-scope (if a script is currently in context). Extra parameters are passed as parameters to the atom. If the atom returns a value, this will be the string given.
- filepath HomeDirectory: Home directory according to LavishScript
- int RunningTime: Amount of time, in milliseconds, the current application has been running. This value wraps after about 23 days of leaving the application running.
- string LSModule: LavishScript version number
- variablescope VariableScope: The global variable scope
- uint CreateQuery[expression]: (Object Queries) Creates a query with the given expression -- e.g. ${LavishScript.CreateQuery[Name=="Bonkers"]}
- string RetrieveQueryExpression[#]: (Object Queries) Retrieves the query expression for a previously created query, by ID
- bool QueryEvaluate[#, object]: (Object Queries) Determines if the given object matches the given query
Methods
- ExecuteAtom[name,...]: Executes an atom with the given name in global- or script-scope (if a script is currently in context). Extra parameters are passed as parameters to the atom.
- RegisterEvent[name]: Registers an event of <name>
- Eval[command,index:string]: Evaluates the given command, directing any lines of output into an index:string
- FreeQuery[#]: (Object Queries) Frees a previously created query, by ID
- RegisterEnum[typeName,bool]: Registers a new enum and LavishScript Object Type with <typeName>. An optional second parameter controls whether the enum is flags, meaning that multiple values may be combined as part of the same value -- if not provided, the default is FALSE. After registering, value names can be added to the enum type via the Enum TLO
Returns
Same as Version
Examples
Display LavishScript version
- echo Version: ${LavishScript.Version}
Display current directory
- echo Directory: ${LavishScript.CurrentDirectory}
Display amount of time application has been running
- echo Time running: ${LavishScript.RunningTime}
Evaluate a command, directing any lines of output into an index
variable index:string MyIndex
LavishScript:Eval["lstype lavishscript",MyIndex]
echo ${MyIndex.Used} lines of output added to MyIndex
Operates On
none
