OverlapDetector2D - Maybells/celeste-godot-utilities GitHub Wiki

Inherits: Node2D > CanvasItem > Node > Object

Description

Finds an object at a point.

Properties

type property default value
PoolStringArray detection_groups []
bool continuous_detection False
Object current_overlap Null

Methods

return type method signature
null add_exception(Object exception)
null reset_exceptions()
null force_overlap_update()
Object get_overlap()

Signals

  • overlap_changed(from, to)

Called when current overlapping object is different from previous.


Properties Descriptions

detection_groups

_Default_ `[]`
Which groups the detector can interact with

continuous_detection

  • bool continuous_detection
_Default_ `False`
If true, calculates overlap every frame. If false, calculates only when moving.

current_overlap

The most recent overlapping object


Method Descriptions

add_exception

  • void add_exception(Object exception)

Adds an exception that will no longer be detected.


reset_exceptions

  • void reset_exceptions()

Removes all exceptions.


force_overlap_update

  • void force_overlap_update()

Recalculates overlap.


get_overlap

Gets the most recent overlapping object.


⚠️ **GitHub.com Fallback** ⚠️