Struct Text

pub struct Text(pub FormattedText);

Tuple Fields

0: FormattedText

Methods from Deref<Target = FormattedText>

pub fn get_base_mut(&mut self) -> &mut BaseComponent

pub fn get_base(&self) -> &BaseComponent

pub fn to_custom_format<F, S, C>( &self, style_formatter: F, text_formatter: S, cleanup_formatter: C, default_style: &Style, ) -> String

where F: FnMut(&Style, &Style, &Style) -> (String, String), S: FnMut(&str) -> String, C: FnMut(&Style) -> String,

Render all components into a single String, using your custom closures to drive styling, text transformation, and final cleanup.

Type params

• F: (running, component, default) -> (prefix, suffix) for per-component styling
• S: &str -> String for text tweaks (escaping, mapping, etc.)
• C: &final_running_style -> String for any trailing cleanup

Args

• style_formatter: how to open/close each component’s style
• text_formatter: how to turn raw text into output text
• cleanup_formatter: emit after all components (e.g. reset codes)
• default_style: where to reset when a component’s reset is true

Example

use azalea_chat::{FormattedText, DEFAULT_STYLE};
use serde::de::Deserialize;

let component = FormattedText::deserialize(&serde_json::json!({
   "text": "Hello, world!",
   "color": "red",
})).unwrap();

let ansi = component.to_custom_format(
    |running, new, default| (running.compare_ansi(new, default), String::new()),
    |text| text.to_string(),
    |style| {
        if !style.is_empty() {
            "\u{1b}[m".to_string()
        } else {
            String::new()
        }
    },
    &DEFAULT_STYLE,
);
println!("{}", ansi);

pub fn to_ansi_with_custom_style(&self, default_style: &Style) -> String

Convert this component into an ANSI string.

This is the same as FormattedText::to_ansi, but you can specify a default Style to use.

pub fn to_ansi(&self) -> String

Convert this component into an ANSI string, so you can print it to your terminal and get styling.

This is technically a shortcut for FormattedText::to_ansi_with_custom_style with a default Style colored white.

Examples

use azalea_chat::FormattedText;
use serde::de::Deserialize;

let component = FormattedText::deserialize(&serde_json::json!({
   "text": "Hello, world!",
   "color": "red",
})).unwrap();

println!("{}", component.to_ansi());

pub fn to_html(&self) -> String

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 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, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

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 register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its [ComponentHooks].

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 Deref for Text

type Target = FormattedText

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Text

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.