Struct tts_external_api::messages::MessageCustomMessage

pub struct MessageCustomMessage {
    pub custom_message: Value,
}

Send a custom message to be forwarded to the onExternalMessage event handler in the currently loaded game. The value of customMessage must be an object, and is passed as a parameter to the event handler. If this value is not an object then the event is not triggered.

Fields

custom_message: Value

Custom message that gets forwarded

Implementations

impl MessageCustomMessage

pub fn new(custom_message: Value) -> Self

Constructs a new Custom Message

pub fn as_message(self) -> Message

Returns self as Message::MessageCustomMessage

Trait Implementations

impl Debug for MessageCustomMessage

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

Formats the value using the given formatter.

impl Serialize for MessageCustomMessage

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

Serialize this value into the given Serde serializer.

impl TryFrom<Message> for MessageCustomMessage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(message: Message) -> Result<Self, Self::Error>

Performs the conversion.