Enum ambient_api::prelude::message::Target

pub enum Target {
    LocalBroadcast {
        include_self: bool,
    },
    Local(EntityId),
    ServerUnreliable,
    ServerReliable,
    ClientBroadcastUnreliable,
    ClientBroadcastReliable,
    ClientTargetedUnreliable(String),
    ClientTargetedReliable(String),
}

The target for a originating message.

Variants

LocalBroadcast

Fields

include_self: bool

Whether or not the message should be sent to the package that originally sent the message.

A message to all other packages running on this side.

Local(EntityId)

A message to a specific package or module running on this side.

ServerUnreliable

Available on crate feature client only.

An unreliable transmission to the server.

Not guaranteed to be received, and must be below one kilobyte.

Unreliable messages are implemented using QUIC datagrams. This makes them ideal for messages that are sent frequently, but are not critical to the functioning of the logic on the server.

Note that this message will only be received by the corresponding package on the server, and not by any other packages. You will need to explicitly relay the message to other packages on the server.

ServerReliable

Available on crate feature client only.

A reliable transmission to the server (guaranteed to be received).

Reliable messages are implemented using QUIC streams. This makes them ideal for messages that are sent infrequently, but must be received by the server.

Note that this message will only be received by the corresponding package on the server, and not by any other packages. You will need to explicitly relay the message to other packages on the server.

ClientBroadcastUnreliable

Available on crate feature server only.

An unreliable transmission to all clients.

Not guaranteed to be received, and must be below one kilobyte.

Unreliable messages are implemented using QUIC datagrams. This makes them ideal for messages that are sent frequently, but are not critical to the functioning of the logic on the client.

Note that this message will only be received by the corresponding package on the client, and not by any other packages. You will need to explicitly relay the message to other packages on the client.

ClientBroadcastReliable

Available on crate feature server only.

A reliable transmission to all clients (guaranteed to be received).

Reliable messages are implemented using QUIC streams. This makes them ideal for messages that are sent infrequently, but must be received by the client.

Note that this message will only be received by the corresponding package on the client, and not by any other packages. You will need to explicitly relay the message to other packages on the client.

ClientTargetedUnreliable(String)

Tuple Fields

0: String

The user to send to.

Available on crate feature server only.

An unreliable transmission to a specific client.

Not guaranteed to be received, and must be below one kilobyte.

Unreliable messages are implemented using QUIC datagrams. This makes them ideal for messages that are sent frequently, but are not critical to the functioning of the logic on the client.

Note that this message will only be received by the corresponding package on the client, and not by any other packages. You will need to explicitly relay the message to other packages on the client.

ClientTargetedReliable(String)

Tuple Fields

0: String

The user to send to.

Available on crate feature server only.

A reliable transmission to a specific client (guaranteed to be received).

Reliable messages are implemented using QUIC streams. This makes them ideal for messages that are sent infrequently, but must be received by the client.

Note that this message will only be received by the corresponding package on the client, and not by any other packages. You will need to explicitly relay the message to other packages on the client.

Trait Implementations

impl Clone for Target

fn clone(&self) -> Target

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Target

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

Formats the value using the given formatter.

impl Ord for Target

fn cmp(&self, other: &Target) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Target

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Target

fn partial_cmp(&self, other: &Target) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Target

impl StructuralEq for Target

impl StructuralPartialEq for Target