Struct ark_api::world::EntityMessageDispatcher

pub struct EntityMessageDispatcher<'message> { /* private fields */ }

The EntityMessageDispatcher is a hub for managing messages to / from the host

Use it to perform various requests and assign closures that will be called when a result is received. You need to call EntityMessageDispatcher::update somewhere in your update routine. This will in turn check if any results have been received and call the corresponding closures.

Implementations

impl<'message> EntityMessageDispatcher<'message>

pub fn remove_all_listeners(&mut self)

Remove all listenerers

pub fn spatial_query_in_global_queue<T>(
    &mut self,
    request: &SpatialQueryRequest,
    f: T
) where
    T: FnMut(&[SpatialQueryHit]) + 'message, 

Registers a request into this EntityMessageDispatcher and puts the outgoing message into the global queue.

pub fn spatial_query<T>(
    &mut self,
    queue: &mut EntityMessageQueue,
    request: &SpatialQueryRequest,
    f: T
) where
    T: FnMut(&[SpatialQueryHit]) + 'message, 

Registers a request into this EntityMessageDispatcher and puts the outgoing message into a queue of your choice.

pub fn animation_in_global_queue<T>(&mut self, request: &AnimationRequest, f: T) where
    T: FnMut(&AnimationReplyType) + 'message, 

Registers an animation into this EntityMessageDispatcher and puts the outgoing message into the global queue.

pub fn animation<T>(
    &mut self,
    queue: &mut EntityMessageQueue,
    request: &AnimationRequest,
    f: T
) where
    T: FnMut(&AnimationReplyType) + 'message, 

Registers an animation into this EntityMessageDispatcher and puts the outgoing message into a queue of your choice.

pub fn on_collision<T>(&mut self, entity: Entity, f: T) where
    T: FnMut(&[OnCollision]) + 'message, 

Registers a callback for listening on collisions

pub fn on_trigger<T>(&mut self, entity: Entity, f: T) where
    T: FnMut(&[OnTrigger]) + 'message, 

Registers a callback for listening on triggers

pub fn update(&mut self)

This needs to be executed to process replies and invoke closures.

The function is responsible for polling EntityMessenger to see if any reply, corresponding to the requests that have been performed on this EntityMessageDispatcher, is received.

pub fn global() -> &'static mut Self

Get the global EntityMessageDispatcher.

Trait Implementations

impl<'message> Default for EntityMessageDispatcher<'message>

fn default() -> EntityMessageDispatcher<'message>

Returns the “default value” for a type.