Difference between revisions of "SetEffectEngineInteger"
From Dragon Age Toolset Wiki
m (Correcting category) |
m (Minor editing, adding "See also" section) |
||
| Line 10: | Line 10: | ||
|param3type=int | |param3type=int | ||
|param3name=nValue | |param3name=nValue | ||
| − | |param3desc=The | + | |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. | ||
| 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 integer on the effect | Sets the specified integer on the effect | ||
| − | == Remarks == | + | == Remarks == <!-- This section contains additional comments, observations and known issues. --> |
| − | <!-- This section contains additional comments, observations and known issues. --> | + | The Engine Effect data structure is used to communicate with the game engine and can only be written to and not read from scripting. It is separate from general purpose Effect data structure which used exchange information. |
| − | The Engine data structure can only be written to and not read from scripting. | + | <!-- == Examples == --><!-- This section contains examples transcluded from the snippet library. --> |
| − | <!-- == Examples == --> | + | == See also == <!-- This section contains links to articles, functions or constant groups. --> |
| − | <!-- This section contains examples transcluded from the snippet library. --> | + | * [[EFFECT_INTERGER_*]] |
| − | + | * [[effect_constants_h]] | |
| − | <!-- This section contains links to articles, functions or constant groups. --> | + | |
| − | + | ||
[[Category: Effect functions]] | [[Category: Effect functions]] | ||
Revision as of 20:13, 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 Engine Effect data structure is used to communicate with the game engine and can only be written to and not read from scripting. It is separate from general purpose Effect data structure which used exchange information.
