Struct bevy_mod_picking::event_listening::OnPointer

pub struct OnPointer<E>where
    E: IsPointerEvent,{ /* private fields */ }

Used to attach a callback to an entity. This callback is executed any time a pointer event triggers this listener when bubbling up the entity hierarchy.

Callback systems will give you access to the ListenedEvent that triggered the event listener. This includes the listener which is the entity with the OnPointer component, and the target which is the entity that generated the event. The target can be this entity or any of its children.

Implementations

impl<E> OnPointer<E>where E: IsPointerEvent,

pub fn run_callback<M>( callback: impl IntoSystem<ListenedEvent<E>, Bubble, M> ) -> OnPointer<E>

Run a callback system any time this event listener is triggered.

pub fn add_command<C>() -> OnPointer<E>where C: From<ListenedEvent<E>> + Command + Send + Sync + 'static,

Add a single [Command] any time this event listener is triggered. The command must implement From<ListenedEvent<E>>.

pub fn commands_mut( func: fn(_: &ListenedEvent<E>, _: &mut Commands<'_, '_>) ) -> OnPointer<E>

Get mutable access to [Commands] any time this event listener is triggered.

pub fn target_commands_mut( func: fn(_: &ListenedEvent<E>, _: &mut EntityCommands<'_, '_, '_>) ) -> OnPointer<E>

Get mutable access to the target entity’s [EntityCommands] using a closure any time this event listener is triggered.

pub fn target_insert(bundle: impl Bundle + Clone) -> OnPointer<E>

Insert a bundle on the target entity any time this event listener is triggered.

pub fn target_remove<B>() -> OnPointer<E>where B: Bundle,

Remove a bundle from the target entity any time this event listener is triggered.

pub fn target_component_mut<C>( func: fn(_: &ListenedEvent<E>, _: &mut C) ) -> OnPointer<E>where C: Component,

Get mutable access to a specific component on the target entity using a closure any time this event listener is triggered. If the component does not exist, an error will be logged.

pub fn send_event<F>() -> OnPointer<E>where F: Event + From<ListenedEvent<E>>,

Send an event F any time this event listener is triggered. F must implement From<ListenedEvent<E>>.

Trait Implementations

impl<E> Component for OnPointer<E>where E: IsPointerEvent, OnPointer<E>: Send + Sync + 'static,

type Storage = TableStorage

impl<E> GetTypeRegistration for OnPointer<E>where E: IsPointerEvent, CallbackSystem<E>: Any + Send + Sync,

fn get_type_registration() -> TypeRegistration

impl<E> Reflect for OnPointer<E>where E: IsPointerEvent, CallbackSystem<E>: Any + Send + Sync,

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the [TypeInfo] of the underlying type.

fn into_any(self: Box<OnPointer<E>, Global>) -> Box<dyn Any + 'static, Global>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect( self: Box<OnPointer<E>, Global> ) -> Box<dyn Reflect + 'static, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object.

fn set( &mut self, value: Box<dyn Reflect + 'static, Global> ) -> Result<(), Box<dyn Reflect + 'static, Global>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<OnPointer<E>, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

impl<E> Struct for OnPointer<E>where E: IsPointerEvent, CallbackSystem<E>: Any + Send + Sync,

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl<E> Typed for OnPointer<E>where E: IsPointerEvent, CallbackSystem<E>: Any + Send + Sync,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.