Difference between revisions of "GetLocalItemProperty"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
m (note on predefining) |
||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetLocalItemProperty | |name=GetLocalItemProperty | ||
| Line 17: | Line 16: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| − | Gets a local itemproperty variable sVarName on the specified | + | Gets a local itemproperty variable sVarName on the specified object. |
| − | object. | + | |
== Remarks == | == Remarks == | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| + | All local variables must be predefined in the target object's variables 2da file before this function can be used successfully. If a local variable is not predefined this function will fail silently. | ||
| + | |||
It should be noted that item properties taken from current list on an object are just copies of those item properties, not references to them. | It should be noted that item properties taken from current list on an object are just copies of those item properties, not references to them. | ||
<!-- == Examples == --> | <!-- == Examples == --> | ||
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
| − | |||
== See also == | == See also == | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
[[SetLocalItemProperty]] | [[SetLocalItemProperty]] | ||
[[Category: Variable functions]] | [[Category: Variable functions]] | ||
Revision as of 05:58, 1 August 2009
Gets a local itemproperty variable on an object.
- Parameters:
- oObject
- Object to get the variable from
- sVarName
- The name of the variable to retrieve
- Returns:
- Returns an itemproperty variable, returns an invalid itemproperty on error.
- Source:
- script.ldf
Description
Gets a local itemproperty variable sVarName on the specified object.
Remarks
All local variables must be predefined in the target object's variables 2da file before this function can be used successfully. If a local variable is not predefined this function will fail silently.
It should be noted that item properties taken from current list on an object are just copies of those item properties, not references to them.
