Struct components::engine::d2::display::TextSprite

pub struct TextSprite {
    pub inner: Sprite,
    pub wrap_width: AnimatedFloat,
    pub letter_spacing: AnimatedFloat,
    pub line_spacing: AnimatedFloat,
    /* private fields */
}

A sprite that displays a line of text using a bitmap font.

Fields

inner: Sprite

wrap_width: AnimatedFloat

The maximum available width of this text before word wrapping to a new line. Defaults to 0 (no word wrapping).

letter_spacing: AnimatedFloat

Additional horizontal space to apply between letters, in pixels. Defaults to 0. Positive values make text look “looser”, negative values look “tighter”.

line_spacing: AnimatedFloat

Additional vertical space to apply between lines, in pixels. Defaults to 0. Positive values make lines look “looser”, negative values look “tighter”.

Implementations

impl TextSprite

pub fn new(font: Font, text: Option<String>) -> TextSprite

pub fn draw(&mut self, gfx: &Box<dyn Graphics + 'static, Global>)

pub fn natural_width(&mut self) -> f32

pub fn natural_height(&mut self) -> f32

pub fn contains_local(&mut self, local_x: f32, local_y: f32) -> bool

pub fn set_wrap_width(&mut self, wrap_width: f32) -> &TextSprite

Chainable convenience method to set the wrap width. @returns This instance, for chaining.

pub fn set_letter_spacing(&mut self, letter_spacing: f32) -> &TextSprite

Chainable convenience method to set the letter spacing. @returns This instance, for chaining.

pub fn set_line_spacing(&mut self, line_spacing: f32) -> &TextSprite

Chainable convenience method to set the line spacing. @returns This instance, for chaining.

pub fn text(&self) -> Option<String>

pub fn set_text(&mut self, text: Option<String>)

pub fn font(&self) -> Font

pub fn set_font(&mut self, font: Font)

pub fn align(&self) -> TextAlign

pub fn set_align(&mut self, align: TextAlign)

pub fn on_update(&mut self, dt: f32)

Trait Implementations

impl AsRef<Sprite> for TextSprite

fn as_ref(&self) -> &Sprite

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TextSprite

fn clone(&self) -> TextSprite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextSprite

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

Formats the value using the given formatter.

impl Default for TextSprite

fn default() -> TextSprite

Returns the “default value” for a type.

impl EntityManager<TextSprite> for Entity

fn get(&self) -> Option<TextSprite>