Struct TextReader 

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

System parameter for reading text spans in a text block.

R is the root text component.

Implementations

impl<'w, 's, R> TextReader<'w, 's, R>

where R: TextRoot,

pub fn iter(&mut self, root_entity: Entity) -> TextSpanIter<'_, R>

Returns an iterator over text spans in a text block, starting with the root entity.

pub fn get( &mut self, root_entity: Entity, index: usize, ) -> Option<(Entity, usize, &str, &TextFont, Color)>

Gets 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<&str>

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<&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<Color>

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) -> &str

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) -> &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) -> Color

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.

Trait Implementations

impl<R> SystemParam for TextReader<'_, '_, R>

where R: TextRoot,

type State = FetchState<R>

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

type Item<'w, 's> = TextReader<'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, ) -> <TextReader<'_, '_, R> as SystemParam>::State

Creates a new instance of this param’s State.

fn init_access( state: &<TextReader<'_, '_, R> as SystemParam>::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam

fn apply( state: &mut <TextReader<'_, '_, R> as SystemParam>::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 <TextReader<'_, '_, R> as SystemParam>::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 mut <TextReader<'_, '_, R> as SystemParam>::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 <TextReader<'_, '_, R> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> <TextReader<'_, '_, R> as SystemParam>::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's, R> ReadOnlySystemParam for TextReader<'w, 's, R>

where R: TextRoot, Local<'s, TextIterScratch>: ReadOnlySystemParam, Query<'w, 's, (&'static R, &'static TextFont, &'static TextColor, Option<&'static Children>)>: ReadOnlySystemParam, Query<'w, 's, (&'static TextSpan, &'static TextFont, &'static TextColor, Option<&'static Children>)>: ReadOnlySystemParam,