Difference between revisions of "NET:LavishScriptAPI.LavishScript.Objects.GetObject"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
| − | Used to retrieve a [[NET: | + | Used to retrieve a [[NET:LavishScriptAPI.LavishScriptObject|LavishScriptObject]] object from a LavishScript '''Top-Level Object'''. |
=== Reference Library === | === Reference Library === | ||
| Line 14: | Line 14: | ||
== Declaration == | == Declaration == | ||
static public LavishScriptObject GetObject(string Name) | static public LavishScriptObject GetObject(string Name) | ||
| − | static public LavishScriptObject GetObject(string Name, string[] indices) | + | static public LavishScriptObject GetObject(string Name, params string[] indices) |
=== Parameters === | === Parameters === | ||
| Line 23: | Line 23: | ||
=== Return Value === | === Return Value === | ||
| − | * [[NET: | + | * [[NET:LavishScriptAPI.LavishScriptObject|LavishScriptObject]] |
: The requested object, or '''null''' | : The requested object, or '''null''' | ||
| Line 43: | Line 43: | ||
== See Also == | == See Also == | ||
| − | * [[NET: | + | * [[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
Contents
Overview
Used to retrieve a LavishScriptObject object from a LavishScript Top-Level Object.
Reference Library
Fully Qualified Name
- LavishScriptAPI.LavishScript.Objects.GetObject
- LavishScriptAPI namespace
- LavishScript class
- Objects class
- GetObject function
- Objects class
- LavishScript class
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();
