Struct Text 

pub struct Text {
    pub label: String,
    pub value: String,
    pub font: String,
    pub font_size: f32,
    pub translation: Vec2,
    pub layer: f32,
    pub rotation: f32,
    pub scale: f32,
}

A Text is a bit of text that exists on the screen.

Fields

label: String

READONLY: A label to identify the text. This is not the text that is displayed! This is the label you use to retrieve and modify your text from the Engine::texts HashMap. This must be unique or the game will crash.

value: String

SYNCED: The actual text value you want to display.

font: String

SYNCED: The font to use. Should be a file name of an .otf or .ttf font located within the assets/ folder somewhere. Defaults to “font/FiraSans-Bold.ttf” (included in the asset pack).

font_size: f32

SYNCED: The font size of the text you want to display. WARNING: As font sizes get larger, the sprites we generate for them get slower to create. Very large sizes will crash. The default font size is 30.0.

translation: Vec2

SYNCED: Where you are in 2D game space. Positive x is right. Positive y is up. (0.0, 0.0) is the center of the screen.

layer: f32

SYNCED: Depth of the text. 0.0 (back) to 999.0 (front) Defaults to TEXT_DEFAULT_LAYER

rotation: f32

SYNCED: Direction you face in radians. Defaults to RIGHT. See also the direction constants.

scale: f32

SYNCED: 1.0 is the normal 100%.

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.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Text

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Text