Difference between revisions of "GetLocalResource"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
m (fixed typo) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetLocalResource | |name=GetLocalResource | ||
| − | |brief=Get a local variable of | + | |brief=Get a local variable of type resource on an object |
|param1type=object | |param1type=object | ||
|param1name=oObject | |param1name=oObject | ||
| 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 variable of type resource on the specified object | + | Gets a local variable of type resource on the specified object. |
| − | + | == 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. | ||
<!-- == 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. --> | ||
[[SetLocalResource]] | [[SetLocalResource]] | ||
[[Category: Variable functions]] | [[Category: Variable functions]] | ||
Latest revision as of 02:43, 20 November 2009
Get a local variable of type resource on an object
- Parameters:
- oObject
- The object from which to get the variable
- sVarName
- The name of the variable
- Returns:
- Returns the value of the variable or an empty resource name on error.
- Source:
- script.ldf
Description
Gets a local variable of type resource 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.
