Difference between revisions of "ObjectType:lavishscript"

From Lavish Software Wiki
Jump to navigation Jump to search
Line 18: Line 18:
 
*'''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.
 
*'''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>
 
*'''RegisterEvent['''name''']''': Registers an event of <name>
 +
*'''Eval['''command''','''index:string''']''': Evaluates the given command, directing any lines of output into an index:string
 +
 +
 
== Returns ==
 
== Returns ==
 
Same as '''Version'''
 
Same as '''Version'''
Line 28: Line 31:
 
===Display amount of time application has been running===
 
===Display amount of time application has been running===
 
*echo Time running: ${LavishScript.RunningTime}
 
*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 ==
 
== Operates On ==

Revision as of 22:28, 11 April 2015

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
  • Object Queries

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


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

See Also