Difference between revisions of "SetEffectString"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (looks okay, removing tag)
m (Correcting category)
 
Line 16: Line 16:
 
|sourcemodule=
 
|sourcemodule=
 
}}
 
}}
 
 
== 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 specified string on the effect
 
Sets the specified string on the effect
 
 
== Remarks ==
 
== Remarks ==
 
<!-- This section contains additional comments, observations and known issues. -->
 
<!-- This section contains additional comments, observations and known issues. -->
 
It should be noted that there is no maximum number of values on an effect, as the array of values on the effect expands as needed.
 
It should be noted that there is no maximum number of values on an effect, as the array of values on the effect expands as needed.
 
 
<!-- == 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. -->
 
[[GetEffectString]]
 
[[GetEffectString]]
[[Category: Effect access functions]]
+
[[Category:Effect functions]]

Latest revision as of 18:54, 10 March 2012

Sets the specified string on the effect

effect SetEffectString(
effect efEffect,
int nIndex,
string sValue
);
Parameters:
efEffect
The effect to set the value on
nIndex
The index of the value to set
sValue
The value of the value to set
Returns:

Returns the modfied effect, returns an invalid effect on error.

Source:

script.ldf

Description

Sets the specified string on the effect

Remarks

It should be noted that there is no maximum number of values on an effect, as the array of values on the effect expands as needed.

See also

GetEffectString