Struct BoxPlace 

#[non_exhaustive]
pub struct BoxPlace {
    pub frame: Rect,
    pub text_x: i32,
    pub text_y: i32,
    pub narration: NarrationAlign,
}

Where a text box goes on the console. Build it with BoxPlace::new: a struct literal doesn’t compile outside this crate, so a new field never breaks a game (ADR-0039).

use shuyi_ui::dialogue::text_box::glyph::{BoxPlace, NarrationAlign};
use shuyi_ui::frame::glyph_buffer::Rect;

const PLACE: BoxPlace = BoxPlace {
    frame: Rect::new(0, 18, 48, 6),
    text_x: 2,
    text_y: 19,
    narration: NarrationAlign::Centred,
};

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

frame: Rect

The box, border included, when it holds one page.

text_x: i32

The column the text starts at.

text_y: i32

The row of the text’s first line.

narration: NarrationAlign

Where narration sits: NarrationAlign::Centred or from text_x.

Implementations

impl BoxPlace

pub const fn new(frame: Rect, text_x: i32, text_y: i32) -> Self

A box at frame whose text starts at column text_x on row text_y, with narration Centred (with_narration changes it).

pub const fn with_narration(self, narration: NarrationAlign) -> Self

The place with narration set as narration says: usable in a const item.

Trait Implementations

impl Clone for BoxPlace

fn clone(&self) -> BoxPlace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BoxPlace

impl Debug for BoxPlace

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

Formats the value using the given formatter.

impl Eq for BoxPlace

impl PartialEq for BoxPlace

fn eq(&self, other: &BoxPlace) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BoxPlace