FANDOM


This file contains functions for working with area of effect (AoE) objects. It defines no constants.

Includes Edit

Standard

  • X2_Inc_Spellhook

Grimoire

Functions Edit

int SGAOEAffectedByGoW (object oAOE) This function uses the AOE_TYPE_* constants to examine area of effect objects. It contains a list of those that should be dispelled by the gust of wind spell, and returns either TRUE or FALSE, if the object should be destroyed.


object SGGetAOEOnObject (object oTarget, string sTag,
object oCaster) This function returns an area of effect object that has been placed on oTarget, having tag sTag, and that was created by oCaster. This function is usually called in a spell script immediately after the application of the AoE to the target. If one is not found meeting the criteria, it returns OBJECT_INVALID.


object SGGetAOEAtLocation (location lTarget, string sTag,
object oCaster) This function returns an area of effect object that has tag sTag, was created by oCaster, and exists at the target location. This function is usually called in a spell script immediately after the application of the AoE at the target location. If one is not found meeting the criteria, it returns OBJECT_INVALID.


void SGSetMobAOECarrier (object oTarget, object oAOE=OBJECT_SELF) This function is called once the AoE object has been acquired, or is called by the AoE object itself. It sets the object the AoE was applied to as a local on the AoE object for later retrieval.


object SGGetMobAOECarrier (object oAOE=OBJECT_SELF) This function returns the object to which the AoE was applied. The object must first have been set by a call to SGSetAOEMobCarrier.


void SGSetPerAOETarget (object oTarget, object oAOE=OBJECT_SELF) This function is called once the AoE object has been acquired, or is called by the AoE object itself. It is to be used for AoEs that are applied to location and are meant to continually act upon a particular target object. The object is set on the AoE as a local variable.


object SGGetPerAOETarget (object oAOE=OBJECT_SELF) This function returns the object the persistent AoE is supposed to be targeting. The object must first have been set by a call to SGSetPerAOETarget.


void SGSetAOEMetaMagicFeat (int iMetamagic, object oAOE=OBJECT_SELF) This function is called once the AoE object has been acquired. It stores the metamagic value used in the initial casting of the spell on the AoE object for later retrieval. This allows AoE spells to be maximized or empowered.


int SGGetAOEMetaMagicFeat (object oAOE=OBJECT_SELF) This function returns the metamagic value which was stored on the AoE object. The value must first have been set by a call to SGSetAOEMetaMagicFeat.


void SGSetAOESpellId (int iSpellID, object oAOE=OBJECT_SELF) This function is called once the AoE object has been acquired. It sets the spell id of the spell that created the AoE as a local variable on the object for later retrieval.


int SGGetAOESpellId (object oAOE=OBJECT_SELF) This function returns the value of the spell id which was stored on the AoE object. The value must first have been set by a call to SGSetAOESpellId.


void SGSetAOEElementalType (int iElementalType, object oAOE=OBJECT_SELF) This function is called once the AoE object has been acquired. It stores the energy type of the spell on the AoE object for later retrieval. This allows for AoE spells to remember the energy type used if the energy substitution feat was used in the spell casting.


int SGGetAOEElementalType (object oAOE=OBJECT_SELF) This function returns the energy type of the spell that created the AoE object. The value must first have been set by a call to SGSetAOEElementalType.


void SGSetAOELocation (location lTarget, object oAOE=OBJECT_SELF) This function is called once the AoE object has been acquired. It stores a location on the AoE object. Usually this location is the location gotten in the initial spell script by GetSpellTargetLocation(). The GetLocation() function, when used on the object, does not return the location used in the initial spell script, so this method was devised to remember that location.


location SGGetAOELocation (object oAOE) This function returns the location value stored by SGSetAOELocation.


void SGSetIsAOEUnderwater (int iTrueFalse, object oAOE=OBJECT_SELF) This function is called once the AoE object has been acquired. It stores whether or not the AoE was cast underwater for later retrieval.


int SGGetIsAOEUnderwater (object oAOE=OBJECT_SELF) This function returns the value store on the AoE object by SGSetIsAOEUnderwater.

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.