Difference between revisions of "GetLocalFloat"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
m
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
 
|name=GetLocalFloat
 
|name=GetLocalFloat
Line 20: Line 19:
 
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. -->
 
[[SetLocalFloat]]
 
[[SetLocalFloat]]
 
[[Category: Variable functions]]
 
[[Category: Variable functions]]

Revision as of 05:58, 1 August 2009

Gets a local floating point variable off of an object.

float GetLocalFloat(
object oObject,
string sVarName
);
Parameters:
oObject
Object to get the var on
sVarName
The name of the floating point variable to retrieve
Returns:

Returns the floating point variable, returns 0.0f on error.

Source:

script.ldf

Description

Gets 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

SetLocalFloat