Grid Placement
Development ⚠️ GridPlacement 6.0 (GECS) is in active development. This is the GDScript ECS architecture.

PlacementSignalBus

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: shared/events/placement_bus.gd

Version: 6.0

class_name: PlacementSignalBus extends: RefCounted

Signals

  • placement_success(data: PlacementSuccessEvent)
    • Emitted when a placement operation fails.
    • Emitted when a placement request has been validated.
    • Emitted when placement is canceled
    • Selection state change events
    • Indicator update events
    • Get singleton instance
  • placement_failure(data: PlacementFailureEvent)
    • Emitted when a placement request has been validated.
    • Emitted when placement is canceled
    • Selection state change events
    • Indicator update events
    • Get singleton instance
  • placement_validated(entity: Entity, result: bool)
    • Emitted when placement is canceled
    • Selection state change events
    • Indicator update events
    • Get singleton instance
  • placement_canceled(entity: Entity, reason: String)
    • Selection state change events
    • Indicator update events
    • Get singleton instance
  • placement_request(user_id: String, grid_id: String, grid_pos: Vector2i)
    • Selection state change events
    • Indicator update events
    • Get singleton instance
  • selection_changed(data: SelectionChangeEvent)
    • Indicator update events
    • Get singleton instance
  • hover_changed(data: HoverChangeEvent)
    • Indicator update events
    • Get singleton instance
  • focus_changed(data: FocusChangeEvent)
    • Indicator update events
    • Get singleton instance
  • indicator_update(data: IndicatorUpdateEvent)
    • Get singleton instance
  • drag_session(data: DragSessionEvent)
    • Get singleton instance
  • management

Exports

(none)

Methods

  • get_instance -> PlacementSignalBus
  • _connect_once(sig: Signal, callable: Callable) -> void
  • _disconnect_if_connected(sig: Signal, callable: Callable) -> void
  • _disconnect_all(sig: Signal) -> void
  • emit_success(entity: Entity, pos: Vector2, grid_pos: Vector2i) -> void
  • emit_failure(entity: Entity, reason: String, issues: Array) -> void
  • emit_validated(entity: Entity, result: bool) -> void
  • emit_canceled(entity: Entity, reason: String) -> void
  • emit_selection_changed(entity: Entity, action: String) -> void
  • emit_hover_changed(entity: Entity, hovered: Entity, previous: Entity = null) -> void
  • emit_focus_changed(entity: Entity, focused: Entity, previous: Entity = null) -> void
  • emit_indicator_update(indicator_entity: Entity, target_entity: Entity, update_type: String, indicator_type: int = -1, position: Vector2 = Vector2.ZERO, grid_position: Vector2i = Vector2i.ZERO) -> void
  • emit_drag_session(drag_entity: Entity, placeable_entity: Entity, session_action: String, grid_position: Vector2i = Vector2i.ZERO, world_position: Vector2 = Vector2.ZERO, placements: int = 0, session_id: String = "") -> void
  • emit_placement_request(user_id: String, grid_id: String, grid_pos: Vector2i) -> void
  • connect_success(callable: Callable) -> void
  • connect_failure(callable: Callable) -> void
  • connect_validated(callable: Callable) -> void
  • connect_canceled(callable: Callable) -> void
  • connect_selection_changed(callable: Callable) -> void
  • connect_hover_changed(callable: Callable) -> void
  • connect_focus_changed(callable: Callable) -> void
  • connect_indicator_update(callable: Callable) -> void
  • connect_drag_session(callable: Callable) -> void
  • disconnect_success(callable: Callable) -> void
  • disconnect_failure(callable: Callable) -> void
  • disconnect_validated(callable: Callable) -> void
  • disconnect_canceled(callable: Callable) -> void
  • disconnect_selection_changed(callable: Callable) -> void
  • disconnect_hover_changed(callable: Callable) -> void
  • disconnect_focus_changed(callable: Callable) -> void
  • disconnect_indicator_update(callable: Callable) -> void
  • disconnect_drag_session(callable: Callable) -> void
  • cleanup -> void