Struct ChatComponentObject

Source
pub struct ChatComponentObject {
Show 14 fields pub text: Option<String>, pub translate: Option<String>, pub keybind: Option<String>, pub bold: Option<bool>, pub italic: Option<bool>, pub underlined: Option<bool>, pub strikethrough: Option<bool>, pub obfuscated: Option<bool>, pub font: Option<String>, pub color: Option<String>, pub insertion: Option<String>, pub click_event: Option<ChatClickEvent>, pub hover_event: Option<ChatHoverEvent>, pub extra: Option<Vec<ChatObject>>,
}
Expand description

A piece of a ChatObject

Fields§

§text: Option<String>

Text of the chat message

§translate: Option<String>

Translation key if the message needs to pull from the language file. See wiki.vg

§keybind: Option<String>

Displays the keybind for the specified key, or the string itself if unknown.

§bold: Option<bool>

Should the text be rendered bold?

§italic: Option<bool>

Should the text be rendered italic?

§underlined: Option<bool>

Should the text be rendered underlined?

§strikethrough: Option<bool>

Should the text be rendered as strikethrough

§obfuscated: Option<bool>

Should the text be rendered as obfuscated? Switching randomly between characters of the same width

§font: Option<String>

The font to use to render, comes in three options:

  • minecraft:uniform - Unicode font
  • minecraft:alt - enchanting table font
  • minecraft:default - font based on resource pack (1.16+)

Any other value can be ignored

§color: Option<String>

The color to display the chat item in. Can be a chat color, format code, or any valid web color

§insertion: Option<String>

Text to insert into the chat box when shift-clicking this component

§click_event: Option<ChatClickEvent>

Defines an event that occurs when this chat item is clicked

§hover_event: Option<ChatHoverEvent>

Defines an event that occurs when this chat item is hovered on

§extra: Option<Vec<ChatObject>>

Sibling components to this chat item. If present, will not be empty

Trait Implementations§

Source§

impl Debug for ChatComponentObject

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ChatComponentObject

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ChatComponentObject

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,