Difference between revisions of "GetLocalInt"
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=GetLocalInt | |name=GetLocalInt | ||
| 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. --> | ||
| − | Returns the value of the integer variable with the name sVarName which is stored | + | Returns the value of the integer variable with the name sVarName which is stored on the object oObject. If no such variable is stored on the object oObject, 0 is returned. |
| − | on the object oObject. If no such variable is stored on the object oObject, 0 is | + | |
| − | returned | + | |
| − | + | To change the value of a local integer value, use [[SetLocalInt]]. | |
| − | + | ||
| + | == Remarks == | ||
| + | <!-- 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. --> | ||
Latest revision as of 05:48, 1 August 2009
Retrieves a local integer variable stored on an object.
- Parameters:
- oObject
- The Object the variable is stored on
- sVarName
- The name of the integer variable to retrieve
- Returns:
- Returns the value of the integer variable. Returns 0 on error.
- Source:
- script.ldf
Description
Returns the value of the integer variable with the name sVarName which is stored on the object oObject. If no such variable is stored on the object oObject, 0 is returned.
To change the value of a local integer value, use SetLocalInt.
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.
