Difference between revisions of "SetEffectEngineInteger"
From Dragon Age Toolset Wiki
m (Minor editing, adding "See also" section) |
m (Fixing description) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name=SetEffectEngineInteger | + | |name = SetEffectEngineInteger |
| − | |brief=Sets the specified integer on the effect Engine Data structure | + | |brief = Sets the specified integer on the effect Engine Data structure |
| − | |param1type=effect | + | |param1type = effect |
| − | |param1name=efEffect | + | |param1name = efEffect |
| − | |param1desc=The effect to set the value on | + | |param1desc = The effect to set the value on |
| − | |param2type=int | + | |param2type = int |
| − | |param2name=nIndex | + | |param2name = nIndex |
| − | |param2desc=The index of the value to set | + | |param2desc = The index of the value to set |
| − | |param3type=int | + | |param3type = int |
| − | |param3name=nValue | + | |param3name = nValue |
| − | |param3desc=The value to be set | + | |param3desc = The value to be set |
| − | |returntype=effect | + | |returntype = effect |
| − | |returndesc=Returns the modified effect, returns an invalid effect on error. | + | |returndesc = Returns the modified effect, returns an invalid effect on error. |
| − | |sourcefile=script.ldf | + | |sourcefile = script.ldf |
| − | |sourcemodule= | + | |sourcemodule = |
}} | }} | ||
== Description == <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | == Description == <!-- 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 integer on the effect | + | Sets the specified integer on the effect, |
== Remarks == <!-- This section contains additional comments, observations and known issues. --> | == Remarks == <!-- This section contains additional comments, observations and known issues. --> | ||
| − | The Engine | + | The effect Engine Data structure is used to communicate with the game engine and can only be written to and not read from scripting. It is distinct from general purpose Effect Data structure which was previously used to exchange information. |
| + | |||
| + | This function should not be confused with [[SetEffectInteger]]. | ||
<!-- == Examples == --><!-- This section contains examples transcluded from the snippet library. --> | <!-- == Examples == --><!-- This section contains examples transcluded from the snippet library. --> | ||
== See also == <!-- This section contains links to articles, functions or constant groups. --> | == See also == <!-- This section contains links to articles, functions or constant groups. --> | ||
Revision as of 21:37, 29 March 2015
Sets the specified integer on the effect Engine Data structure
- Parameters:
- efEffect
- The effect to set the value on
- nIndex
- The index of the value to set
- nValue
- The value to be set
- Returns:
- Returns the modified effect, returns an invalid effect on error.
- Source:
- script.ldf
Description
Sets the specified integer on the effect,
Remarks
The effect Engine Data structure is used to communicate with the game engine and can only be written to and not read from scripting. It is distinct from general purpose Effect Data structure which was previously used to exchange information.
This function should not be confused with SetEffectInteger.
