Difference between revisions of "SetEffectEngineObject"
From Dragon Age Toolset Wiki
m (Correcting category) |
m (Fixing based on SetEffectEngineInteger) |
||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
| − | |name=SetEffectEngineObject | + | |name = SetEffectEngineObject |
| − | |brief= | + | |brief = Sets the specified object on the effect Engine Data structure |
| − | |param1type=effect | + | |param1type = effect |
| − | |param1name=efEffect | + | |param1name = efEffect |
| − | |param1desc= | + | |param1desc = The effect to set the value on |
| − | |param2type=int | + | |param2type = int |
| − | |param2name=nIndex | + | |param2name = nIndex |
| − | |param2desc= | + | |param2desc = The index of the value to set |
| − | |param3type=object | + | |param3type = object |
| − | |param3name=oValue | + | |param3name = oValue |
| − | |param3desc= | + | |param3desc = The value to be set |
| − | |returntype=effect | + | |returntype = effect |
| − | |returndesc= | + | |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. --> | |
| − | <!-- 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 object on the effect. |
| − | + | == Remarks == <!-- This section contains additional comments, observations and known issues. --> | |
| − | <!-- This section contains additional comments, observations and known issues. --> | + | 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 [[SetEffectObject]]. | ||
| + | <!-- == Examples == --><!-- This section contains examples transcluded from the snippet library. --> | ||
| + | == See also == <!-- This section contains links to articles, functions or constant groups. --> | ||
| + | * [[effect_constants_h]] | ||
[[Category: Effect functions]] | [[Category: Effect functions]] | ||
Latest revision as of 21:42, 29 March 2015
Sets the specified object on the effect Engine Data structure
- Parameters:
- efEffect
- The effect to set the value on
- nIndex
- The index of the value to set
- oValue
- The value to be set
- Returns:
- Returns the modified effect, returns an invalid effect on error.
- Source:
- script.ldf
Description
Sets the specified object 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 SetEffectObject.
