Struct ark_api::behavior::Behavior

pub struct Behavior;

The Behavior API provides behavior modules functionality for interacting with the world

Implementations

impl Behavior

pub fn aspect_get(&self, addr: AspectAddr) -> Option<Vec<u8>>

Retrieve a serialized representation of aspect data of the given actor and aspect type if it exists

The serialization format has to be defined in a protocol that is agreed upon with the owning controller module

pub fn send_outgoing_messages(
    &self,
    outgoing_messages: &[OutgoingMessage]
) -> Result<(), Error>

Batch send OutgoingMessage data back to the controller module

It is important to understand that this doesn’t send the message directly to a behavior instance for processing. It is sent to the controller module who then decides what to do with it.

For performance reasons it is recommended to always batch as many outgoing messages together as that will reduce calls over FFI, which are expensive

TODO: Should return a custom error type through which a user can identify which messages/behavior modules failed and why

pub fn iter_actors_with_aspect(
    &self,
    aspect_guid: Guid
) -> Option<ActorsWithAspectIter>

Retrieve an iterator over all actors with the given aspect GUID

pub fn random_seed_value(&self) -> u128

Retrieves a fixed but random value (different each execution of the behavior module, but maintained on respawn).

Trait Implementations

impl Clone for Behavior

fn clone(&self) -> Behavior

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Behavior