Difference between revisions of "NET:LavishScriptAPI.LavishScript.Objects.GetObject"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 
== Overview ==
 
== Overview ==
Used to retrieve a [[NET:Lavish.InnerSpace.dll#LavishScriptObject|LavishScriptObject]] object from a LavishScript '''Top-Level Object'''.
+
Used to retrieve a [[NET:LavishScriptAPI.LavishScriptObject|LavishScriptObject]] object from a LavishScript '''Top-Level Object'''.
  
 
=== Reference Library ===
 
=== Reference Library ===
Line 23: Line 23:
  
 
=== Return Value ===
 
=== Return Value ===
* [[NET:Lavish.InnerSpace.dll#LavishScriptObject|LavishScriptObject]]
+
* [[NET:LavishScriptAPI.LavishScriptObject|LavishScriptObject]]
 
: The requested object, or '''null'''
 
: The requested object, or '''null'''
  
Line 43: Line 43:
  
 
== See Also ==
 
== See Also ==
* [[NET:Lavish.InnerSpace.dll#LavishScriptObject|LavishScriptObject]]
+
* [[NET:LavishScriptAPI.LavishScriptObject|LavishScriptObject]]
 
* [[IS:.NET|Inner Space .NET]]
 
* [[IS:.NET|Inner Space .NET]]
 
* [[NET:Lavish.InnerSpace.dll|Lavish.InnerSpace.dll]]
 
* [[NET:Lavish.InnerSpace.dll|Lavish.InnerSpace.dll]]

Latest revision as of 23:37, 16 December 2006

Overview

Used to retrieve a LavishScriptObject object from a LavishScript Top-Level Object.

Reference Library

Lavish.InnerSpace.dll

Fully Qualified Name

LavishScriptAPI.LavishScript.Objects.GetObject

Declaration

static public LavishScriptObject GetObject(string Name)
static public LavishScriptObject GetObject(string Name, params string[] indices)

Parameters

  • string Name
Name of the LavishScript Top-Level Object to access
  • string[] indices
Parameters, if any, to pass to the LavishScript Top-Level Object for dynamic retrieval

Return Value

The requested object, or null

Examples

C#

Frame.Lock();
LavishScriptObject Obj = LavishScript.Objects.GetObject("LavishScript");
if (Obj == null)
{
    InnerSpace.Echo("object not found");
}
else
{
    /* "LavishScript" object's ToString value is its version number, which follows the form of a typical float */
    float Version = Obj.GetValue<float>();
    InnerSpace.Echo("LavishScript Version " + Version.ToString());
}
Frame.Unlock();

See Also