Struct TextReader 

pub struct TextReader<'w, 's, 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: TextRoot> TextReader<'w, 's, R>

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, LineHeight)>

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 get_line_height( &mut self, root_entity: Entity, index: usize, ) -> Option<LineHeight>

Gets the LineHeight 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.

pub fn line_height(&mut self, root_entity: Entity, index: usize) -> LineHeight

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

Trait Implementations

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

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) -> Self::State

Creates a new instance of this param’s State.

fn init_access( state: &Self::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 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 mut 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 TextReader<'w, 's, R>

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