Skip to Content
defold-typescript libraries
selimanac

selimanac/defold-daabbcc/daabbcc

Dynamic Tree (aka AABB Tree) native extension for Defold Engine

  • GitHub: selimanac/defold-daabbcc — pinned to v3.0.9
    1. Pick a release from selimanac/defold-daabbcc releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as daabbcc from "daabbcc"

Functions

new_group(rebuild_type?: number): number

New empty group for AABBs. Every group is a separate dynamic tree.

Parameters

  • rebuild_type?: number — How the tree is rebuilt after each update of moving game object positions: UPDATE_INCREMENTAL (default), UPDATE_FULLREBUILD or UPDATE_PARTIALREBUILD.

Returns

  • number — New group ID.

remove_group(group_id: number)

Removes the group and all associated AABBs and game objects.

Parameters

  • group_id: number — Group ID.

insert_aabb(group_id: number, x: number, y: number, width: number, height: number, category_bit?: number): number

Insert an AABB into the group.

Parameters

  • group_id: number — Group ID.
  • x: number — X position of the AABB.
  • y: number — Y position of the AABB.
  • width: number — Width of the AABB.
  • height: number — Height of the AABB.
  • category_bit?: number — Single category bit the AABB belongs to. Default is all.

Returns

  • number — New AABB ID.

insert_gameobject(group_id: number, go_url: SceneGameObjectAddress | Hash | Url, width: number, height: number, category_bit?: number, get_world_position?: boolean): number

Insert a game object and its associated AABB into a group. Most suitable for constantly moving game objects; use insert_aabb for static ones.

Parameters

  • group_id: number — Group ID.
  • go_url: SceneGameObjectAddress | Hash | Url — The game object.
  • width: number — Width of the AABB.
  • height: number — Height of the AABB.
  • category_bit?: number — Single category bit the AABB belongs to. Default is all.
  • get_world_position?: boolean — Use the game object's world position. Default is false.

Returns

  • number — New AABB ID.

update_aabb(group_id: number, aabb_id: number, x: number, y: number, width: number, height: number)

Updates the AABB position and size. Does not affect game objects, whose AABB positions are overwritten by the internal update.

Parameters

  • group_id: number — Group ID.
  • aabb_id: number — AABB ID.
  • x: number — X position of the AABB.
  • y: number — Y position of the AABB.
  • width: number — Width of the AABB.
  • height: number — Height of the AABB.

update_gameobject_size(group_id: number, aabb_id: number, width: number, height: number)

Updates the size of a game object's AABB.

Parameters

  • group_id: number — Group ID.
  • aabb_id: number — AABB ID.
  • width: number — Width of the AABB.
  • height: number — Height of the AABB.

remove(group_id: number, aabb_id: number)

Removes the AABB and its game object from the group.

Parameters

  • group_id: number — Group ID.
  • aabb_id: number — AABB ID.

query_aabb(group_id: number, x: number, y: number, width: number, height: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ QueryResult | undefined, number ]>

Query possible overlaps using a raw AABB.

Parameters

  • group_id: number — Group ID.
  • x: number — X position of the AABB.
  • y: number — Y position of the AABB.
  • width: number — Width of the AABB.
  • height: number — Height of the AABB.
  • mask_bits?: number — Default is all.
  • get_manifold?: boolean — Include the collision manifold. Default is false.
  • get_bits?: boolean — Include category bits without manifold generation. Default is false.

Returns

  • LuaMultiReturn<[ QueryResult | undefined, number ]> — The overlapping AABBs, or undefined when there are none, and their count.

query_id(group_id: number, aabb_id: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ QueryResult | undefined, number ]>

Query possible overlaps using an AABB ID.

Parameters

  • group_id: number — Group ID.
  • aabb_id: number — AABB ID.
  • mask_bits?: number — Default is all.
  • get_manifold?: boolean — Include the collision manifold. Default is false.
  • get_bits?: boolean — Include category bits without manifold generation. Default is false.

Returns

  • LuaMultiReturn<[ QueryResult | undefined, number ]> — The overlapping AABBs, or undefined when there are none, and their count.

query_aabb_sort(group_id: number, x: number, y: number, width: number, height: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ SortedQueryResult | undefined, number ]>

Query possible overlaps using a raw AABB, ordered from closest to farthest.

Parameters

  • group_id: number — Group ID.
  • x: number — X position of the AABB.
  • y: number — Y position of the AABB.
  • width: number — Width of the AABB.
  • height: number — Height of the AABB.
  • mask_bits?: number — Default is all.
  • get_manifold?: boolean — Include the collision manifold. Default is false.
  • get_bits?: boolean — Include category bits without manifold generation. Default is false.

Returns

  • LuaMultiReturn<[ SortedQueryResult | undefined, number ]> — The overlapping AABBs, or undefined when there are none, and their count.

query_id_sort(group_id: number, aabb_id: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ SortedQueryResult | undefined, number ]>

Query possible overlaps using an AABB ID, ordered from closest to farthest.

Parameters

  • group_id: number — Group ID.
  • aabb_id: number — AABB ID.
  • mask_bits?: number — Default is all.
  • get_manifold?: boolean — Include the collision manifold. Default is false.
  • get_bits?: boolean — Include category bits without manifold generation. Default is false.

Returns

  • LuaMultiReturn<[ SortedQueryResult | undefined, number ]> — The overlapping AABBs, or undefined when there are none, and their count.

raycast(group_id: number, start_x: number, start_y: number, end_x: number, end_y: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ QueryResult | undefined, number ]>

Perform a ray cast against the group.

Parameters

  • group_id: number — Group ID.
  • start_x: number — Ray start X.
  • start_y: number — Ray start Y.
  • end_x: number — Ray end X.
  • end_y: number — Ray end Y.
  • mask_bits?: number — Default is all.
  • get_manifold?: boolean — Include the collision manifold. Default is false.
  • get_bits?: boolean — Include category bits without manifold generation. Default is false.

Returns

  • LuaMultiReturn<[ QueryResult | undefined, number ]> — The hit AABBs, or undefined when there are none, and their count.

raycast_sort(group_id: number, start_x: number, start_y: number, end_x: number, end_y: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ SortedQueryResult | undefined, number ]>

Perform a ray cast against the group, ordered from closest to farthest.

Parameters

  • group_id: number — Group ID.
  • start_x: number — Ray start X.
  • start_y: number — Ray start Y.
  • end_x: number — Ray end X.
  • end_y: number — Ray end Y.
  • mask_bits?: number — Default is all.
  • get_manifold?: boolean — Include the collision manifold. Default is false.
  • get_bits?: boolean — Include category bits without manifold generation. Default is false.

Returns

  • LuaMultiReturn<[ SortedQueryResult | undefined, number ]> — The hit AABBs, or undefined when there are none, and their count.

run(state: boolean)

Pause or resume the internal game object position update. Enabled by default; it does not iterate when no game objects are registered.

Parameters

  • state: boolean — true to resume, false to pause.

update_frequency(frequency: number)

Set an independent frequency for the game object position update. The default is the project's display.frequency.

Parameters

  • frequency: number — Update frequency.

rebuild(group_id: number, full_build: boolean)

Partially or fully rebuild a group.

Parameters

  • group_id: number — Group ID.
  • full_build: boolean — true for a full rebuild, false for a partial one.

rebuild_all(_unused: undefined, full_build: boolean)

Partially or fully rebuild all groups.

The runtime reads the flag from the second argument, so pass undefined first.

Parameters

  • _unused: undefined — Ignored by the runtime.
  • full_build: boolean — true for a full rebuild, false for a partial one.

reset()

Removes all AABBs, groups and game objects, resetting to the initial state. Recommended when you are done with it, such as when a level ends.

Variables

UPDATE_INCREMENTAL: number

No rebuild. Default.

UPDATE_FULLREBUILD: number

Full rebuild.

UPDATE_PARTIALREBUILD: number

Partial rebuild. Recommended for lots of moving AABBs.

Types

type QueryResult = number[] | BitsHit[] | ManifoldHit[]

type SortedQueryResult = SortedHit[] | BitsHit[] | ManifoldHit[]

BitsHit

BitsHit.id: number

The AABB ID.

BitsHit.category_bits: number

The category bits the AABB was inserted with.

ManifoldHit

interface ManifoldHit extends SortedHit

ManifoldHit.depth: number

Penetration depth.

ManifoldHit.contact_point_x: number

Contact point X.

ManifoldHit.contact_point_y: number

Contact point Y.

ManifoldHit.normal_x: number

Collision normal X.

ManifoldHit.normal_y: number

Collision normal Y.

SortedHit

interface SortedHit extends BitsHit

SortedHit.distance: number

Distance from the query or ray origin.

On this page

Functionsnew_group(rebuild_type?: number): numberremove_group(group_id: number)insert_aabb(group_id: number, x: number, y: number, width: number, height: number, category_bit?: number): numberinsert_gameobject(group_id: number, go_url: SceneGameObjectAddress | Hash | Url, width: number, height: number, category_bit?: number, get_world_position?: boolean): numberupdate_aabb(group_id: number, aabb_id: number, x: number, y: number, width: number, height: number)update_gameobject_size(group_id: number, aabb_id: number, width: number, height: number)remove(group_id: number, aabb_id: number)query_aabb(group_id: number, x: number, y: number, width: number, height: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ QueryResult | undefined, number ]>query_id(group_id: number, aabb_id: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ QueryResult | undefined, number ]>query_aabb_sort(group_id: number, x: number, y: number, width: number, height: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ SortedQueryResult | undefined, number ]>query_id_sort(group_id: number, aabb_id: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ SortedQueryResult | undefined, number ]>raycast(group_id: number, start_x: number, start_y: number, end_x: number, end_y: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ QueryResult | undefined, number ]>raycast_sort(group_id: number, start_x: number, start_y: number, end_x: number, end_y: number, mask_bits?: number, get_manifold?: boolean, get_bits?: boolean): LuaMultiReturn<[ SortedQueryResult | undefined, number ]>run(state: boolean)update_frequency(frequency: number)rebuild(group_id: number, full_build: boolean)rebuild_all(_unused: undefined, full_build: boolean)reset()VariablesUPDATE_INCREMENTAL: numberUPDATE_FULLREBUILD: numberUPDATE_PARTIALREBUILD: numberTypestype QueryResult = number[] | BitsHit[] | ManifoldHit[]type SortedQueryResult = SortedHit[] | BitsHit[] | ManifoldHit[]BitsHitBitsHit.id: numberBitsHit.category_bits: numberManifoldHitinterface ManifoldHit extends SortedHitManifoldHit.depth: numberManifoldHit.contact_point_x: numberManifoldHit.contact_point_y: numberManifoldHit.normal_x: numberManifoldHit.normal_y: numberSortedHitinterface SortedHit extends BitsHitSortedHit.distance: number