Struct valence_text::Text

source ·

pub struct Text(/* private fields */);

Expand description

Represents formatted text in Minecraft’s JSON text format.

Text is used in various places such as chat, window titles, disconnect messages, written books, signs, and more.

For more information, see the relevant Minecraft Wiki article.

§Examples

With IntoText in scope, you can write the following:

use valence_text::{Color, IntoText, Text};

let txt = "The text is ".into_text()
    + "Red".color(Color::RED)
    + ", "
    + "Green".color(Color::GREEN)
    + ", and also "
    + "Blue".color(Color::BLUE)
    + "! And maybe even "
    + "Italic".italic()
    + ".";

assert_eq!(
    txt.to_string(),
    r#"{"text":"The text is ","extra":[{"text":"Red","color":"red"},{"text":", "},{"text":"Green","color":"green"},{"text":", and also "},{"text":"Blue","color":"blue"},{"text":"! And maybe even "},{"text":"Italic","italic":true},{"text":"."}]}"#
);

Implementations§

source §

impl Text

source

pub fn text(plain: P) -> Self
where P: Into<Cow<'static, str>>,

Constructs a new plain text object.

source

pub fn translate<K, W>(key: K, with: W) -> Self
where K: Into<Cow<'static, str>>, W: Into<Vec<Text>>,

Create translated text based on the given translation key, with extra text components to be inserted into the slots of the translation text.

source

pub fn score<N, O>( name: N, objective: O, value: Option<Cow<'static, str>>, ) -> Self
where N: Into<Cow<'static, str>>, O: Into<Cow<'static, str>>,

Create a score from the scoreboard with an optional custom value.

source

pub fn selector<S>(selector: S, separator: Option<Text>) -> Self
where S: Into<Cow<'static, str>>,

Creates a text component for selecting entity names with an optional custom separator.

source

pub fn keybind<K>(keybind: K) -> Self
where K: Into<Cow<'static, str>>,

Creates a text component for a keybind. The keybind should be a valid keybind identifier.

source

pub fn block_nbt<B, N>( block: B, nbt: N, interpret: Option<bool>, separator: Option<Text>, ) -> Self
where B: Into<Cow<'static, str>>, N: Into<Cow<'static, str>>,

Creates a text component for a block NBT tag.

source

pub fn entity_nbt<E, N>( entity: E, nbt: N, interpret: Option<bool>, separator: Option<Text>, ) -> Self
where E: Into<Cow<'static, str>>, N: Into<Cow<'static, str>>,

Creates a text component for an entity NBT tag.

source

pub fn storage_nbt<S, N>( storage: S, nbt: N, interpret: Option<bool>, separator: Option<Text>, ) -> Self
where S: Into<Ident<Cow<'static, str>>>, N: Into<Cow<'static, str>>,

Creates a text component for a command storage NBT tag.

source

pub fn is_empty(&self) -> bool

Returns true if the text contains no characters. Returns false otherwise.

source

pub fn to_legacy_lossy(&self) -> String

Converts the Text object to a plain string with the legacy formatting (§ and format codes)

Removes everything that can’t be represented with a § and a modifier. Any colors not on the the legacy color list will be replaced with their closest equivalent.

Trait Implementations§

source §

impl<T: IntoText<'static>> Add<T> for Text

source §

type Output = Text

The resulting type after applying the + operator.

source §

fn add(self, rhs: T) -> Self::Output

Performs the + operation. Read more

source §

impl<T: IntoText<'static>> AddAssign<T> for Text

source §

fn add_assign(&mut self, rhs: T)

Performs the += operation. Read more

source §

impl Clone for Text

source §

fn clone(&self) -> Text

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

source §

impl Debug for Text

source §

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

Formats the value using the given formatter. Read more

source §

impl Default for Text

source §

fn default() -> Text

Returns the “default value” for a type. Read more

source §

impl Deref for Text

source §

type Target = TextInner

The resulting type after dereferencing.

source §

fn deref(&self) -> &Self::Target

Dereferences the value.

source §

impl DerefMut for Text

source §

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

source §

impl<'de> Deserialize<'de> for Text

source §

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more

source §

impl Display for Text

source §

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

Formats the value using the given formatter. Read more

source §