Struct yy_boss::YypBoss

pub struct YypBoss {
    pub directory_manager: DirectoryManager,
    pub pipeline_manager: PipelineManager,
    pub sprites: YyResourceHandler<Sprite>,
    // some fields omitted
}

Fields

directory_manager: DirectoryManager

pipeline_manager: PipelineManager

sprites: YyResourceHandler<Sprite>

Implementations

impl YypBoss

pub fn new(path_to_yyp: &Path) -> AnyResult<YypBoss>

Creates a new YyBoss Manager and performs startup file reading.

pub fn default_texture_path(&self) -> Option<TexturePath>

Gets the default texture path, if it exists. The "Default" group simply has the name "Default".

pub fn current_resource_names(&self) -> Vec<(String, Resource)>

Returns a list of resource names already being used by the system.

In a project with a sprite spr_player and an object obj_player, this HashSet would contain "spr_player" and "obj_player".

pub fn new_folder_end(
    &mut self,
    parent_path: &ViewPath,
    name: String
) -> Result<ViewPath, FolderGraphError>

Adds a subfolder to the folder given at parent_path at the final order. If a tree looks like:

 Sprites/
     - spr_player
     - spr_enemy

and user adds a folder with name Items to the Sprites folder, then the output tree will be:

Sprites/
    - spr_player
    - spr_enemy
    - Items/

add_folder_to_end returns a Result<ViewPath>, where ViewPath is of the newly created folder. This allows for easy sequential operations, such as adding a folder and then adding a file to that folder.

pub fn new_folder_order(
    &mut self,
    parent_path: ViewPath,
    name: String,
    order: usize
) -> Result<ViewPath, FolderGraphError>

Adds a subfolder to the folder given at parent_path at given order. If a tree looks like:

 Sprites/
     - spr_player
     - OtherSprites/
     - spr_enemy

and user adds a folder with name Items to the Sprites folder with an order of 1, then the output tree will be:

Sprites/
    - spr_player
    - Items/
    - OtherSprites/
    - spr_enemy

add_folder_with_order returns a Result<ViewPath>, where ViewPath is of the newly created folder. This allows for easy sequential operations, such as adding a folder and then adding a file to that folder.

Nb: when users have Gms2 in "Alphabetical" sort order, the order value here is largely ignored by the IDE. This can make for odd and unexpected results.

pub fn new_resource_end(
    &mut self,
    parent_path: ViewPath,
    resource_name: &str,
    resource_kind: Resource
) -> Result<CreatedResource, FolderGraphError>

Adds a file to the folder given at parent_path and with the final order. If a tree looks like:

 Sprites/
     - spr_player
     - spr_enemy

and user adds a file with name spr_item to the Sprites folder, then the output tree will be:

Sprites/
    - spr_player
    - spr_enemy
    - spr_item

This function returns a FilledResourceToken, which is a required parameter for then assigning the Sprite to the Token.

pub fn remove_resource(
    &mut self,
    resource_name: &str,
    resource_kind: Resource
) -> Result<RemovedResource, FolderGraphError>

pub fn get_resource(&self, resource_name: &str) -> Option<CreatedResource>

Checks if a resource with a given name exists. If it does, it will return information on that resource in the form of the CreatedResource token, which can tell the user the type of resource.

pub fn serialize(&mut self) -> AnyResult<()>

Serializes the YypBoss data to disk at the path of the Yyp.

impl YypBoss

pub fn root_path(&self) -> ViewPath

pub fn yyp(&self) -> &Yyp

Shows the underlying Yyp. This is exposed mostly for integration tests.

pub fn root_folder(&self) -> &FolderGraph

Gives a reference to the current FolderGraph.

pub fn folder(&self, view_path: &ViewPath) -> Option<FolderGraph>

This could be a very hefty allocation!

Trait Implementations

impl Debug for YypBoss

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

Formats the value using the given formatter.

impl Into<Yyp> for YypBoss

fn into(self) -> Yyp

Performs the conversion.

impl PartialEq<YypBoss> for YypBoss

fn eq(&self, other: &Self) -> 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 !=.