Struct Terminal

pub struct Terminal { /* private fields */ }

A grid of tiles for rendering colorful ascii.

Implementations

impl Terminal

pub fn new(size: impl GridSize) -> Self

pub fn from_rexpaint_file(file_path: impl AsRef<str>) -> Result<Self>

Create a terminal from a REXPaint file. Note this writes all layers to the same terminal, so it won’t preserve the transparent layering aspect of actual rexpaint files.

pub fn from_string(string: impl AsRef<str>) -> Option<Self>

Create a terminal from a string, where each line is a row of the terminal. Empty lines will be ignored, add a space if you want an actual empty row built into the terminal.

Example

use bevy_ascii_terminal::Terminal;
let terminal = Terminal::from_string("Hello\nWorld").unwrap();

pub fn with_clear_tile(self, clear_tile: Tile) -> Self

Specify the terminal’s clear tile. This is the default tile used when clearing a dense terminal.

pub fn with_string<T: AsRef<str>>( self, xy: impl Into<PivotedPoint>, string: impl Into<TerminalString<T>>, ) -> Self

A utility function to add a string to the terminal during creation.

pub fn put_char(&mut self, xy: impl Into<PivotedPoint>, ch: char) -> &mut Tile

Insert a character to the terminal.

This returns a mutable reference to the terminal tile which can be used to further modify it.

Example

use bevy_ascii_terminal::*;
let mut terminal = Terminal::new([10, 10]);
terminal.put_char([5, 5], 'X').fg(color::RED);

pub fn put_fg_color( &mut self, xy: impl Into<PivotedPoint>, color: impl Into<LinearRgba>, ) -> &mut Tile

Set the foreground color of a tile.

This returns a mutable reference to the terminal tile which can be used to further modify it.

Example

use bevy_ascii_terminal::*;
let mut terminal = Terminal::new([10, 10]);
terminal.put_fg_color([5, 5], color::RED).bg(color::BLUE);

pub fn put_bg_color( &mut self, xy: impl Into<PivotedPoint>, color: impl Into<LinearRgba>, ) -> &mut Tile

Set the background color of a tile.

This returns a mutable reference to the terminal tile which can be used to further modify it.

Example

use bevy_ascii_terminal::*;
let mut terminal = Terminal::new([10, 10]);
terminal.put_bg_color([5, 5], color::BLUE).fg(color::RED);

pub fn put_tile(&mut self, xy: impl Into<PivotedPoint>, tile: Tile) -> &mut Tile

Insert a tile into the terminal.

pub fn clear(&mut self)

Clear the terminal, setting all tiles to the terminal’s clear_tile.

pub fn fill(&mut self, tile: Tile)

pub fn put_string<T: AsRef<str>>( &mut self, xy: impl Into<PivotedPoint>, string: impl Into<TerminalString<T>>, )

Write a formatted string to the terminal.

Formatting options can be applied to the string before writing it to the terminal, see TerminalString.

By default strings will be written to the top left of the terminal. You can apply a pivot to the xy position to change this.

Example

use bevy_ascii_terminal::*;
let mut terminal = Terminal::new([10, 10]);
terminal.put_string([5, 5], "Hello, World!".bg(color::BLUE));
terminal.put_string([1, 1].pivot(Pivot::BottomLeft), "Beep beep!");

pub fn read_line( &self, xy: impl Into<PivotedPoint>, width: usize, ) -> impl Iterator<Item = char> + '_

Read a line of characters starting from a grid position on the terminal.

As with Terminal::put_string the xy position will default to a top-left pivot.

pub fn tile_to_index(&self, xy: impl Into<PivotedPoint>) -> usize

Transform a local 2d tile index into 1d index into the terminal tile data.

pub fn index_to_tile(&self, i: usize) -> IVec2

Convert a 1d index into the terminal tile data into it’s corresponding 2d tile index.

pub fn tile_mut(&mut self, xy: impl Into<PivotedPoint>) -> &mut Tile

Retrieve a tile at the grid position. This will panic if the position is out of bounds.

pub fn tile(&self, xy: impl Into<PivotedPoint>) -> &Tile

Retrieve a tile at the grid position. This will panic if the position is out of bounds.

pub fn width(&self) -> usize

pub fn height(&self) -> usize

pub fn size(&self) -> UVec2

pub fn tile_count(&self) -> usize

pub fn tiles(&self) -> &[Tile]

The terminal tiles as a slice.

pub fn tiles_mut(&mut self) -> &mut [Tile]

The terminal tiles as a slice.

pub fn iter_row(&self, row: usize) -> impl DoubleEndedIterator<Item = &Tile>

Iterate over a row of terminal tiles. Row indices start from 0 at the bottom.

pub fn iter_row_mut( &mut self, row: usize, ) -> impl DoubleEndedIterator<Item = &mut Tile>

Iterate over a row of terminal tiles. Row indices start from 0 at the bottom.

pub fn iter_column( &self, column: usize, ) -> impl DoubleEndedIterator<Item = &Tile>

Iterate over a column of terminal tiles. Column indices start from 0 at the left.

pub fn iter_column_mut( &mut self, column: usize, ) -> impl DoubleEndedIterator<Item = &mut Tile>

Iterate over a column of terminal tiles. Column indices start from 0 at the left.

pub fn iter_rect( &self, rect: GridRect, ) -> impl DoubleEndedIterator<Item = &Tile>

Iterate over a rectangular section of terminal tiles.

pub fn iter_rect_mut( &mut self, rect: GridRect, ) -> impl DoubleEndedIterator<Item = &mut Tile>

Iterate over a rectangular section of terminal tiles.

pub fn iter_xy(&self) -> impl DoubleEndedIterator<Item = (IVec2, &Tile)>

An iterator over all tiles that also yields each tile’s 2d grid position

pub fn iter_xy_mut( &mut self, ) -> impl DoubleEndedIterator<Item = (IVec2, &mut Tile)>

An iterator over all tiles that also yields each tile’s 2d grid position

pub fn iter(&self) -> impl Iterator<Item = &Tile>

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Tile>

pub fn bounds(&self) -> GridRect

The local grid bounds of the terminal. For world bounds see TerminalTransform.

pub fn clear_tile(&self) -> Tile

pub fn resize(&mut self, new_size: impl GridSize)

Trait Implementations

impl Clone for Terminal

fn clone(&self) -> Terminal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Terminal

where Self: Send + Sync + 'static,

Required Components: TerminalTransform, TerminalFont, TerminalMeshPivot, UvMappingHandle, Mesh2d, [MeshMaterial2d < TerminalMaterial >], RebuildMeshVerts.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

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 Debug for Terminal

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

Formats the value using the given formatter.

impl FromReflect for Terminal

where Terminal: Any + Send + Sync, UVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Tile>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Tile: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Terminal

where Terminal: Any + Send + Sync, UVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Tile>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Tile: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialReflect for Terminal

where Terminal: Any + Send + Sync, UVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Tile>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Tile: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Terminal

where Terminal: Any + Send + Sync, UVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Tile>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Tile: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Struct for Terminal

where Terminal: Any + Send + Sync, UVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Tile>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Tile: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for Terminal

where Terminal: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Terminal

where Terminal: Any + Send + Sync, UVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Tile>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Tile: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.