Difference between revisions of "GetLocalEffect"
From Dragon Age Toolset Wiki
(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: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetLocalEffect | |name=GetLocalEffect | ||
| Line 22: | Line 21: | ||
== 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. | ||
| + | |||
It should be noted that effects taken from current effects on an object are just copies of those effects, not references to them. | It should be noted that effects taken from current effects on an object are just copies of those effects, not references to them. | ||
<!-- == 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. --> | ||
[[SetLocalEffect]] | [[SetLocalEffect]] | ||
[[Category: Variable functions]] | [[Category: Variable functions]] | ||
Latest revision as of 06:00, 1 August 2009
Gets a local effect variable on an object.
- Parameters:
- oObject
- Object to get the variable from
- sVarName
- The name of the variable to retrieve
- Returns:
- Returns an effect variable, returns an invalid effect on error.
- Source:
- script.ldf
Description
Gets a local effect 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.
It should be noted that effects taken from current effects on an object are just copies of those effects, not references to them.
