Struct GitAreaEffect 

pub struct GitAreaEffect {

    pub shape: GitAreaEffectShape,
    pub tag: String,
    pub area_effect_id: i32,
    pub spell_id: u32,
    pub spell_save_dc: i32,
    pub spell_level: i32,
    pub meta_magic_type: u8,
    pub creator_id: u32,
    pub linked_to_object: u32,
    pub last_entered: u32,
    pub last_left: u32,
    pub duration: u32,
    pub duration_type: u8,
    pub last_heartbeat_day: u32,
    pub last_heartbeat_time: u32,
    pub on_heartbeat: ResRef,
    pub on_user_defined: ResRef,
    pub on_obj_enter: ResRef,
    pub on_obj_exit: ResRef,
    pub object_id: ObjectId,
    pub orientation_x: f32,
    pub orientation_y: f32,
    pub orientation_z: f32,
    pub position_x: f32,
    pub position_y: f32,
    pub position_z: f32,
}

An area-of-effect object placed in the area (struct type 13).

These are runtime spell and ability effects. Unlike every other object list, they have no blueprint: no loader in the binary ever opens a template for one, so UseTemplates has nothing to select between and Git::area_effects is a plain Vec rather than a GitObjects.

Not exercised by the fixture corpus

Every save in fixtures/saves/ has an empty AreaEffectList, so this field set comes from the engine’s own load and save paths rather than from real data. A test asserts the lists are still empty, so a corpus that grows one fails loudly instead of quietly going unchecked.

Fields

shape: GitAreaEffectShape

The effect’s footprint, as whichever shape the file describes.

tag: String

Object tag (Tag).

area_effect_id: i32

Effect row (AreaEffectId), into vfx_persistent.2da.

spell_id: u32

Originating spell (SpellId).

spell_save_dc: i32

Save DC of the originating spell (SpellSaveDC).

spell_level: i32

Level of the originating spell (SpellLevel).

meta_magic_type: u8

Metamagic applied to the originating spell (MetaMagicType).

creator_id: u32

Object that created the effect (CreatorId).

linked_to_object: u32

Object the effect is attached to (LinkedToObject).

last_entered: u32

Last object to enter the effect (LastEntered).

last_left: u32

Last object to leave the effect (LastLeft).

duration: u32

Remaining duration (Duration).

duration_type: u8

How the duration is counted (DurationType).

last_heartbeat_day: u32

Day of the last heartbeat (LastHrtbtDay).

last_heartbeat_time: u32

Time of the last heartbeat (LastHrtbtTime).

on_heartbeat: ResRef

OnHeartbeat. Written by the engine, never read back.

on_user_defined: ResRef

OnUserDefined. Written by the engine, never read back.

on_obj_enter: ResRef

OnObjEnter. Written by the engine, never read back.

on_obj_exit: ResRef

OnObjExit. Written by the engine, never read back.

object_id: ObjectId

Runtime object id (ObjectId).

Defaults to the engine-wide OBJECT_INVALID placeholder rather than zero, which is what a freshly constructed object carries.

orientation_x: f32

X orientation (OrientationX).

orientation_y: f32

Y orientation (OrientationY).

orientation_z: f32

Z orientation (OrientationZ).

position_x: f32

X position (PositionX).

position_y: f32

Y position (PositionY).

position_z: f32

Z position (PositionZ).

Implementations

impl GitAreaEffect

pub const SCHEMA: [Field; 25]

This view’s schema, one entry per declared field.

pub const PARTS: &'static [&'static [Field]]

This type’s schema in parts, which is what a container holding it references.

Own fields first, then one part per flattened child in the order they are declared.

pub fn read_declared(root: &GffStruct) -> Self

Reads every declared field off root.

Absent fields take the entry’s own answer, so a fallback is derived from the declaration rather than restated beside it.

A field declaring a hand-written read is left at that answer for the view to overwrite.

pub fn write_declared(&self, root: &mut GffStruct)

Writes every declared field onto root, leaving out the ones their entry says the engine’s own writer leaves out.

A field declaring a hand-written write is not touched here.

impl GitAreaEffect

pub fn read_element(structure: &GffStruct) -> Self

Reads one AreaEffectList element, resolving the shape’s four labels.

pub fn write_element(&self, structure: &mut GffStruct)

Writes one element, emitting only the dimensions its shape uses.

A circle carrying a Width would be a field the engine never wrote.

Trait Implementations

impl Clone for GitAreaEffect

fn clone(&self) -> GitAreaEffect

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GitAreaEffect

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GitAreaEffect

fn default() -> Self

What a file omitting every label loads to, which is what makes an authored file land in a known state rather than at zero.

impl HasSchema for GitAreaEffect

fn schema() -> &'static [Field]

The root field schema for this resource type.

fn parts() -> &'static [&'static [Field]]

The same schema in parts, own fields first.

impl PartialEq for GitAreaEffect

fn eq(&self, other: &GitAreaEffect) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GitAreaEffect