Struct Component 

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

A JSON text component, built field by field.

use rift_plugin::text::Component;

let invite = Component::text("Alex invited you. ")
    .extra(Component::text("[Accept]").color("green").bold().run_command("/party accept Alex"));
assert_eq!(
    serde_json::Value::from(invite),
    serde_json::json!({
        "text": "Alex invited you. ",
        "extra": [{
            "text": "[Accept]", "color": "green", "bold": true,
            "click_event": {"action": "run_command", "command": "/party accept Alex"},
        }],
    })
);

Implementations

impl Component

pub fn text(text: impl Into<String>) -> Self

A component showing text.

pub fn color(self, color: impl Into<String>) -> Self

A colour name such as red or #ff8800.

pub fn bold(self) -> Self

Bold text.

pub fn italic(self) -> Self

Italic text.

pub fn underlined(self) -> Self

Underlined text.

pub fn strikethrough(self) -> Self

Struck-through text.

pub fn obfuscated(self) -> Self

Obfuscated (scrambling) text.

pub fn run_command(self, command: impl Into<String>) -> Self

A click runs command (with its leading /) as the player.

pub fn suggest_command(self, command: impl Into<String>) -> Self

A click puts command into the player’s chat box.

pub fn open_url(self, url: impl Into<String>) -> Self

A click opens url (http or https) after a confirmation.

pub fn copy_to_clipboard(self, text: impl Into<String>) -> Self

A click copies text to the clipboard.

pub fn hover_text(self, text: impl Into<String>) -> Self

Hover text shown as written.

pub fn hover(self, component: impl Into<Value>) -> Self

Hover text as a component, such as another Component or a mini object.

pub fn insertion(self, text: impl Into<String>) -> Self

Text inserted into the chat box on shift-click.

pub fn extra(self, child: impl Into<Value>) -> Self

Appends a child: a Component, an authoring object or a string shown as written. Children inherit this component’s style.

pub fn field(self, key: impl Into<String>, value: impl Into<Value>) -> Self

Sets any other field, such as font, shadow_color or "italic": false.

pub fn to_value(&self) -> Value

The component as JSON.

Trait Implementations

impl Clone for Component

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

impl Display for Component

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

The JSON text.

impl From<Component> for Value

fn from(builder: Component) -> Value

Converts to this type from the input type.

impl PartialEq for Component

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Component