Struct bevy::text::Text

pub struct Text {
    pub sections: Vec<TextSection>,
    pub justify: JustifyText,
    pub linebreak_behavior: BreakLineOn,
}

Fields

sections: Vec<TextSection>

justify: JustifyText

The text’s internal alignment. Should not affect its position within a container.

linebreak_behavior: BreakLineOn

How the text should linebreak when running out of the bounds determined by max_size

Implementations

impl Text

pub fn from_section(value: impl Into<String>, style: TextStyle) -> Text

Constructs a Text with a single section.

// Basic usage.
let hello_world = Text::from_section(
    // Accepts a String or any type that converts into a String, such as &str.
    "hello world!",
    TextStyle {
        font: font_handle.clone(),
        font_size: 60.0,
        color: Color::WHITE,
    },
);

let hello_bevy = Text::from_section(
    "hello world\nand bevy!",
    TextStyle {
        font: font_handle,
        font_size: 60.0,
        color: Color::WHITE,
    },
) // You can still add text justifaction.
.with_justify(JustifyText::Center);

pub fn from_sections(sections: impl IntoIterator<Item = TextSection>) -> Text

Constructs a Text from a list of sections.

let hello_world = Text::from_sections([
    TextSection::new(
        "Hello, ",
        TextStyle {
            font: font_handle.clone(),
            font_size: 60.0,
            color: Color::BLUE,
        },
    ),
    TextSection::new(
        "World!",
        TextStyle {
            font: font_handle,
            font_size: 60.0,
            color: Color::RED,
        },
    ),
]);

pub const fn with_justify(self, justify: JustifyText) -> Text

Returns this Text with a new JustifyText.

pub const fn with_no_wrap(self) -> Text

Returns this Text with soft wrapping disabled. Hard wrapping, where text contains an explicit linebreak such as the escape sequence \n, will still occur.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Text

where Text: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl FromReflect for Text

where Text: Any + Send + Sync, Vec<TextSection>: FromReflect + TypePath, JustifyText: FromReflect + TypePath, BreakLineOn: FromReflect + TypePath,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Text>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Text

where Text: Any + Send + Sync, Vec<TextSection>: FromReflect + TypePath, JustifyText: FromReflect + TypePath, BreakLineOn: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for Text

where Text: Any + Send + Sync, Vec<TextSection>: FromReflect + TypePath, JustifyText: FromReflect + TypePath, BreakLineOn: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Text>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Text>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Text>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for Text

where Text: Any + Send + Sync, Vec<TextSection>: FromReflect + TypePath, JustifyText: FromReflect + TypePath, BreakLineOn: FromReflect + TypePath,

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for Text

where Text: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Text

where Text: Any + Send + Sync, Vec<TextSection>: FromReflect + TypePath, JustifyText: FromReflect + TypePath, BreakLineOn: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.