Actoreffect (Data Type)¶

• Table of contents
• Actoreffect (Data Type)
  • Description
  • Aquisition
  • Members
    • Effect Details
  • Methods

Description¶

This DataType includes all of the data available to ISXEQ2 related to effects on actors.  (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 actoreffect datatype object is via the Effect member of actor.

Members¶

• int ID
• int MainIconID
• int BackDropIconID
• int CurrentIncrements

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¶

• Examine