# {py:mod}`simvx.core.animation.state_machine`

```{py:module} simvx.core.animation.state_machine
```

```{autodoc2-docstring} simvx.core.animation.state_machine
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`AnimationState <simvx.core.animation.state_machine.AnimationState>`
  - ```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationState
    :summary:
    ```
* - {py:obj}`Transition <simvx.core.animation.state_machine.Transition>`
  - ```{autodoc2-docstring} simvx.core.animation.state_machine.Transition
    :summary:
    ```
* - {py:obj}`AnimationTree <simvx.core.animation.state_machine.AnimationTree>`
  - ```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree
    :summary:
    ```
````

### Data

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

* - {py:obj}`log <simvx.core.animation.state_machine.log>`
  - ```{autodoc2-docstring} simvx.core.animation.state_machine.log
    :summary:
    ```
````

### API

````{py:data} log
:canonical: simvx.core.animation.state_machine.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.core.animation.state_machine.log
```

````

`````{py:class} AnimationState
:canonical: simvx.core.animation.state_machine.AnimationState

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationState
```

````{py:attribute} name
:canonical: simvx.core.animation.state_machine.AnimationState.name
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationState.name
```

````

````{py:attribute} clip
:canonical: simvx.core.animation.state_machine.AnimationState.clip
:type: simvx.core.animation.track.AnimationClip
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationState.clip
```

````

````{py:attribute} speed_scale
:canonical: simvx.core.animation.state_machine.AnimationState.speed_scale
:type: float
:value: >
   1.0

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationState.speed_scale
```

````

````{py:attribute} loop
:canonical: simvx.core.animation.state_machine.AnimationState.loop
:type: bool
:value: >
   True

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationState.loop
```

````

`````

`````{py:class} Transition
:canonical: simvx.core.animation.state_machine.Transition

```{autodoc2-docstring} simvx.core.animation.state_machine.Transition
```

````{py:attribute} from_state
:canonical: simvx.core.animation.state_machine.Transition.from_state
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.state_machine.Transition.from_state
```

````

````{py:attribute} to_state
:canonical: simvx.core.animation.state_machine.Transition.to_state
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.state_machine.Transition.to_state
```

````

````{py:attribute} condition
:canonical: simvx.core.animation.state_machine.Transition.condition
:type: collections.abc.Callable[[], bool]
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.state_machine.Transition.condition
```

````

````{py:attribute} blend_time
:canonical: simvx.core.animation.state_machine.Transition.blend_time
:type: float
:value: >
   0.2

```{autodoc2-docstring} simvx.core.animation.state_machine.Transition.blend_time
```

````

`````

`````{py:class} AnimationTree(target=None, **kwargs)
:canonical: simvx.core.animation.state_machine.AnimationTree

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

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.__init__
```

````{py:method} add_state(name: str, clip: simvx.core.animation.track.AnimationClip, speed_scale: float = 1.0, loop: bool = True)
:canonical: simvx.core.animation.state_machine.AnimationTree.add_state

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.add_state
```

````

````{py:method} add_transition(from_state: str, to_state: str, condition: collections.abc.Callable[[], bool], blend_time: float = 0.2)
:canonical: simvx.core.animation.state_machine.AnimationTree.add_transition

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.add_transition
```

````

````{py:method} set_parameter(name: str, value: typing.Any)
:canonical: simvx.core.animation.state_machine.AnimationTree.set_parameter

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.set_parameter
```

````

````{py:method} get_parameter(name: str, default: typing.Any = None) -> typing.Any
:canonical: simvx.core.animation.state_machine.AnimationTree.get_parameter

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.get_parameter
```

````

````{py:method} start(state_name: str)
:canonical: simvx.core.animation.state_machine.AnimationTree.start

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.start
```

````

````{py:method} stop()
:canonical: simvx.core.animation.state_machine.AnimationTree.stop

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.stop
```

````

````{py:method} process(dt: float)
:canonical: simvx.core.animation.state_machine.AnimationTree.process

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.process
```

````

````{py:method} to_dict() -> dict
:canonical: simvx.core.animation.state_machine.AnimationTree.to_dict

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.to_dict
```

````

````{py:method} from_dict(data: dict, target=None)
:canonical: simvx.core.animation.state_machine.AnimationTree.from_dict
:classmethod:

```{autodoc2-docstring} simvx.core.animation.state_machine.AnimationTree.from_dict
```

````

````{py:attribute} strict_errors
:canonical: simvx.core.animation.state_machine.AnimationTree.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.animation.state_machine.AnimationTree.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.animation.state_machine.AnimationTree.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.animation.state_machine.AnimationTree.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.animation.state_machine.AnimationTree.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.animation.state_machine.AnimationTree.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.animation.state_machine.AnimationTree.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.animation.state_machine.AnimationTree.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.animation.state_machine.AnimationTree.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.animation.state_machine.AnimationTree.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.state_machine.AnimationTree.find_child

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.state_machine.AnimationTree.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.animation.state_machine.AnimationTree.find_all

````

````{py:property} path
:canonical: simvx.core.animation.state_machine.AnimationTree.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.animation.state_machine.AnimationTree.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.animation.state_machine.AnimationTree.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.animation.state_machine.AnimationTree.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.animation.state_machine.AnimationTree.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.animation.state_machine.AnimationTree.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.animation.state_machine.AnimationTree.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.animation.state_machine.AnimationTree.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.animation.state_machine.AnimationTree.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.animation.state_machine.AnimationTree.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.state_machine.AnimationTree.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.state_machine.AnimationTree.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.animation.state_machine.AnimationTree.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.animation.state_machine.AnimationTree.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.animation.state_machine.AnimationTree.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.animation.state_machine.AnimationTree.destroy

````

````{py:property} app
:canonical: simvx.core.animation.state_machine.AnimationTree.app

````

````{py:property} tree
:canonical: simvx.core.animation.state_machine.AnimationTree.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.animation.state_machine.AnimationTree.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.animation.state_machine.AnimationTree.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.animation.state_machine.AnimationTree.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.animation.state_machine.AnimationTree.__repr__

````

`````