Struct yy_typings::sprite::SpriteSequence

pub struct SpriteSequence {
    pub sprite_id: FilesystemPath,
    pub time_units: usize,
    pub playback: usize,
    pub playback_speed: f64,
    pub playback_speed_type: PlaybackSpeed,
    pub auto_record: bool,
    pub volume: f64,
    pub length: f64,
    pub events: SpriteEvents,
    pub moments: SpriteMoments,
    pub tracks: Vec<Track>,
    pub visible_range: Option<VisibleRange>,
    pub lock_origin: bool,
    pub show_backdrop: bool,
    pub show_backdrop_image: bool,
    pub backdrop_image_path: String,
    pub backdrop_image_opacity: f64,
    pub backdrop_width: u64,
    pub backdrop_height: u64,
    pub backdrop_x_offset: f64,
    pub backdrop_y_offset: f64,
    pub xorigin: isize,
    pub yorigin: isize,
    pub event_to_function: Value,
    pub event_stub_script: Option<()>,
    pub parent: FilesystemPath,
    pub resource_version: String,
    pub name: String,
    pub tags: Tags,
    pub resource_type: ConstGmSequence,
}

Fields

sprite_id: FilesystemPath

The path to the parent sprite.

time_units: usize

The Units of time of the Sequence. It will always be 1 in a Sprite.

playback: usize

Will always be One.

playback_speed: f64

The playback speed of the Sequence.

playback_speed_type: PlaybackSpeed

The type of the playback speed.

auto_record: bool

Whether to autorecord the sequence. This will always be true for sprites.

volume: f64

The volume of the sequence. Always 1.

length: f64

The number of frames of the Sprite. GMS2 records this as an f64 due to its shared status between sequences -- this can be converted to a usize without issue.

events: SpriteEvents

The sprite events, which are always the Default value of SpriteEvents, for the Sprite.

moments: SpriteMoments

The sprite moments, which are always the Default value of SpriteMoments, for the Sprite.

tracks: Vec<Track>

The "tracks" which the Sprite has. There is only every One track for a Sprite.

visible_range: Option<VisibleRange>

This denotes which range is visible. I am not clear what it means.

lock_origin: bool

Whether the origin of the sprite is locked in the GMS2 Editor. It has no effect otherwise.

show_backdrop: bool

show_backdrop_image: bool

backdrop_image_path: String

backdrop_image_opacity: f64

backdrop_width: u64

backdrop_height: u64

backdrop_x_offset: f64

backdrop_y_offset: f64

xorigin: isize

yorigin: isize

event_to_function: Value

This can be a {}, which basically is impossible for us to parse. So that's a mess.

event_stub_script: Option<()>

parent: FilesystemPath

This is a duplicate of sprite_id, and should always be the same value. It is unknown why there is duplicate data.

resource_version: String

The resource version. Currently 1.3.

name: String

The name of the SpriteSequence, which is always an empty string.

tags: Tags

The tags given to this resource. Empty.

resource_type: ConstGmSequence

This is the resource type. Always GMSequence.

Trait Implementations

impl Clone for SpriteSequence

fn clone(&self) -> SpriteSequence

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteSequence

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

Formats the value using the given formatter.

impl Default for SpriteSequence

fn default() -> Self

Return SpriteSequence { sprite_id: Default::default(), time_units: 1, playback: 1, playback_speed: Default::default(), playback_speed_type: Default::default(), auto_record: true, volume: 1.0, length: Default::default(), events: Default::default(), moments: Default::default(), tracks: Default::default(), visible_range: Default::default(), lock_origin: Default::default(), show_backdrop: true, show_backdrop_image: false, backdrop_image_path: String :: new(), backdrop_image_opacity: 0.5, backdrop_width: Default::default(), backdrop_height: Default::default(), backdrop_x_offset: Default::default(), backdrop_y_offset: Default::default(), xorigin: Default::default(), yorigin: Default::default(), event_to_function: serde_json :: Value :: Object(serde_json :: Map :: new()), event_stub_script: None, parent: Default::default(), resource_version: "1.3" . to_string(), name: String :: new(), tags: vec ! [], resource_type: Default::default() }

impl<'de> Deserialize<'de> for SpriteSequence

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<SpriteSequence> for SpriteSequence

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for SpriteSequence

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SpriteSequence