Struct AreMiniGameObjectScripts 

pub struct AreMiniGameObjectScripts {
    pub on_create: ResRef,
    pub on_heartbeat: ResRef,
    pub on_anim_event: ResRef,
    pub on_hit_bullet: ResRef,
    pub on_hit_follower: ResRef,
}

The Scripts struct every minigame object carries.

Read by CSWMiniGameObject::LoadScripts, which obstacles use directly and vehicles extend (see AreMiniGameVehicleScripts). Every slot defaults to an empty resref and the engine writes that empty value into the script slot whether or not the file supplied one, so an absent field clears a prior script rather than leaving it in place.

OnHeartbeat is the fifth and last slot the base reads, after OnAnimEvent.

It was missing from the write-up of this subsystem, and from the corpus scan the write-up was checked against, because the ARE root carries a script field under the same label: a scan keyed on bare labels sees the root’s and counts the nested one as already modelled.

Fields

on_create: ResRef

Fired when the object is created (OnCreate).

on_heartbeat: ResRef

Fired on the object’s heartbeat (OnHeartbeat).

on_anim_event: ResRef

Fired on a model animation event (OnAnimEvent).

on_hit_bullet: ResRef

Fired when a bullet hits the object (OnHitBullet).

on_hit_follower: ResRef

Fired when a track follower hits the object (OnHitFollower).

Trait Implementations

impl Clone for AreMiniGameObjectScripts

fn clone(&self) -> AreMiniGameObjectScripts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AreMiniGameObjectScripts

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

Formats the value using the given formatter.

impl Default for AreMiniGameObjectScripts

fn default() -> AreMiniGameObjectScripts

Returns the “default value” for a type.

impl PartialEq for AreMiniGameObjectScripts

fn eq(&self, other: &AreMiniGameObjectScripts) -> 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 AreMiniGameObjectScripts