Difference between revisions of "SetLocalString"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Generated by Sunjammer's Dragon Age Script Paser)
 
m (note on predefining)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
 
|name=SetLocalString
 
|name=SetLocalString
Line 23: Line 22:
 
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.
  
 
<!-- == 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. -->
 
[[GetLocalString]]
 
[[GetLocalString]]
 
[[Category: Variable functions]]
 
[[Category: Variable functions]]

Latest revision as of 06:02, 1 August 2009

Sets a local string variable on an object.

void SetLocalString(
object oObject,
string sVarName,
string sValue
);
Parameters:
oObject
Object to set the variable on
sVarName
The name of the string variable to set
sValue
The value of the string variable
Returns:

Nothing.

Source:

script.ldf

Description

Sets 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.

See also

GetLocalString