Struct Sprite 

pub struct Sprite {
    pub name: String,
    pub description: String,
    pub size: Vec2,
    pub atlas: Option<String>,
    pub legacy: Option<LegacyRegion>,
    pub own: Option<LegacyRegion>,
    pub border: f32,
}

One entry of Yog’s GUI sprite table (SPRITES).

Fields

name: String

The stable Yog name (sprite:<name>).

description: String

What it is, for editors’ pickers.

size: Vec2

Natural size in GUI pixels (1.20.2+; 1.20.1 uses the legacy region’s).

atlas: Option<String>

GUI-atlas sprite id on Minecraft 1.20.2+ (minecraft:<id>, i.e. textures/gui/sprites/<id>.png).

legacy: Option<LegacyRegion>

Where it lives on 1.20.1.

own: Option<LegacyRegion>

Yog’s own picture of it (yog:textures/gui/…), for a version that has neither.

border: f32

Nine-slice border in pixels when stretched (0 = scale the whole image).

Implementations

impl Sprite

pub fn size(&self, atlas: bool) -> Vec2

Natural size on a host with (true) or without the GUI sprite atlas.

pub fn is_procedural(&self) -> bool

Drawn by Yog itself (no texture on any version) — the inventory slot.

pub fn sources(&self) -> Vec<SpriteSource<'_>>

Where it may come from, in the order a host tries them: the GUI atlas’s sprite (minecraft:<id>), the game’s texture region, Yog’s own picture. The host draws it from the first its game has.

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sprite

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

Formats the value using the given formatter.

impl PartialEq for Sprite

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Sprite