Difference between revisions of "SetLocalFloat"

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=SetLocalFloat
 
|name=SetLocalFloat
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 a local floating point variable sVarName on the specified
+
Sets a local floating point variable sVarName on the specified 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. -->
 
[[GetLocalFloat]]
 
[[GetLocalFloat]]
 
[[Category: Variable functions]]
 
[[Category: Variable functions]]

Latest revision as of 06:06, 1 August 2009

Sets a local floating point variable on an object.

void SetLocalFloat(
object oObject,
string sVarName,
float fValue
);
Parameters:
oObject
Object to set the variable on
sVarName
The name of the floating point variable to set
fValue
The value of the variable to set
Returns:

Nothing.

Source:

script.ldf

Description

Sets a local floating point 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

GetLocalFloat