`simvx.editor.hints`¶

First-Run Hints — Contextual hints and interactive tour for new users.

Module Contents¶

Classes¶

`HintOverlay`	Shows contextual hints for first-time users.
`TourGuide`	Interactive first-run tour that walks through editor panels.

Data¶

log

API¶

simvx.editor.hints.log¶: ‘getLogger(…)’

class simvx.editor.hints.HintOverlay(**kwargs)[source]¶

Bases: simvx.core.ui.core.Control

Shows contextual hints for first-time users.

Displays a small overlay bar at the bottom of the parent with helpful tips based on editor context (empty scene tree, first play, etc.). Each hint is shown at most once per session.

Usage::

hints = HintOverlay()
parent.add_child(hints)
hints.show_hint("scene_tree_empty")  # Shows: "Add a node with the + button or Ctrl+A"
hints.dismiss()                      # Manually dismiss current hint

Initialization

HINTS: dict[str, str]¶: None

enabled¶: ‘Property(…)’

show_hint(key: str) → bool[source]¶

Show a hint by key, if it hasn’t been shown before.

Returns True if the hint was shown, False if already dismissed or unknown key.

dismiss() → None[source]¶: Dismiss the current hint, marking it as shown.

property active_hint: str | None[source]¶: Return the currently displayed hint key, or None.

property active_hint_text: str | None[source]¶: Return the currently displayed hint text, or None.

property shown_hints: set[str][source]¶: Return the set of hint keys that have been shown/dismissed.

reset() → None[source]¶: Reset all shown hints so they can appear again.

process(dt: float) → None[source]¶: Auto-dismiss hints after a timeout.

draw(renderer) → None[source]¶

size_x¶: ‘Property(…)’

size_y¶: ‘Property(…)’

anchor_left¶: ‘Property(…)’

anchor_top¶: ‘Property(…)’

anchor_right¶: ‘Property(…)’

anchor_bottom¶: ‘Property(…)’

margin_left¶: ‘Property(…)’

margin_top¶: ‘Property(…)’

margin_right¶: ‘Property(…)’

margin_bottom¶: ‘Property(…)’

property size: simvx.core.math.types.Vec2¶

touch_mode: str¶: ‘mouse’

property theme: simvx.core.ui.types.Theme | None¶

property mouse_over: bool¶

property focused: bool¶

property disabled: bool¶

get_theme() → simvx.core.ui.types.Theme¶

queue_redraw()¶

get_minimum_size() → simvx.core.math.types.Vec2¶

get_rect() → tuple[float, float, float, float]¶

get_global_rect() → tuple[float, float, float, float]¶

is_point_inside(point) → bool¶

set_anchor_preset(preset: simvx.core.ui.enums.AnchorPreset)¶

set_focus()¶

grab_focus()¶

release_focus()¶

has_focus() → bool¶

focus_next_control()¶

focus_previous_control()¶

grab_mouse()¶

release_mouse()¶

set_drag_preview(control: simvx.core.ui.core.Control)¶

draw_popup(renderer)¶

is_popup_point_inside(point) → bool¶

popup_input(event)¶

dismiss_popup()¶

z_index¶: ‘Property(…)’

z_as_relative¶: ‘Property(…)’

render_layer¶: ‘Property(…)’

set_render_layer(index: int, enabled: bool = True) → None¶

is_on_render_layer(index: int) → bool¶

property absolute_z_index: int¶

property position: simvx.core.math.types.Vec2¶

property rotation: float¶

property rotation_degrees: float¶

property scale: simvx.core.math.types.Vec2¶

property world_position: simvx.core.math.types.Vec2¶

property world_rotation: float¶

property world_scale: simvx.core.math.types.Vec2¶

property forward: simvx.core.math.types.Vec2¶

property right: simvx.core.math.types.Vec2¶

translate(offset: tuple[float, float] | numpy.ndarray)¶

rotate(radians: float)¶

rotate_deg(degrees: float)¶

look_at(target: tuple[float, float] | numpy.ndarray)¶

transform_points(points: list[simvx.core.math.types.Vec2]) → list[simvx.core.math.types.Vec2]¶

draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, colour=None)¶

wrap_screen(margin: float = 20)¶

strict_errors: ClassVar[bool]¶: True

script_error_raised¶: ‘Signal(…)’

classmethod __init_subclass__(**kwargs)¶

property name: str¶

property process_mode: simvx.core.descriptors.ProcessMode¶

property visible: bool¶

reset_error() → None¶

add_child(node: simvx.core.node.Node) → simvx.core.node.Node¶

remove_child(node: simvx.core.node.Node)¶

reparent(new_parent: simvx.core.node.Node)¶

get_node(path: str) → simvx.core.node.Node¶

find_child(name: str, recursive: bool = False) → simvx.core.node.Node | None¶

find(node_type: type, recursive: bool = True) → simvx.core.node.Node | None¶

find_all(node_type: type, recursive: bool = True) → list¶

walk(*, include_self: bool = True) → collections.abc.Iterator[simvx.core.node.Node]¶

property path: str¶

add_to_group(group: str)¶

remove_from_group(group: str)¶

is_in_group(group: str) → bool¶

ready() → None¶

enter_tree() → None¶

exit_tree() → None¶

physics_process(dt: float) → None¶

picked(event: simvx.core.events.InputEvent) → None¶

handle_input(event: simvx.core.events.TreeInputEvent) → None¶

unhandled_input(event: simvx.core.events.TreeInputEvent) → None¶

start_coroutine(gen: simvx.core.descriptors.Coroutine) → simvx.core.descriptors.CoroutineHandle¶

stop_coroutine(gen_or_handle)¶

clear_children()¶

destroy()¶

property app¶

property tree: simvx.core.scene_tree.SceneTree¶

__getitem__(key: str)¶

classmethod get_properties() → dict[str, simvx.core.descriptors.Property]¶

__repr__()¶

class simvx.editor.hints.TourGuide(**kwargs)[source]¶