Struct yy_typings::sprite::Frame

pub struct Frame {
    pub composite_image: Image,
    pub images: Vec<Image>,
    pub parent: FilesystemPath,
    pub resource_version: String,
    pub name: FrameId,
    pub tags: Tags,
    pub resource_type: ConstGmSpriteFrame,
}

Fields

composite_image: Image

This is the actual image you'll see in the game. It's a composite of the images below. It's LayerID will always be UUID::default, or 0000...0000, but it's FrameID will always == Self.Id.

images: Vec<Image>

These are the images which compose the composite image. At the minimum, there will be one Image. It's LayerID will correspond to the LayerId of a Sprite above.

parent: FilesystemPath

This is the path to the sprite parent. It will always have the name of the Sprite name, and the path to the sprite .yy file.

resource_version: String

The version of this particular resource.

name: FrameId

This is the name of the Frame, which will always be a UUID.

tags: Tags

These are the tags affixed to this frame, which is not possible.

resource_type: ConstGmSpriteFrame

This is the type of Resource.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Self

Return Frame { composite_image: Default::default(), images: Default::default(), parent: Default::default(), resource_version: "1.0" . to_string(), name: Default::default(), tags: vec ! [], resource_type: Default::default() }

impl<'de> Deserialize<'de> for Frame

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

Deserialize this value from the given Serde deserializer.

impl Eq for Frame

impl PartialEq<Frame> for Frame

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

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

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

This method tests for !=.

impl Serialize for Frame

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Frame

impl StructuralPartialEq for Frame