Difference between revisions of "SetLocalResource"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
m (note on predefining)
 
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
 
|name=SetLocalResource
 
|name=SetLocalResource
Line 20: Line 19:
 
== 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. -->
Sets the value of a local variable of type resource on the specified object
+
Sets the value of a local variable of type resource on the specified 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. -->
 
[[GetLocalResource]]
 
[[GetLocalResource]]
 
[[Category: Variable functions]]
 
[[Category: Variable functions]]

Latest revision as of 06:02, 1 August 2009

Sets a local variable of type resource on an object

void SetLocalResource(
object oObject,
string sVarName,
resource sResource
);
Parameters:
oObject
The object on which to set the variable
sVarName
The name of the variable
sResource
The new value of the variable
Returns:

Nothing.

Source:

script.ldf

Description

Sets the value of 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.

See also

GetLocalResource