Struct ambient_api::prelude::message::MessageContext

pub struct MessageContext {
    pub source: Source,
    pub listener: Listener,
}

Message context.

Fields

source: Source

Where the message came from.

listener: Listener

The listener that can be used to stop listening.

Implementations

impl MessageContext

pub fn runtime(&self) -> bool

Is this message from the runtime?

pub fn server(&self) -> bool

Available on crate feature client only.

Is this message from the corresponding serverside package?

pub fn client_user_id(&self) -> Option<String>

Available on crate feature server only.

The user that sent this message, if any.

pub fn client_entity_id(&self) -> Option<EntityId>

Available on crate feature server only.

The entity ID of the player that sent this message, if any.

pub fn local(&self) -> Option<EntityId>

The module on this side that sent this message, if any.

pub fn stop(&self)

Stops listening.

Trait Implementations

impl Debug for MessageContext

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

Formats the value using the given formatter.