Struct yy_boss::YypBoss

pub struct YypBoss { /* fields omitted */ }

Implementations

impl YypBoss

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

Creates a new YyBoss Manager and performs startup file reading.

pub fn absolute_path(&self) -> &Path

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) -> &HashSet<String>

Gets an unordered HashSet of currently used resource names.

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

pub fn overwrite_sprite(
    &mut self,
    sprite: Sprite,
    associated_data: Vec<(FrameId, SpriteImageBuffer)>
) -> AnyResult<()>

Add a sprite into the YYP Boss. If the sprite doesn't exist, throws an error!

pub fn add_sprite(
    &mut self,
    sprite: Sprite,
    associated_data: Vec<(FrameId, SpriteImageBuffer)>
)

Add a sprite into the YYP Boss. It is not immediately serialized, but will be serialized the next time the entire YYP Boss is.

Please note -- the name of the Sprite MIGHT change if that name already exists!

pub fn mark_sprite_with_path(
    &mut self,
    sprite_id: FilesystemPath,
    ase_name: String
)

For the shared data in a sprite. a little messy!

pub fn get_sprite(&self, sprite_name: &str) -> Option<&Sprite>

This gets the data on a given Sprite with a given name. If no Sprite by that name exists, then a None is returned. It does not return a handle on the Associated Data of the Sprite.

pub fn get_sprite_data(&self) -> Option<<Sprite as YyResource>::SharedData>

pub fn add_folder_to_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 add_folder_with_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.

pub fn add_file_at_end(
    &mut self,
    parent_path: ViewPath,
    name: String,
    child: FilesystemPath
) -> Result<usize, 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

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

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

 Sprites/
     - spr_player
     - spr_enemy

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

Sprites/
    - spr_player
    - spr_item
    - spr_enemy

Additionally, spr_enemy's order will be updated to be 2.

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

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!

impl YypBoss

Utilities

pub fn ensure_yyboss_data(path: &Path) -> AnyResult<()>

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 !=.