# {py:mod}`simvx.core.ai.agent_node`

```{py:module} simvx.core.ai.agent_node
```

```{autodoc2-docstring} simvx.core.ai.agent_node
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`BrainRunner <simvx.core.ai.agent_node.BrainRunner>`
  - ```{autodoc2-docstring} simvx.core.ai.agent_node.BrainRunner
    :summary:
    ```
* - {py:obj}`AgentNode <simvx.core.ai.agent_node.AgentNode>`
  - ```{autodoc2-docstring} simvx.core.ai.agent_node.AgentNode
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`build_ai_context <simvx.core.ai.agent_node.build_ai_context>`
  - ```{autodoc2-docstring} simvx.core.ai.agent_node.build_ai_context
    :summary:
    ```
````

### API

````{py:function} build_ai_context(node: simvx.core.node.Node, dt: float, blackboard: simvx.core.ai.blackboard.Blackboard) -> simvx.core.ai.brain.AIContext
:canonical: simvx.core.ai.agent_node.build_ai_context

```{autodoc2-docstring} simvx.core.ai.agent_node.build_ai_context
```
````

`````{py:class} BrainRunner(brain: simvx.core.ai.brain.Brain, blackboard: simvx.core.ai.blackboard.Blackboard, *, tick_interval: float = 0.0)
:canonical: simvx.core.ai.agent_node.BrainRunner

```{autodoc2-docstring} simvx.core.ai.agent_node.BrainRunner
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ai.agent_node.BrainRunner.__init__
```

````{py:method} step(node: simvx.core.node.Node, dt: float) -> None
:canonical: simvx.core.ai.agent_node.BrainRunner.step

```{autodoc2-docstring} simvx.core.ai.agent_node.BrainRunner.step
```

````

`````

`````{py:class} AgentNode(*, brain: simvx.core.ai.brain.Brain | None = None, squad: simvx.core.ai.blackboard.Blackboard | None = None, **kwargs: typing.Any)
:canonical: simvx.core.ai.agent_node.AgentNode

Bases: {py:obj}`simvx.core.node.Node`

```{autodoc2-docstring} simvx.core.ai.agent_node.AgentNode
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ai.agent_node.AgentNode.__init__
```

````{py:attribute} tick_interval
:canonical: simvx.core.ai.agent_node.AgentNode.tick_interval
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ai.agent_node.AgentNode.tick_interval
```

````

````{py:method} on_ready() -> None
:canonical: simvx.core.ai.agent_node.AgentNode.on_ready

````

````{py:method} on_update(dt: float) -> None
:canonical: simvx.core.ai.agent_node.AgentNode.on_update

````

````{py:method} on_exit_tree() -> None
:canonical: simvx.core.ai.agent_node.AgentNode.on_exit_tree

````

````{py:attribute} strict_errors
:canonical: simvx.core.ai.agent_node.AgentNode.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.ai.agent_node.AgentNode.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.ai.agent_node.AgentNode.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.ai.agent_node.AgentNode.name
:type: str

````

````{py:property} update_mode
:canonical: simvx.core.ai.agent_node.AgentNode.update_mode
:type: simvx.core.descriptors.UpdateMode

````

````{py:property} visible
:canonical: simvx.core.ai.agent_node.AgentNode.visible
:type: bool

````

````{py:method} reset_error() -> None
:canonical: simvx.core.ai.agent_node.AgentNode.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.ai.agent_node.AgentNode.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.ai.agent_node.AgentNode.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.ai.agent_node.AgentNode.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.ai.agent_node.AgentNode.get_node

````

````{py:method} get_node_or_none(path: str) -> simvx.core.node.Node | None
:canonical: simvx.core.ai.agent_node.AgentNode.get_node_or_none

````

````{py:method} find(target, *, direct: bool = False)
:canonical: simvx.core.ai.agent_node.AgentNode.find

````

````{py:method} find_all(target, *, direct: bool = False)
:canonical: simvx.core.ai.agent_node.AgentNode.find_all

````

````{py:method} walk(*, include_self: bool = True) -> collections.abc.Iterator[simvx.core.node.Node]
:canonical: simvx.core.ai.agent_node.AgentNode.walk

````

````{py:property} path
:canonical: simvx.core.ai.agent_node.AgentNode.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.ai.agent_node.AgentNode.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.ai.agent_node.AgentNode.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.ai.agent_node.AgentNode.is_in_group

````

````{py:method} on_enter_tree() -> None
:canonical: simvx.core.ai.agent_node.AgentNode.on_enter_tree

````

````{py:method} on_fixed_update(dt: float) -> None
:canonical: simvx.core.ai.agent_node.AgentNode.on_fixed_update

````

````{py:method} on_draw(renderer) -> None
:canonical: simvx.core.ai.agent_node.AgentNode.on_draw

````

````{py:method} on_picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.ai.agent_node.AgentNode.on_picked

````

````{py:method} on_unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.ai.agent_node.AgentNode.on_unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.ai.agent_node.AgentNode.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.ai.agent_node.AgentNode.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.ai.agent_node.AgentNode.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.ai.agent_node.AgentNode.destroy

````

````{py:method} call_deferred(method: collections.abc.Callable[..., typing.Any], *args: typing.Any) -> None
:canonical: simvx.core.ai.agent_node.AgentNode.call_deferred

````

````{py:property} app
:canonical: simvx.core.ai.agent_node.AgentNode.app

````

````{py:property} tree
:canonical: simvx.core.ai.agent_node.AgentNode.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:property} physics
:canonical: simvx.core.ai.agent_node.AgentNode.physics

````

````{py:property} physics_2d
:canonical: simvx.core.ai.agent_node.AgentNode.physics_2d

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.ai.agent_node.AgentNode.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.ai.agent_node.AgentNode.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.ai.agent_node.AgentNode.__repr__

````

`````