Struct BehaviorConfig 

pub struct BehaviorConfig {
    pub schema: Option<String>,
    pub name: String,
    pub description: Option<String>,
    pub root: CompositionConfig,
    pub configs: HashMap<String, Value>,
}

A behavior tree definition loaded from a JSON configuration file.

Fields

schema: Option<String>

URL of the JSON schema this configuration conforms to.

name: String

Name of this behavior.

description: Option<String>

Human-readable description of what this behavior does.

root: CompositionConfig

The root node of the behavior tree.

configs: HashMap<String, Value>

Named configuration values referenced by nodes in the behavior tree via config_ref.

Implementations

impl BehaviorConfig

pub fn from_json(json: &str) -> Result<BehaviorConfig, Error>

Load a behavior configuration from a JSON string.

Example

use mecha10_behavior_runtime::BehaviorConfig;

let json = r#"{
    "name": "test_behavior",
    "root": {
        "type": "sequence",
        "children": []
    }
}"#;

let config = BehaviorConfig::from_json(json).unwrap();
assert_eq!(config.name, "test_behavior");

pub fn from_file(path: impl AsRef<Path>) -> Result<BehaviorConfig, Error>

Load a behavior configuration from a JSON file.

pub fn to_json(&self) -> Result<String, Error>

Convert this configuration to JSON.

pub fn generate_schema() -> Result<String, Error>

Generate a JSON schema for this configuration type.

This can be used for editor IntelliSense and validation.

pub fn schema_value() -> Value

The schemars-derived JSON Schema for this configuration type, as a serde_json::Value – the same schema generate_schema serializes to a pretty-printed string, super::validator’s runtime validator is built from, and cargo run --example export_schemas (packages/cli/examples/export_schemas.rs) renders to schemas/behavior.schema.json, the single standard-named schemas/ source of truth for this type (LAB-4245 folded the old separate cargo run --example generate_schema → schemas/behavior_composition_v1.json path into this one).

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

Get a configuration value by reference key.

Trait Implementations

impl Clone for BehaviorConfig

fn clone(&self) -> BehaviorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BehaviorConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BehaviorConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<BehaviorConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for BehaviorConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for BehaviorConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.