Struct ark_api::world::FormattedText

pub struct FormattedText { /* private fields */ }

Represents formatted text that can be attached to a Render component.

Implementations

impl FormattedText

pub fn new(data: &str) -> Self

Creates the FormattedText from data.

data contains a formatted string, formatted using a custom markup language documented elsewhere. If the string is empty, nothing will be drawn. Only characters supported by Ark’s current hardcoded fonts will work, others may be replaced with little squares or similar. Multiline is OK, \n will be treated as a linebreak (\r is ignored). A native \n character will also be considered a line break.

TODO: Replace this constructor with one that takes a high level representation and encodes the string, similar to the one in ark-modules.

Panics

If there are mistakes in the formatting, it will panic. This is intentional currently since we only intend the markup to be generated from a higher level source, so panics will catch bugs in that conversion but should otherwise never happen.

pub fn new_with_fonts(data: &str, fonts: Vec<Font>) -> Self

Creates the FormattedText from data.

data contains a formatted string, formatted using a custom markup language documented elsewhere. If the string is empty, nothing will be drawn. Only characters supported by Ark’s current hardcoded fonts will work, others may be replaced with little squares or similar. Multiline is OK, \n will be treated as a linebreak (\r is ignored). A native \n character will also be considered a line break.

Also takes a vector of fonts which can be indexed into with including \f in the string.

TODO: Replace this constructor with one that takes a high level representation and encodes the string, similar to the one in ark-modules.

Panics

If there are mistakes in the formatting, it will panic. This is intentional currently since we only intend the markup to be generated from a higher level source, so panics will catch bugs in that conversion but should otherwise never happen.

Trait Implementations

impl Clone for FormattedText

fn clone(&self) -> FormattedText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FormattedText

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

Formats the value using the given formatter.

impl Hash for FormattedText

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<FormattedText> for FormattedText

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ValueConverterTrait<FormattedText> for ValueConverter

fn into_value(v: FormattedText) -> Value

Wraps the passed-in value in a Value enum.

fn from_value(v: &Value) -> FormattedText

Extracts the value from a Value enum.

impl Eq for FormattedText

impl StructuralEq for FormattedText

impl StructuralPartialEq for FormattedText