# {py:mod}`simvx.editor.hints`

```{py:module} simvx.editor.hints
```

```{autodoc2-docstring} simvx.editor.hints
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`HintOverlay <simvx.editor.hints.HintOverlay>`
  - ```{autodoc2-docstring} simvx.editor.hints.HintOverlay
    :summary:
    ```
* - {py:obj}`TourGuide <simvx.editor.hints.TourGuide>`
  - ```{autodoc2-docstring} simvx.editor.hints.TourGuide
    :summary:
    ```
````

### Data

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

* - {py:obj}`log <simvx.editor.hints.log>`
  - ```{autodoc2-docstring} simvx.editor.hints.log
    :summary:
    ```
````

### API

````{py:data} log
:canonical: simvx.editor.hints.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.editor.hints.log
```

````

`````{py:class} HintOverlay(**kwargs)
:canonical: simvx.editor.hints.HintOverlay

Bases: {py:obj}`simvx.core.ui.core.Control`

```{autodoc2-docstring} simvx.editor.hints.HintOverlay
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.__init__
```

````{py:attribute} HINTS
:canonical: simvx.editor.hints.HintOverlay.HINTS
:type: dict[str, str]
:value: >
   None

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.HINTS
```

````

````{py:attribute} enabled
:canonical: simvx.editor.hints.HintOverlay.enabled
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.enabled
```

````

````{py:method} show_hint(key: str) -> bool
:canonical: simvx.editor.hints.HintOverlay.show_hint

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.show_hint
```

````

````{py:method} dismiss() -> None
:canonical: simvx.editor.hints.HintOverlay.dismiss

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.dismiss
```

````

````{py:property} active_hint
:canonical: simvx.editor.hints.HintOverlay.active_hint
:type: str | None

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.active_hint
```

````

````{py:property} active_hint_text
:canonical: simvx.editor.hints.HintOverlay.active_hint_text
:type: str | None

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.active_hint_text
```

````

````{py:property} shown_hints
:canonical: simvx.editor.hints.HintOverlay.shown_hints
:type: set[str]

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.shown_hints
```

````

````{py:method} reset() -> None
:canonical: simvx.editor.hints.HintOverlay.reset

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.reset
```

````

````{py:method} process(dt: float) -> None
:canonical: simvx.editor.hints.HintOverlay.process

```{autodoc2-docstring} simvx.editor.hints.HintOverlay.process
```

````

````{py:method} draw(renderer) -> None
:canonical: simvx.editor.hints.HintOverlay.draw

````

````{py:attribute} size_x
:canonical: simvx.editor.hints.HintOverlay.size_x
:value: >
   'Property(...)'

````

````{py:attribute} size_y
:canonical: simvx.editor.hints.HintOverlay.size_y
:value: >
   'Property(...)'

````

````{py:attribute} anchor_left
:canonical: simvx.editor.hints.HintOverlay.anchor_left
:value: >
   'Property(...)'

````

````{py:attribute} anchor_top
:canonical: simvx.editor.hints.HintOverlay.anchor_top
:value: >
   'Property(...)'

````

````{py:attribute} anchor_right
:canonical: simvx.editor.hints.HintOverlay.anchor_right
:value: >
   'Property(...)'

````

````{py:attribute} anchor_bottom
:canonical: simvx.editor.hints.HintOverlay.anchor_bottom
:value: >
   'Property(...)'

````

````{py:attribute} margin_left
:canonical: simvx.editor.hints.HintOverlay.margin_left
:value: >
   'Property(...)'

````

````{py:attribute} margin_top
:canonical: simvx.editor.hints.HintOverlay.margin_top
:value: >
   'Property(...)'

````

````{py:attribute} margin_right
:canonical: simvx.editor.hints.HintOverlay.margin_right
:value: >
   'Property(...)'

````

````{py:attribute} margin_bottom
:canonical: simvx.editor.hints.HintOverlay.margin_bottom
:value: >
   'Property(...)'

````

````{py:property} size
:canonical: simvx.editor.hints.HintOverlay.size
:type: simvx.core.math.types.Vec2

````

````{py:attribute} touch_mode
:canonical: simvx.editor.hints.HintOverlay.touch_mode
:type: str
:value: >
   'mouse'

````

````{py:property} theme
:canonical: simvx.editor.hints.HintOverlay.theme
:type: simvx.core.ui.types.Theme | None

````

````{py:property} mouse_over
:canonical: simvx.editor.hints.HintOverlay.mouse_over
:type: bool

````

````{py:property} focused
:canonical: simvx.editor.hints.HintOverlay.focused
:type: bool

````

````{py:property} disabled
:canonical: simvx.editor.hints.HintOverlay.disabled
:type: bool

````

````{py:method} get_theme() -> simvx.core.ui.types.Theme
:canonical: simvx.editor.hints.HintOverlay.get_theme

````

````{py:method} queue_redraw()
:canonical: simvx.editor.hints.HintOverlay.queue_redraw

````

````{py:method} get_minimum_size() -> simvx.core.math.types.Vec2
:canonical: simvx.editor.hints.HintOverlay.get_minimum_size

````

````{py:method} get_rect() -> tuple[float, float, float, float]
:canonical: simvx.editor.hints.HintOverlay.get_rect

````

````{py:method} get_global_rect() -> tuple[float, float, float, float]
:canonical: simvx.editor.hints.HintOverlay.get_global_rect

````

````{py:method} is_point_inside(point) -> bool
:canonical: simvx.editor.hints.HintOverlay.is_point_inside

````

````{py:method} set_anchor_preset(preset: simvx.core.ui.enums.AnchorPreset)
:canonical: simvx.editor.hints.HintOverlay.set_anchor_preset

````

````{py:method} set_focus()
:canonical: simvx.editor.hints.HintOverlay.set_focus

````

````{py:method} grab_focus()
:canonical: simvx.editor.hints.HintOverlay.grab_focus

````

````{py:method} release_focus()
:canonical: simvx.editor.hints.HintOverlay.release_focus

````

````{py:method} has_focus() -> bool
:canonical: simvx.editor.hints.HintOverlay.has_focus

````

````{py:method} focus_next_control()
:canonical: simvx.editor.hints.HintOverlay.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.editor.hints.HintOverlay.focus_previous_control

````

````{py:method} grab_mouse()
:canonical: simvx.editor.hints.HintOverlay.grab_mouse

````

````{py:method} release_mouse()
:canonical: simvx.editor.hints.HintOverlay.release_mouse

````

````{py:method} set_drag_preview(control: simvx.core.ui.core.Control)
:canonical: simvx.editor.hints.HintOverlay.set_drag_preview

````

````{py:method} draw_popup(renderer)
:canonical: simvx.editor.hints.HintOverlay.draw_popup

````

````{py:method} is_popup_point_inside(point) -> bool
:canonical: simvx.editor.hints.HintOverlay.is_popup_point_inside

````

````{py:method} popup_input(event)
:canonical: simvx.editor.hints.HintOverlay.popup_input

````

````{py:method} dismiss_popup()
:canonical: simvx.editor.hints.HintOverlay.dismiss_popup

````

````{py:attribute} z_index
:canonical: simvx.editor.hints.HintOverlay.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.editor.hints.HintOverlay.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.editor.hints.HintOverlay.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.editor.hints.HintOverlay.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.editor.hints.HintOverlay.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.editor.hints.HintOverlay.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.editor.hints.HintOverlay.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.editor.hints.HintOverlay.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.editor.hints.HintOverlay.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.editor.hints.HintOverlay.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_position
:canonical: simvx.editor.hints.HintOverlay.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.editor.hints.HintOverlay.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.editor.hints.HintOverlay.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.editor.hints.HintOverlay.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.editor.hints.HintOverlay.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.editor.hints.HintOverlay.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.editor.hints.HintOverlay.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.editor.hints.HintOverlay.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.editor.hints.HintOverlay.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.editor.hints.HintOverlay.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, colour=None)
:canonical: simvx.editor.hints.HintOverlay.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.editor.hints.HintOverlay.wrap_screen

````

````{py:attribute} strict_errors
:canonical: simvx.editor.hints.HintOverlay.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.editor.hints.HintOverlay.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.editor.hints.HintOverlay.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.editor.hints.HintOverlay.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.editor.hints.HintOverlay.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:property} visible
:canonical: simvx.editor.hints.HintOverlay.visible
:type: bool

````

````{py:method} reset_error() -> None
:canonical: simvx.editor.hints.HintOverlay.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.editor.hints.HintOverlay.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.editor.hints.HintOverlay.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.editor.hints.HintOverlay.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.editor.hints.HintOverlay.get_node

````

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

````

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

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.editor.hints.HintOverlay.find_all

````

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

````

````{py:property} path
:canonical: simvx.editor.hints.HintOverlay.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.editor.hints.HintOverlay.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.editor.hints.HintOverlay.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.editor.hints.HintOverlay.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.editor.hints.HintOverlay.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.editor.hints.HintOverlay.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.editor.hints.HintOverlay.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.editor.hints.HintOverlay.physics_process

````

````{py:method} picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.editor.hints.HintOverlay.picked

````

````{py:method} handle_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.editor.hints.HintOverlay.handle_input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.editor.hints.HintOverlay.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.editor.hints.HintOverlay.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.editor.hints.HintOverlay.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.editor.hints.HintOverlay.clear_children

````

````{py:method} destroy()
:canonical: simvx.editor.hints.HintOverlay.destroy

````

````{py:property} app
:canonical: simvx.editor.hints.HintOverlay.app

````

````{py:property} tree
:canonical: simvx.editor.hints.HintOverlay.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.editor.hints.HintOverlay.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.editor.hints.HintOverlay.__repr__

````

`````

`````{py:class} TourGuide(**kwargs)
:canonical: simvx.editor.hints.TourGuide

Bases: {py:obj}`simvx.core.ui.core.Control`

```{autodoc2-docstring} simvx.editor.hints.TourGuide
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.editor.hints.TourGuide.__init__
```

````{py:attribute} tour_completed
:canonical: simvx.editor.hints.TourGuide.tour_completed
:value: >
   'Signal(...)'

```{autodoc2-docstring} simvx.editor.hints.TourGuide.tour_completed
```

````

````{py:method} start() -> None
:canonical: simvx.editor.hints.TourGuide.start

```{autodoc2-docstring} simvx.editor.hints.TourGuide.start
```

````

````{py:method} stop() -> None
:canonical: simvx.editor.hints.TourGuide.stop

```{autodoc2-docstring} simvx.editor.hints.TourGuide.stop
```

````

````{py:property} is_active
:canonical: simvx.editor.hints.TourGuide.is_active
:type: bool

```{autodoc2-docstring} simvx.editor.hints.TourGuide.is_active
```

````

````{py:method} process(dt: float) -> None
:canonical: simvx.editor.hints.TourGuide.process

```{autodoc2-docstring} simvx.editor.hints.TourGuide.process
```

````

````{py:method} draw(renderer) -> None
:canonical: simvx.editor.hints.TourGuide.draw

````

````{py:attribute} size_x
:canonical: simvx.editor.hints.TourGuide.size_x
:value: >
   'Property(...)'

````

````{py:attribute} size_y
:canonical: simvx.editor.hints.TourGuide.size_y
:value: >
   'Property(...)'

````

````{py:attribute} anchor_left
:canonical: simvx.editor.hints.TourGuide.anchor_left
:value: >
   'Property(...)'

````

````{py:attribute} anchor_top
:canonical: simvx.editor.hints.TourGuide.anchor_top
:value: >
   'Property(...)'

````

````{py:attribute} anchor_right
:canonical: simvx.editor.hints.TourGuide.anchor_right
:value: >
   'Property(...)'

````

````{py:attribute} anchor_bottom
:canonical: simvx.editor.hints.TourGuide.anchor_bottom
:value: >
   'Property(...)'

````

````{py:attribute} margin_left
:canonical: simvx.editor.hints.TourGuide.margin_left
:value: >
   'Property(...)'

````

````{py:attribute} margin_top
:canonical: simvx.editor.hints.TourGuide.margin_top
:value: >
   'Property(...)'

````

````{py:attribute} margin_right
:canonical: simvx.editor.hints.TourGuide.margin_right
:value: >
   'Property(...)'

````

````{py:attribute} margin_bottom
:canonical: simvx.editor.hints.TourGuide.margin_bottom
:value: >
   'Property(...)'

````

````{py:property} size
:canonical: simvx.editor.hints.TourGuide.size
:type: simvx.core.math.types.Vec2

````

````{py:attribute} touch_mode
:canonical: simvx.editor.hints.TourGuide.touch_mode
:type: str
:value: >
   'mouse'

````

````{py:property} theme
:canonical: simvx.editor.hints.TourGuide.theme
:type: simvx.core.ui.types.Theme | None

````

````{py:property} mouse_over
:canonical: simvx.editor.hints.TourGuide.mouse_over
:type: bool

````

````{py:property} focused
:canonical: simvx.editor.hints.TourGuide.focused
:type: bool

````

````{py:property} disabled
:canonical: simvx.editor.hints.TourGuide.disabled
:type: bool

````

````{py:method} get_theme() -> simvx.core.ui.types.Theme
:canonical: simvx.editor.hints.TourGuide.get_theme

````

````{py:method} queue_redraw()
:canonical: simvx.editor.hints.TourGuide.queue_redraw

````

````{py:method} get_minimum_size() -> simvx.core.math.types.Vec2
:canonical: simvx.editor.hints.TourGuide.get_minimum_size

````

````{py:method} get_rect() -> tuple[float, float, float, float]
:canonical: simvx.editor.hints.TourGuide.get_rect

````

````{py:method} get_global_rect() -> tuple[float, float, float, float]
:canonical: simvx.editor.hints.TourGuide.get_global_rect

````

````{py:method} is_point_inside(point) -> bool
:canonical: simvx.editor.hints.TourGuide.is_point_inside

````

````{py:method} set_anchor_preset(preset: simvx.core.ui.enums.AnchorPreset)
:canonical: simvx.editor.hints.TourGuide.set_anchor_preset

````

````{py:method} set_focus()
:canonical: simvx.editor.hints.TourGuide.set_focus

````

````{py:method} grab_focus()
:canonical: simvx.editor.hints.TourGuide.grab_focus

````

````{py:method} release_focus()
:canonical: simvx.editor.hints.TourGuide.release_focus

````

````{py:method} has_focus() -> bool
:canonical: simvx.editor.hints.TourGuide.has_focus

````

````{py:method} focus_next_control()
:canonical: simvx.editor.hints.TourGuide.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.editor.hints.TourGuide.focus_previous_control

````

````{py:method} grab_mouse()
:canonical: simvx.editor.hints.TourGuide.grab_mouse

````

````{py:method} release_mouse()
:canonical: simvx.editor.hints.TourGuide.release_mouse

````

````{py:method} set_drag_preview(control: simvx.core.ui.core.Control)
:canonical: simvx.editor.hints.TourGuide.set_drag_preview

````

````{py:method} draw_popup(renderer)
:canonical: simvx.editor.hints.TourGuide.draw_popup

````

````{py:method} is_popup_point_inside(point) -> bool
:canonical: simvx.editor.hints.TourGuide.is_popup_point_inside

````

````{py:method} popup_input(event)
:canonical: simvx.editor.hints.TourGuide.popup_input

````

````{py:method} dismiss_popup()
:canonical: simvx.editor.hints.TourGuide.dismiss_popup

````

````{py:attribute} z_index
:canonical: simvx.editor.hints.TourGuide.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.editor.hints.TourGuide.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.editor.hints.TourGuide.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.editor.hints.TourGuide.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.editor.hints.TourGuide.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.editor.hints.TourGuide.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.editor.hints.TourGuide.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.editor.hints.TourGuide.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.editor.hints.TourGuide.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.editor.hints.TourGuide.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_position
:canonical: simvx.editor.hints.TourGuide.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.editor.hints.TourGuide.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.editor.hints.TourGuide.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.editor.hints.TourGuide.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.editor.hints.TourGuide.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.editor.hints.TourGuide.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.editor.hints.TourGuide.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.editor.hints.TourGuide.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.editor.hints.TourGuide.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.editor.hints.TourGuide.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, colour=None)
:canonical: simvx.editor.hints.TourGuide.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.editor.hints.TourGuide.wrap_screen

````

````{py:attribute} strict_errors
:canonical: simvx.editor.hints.TourGuide.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.editor.hints.TourGuide.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.editor.hints.TourGuide.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.editor.hints.TourGuide.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.editor.hints.TourGuide.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:property} visible
:canonical: simvx.editor.hints.TourGuide.visible
:type: bool

````

````{py:method} reset_error() -> None
:canonical: simvx.editor.hints.TourGuide.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.editor.hints.TourGuide.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.editor.hints.TourGuide.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.editor.hints.TourGuide.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.editor.hints.TourGuide.get_node

````

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

````

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

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.editor.hints.TourGuide.find_all

````

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

````

````{py:property} path
:canonical: simvx.editor.hints.TourGuide.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.editor.hints.TourGuide.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.editor.hints.TourGuide.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.editor.hints.TourGuide.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.editor.hints.TourGuide.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.editor.hints.TourGuide.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.editor.hints.TourGuide.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.editor.hints.TourGuide.physics_process

````

````{py:method} picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.editor.hints.TourGuide.picked

````

````{py:method} handle_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.editor.hints.TourGuide.handle_input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.editor.hints.TourGuide.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.editor.hints.TourGuide.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.editor.hints.TourGuide.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.editor.hints.TourGuide.clear_children

````

````{py:method} destroy()
:canonical: simvx.editor.hints.TourGuide.destroy

````

````{py:property} app
:canonical: simvx.editor.hints.TourGuide.app

````

````{py:property} tree
:canonical: simvx.editor.hints.TourGuide.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.editor.hints.TourGuide.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.editor.hints.TourGuide.__repr__

````

`````