function GetLocalObject (object oObject, string sVarName) Get oObject's local object variable sVarName
* Return value on error: OBJECT_INVALID
* Return type: object
* Include file: nwscriptdefn
Attributes | Values |
---|
rdfs:label
| |
rdfs:comment
| - function GetLocalObject (object oObject, string sVarName) Get oObject's local object variable sVarName
* Return value on error: OBJECT_INVALID
* Return type: object
* Include file: nwscriptdefn
- The GetLocalObject() NWScript command returns the value of a local variable when that value is an object. It returns OBJECT_INVALID on any error condition, such as if the specified local variable was never set, if it was set as something other than an object, or if an invalid object is provided.
|
dcterms:subject
| |
dbkwik:nwn2/proper...iPageUsesTemplate
| |
returns
| |
Name
| |
param
| - object oObject
- string sVarName
|
param2desc
| - The name of the local variable, as a string.
|
param1desc
| - The object on which the local variable is stored.
|
dbkwik:nwn/property/wikiPageUsesTemplate
| |
abstract
| - function GetLocalObject (object oObject, string sVarName) Get oObject's local object variable sVarName
* Return value on error: OBJECT_INVALID
* Return type: object
* Include file: nwscriptdefn
- The GetLocalObject() NWScript command returns the value of a local variable when that value is an object. It returns OBJECT_INVALID on any error condition, such as if the specified local variable was never set, if it was set as something other than an object, or if an invalid object is provided. This is perhaps the most common way one can sometimes obtain an invalid object that is not equal to OBJECT_INVALID. (This happens when the object used as the value of the variable is destroyed—or logs out and does not log back in, in the case of player characters—between the times when the local variable is set and retrieved.)
|