Project

General

Profile

ISXEQ2 »

effect (Data Type)

Description

This DataType includes all of the data available to ISXEQ2 related to effects.  (Additional information is available in the effectinfo datatype, which is accessible via the ToEffectInfo member below.)

(Please note that all members of this datatype are available in memory at all times and never require a server or cache check.)

Aquisition

The best way to acquire an effect datatype object is via the Effect member or QueryEffects method of character.

Members

  • int ID
  • int MainIconID
  • int BackDropIconID
  • int CurrentIncrements
  • string Type
    • ​Returns:  Beneficial, Detrimental, or Unknown
  • float Duration
    • This is the current duration of the effect in seconds.
  • float MaxDuration
    • This is the maximum duration of the effect in seconds.

Effect Details

  • bool IsEffectInfoAvailable
    • If the effect "details" are not already stored in a cache, then this will return FALSE until it is available.  Script writers are encouraged to utilize the logic shown in the sample included with the Knowledgebase article "Iterating Effects and Handling 'effectinfo' Aquisition".
  • effectinfo ToEffectInfo
    • If the effect "details" are not already stored in a cache, then this will return NULL until it is available.  Script writers are encouraged to utilize the logic shown in the sample included with the Knowledgebase article "Iterating Effects and Handling 'effectinfo' Aquisition".
    • (Note:   Due to how ISXEQ2 handles the acquisition of effectinfo, script writers should check IsEffectInfoAvailable until it's TRUE before using ToEffectInfo (as opposed to checking ToEffectInfo until it's not NULL.)    This methodology will avoid spamming the server with requests.)

Methods

  • Cancel
  • Examine
  • Hide

Technical Notes

  • If you log off and back on with 'duration' buffs/effects, will notice that the MaxDuration will change to reflect that.  For example, a spell might have a max duration of 900 seconds. If you log off when the "Duration" is 850, then when log back on, the MaxDuration will say 850 and Duration will tick down from there. This is how SOE keeps your buffs/effects from timing away while you're offline.
  • The MainIconID and BackDropIconID members will match the corresponding values found via the ability datatype.
  • The Duration and MaxDuration members are only available for effects on the current player character.