Skip to content

Home

Jump to bottom
selimanac edited this page Oct 5, 2024 · 14 revisions

Installation

You can use the A* extension in your own project by adding this project as a Defold library dependency.
Open your game.project file, select Project and add a Dependencies field:

https://github.com/selimanac/defold-astar/archive/master.zip <- TODO 3.0

or you can add stable versions from releases.

Examples

Flappy Bird Clone: https://github.com/selimanac/DAABBCC-Flappybird-Example
Breakout: https://github.com/selimanac/DAABBCC-Breakout-Example

Support

Defold Forum: https://forum.defold.com/t/daabbcc-dynamic-aabb-tree-native-extension-with-branch-and-bound-algorithm

API

aabb.new_group()

New empty group for AABBs.

RETURN

  • group_id (int) - New group ID.

EXAMPLE

   local group_id = aabb.new_group()

aabb.insert(group_id, x, y, width, height)

Insert AABB into the group.

PARAMETERS

  • group_id (int) - Group ID.
  • x (number) - X position of AABB.
  • y (number) - Y position of AABB.
  • width (int) - Width of AABB.
  • height (int) - Height of AABB.

RETURN

  • aabb_id (int) - New AABB ID.

EXAMPLE

	
    local x = 0
    local y = 0
    local width = 50
    local height = 50
    local group_id = aabb.new_group()

    local aabb_id = aabb.insert(group_id, x, y, width, height)

    -- OR --

    self.pos = go.get_position(".")
    self.size = go.get("#sprite", "size")
    self.group_id = aabb.new_group()

    self.aabb_id = aabb.insert(self.group_id, self.pos.x , self.pos.y, self.size.x, self.size.y)

aabb.insert_gameobject(group_id, url, width, height)

Insert Gameobject and the associated AABB into a group.
Most suitable for moving gameobjects. If your gameobject is static then use aabb.insert instead.

PARAMETERS

  • group_id (int) - Group ID.
  • url (msg.url) - URL of Gameobject.
  • width (int) - Width of AABB.
  • height (int) - Height of AABB.

RETURN

  • aabb_id (int) - New AABB ID.

EXAMPLE

	
    local go_url = msg.url("/go")
    local width = 50
    local height = 50
    local group_id = aabb.new_group()

    local aabb_id = aabb.insert_gameobject(group_id, go_url, width, height)

aabb.update(group_id, aabb_id, x, y, width, height)

Updates the AABB position and size when you change its position or size.
Gameobject AABB positions will be overwritten.

PARAMETERS

  • group_id (int) - Group ID.
  • aabb_id (int) - AABB ID.
  • x (number) - X position of AABB.
  • y (number) - Y position of AABB.
  • width (int) - Width of AABB.
  • height (int) - Height of AABB.

EXAMPLE

    local x = 0
    local y = 0
    local width = 50
    local height = 50
    local group_id = aabb.new_group()
    local aabb_id = aabb.insert(group_id, x, y, width, height)
 
    local new_x = 10
    local new_y = 10
    local new_w = 60
    local new_h = 60

    aabb.update(group_id, aabb_id, new_x, new_y, new_w, new_h)

aabb.update_gameobject(group_id, aabb_id, w, h)

Updates the AABB size related to the Gameobject.

PARAMETERS

  • group_id (int) - Group ID.
  • aabb_id (int) - AABB ID.
  • width (int) - Width of AABB.
  • height (int) - Height of AABB.

EXAMPLE

    local go_url = msg.url("/go")
    local width = 50
    local height = 50
    local group_id = aabb.new_group()
    local aabb_id = aabb.insert_gameobject(group_id, go_url, width, height)
	
    local new_w = 60
    local new_h = 60

    aabb.update_gameobject(group_id, aabb_id,  new_w, new_h)

aabb.query_id(group_id, aabb_id)

Query the possible overlaps using AABB ID.

PARAMETERS

  • group_id (int) - Group ID.
  • aabb_id (int) - AABB ID.

RETURN

  • result (table) - Table of possible overlapping AABBs.
  • count (int) - Count of result table.

EXAMPLE

    local go_url = msg.url("/go")
    local width = 50
    local height = 50
    local group_id = aabb.new_group()
    local aabb_id = aabb.insert_gameobject(group_id, go_url, width, height)

    local result, count = aabb.query_id(group_id, aabb_id)

    if result then
        for i = 1, count do
            print(result[i])
        end
    end

aabb.query(group_id, x, y, width, height)

Query the possible overlaps without AABB ID.

PARAMETERS

  • group_id (int) - Group ID.
  • x (number) - X position.
  • y (number) - Y position.
  • width (int) - Width.
  • height (int) - Height.

RETURN

  • result (table) - Table of possible overlapping AABBs.
  • count (int) - Count of result table.

EXAMPLE

    local x = 0
    local y = 0
    local width = 50
    local height = 50
    local group_id = aabb.new_group()
   

   local result, count = aabb.query(group_id, x, y, width, height)
    
    if result then
        for i = 1, count do
            print(result[i])
        end
    end

aabb.query_id_sort(group_id, aabb_id)

Query the possible overlaps using AABB ID.
Returns result table with ids and distance, ordered by closest first.

PARAMETERS

  • group_id (int) - Group ID.
  • aabb_id (int) - AABB ID.

RETURN

  • result (table) - Table of possible overlapping AABBs. Result table contains aabb_id and distance.
  • count (int) - Count of result table.

EXAMPLE

    local go_url = msg.url("/go")
    local width = 50
    local height = 50
    local group_id = aabb.new_group()
    local aabb_id = aabb.insert_gameobject(group_id, go_url, width, height)

    local result, count = aabb.query_id_sort(group_id, aabb_id)

    if result then
        for i = 1, count do
            print(result[i])
        end
    end

aabb.query_sort(group_id, x, y, width, height)

Query the possible overlaps without AABB ID.
Returns result table with ids and distance, ordered by closest first.

PARAMETERS

  • group_id (int) - Group ID.
  • x (number) - X position.
  • y (number) - Y position.
  • width (int) - Width.
  • height (int) - Height.

RETURN

  • result (table) - Table of possible overlapping AABBs. Result table contains aabb_id and distance.
  • count (int) - Count of result table.

EXAMPLE

    local x = 0
    local y = 0
    local width = 50
    local height = 50
    local group_id = aabb.new_group()

    local result, count = aabb.query_sort(group_id, x, y, width, height)
    
    if result then
        for i = 1, count do
            print(result[i])
        end
    end

aabb.raycast(group_id, start_x, start_y, end_x, end_y)

Query the possible overlaps using RAYCAST.

PARAMETERS

  • group_id (int) - Group ID.
  • start_x (number) - Ray start position X.
  • start_y (number) - Ray start position Y.
  • end_x (number) - Ray end position X.
  • end_y (number) - Ray end position Y.

RETURN

  • result (table) - Table of possible overlapping AABBs.
  • count (int) - Count of result table.

EXAMPLE

    local group_id = aabb.new_group()

    local ray_start = vmath.vector3(0, 0, 0)
    local ray_end = vmath.vector3(365, 370, 0)

    local result, count = aabb.raycast(group_id, ray_start.x, ray_start.y, ray_end.x, ray_end.y)
    
    if result then
        for i = 1, count do
            print(result[i])
        end
    end

aabb.raycast_sort(group_id, start_x, start_y, end_x, end_y)

Query the possible overlaps using RAYCAST.
Returns result table with ids and distance, ordered by closest first.

PARAMETERS

  • group_id (int) - Group ID.
  • start_x (number) - Ray start position X.
  • start_y (number) - Ray start position Y.
  • end_x (number) - Ray end position X.
  • end_y (number) - Ray end position Y.

RETURN

  • result (table) - Table of possible overlapping AABBs. Result table contains aabb_id and distance.
  • count (int) - Count of result table.

EXAMPLE

    local group_id = aabb.new_group()

    local ray_start = vmath.vector3(0, 0, 0)
    local ray_end = vmath.vector3(365, 370, 0)

    local result, count = aabb.raycast_sort(group_id, ray_start.x, ray_start.y, ray_end.x, ray_end.y)
    
    if result then
        for i = 1, count do
            print(result[i])
        end
    end

aabb.remove_group(group_id)

Removes the group and all associated AABBs and Gameobjects.

PARAMETERS

  • group_id (int) - Group ID.

EXAMPLE

    local group_id = aabb.new_group()

    aabb.remove_group(group_id)

aabb.remove(group_id, aabb_id)

Removes the AABB and Gameobject from group.

PARAMETERS

  • group_id (int) - Group ID.
  • aabb_id (int) - AABB ID.

EXAMPLE

    local go_url = msg.url("/go")
    local width = 50
    local height = 50
    local group_id = aabb.new_group()
    local aabb_id = aabb.insert_gameobject(group_id, go_url, width, height)

    aabb.remove(group_id, aabb_id)

aabb.remove_gameobject(group_id, aabb_id)

Removes gameobject and the associated AABB.
You don't need to call aabb.remove again for removing AABB.

PARAMETERS

  • group_id (int) - Group ID.
  • aabb_id (int) - AABB ID.

EXAMPLE

    local go_url = msg.url("/go")
    local width = 50
    local height = 50
    local group_id = aabb.new_group()
    local aabb_id = aabb.insert_gameobject(group_id, go_url, width, height)

    aabb.remove_gameobject(group_id, aabb_id)

aabb.run(state)

Stop/resume Gameobject position update iteration. It is true by default, but does not iterate when when there are no Gameobjects registered.

PARAMETERS

  • state (boolean) - True/False

EXAMPLE

    aabb.run(true)

aabb.clear()

Clear everything (AABBs,groups, gameobjects) and reset to initial state.

EXAMPLE

    aabb.clear()

aabb.update_frequency(update_frequency)

It is possible to set a independent update frequency for gameobject loop. Default value is set from game.project file(display.frequency).

PARAMETERS

  • update_frequency (int) - Update Frequency.

EXAMPLE

    aabb.update_frequency(5)

Toss a Coin to Your Witcher

If you find my Defold Extensions useful for your projects, please consider supporting it.
I'd love to hear about your projects! Please share your released projects that use my native extensions. It would be very motivating for me.

Initialize DAABBCC

Category & Mask Bits

Result Manifold

Groups

AABBs

Queries

Raycast

Utilities

Clone this wiki locally