# {py:mod}`simvx.core.debug`

```{py:module} simvx.core.debug
```

```{autodoc2-docstring} simvx.core.debug
:allowtitles:
```

## Submodules

```{toctree}
:titlesonly:
:maxdepth: 1

simvx.core.debug.overlay
simvx.core.debug.ui_inspector
simvx.core.debug.profiler
```

## Package Contents

### Classes

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

* - {py:obj}`Debug <simvx.core.debug.Debug>`
  - ```{autodoc2-docstring} simvx.core.debug.Debug
    :summary:
    ```
* - {py:obj}`DebugNode <simvx.core.debug.DebugNode>`
  - ```{autodoc2-docstring} simvx.core.debug.DebugNode
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.core.debug.__all__>`
  - ```{autodoc2-docstring} simvx.core.debug.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.debug.__all__
:value: >
   ['Debug', 'DebugNode']

```{autodoc2-docstring} simvx.core.debug.__all__
```

````

`````{py:class} Debug
:canonical: simvx.core.debug.Debug

```{autodoc2-docstring} simvx.core.debug.Debug
```

````{py:attribute} enabled
:canonical: simvx.core.debug.Debug.enabled
:type: bool
:value: >
   False

```{autodoc2-docstring} simvx.core.debug.Debug.enabled
```

````

````{py:attribute} profiler
:canonical: simvx.core.debug.Debug.profiler
:value: >
   '_LazyAttr(...)'

```{autodoc2-docstring} simvx.core.debug.Debug.profiler
```

````

````{py:attribute} ui_inspector
:canonical: simvx.core.debug.Debug.ui_inspector
:value: >
   '_LazyAttr(...)'

```{autodoc2-docstring} simvx.core.debug.Debug.ui_inspector
```

````

````{py:attribute} overlay
:canonical: simvx.core.debug.Debug.overlay
:value: >
   '_LazyAttr(...)'

```{autodoc2-docstring} simvx.core.debug.Debug.overlay
```

````

````{py:method} toggle()
:canonical: simvx.core.debug.Debug.toggle
:classmethod:

```{autodoc2-docstring} simvx.core.debug.Debug.toggle
```

````

````{py:method} create_node() -> simvx.core.debug.DebugNode
:canonical: simvx.core.debug.Debug.create_node
:classmethod:

```{autodoc2-docstring} simvx.core.debug.Debug.create_node
```

````

`````

`````{py:class} DebugNode(name: str = '', **kwargs)
:canonical: simvx.core.debug.DebugNode

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

```{autodoc2-docstring} simvx.core.debug.DebugNode
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.debug.DebugNode.__init__
```

````{py:method} process(dt: float)
:canonical: simvx.core.debug.DebugNode.process

````

````{py:method} draw(renderer)
:canonical: simvx.core.debug.DebugNode.draw

````

````{py:attribute} script_error_raised
:canonical: simvx.core.debug.DebugNode.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.debug.DebugNode.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.debug.DebugNode.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.debug.DebugNode.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.debug.DebugNode.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.debug.DebugNode.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.debug.DebugNode.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.debug.DebugNode.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.debug.DebugNode.get_node

````

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

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.debug.DebugNode.find

````

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

````

````{py:property} path
:canonical: simvx.core.debug.DebugNode.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.debug.DebugNode.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.debug.DebugNode.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.debug.DebugNode.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.debug.DebugNode.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.debug.DebugNode.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.debug.DebugNode.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.debug.DebugNode.physics_process

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.debug.DebugNode.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.debug.DebugNode.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.debug.DebugNode.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.debug.DebugNode.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.debug.DebugNode.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.debug.DebugNode.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.debug.DebugNode.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.debug.DebugNode.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.debug.DebugNode.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.debug.DebugNode.__getitem__

````

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

````

````{py:attribute} get_settings
:canonical: simvx.core.debug.DebugNode.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.debug.DebugNode.__repr__

````

`````