Difference between revisions of "GetLocalString"
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=GetLocalString | |name=GetLocalString | ||
| 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 string variable sVarName on the specified | + | Gets a local string variable sVarName on the specified object. |
| − | 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. --> | ||
Latest revision as of 05:52, 1 August 2009
Gets a local string variable on an object.
- Parameters:
- oObject
- Object to get the variable from
- sVarName
- The name of the string variable to retrieve
- Returns:
- Returns the string variable, returns an empty string on error.
- Source:
- script.ldf
Description
Gets a local string 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.
