Struct Blackboard 

pub struct Blackboard {
    pub time: f64,
    /* private fields */
}

A typed key-value store shared by all nodes in a behavior tree.

Entries can optionally expire after a time-to-live (TTL) measured in seconds. Call Blackboard::tick every frame with dt to process expirations.

Fields

time: f64

Running simulation time in seconds (accumulated from tick(dt) calls).

Implementations

impl Blackboard

pub fn new() -> Self

pub fn tick(&mut self, dt: f64)

Advance the blackboard clock and expire stale entries.

pub fn set<V: Into<BlackboardValue>>(&mut self, key: &str, value: V)

Insert a key-value pair with no expiry.

pub fn set_with_ttl<V: Into<BlackboardValue>>( &mut self, key: &str, value: V, ttl: f64, )

Insert a key-value pair that will expire after ttl seconds.

pub fn get(&self, key: &str) -> Option<&BlackboardValue>

Retrieve a value by key.

pub fn get_bool(&self, key: &str) -> Option<bool>

pub fn get_int(&self, key: &str) -> Option<i64>

pub fn get_float(&self, key: &str) -> Option<f64>

pub fn get_str(&self, key: &str) -> Option<&str>

pub fn get_vec2(&self, key: &str) -> Option<Vec2>

pub fn get_vec3(&self, key: &str) -> Option<Vec3>

pub fn get_entity(&self, key: &str) -> Option<u64>

pub fn contains(&self, key: &str) -> bool

pub fn remove(&mut self, key: &str) -> Option<BlackboardValue>

pub fn clear(&mut self)

pub fn len(&self) -> usize

Number of live entries.

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> impl Iterator<Item = (&str, &BlackboardValue)>

Iterate over all live key-value pairs.

pub fn float_gt(&self, key: &str, threshold: f64) -> bool

Compare a float entry against a threshold.

pub fn float_lt(&self, key: &str, threshold: f64) -> bool

pub fn float_gte(&self, key: &str, threshold: f64) -> bool

pub fn float_lte(&self, key: &str, threshold: f64) -> bool

pub fn increment(&mut self, key: &str, delta: i64)

Increment an integer counter by delta. Missing keys start at 0.

pub fn decrement(&mut self, key: &str, delta: i64)

Decrement an integer counter by delta.

pub fn toggle(&mut self, key: &str)

Toggle a boolean entry. Missing keys become true.

Trait Implementations

impl Debug for Blackboard

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

Formats the value using the given formatter.

impl Default for Blackboard

fn default() -> Blackboard

Returns the “default value” for a type.