Struct Agent 

pub struct Agent { /* private fields */ }

Agent represents an AI-powered NPC in a game

Implementations

impl Agent

pub fn new(config: AgentConfig) -> Self

Create a new agent with the given configuration

Arguments

• config - Agent configuration

Returns

A new Agent instance

pub fn new_with_tts(config: AgentConfig) -> Self

Create a new agent with TTS service

pub async fn speak( &self, text: &str, emotions: &EmotionalState, urgency: f32, ) -> Result<AudioData>

Generate speech for agent response

pub fn id(&self) -> Uuid

Get the agent’s unique ID

pub fn name(&self) -> &str

Get the agent’s name

pub async fn state(&self) -> AgentState

Get the agent’s current state

pub async fn emotional_state(&self) -> EmotionalState

Get a copy of the agent’s current emotional state

pub async fn emotion_vector(&self) -> [f32; 8]

Get the agent’s emotion vector as a float array

pub async fn update_emotion(&self, emotion: &str, delta: f32)

Update a specific emotion by a delta value

Arguments

• emotion - Name of the emotion to update (e.g., “joy”, “fear”)
• delta - Amount to change the emotion by (-1.0 to 1.0)

pub async fn decay_emotions(&self)

Apply emotional decay to all emotions

This should be called periodically (e.g., every frame or tick) to allow emotions to naturally fade over time

pub async fn emotional_valence(&self) -> f32

Get the current emotional valence (-1.0 to 1.0)

Valence represents how positive or negative the agent feels

pub async fn emotional_arousal(&self) -> f32

Get the current emotional arousal (0.0 to 1.0)

Arousal represents how intensely the agent is feeling

pub async fn add_behavior<B: Behavior + 'static>(&self, behavior: B)

Add a behavior to the agent

Arguments

• behavior - A behavior to add to the agent

pub async fn add_boxed_behavior(&self, behavior: Box<dyn Behavior>)

Add a boxed behavior to the agent

Arguments

• behavior - A boxed behavior to add to the agent

pub async fn update_context(&self, context: AgentContext)

Update the agent’s context with new data

Arguments

• context - New context data to merge with existing context

pub async fn start(&self) -> Result<()>

Start the agent

This initializes the agent and prepares it for operation

pub async fn stop(&self) -> Result<()>

Stop the agent

pub async fn process_input(&self, input: &str) -> Result<String>

Process player input and generate a response

Arguments

• input - Player input to process

Returns

A result containing the agent’s response

pub fn on_event<F>(&self, event: AgentEvent, callback: F)

where F: Fn(&Agent, &str) + Send + Sync + 'static,

Register a callback for agent events using typed events

Arguments

• event - Event type to trigger the callback
• callback - Callback function

Example

agent.on_event(AgentEvent::Start, |agent, data| {
    println!("Agent {} started: {}", agent.name(), data);
});

pub fn register_callback<F>(&self, event: &str, callback: F)

where F: Fn(&Agent, &str) + Send + Sync + 'static,

👎Deprecated since 0.1.5: Use on_event() with AgentEvent enum instead

Register a callback for agent events (deprecated, use on_event)

Arguments

• event - Event name to trigger the callback
• callback - Callback function

pub fn clone_for_binding(&self) -> Self

Create a new agent with the same configuration but new state

This is a simplified clone method that creates a new agent with the same configuration but with fresh state. This is useful for creating copies of agents for engine bindings.

pub async fn add_memory( &self, category: MemoryCategory, content: &str, importance: f64, tags: Option<Vec<String>>, ) -> Result<()>

Add a memory to the agent’s memory system

pub async fn add_emotional_memory( &self, category: MemoryCategory, content: &str, importance: f64, valence: f64, intensity: f64, tags: Option<Vec<String>>, ) -> Result<()>

Add a memory with emotional context to the agent’s memory system

pub async fn memory_count(&self) -> usize

Get the total number of memories stored

pub async fn clear_memories(&self) -> usize

Clear all non-permanent memories

pub async fn get_memories_by_category( &self, category: MemoryCategory, ) -> Vec<Memory>

Get all memories of a specific category

pub async fn retrieve_relevant_memories( &self, query: &str, limit: usize, ) -> Result<Vec<Memory>>

Retrieve memories relevant to a query

pub async fn forget_memory(&self, memory_id: &str) -> Result<()>

Forget a specific memory by ID

pub async fn forget_memories_by_category( &self, category: MemoryCategory, ) -> usize

Forget all memories of a specific category

pub async fn has_memory(&self, memory_id: &str) -> bool

Check if a memory exists by ID

pub async fn get_memory(&self, memory_id: &str) -> Option<Memory>

Get a specific memory by ID

Trait Implementations

impl Debug for Agent

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

Formats the value using the given formatter.

impl From<&Agent> for UnityAgentState

fn from(agent: &Agent) -> Self

Converts to this type from the input type.