Struct Text 

pub struct Text {
    pub content: Arc<str>,
    pub font: Handle<Font>,
    pub font_size: f32,
    pub color: Color,
    pub layer: i32,
}

renderable text component.

any entity carrying a Transform and a Text is drawn automatically each frame. position comes from Transform.translation.

example

use lunar::prelude::*;

fn spawn_label(mut commands: Commands, mut assets: ResMut<AssetServer>) {
    let font = assets.load_font("ui.ttf");
    commands.spawn((
        Transform::from_xy(10.0, 10.0),
        Text::new("Score: 0", font).with_size(20.0),
    ));
}

Fields

content: Arc<str>

text content. use Arc::from("hello") or Arc::from(string) to set.

font: Handle<Font>

font to render with

font_size: f32

font size in pixels

color: Color

text color (RGBA)

layer: i32

render layer

Implementations

impl Text

pub fn new(content: impl Into<Arc<str>>, font: Handle<Font>) -> Self

create a text component with default settings (16px white, UI layer)

pub const fn with_size(self, font_size: f32) -> Self

set font size in pixels

pub const fn with_color(self, color: Color) -> Self

set text color

pub const fn with_layer(self, layer: i32) -> Self

set the render layer

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Text

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for Text

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

Formats the value using the given formatter.