...
- Exist as an OBJECT_TYPE_AREA_OF_EFFECT and searchable specifically with GetFirstObjectInShape and GetNearestObject (yes both movable and non-movable ones)
- Has a tag matching the "LABEL" column and findable using GetObjectByTag and GetNearestObjectByTag
- This is also - without further interaction - the only way to get the bounding sizes and other properties
- Has special properties set on it regarding:
- The creator (the object the script applying the effect was called from) returned by GetAreaOfEffectCreator(OBJECT_SELF)
- The event scripts: On Enter, On Exit and Heartbeat - done from the script command or the 2da line - there is also a User Defined Event apparently available, but cannot be set at inception but later can with SetEventScript (needs testing!)
- The size and shape of it from the 2da entry
- The duration remaining (not sure this can be retrieved)
- The spell ID which is used when applying effects (so they can be accurately removed later)
- The spell save DC - should set to the right amount when GetSpellSaveDC is called, we hope, although it could still change after later castings. To test in EE.
- The caster level - should be set to the right amount when using ResistSpell, GetCasterLevel (not sure if using OBJECT_SELF or GetAreaOfEffectCreator) and when new effects are applied from the AOE object (which get traced to the creator of the AOE applying them). However this probably needs heavily testing to be really sure it does all this in EE.
- If the AOE calls EventSpellCastAt it will use the creator, not itself, as the caster
- If the AOE applies an effect apparently (needs fully testing - in the case of now-invalid casters also!) it gets created with the correct spell ID and that the creator is GetAreaOfEffectCreator.
Moving Object Properties
- Applied as an effect that is searchable by GetFirst/NextEffect and can be removed with RemoveEffect and DispelMagic functions. The duration is tracked here instead and is retrievable.
- Will be moving with the object it is applied to - although is known to "Lag behind" meaning the creature moves outside of the AOE area and the OnExit event removes it. This is especially true if the creature is moving fast or there are just a lot of things going on and the AOE just...doesn't update it's location.
- Think of it as a check that does JumpToLocation(GetLocation(GetAreaOfEffectCreator(OBJECT_SELF))) done...intermittently
...
There are some oddities when AOEs overlap.
2da Columns
| Column Name | Example | Valid Values | Description and Notes |
|---|---|---|---|
| LABEL | VFX_PER_FOGACID | Text that matches a tag format | For once a LABEL column that is actually used by the game! This column is used to set the tag of the created AOE object. Tags are usually upper case, with no spaces. Bioware signifies "VFX_PER_" as "persistent", applied to the ground, and VFX_MOB_ as "mobile" - ie applied to a creature. |
| SHAPE | C | C - Circular R - Retangular | There doesn't appear to be any other options, but C and R cover most use cases. |
| RADIUS | 5 | Float value | Radius in meters if SHAPE is C. This is used both for the edge where On Enter is triggered/objects are considered inside the AOE, but also for the VFX limits if MODEL01/MODEL02/MODEL03 is used. |
| WIDTH | 10 | Float value | Width in meters if SHAPE is R This is used both for the edge where On Enter is triggered/objects are considered inside the AOE, but also for the VFX limits if MODEL01/MODEL02/MODEL03 is used. |
| LENGTH | 2 | Float value | Length in meters if SHAPE is R This is used both for the edge where On Enter is triggered/objects are considered inside the AOE, but also for the VFX limits if MODEL01/MODEL02/MODEL03 is used. |
| ONENTER | NW_S0_AcidFogA | Resref of script NSS file | On Enter script that fires when an object enters the area. Bioware ones are signified by "A" |
| ONEXIT | NW_S0_AcidFogB | Resref of script NSS file | On Exit script that fires when an object leaves the area (also happens if the AOE duration runs out or it is destroyed). Bioware ones are signified by "A" |
| HEARTBEAT | NW_S0_AcidFogC | Resref of script NSS file | On Heartbeat script that fires when 6 seconds has elapsed (so "once per round") if the AOE object gets proper updates mind you (See: issues above). Bioware ones are signified by "C". |
| OrientWithGround | 0 | 0 or 1 | Presumably causes the VFX to be orientated with the ground, so on slopes it'd be flat against the slope. No default AOE Bioware uses has this turned on, probably because it'd look weird. |
| DurationVFX | 230 | visualeffects.2da line reference | A large, single VFX that is applied to the position of the VFX when the AOE is in place. Many that use this option do not use the other options in this list. |
| MODEL01 | vps_fogacid | Resref of VFX model | If MODEL01 is defined then NUMACT01 amounts are spawned for DURATION01 milliseconds randomly in the area with EDGEWGHT01 affecting how close to the edge they are. |
| MODEL02 | vps_fogacid | Resref of VFX model | If MODEL02 is defined then NUMACT03 amounts are spawned for DURATION02 milliseconds randomly in the area with EDGEWGHT02 affecting how close to the edge they are. |
| MODEL03 | vps_fogacid | Resref of VFX model | If MODEL03 is defined then NUMACT03 amounts are spawned for DURATION03 milliseconds randomly in the area with EDGEWGHT03 affecting how close to the edge they are. |
| NUMACT01 | 5 | Integer amount | Amount of MODEL01 VFX models to spawn |
| NUMACT02 | 10 | Integer amount | Amount of MODEL02 VFX models to spawn |
| NUMACT03 | 5 | Integer amount | Amount of MODEL03 VFX models to spawn |
| DURATION01 | 3400 | Integer milliseconds | Amount of time MODEL01 VFX models stay for |
| DURATION02 | 1100 | Integer milliseconds | Amount of time MODEL02 VFX models stay for |
| DURATION03 | 1900 | Integer milliseconds | Amount of time MODEL03 VFX models stay for |
| EDGEWGHT01 | 0 | 0.0 - 1.0 float | Edge weight of MODEL01 VFX inside the AOE shape |
| EDGEWGHT02 | 0.25 | 0.0 - 1.0 float | Edge weight of MODEL02 VFX inside the AOE shape |
| EDGEWGHT03 | 0.25 | 0.0 - 1.0 float | Edge weight of MODEL03 VFX inside the AOE shape |
| SoundImpact | sps_darkness | Resref of sound file | A one time single shot sound effect played at the location of where the AOE is spawned |
| SoundDuration | sps_fog_loop | Resref of sound file | A repeating constantly playing sound effect centered on the location where the AOE is |
| SoundCessation | **** | Resref of sound file | A one time single shot sound effect played at the location of where the AOE is when it is removed from the game (end of duration/DestroyObject) |
| SoundOneShot | sps_fog | Resref of sound file | A sound that apparently repeatedly randomly plays each round |
| SoundOneShotPercentage | 0.3 | 0.0 - 1.0 float | Percentage chance (per round?) to play the SoundOneShot VFX |
| MODELMIN01 | vps_fogacid_L | Resref of VFX model | Replaces MODEL01 if present and is on Low Quality Graphics mode |
| MODELMIN02 | vps_fogacid_L | Resref of VFX model | Replaces MODEL02 if present and is on Low Quality Graphics mode |
| MODELMIN03 | vps_fogacid_L | Resref of VFX model | Replaces MODEL03 if present and is on Low Quality Graphics mode |