Struct yy_boss::YypFolder

pub struct YypFolder {
    pub folder_path: ViewPathLocation,
    pub order: usize,
    pub resource_version: ResourceVersion,
    pub name: String,
    pub tags: Vec<String>,
    pub resource_type: ConstGmFolder,
}

A YYP Folder. These form a graph, but each path is a full path from the root. Therefore, to create a tree, one must walk from the root to the final destination.

Fields

folder_path: ViewPathLocation

The full path from the root to the virtual folder location. The first part of the path is always folders. For top level folders, will look like "Folders/Fonts.yy", for example.

order: usize

The order within the subfolder. If custom ordering is added, then this will be the order as the resources appear within the tree structure. Otherwise, it is meaningless, and Gms2 appears to not keep in tracked or coherent.

resource_version: ResourceVersion

The resource version of this Resource. Currently "1.0".

name: String

The human-readable name of this Folder. The last part of the folder_path and this name should agree. Human readable names include examples such as "Sprites", "Light Data", or "Really Good Tiles".

tags: Vec<String>

Apparently tags can be placed here, even though they definitely can't. Don't do that.

resource_type: ConstGmFolder

The Resource Type of this folder, which is always "GMFolder".

Trait Implementations

impl Clone for YypFolder

fn clone(&self) -> YypFolder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for YypFolder

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

Formats the value using the given formatter.

impl Default for YypFolder

fn default() -> YypFolder

Return YypFolder { folder_path: Default::default(), order: Default::default(), resource_version: Default::default(), name: Default::default(), tags: Default::default(), resource_type: Default::default() }

impl<'de> Deserialize<'de> for YypFolder

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

Deserialize this value from the given Serde deserializer.

impl Eq for YypFolder

impl Hash for YypFolder

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for YypFolder

fn cmp(&self, other: &YypFolder) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<YypFolder> for YypFolder

This is an ugly partialeq impl here. I'm just not sure what the best option is right now, especially when it comes to unit tests.

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<YypFolder> for YypFolder

fn partial_cmp(&self, other: &YypFolder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &YypFolder) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &YypFolder) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &YypFolder) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &YypFolder) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for YypFolder

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

Serialize this value into the given Serde serializer.

impl YypSerialization for YypFolder

fn yyp_serialization(&self, indentation: usize) -> String

const LINE_ENDING: &'static str