pub enum Command<'gc, 'a, C: CustomTypes<S>, S: System<C>> {
    Print {
        style: PrintStyle,
        value: Option<Value<'gc, C, S>>,
    },
    SetProperty {
        prop: Property,
        value: Value<'gc, C, S>,
    },
    ChangeProperty {
        prop: Property,
        delta: Value<'gc, C, S>,
    },
    ClearEffects,
    ClearDrawings,
    SetCostume,
    PlaySound {
        sound: Rc<Audio>,
        blocking: bool,
    },
    GotoXY {
        x: Number,
        y: Number,
    },
    GotoEntity {
        target: &'a Entity<'gc, C, S>,
    },
    PointTowardsXY {
        x: Number,
        y: Number,
    },
    PointTowardsEntity {
        target: &'a Entity<'gc, C, S>,
    },
    Forward {
        distance: Number,
    },
}
Expand description

A non-value-returning command issued from the runtime.

Variants§

§

Print

Fields

§value: Option<Value<'gc, C, S>>

Output Some Value or None to perform a Snap!-style clear.

§

SetProperty

Fields

§value: Value<'gc, C, S>

Set an entity property to a specific value.

§

ChangeProperty

Fields

§delta: Value<'gc, C, S>

Apply a relative change to the value of an entity property.

§

ClearEffects

Clear all graphic effects on the entity. This is equivalent to setting all the graphic effect properties to zero.

§

ClearDrawings

Clear all drawings made by all sprites.

§

SetCostume

Sets the costume on the entity. At this point the costume has already been assigned to Entity::costume, so this is just a hook for any custom update code that is needed for external purposes.

§

PlaySound

Fields

§sound: Rc<Audio>
§blocking: bool

Plays a sound, optionally with a request to block until the sound is finished playing. It is up to the receiver to actually satisfy this blocking aspect, if desired.

§

GotoXY

Fields

Moves the entity to a specific location.

§

GotoEntity

Fields

§target: &'a Entity<'gc, C, S>

Moves the current entity to the same position as the target entity.

§

PointTowardsXY

Fields

Points the entity towards a specific location.

§

PointTowardsEntity

Fields

§target: &'a Entity<'gc, C, S>

Points the current entity towards a target entity.

§

Forward

Fields

§distance: Number

Move forward by a given distance. If the distance is negative, move backwards instead.

Implementations§

source§

impl<'gc, C: CustomTypes<S>, S: System<C>> Command<'gc, '_, C, S>

source

pub fn feature(&self) -> Feature

Gets the Feature associated with this command.

Auto Trait Implementations§

§

impl<'gc, 'a, C, S> !RefUnwindSafe for Command<'gc, 'a, C, S>

§

impl<'gc, 'a, C, S> !Send for Command<'gc, 'a, C, S>

§

impl<'gc, 'a, C, S> !Sync for Command<'gc, 'a, C, S>

§

impl<'gc, 'a, C, S> Unpin for Command<'gc, 'a, C, S>

§

impl<'gc, 'a, C, S> !UnwindSafe for Command<'gc, 'a, C, S>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more