Struct AuthoredStrings 

pub struct AuthoredStrings {
    pub key: Option<String>,
    pub text: Option<String>,
    pub placeholder: Option<String>,
    pub alt: Option<String>,
    pub tooltip: Option<String>,
    pub tooltip_key: Option<String>,
}

The strings an element was authored with and the catalogue key that names them, carried so the element can be rebuilt in another locale without re-reading the markup.

Every field is an opaque string here, exactly like TextFormat: core keeps what the author wrote, and the rule that turns a key into a message lives on the other side of the seam. An element with no key and no format carries none of this.

Fields

key: Option<String>

The translatable="key" catalogue key, when the element names one.

text: Option<String>

The element’s authored text.

placeholder: Option<String>

A text entry’s authored prompt.

alt: Option<String>

An image’s authored alternative text.

tooltip: Option<String>

The authored body of the wrapping tooltip.

tooltip_key: Option<String>

The tooltip’s own catalogue key, which is separate from the element’s: a tooltip is its own element with its own text.

Trait Implementations

impl Clone for AuthoredStrings

fn clone(&self) -> AuthoredStrings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for AuthoredStrings

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_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [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 AuthoredStrings

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

Formats the value using the given formatter.

impl Default for AuthoredStrings

fn default() -> AuthoredStrings

Returns the “default value” for a type.