Skip to main content

GitAreaEffect

Struct GitAreaEffect 

Source
pub struct GitAreaEffect {
Show 26 fields pub tag: String, pub object_id: ObjectId, pub area_effect_id: i32, pub spell_id: u32, pub spell_save_dc: i32, pub spell_level: i32, pub meta_magic_type: u8, pub shape: GitAreaEffectShape, 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 position_x: f32, pub position_y: f32, pub position_z: f32, pub orientation_x: f32, pub orientation_y: f32, pub orientation_z: f32, pub on_heartbeat: ResRef, pub on_user_defined: ResRef, pub on_obj_enter: ResRef, pub on_obj_exit: ResRef,
}
Expand description

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§

§tag: String

Object tag (Tag).

§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.

§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).

§shape: GitAreaEffectShape

The ground the effect covers.

§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).

§position_x: f32

X position (PositionX).

§position_y: f32

Y position (PositionY).

§position_z: f32

Z position (PositionZ).

§orientation_x: f32

X orientation (OrientationX).

§orientation_y: f32

Y orientation (OrientationY).

§orientation_z: f32

Z orientation (OrientationZ).

§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.

Trait Implementations§

Source§

impl Clone for GitAreaEffect

Source§

fn clone(&self) -> GitAreaEffect

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GitAreaEffect

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GitAreaEffect

Source§

fn default() -> GitAreaEffect

Returns the “default value” for a type. Read more
Source§

impl PartialEq for GitAreaEffect

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for GitAreaEffect

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.