Struct TextWriter

pub struct TextWriter<'w, 's, R: TextRoot> { /* private fields */ }

System parameter for reading and writing text spans in a text block.

R is the root text component, and S is the text span component on children.

Implementations

impl<'w, 's, R: TextRoot> TextWriter<'w, 's, R>

pub fn get( &mut self, root_entity: Entity, index: usize, ) -> Option<(Entity, usize, Mut<'_, String>, Mut<'_, TextFont>, Mut<'_, TextColor>)>

Gets a mutable reference to a text span within a text block at a specific index in the flattened span list.

pub fn get_text( &mut self, root_entity: Entity, index: usize, ) -> Option<Mut<'_, String>>

Gets the text value of a text span within a text block at a specific index in the flattened span list.

pub fn get_font( &mut self, root_entity: Entity, index: usize, ) -> Option<Mut<'_, TextFont>>

Gets the TextFont of a text span within a text block at a specific index in the flattened span list.

pub fn get_color( &mut self, root_entity: Entity, index: usize, ) -> Option<Mut<'_, TextColor>>

Gets the TextColor of a text span within a text block at a specific index in the flattened span list.

pub fn text(&mut self, root_entity: Entity, index: usize) -> Mut<'_, String>

Gets the text value of a text span within a text block at a specific index in the flattened span list.

Panics if there is no span at the requested index.

pub fn font(&mut self, root_entity: Entity, index: usize) -> Mut<'_, TextFont>

Gets the TextFont of a text span within a text block at a specific index in the flattened span list.

Panics if there is no span at the requested index.

pub fn color(&mut self, root_entity: Entity, index: usize) -> Mut<'_, TextColor>

Gets the TextColor of a text span within a text block at a specific index in the flattened span list.

Panics if there is no span at the requested index.

pub fn for_each( &mut self, root_entity: Entity, callback: impl FnMut(Entity, usize, Mut<'_, String>, Mut<'_, TextFont>, Mut<'_, TextColor>), )

Invokes a callback on each span in a text block, starting with the root entity.

pub fn for_each_text( &mut self, root_entity: Entity, callback: impl FnMut(Mut<'_, String>), )

Invokes a callback on each span’s string value in a text block, starting with the root entity.

pub fn for_each_font( &mut self, root_entity: Entity, callback: impl FnMut(Mut<'_, TextFont>), )

Invokes a callback on each span’s TextFont in a text block, starting with the root entity.

pub fn for_each_color( &mut self, root_entity: Entity, callback: impl FnMut(Mut<'_, TextColor>), )

Invokes a callback on each span’s TextColor in a text block, starting with the root entity.

pub fn for_each_until( &mut self, root_entity: Entity, callback: impl FnMut(Entity, usize, Mut<'_, String>, Mut<'_, TextFont>, Mut<'_, TextColor>) -> bool, )

Invokes a callback on each span in a text block, starting with the root entity.

Traversal will stop when the callback returns false.

Trait Implementations

impl<R: TextRoot> SystemParam for TextWriter<'_, '_, R>

type State = FetchState<R>

Used to store data which persists across invocations of a system.

type Item<'w, 's> = TextWriter<'w, 's, R>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn validate_param<'w, 's>( state: &'s Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's, R: TextRoot> ReadOnlySystemParam for TextWriter<'w, 's, R>

where ResMut<'w, TextIterScratch>: ReadOnlySystemParam, Query<'w, 's, (&'static mut R, &'static mut TextFont, &'static mut TextColor), Without<TextSpan>>: ReadOnlySystemParam, Query<'w, 's, (&'static mut TextSpan, &'static mut TextFont, &'static mut TextColor), Without<R>>: ReadOnlySystemParam, Query<'w, 's, &'static Children>: ReadOnlySystemParam,