Skip to main content

Effect

Enum Effect 

Source
pub enum Effect {
    SetVar {
        slot: u16,
        value: Val,
        add: bool,
    },
    SetLocal {
        slot: u16,
        value: Val,
        add: bool,
    },
    SetTransform {
        entity: Entity,
        transform: Transform,
    },
    Spawn(SpawnEffect),
    Despawn(Entity),
    Reparent {
        child: Entity,
        parent: Option<Entity>,
    },
    Visible(Entity, bool),
    Sound(PlayCue),
    Scene {
        scene: AssetId,
        transition: String,
    },
    Screen(AssetId),
    Story(StoryPlayback),
    Save,
}
Expand description

One world change a behavior asked for, in body order.

Variants§

§

SetVar

Write a world variable.

Fields

§slot: u16

The variable’s slot.

§value: Val

The value produced.

§add: bool

Add to the current value rather than replacing it.

§

SetLocal

Write one of the instance’s locals.

Fields

§slot: u16

The local’s slot.

§value: Val

The value produced.

§add: bool

Add to the current value rather than replacing it.

§

SetTransform

Replace an entity’s transform.

Fields

§entity: Entity

The entity to move.

§transform: Transform

Its new transform.

§

Spawn(SpawnEffect)

Copy a template into the world.

§

Despawn(Entity)

Remove an entity.

§

Reparent

Move an entity under another parent, or to the root.

Fields

§child: Entity

The entity to move.

§parent: Option<Entity>

Its new parent, or None for the root.

§

Visible(Entity, bool)

Show or hide an entity.

§

Sound(PlayCue)

Play an audio cue.

§

Scene

Load a scene.

Fields

§scene: AssetId

The scene to load.

§transition: String

The transition to play.

§

Screen(AssetId)

Show a screen.

§

Story(StoryPlayback)

Drive story playback.

§

Save

Persist the world’s behavior state.

Trait Implementations§

Source§

impl Clone for Effect

Source§

fn clone(&self) -> Effect

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 Effect

Source§

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

Formats the value using the given formatter. Read more

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> 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<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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.