Struct bevy_replicon_attributes::ServerEventSender

pub struct ServerEventSender<'w, T: Event + Clone> { /* private fields */ }

System param for sending server events controlled by visibility conditions.

Sent events are forwarded to bevy_replicon, which then transmits them to clients.

If your event is not Clone, you need to use EventWriter<ToClients<T>> manually.

Implementations

impl<'w, T: Event + Clone> ServerEventSender<'w, T>

pub fn send( &mut self, attributes: &ClientAttributes<'_>, event: T, condition: Visibility )

Sends an event to clients that satisfy the visibility condition.

Note that the event will be cloned for each client.

Trait Implementations

impl<T: Event + Clone> SystemParam for ServerEventSender<'_, T>

type State = FetchState<T>

Used to store data which persists across invocations of a system.

type Item<'w, 's> = ServerEventSender<'w, T>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any [World] access used by this [SystemParam] and creates a new instance of this param’s State.

fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta )

For the specified [Archetype], registers the components accessed by this [SystemParam] (if applicable).

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this [SystemParam]’s state. This is used to apply Commands during apply_deferred.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's, T: Event + Clone> ReadOnlySystemParam for ServerEventSender<'w, T>

where EventWriter<'w, ToClients<T>>: ReadOnlySystemParam,