Struct ark_api::behavior_controller::BehaviorInstance

pub struct BehaviorInstance(_);

Weak reference to a behavior instance that lives somewhere in an external behavior module.

Cloning will create another reference to the same behavior instance. If you want to do a deep clone that creates a new instance, use the BehaviorInstance::deep_clone function.

The instance is destroyed when all its weak references are dropped.

Implementations

impl BehaviorInstance

pub fn new(type_id: BehaviorTypeId, params: &str) -> Self

Create a behavior instance of the specific type with the provided construction parameters

pub fn restore(type_id: BehaviorTypeId, bytes: &[u8]) -> Self

Restore a behavior instance by deserializing it from a persistent representation

pub fn deep_clone(instance: &Self) -> Self

Creates a clone of the current instance, and returns a reference to the newly created one.

pub fn persist(&self) -> Vec<u8>

Persist a behavior instance by serializing it to a blob

pub fn type_id(&self) -> BehaviorTypeId

Retrieve the BehaviorTypeId of this instance

Trait Implementations

impl Clone for BehaviorInstance

fn clone(&self) -> BehaviorInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BehaviorInstance

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for BehaviorInstance

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<BehaviorInstance> for BehaviorInstance

fn eq(&self, other: &BehaviorInstance) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BehaviorInstance

impl StructuralEq for BehaviorInstance

impl StructuralPartialEq for BehaviorInstance