pub struct EventWriter<'w, E: WorldEvent> { /* private fields */ }Expand description
Writes ordered typed events for later Systems in the current stage.
A send failure poisons the complete stage even when its returned error is
ignored. The scheduler stops before the next System and discards that
stage’s pending structural and transition Commands. Successful sends become
immediately visible to later EventReader parameters of the same type.
To inspect earlier events and then write the same type in one System, use
this writer’s Self::iter method. Requesting both EventReader<E> and
EventWriter<E> in one System conflicts over the same ECS channel.
Implementations§
Source§impl<E: WorldEvent> EventWriter<'_, E>
impl<E: WorldEvent> EventWriter<'_, E>
Trait Implementations§
Source§impl<'a, E: WorldEvent> IntoIterator for &'a EventWriter<'_, E>
impl<'a, E: WorldEvent> IntoIterator for &'a EventWriter<'_, E>
impl<'w, 's, E: WorldEvent> ReadOnlySystemParam for EventWriter<'w, E>where
ResMut<'w, EventChannel<E>>: ReadOnlySystemParam,
Res<'w, EventStageState>: ReadOnlySystemParam,
Res<'w, EventFailureState>: ReadOnlySystemParam,
Source§impl<E: WorldEvent> SystemParam for EventWriter<'_, E>
impl<E: WorldEvent> SystemParam for EventWriter<'_, E>
Source§type Item<'w, 's> = EventWriter<'w, E>
type Item<'w, 's> = EventWriter<'w, E>
The item type returned when constructing this system param.
The value of this associated type should be
Self, instantiated with new lifetimes. Read moreSource§fn init_access(
state: &Self::State,
system_meta: &mut SystemMeta,
component_access_set: &mut FilteredAccessSet,
world: &mut World,
)
fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )
Source§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
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 ApplyDeferred.Source§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>,
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )
Queues any deferred mutations to be applied at the next
ApplyDeferred.Source§unsafe fn get_param<'w, 's>(
state: &'s mut Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
change_tick: Tick,
) -> Result<Self::Item<'w, 's>, SystemParamValidationError>
unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<Self::Item<'w, 's>, SystemParamValidationError>
Creates a parameter to be passed into a
SystemParamFunction. Read moreAuto Trait Implementations§
impl<'w, E> !UnwindSafe for EventWriter<'w, E>
impl<'w, E> Freeze for EventWriter<'w, E>
impl<'w, E> RefUnwindSafe for EventWriter<'w, E>where
ResMut<'w, EventChannel<E>>: RefUnwindSafe,
impl<'w, E> Send for EventWriter<'w, E>
impl<'w, E> Sync for EventWriter<'w, E>
impl<'w, E> Unpin for EventWriter<'w, E>
impl<'w, E> UnsafeUnpin for EventWriter<'w, E>where
ResMut<'w, EventChannel<E>>: UnsafeUnpin,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
impl<S, T> Duplex<S> for Twhere
T: FromSample<S> + ToSample<S>,
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.