collider.md

Collider

A collider has a collision shape (box, sphere, capsule, ...) and is attached to a CollisionBody or RigidBody.

A body can have multiple colliders. The collider also have a mass value and a Material with many physics parameters like friction or bounciness. When you create a body, you need to attach at least one collider to it if you want that body to be able to collide in the physics world.

Create

local collider = body:addCollider(shape, transform)

Methods

• Collider:getEntityId() number
• Collider:getCollisionShape() CollisionShape
• Collider:getBody() CollisionBody
• Collider:getUserData() table|nil
• Collider:setUserData(userData)
• Collider:getLocalToBodyTransform() Transform
• Collider:setLocalToBodyTransform(transform)
• Collider:getLocalToWorldTransform() Transform
• Collider:getWorldAABB() AABB
• Collider:testAABBOverlap(worldAABB) bool
• Collider:testPointInside(worldPoint) bool
• Collider:raycast(ray) RaycastInfo|nil
• Collider:getCollideWithMaskBits() number
• Collider:setCollideWithMaskBits(collideWithMaskBits)
• Collider:getCollisionCategoryBits() number
• Collider:setCollisionCategoryBits(collisionCategoryBits)
• Collider:getBroadPhaseId() number
• Collider:getMaterial() Material
• Collider:setMaterial(material)
• Collider:getMaterialBounciness() number
• Collider:setMaterialBounciness(bounciness)
• Collider:getMaterialFrictionCoefficient() number
• Collider:setMaterialFrictionCoefficient(frictionCoefficient)
• Collider:getMaterialMassDensity() number
• Collider:setMaterialMassDensity(massDensity)
• Collider:getIsTrigger() bool
• Collider:setIsTrigger(isTrigger)

---

Collider:getEntityId()

Return the corresponding entity id of the collider.

RETURN

• (number)

---

Collider:getCollisionShape()

Return the collision shape.

RETURN

• (CollisionShape)

---

Collider:getBody()

Return the parent body.

RETURN

• (CollisionBody)

---

Collider:getUserData()

Return a table attached to this body or nil.

RETURN

• (table|nil)

---

Collider:setUserData(userData)

Attach user data to this body.

PARAMETERS

• userData (table|nil)

---

Collider:getLocalToBodyTransform()

Return the local to parent body transform.

RETURN

• (Transform)

---

Collider:setLocalToBodyTransform(transform)

Set the local to parent body transform.

PARAMETERS

• transform (Transform)

---

Collider:getLocalToWorldTransform()

Return the local to world transform.

RETURN

• (Transform)

---

Collider:getWorldAABB()

Return the AABB of the collider in world-space.

RETURN

• (AABB)

---

Collider:testAABBOverlap(worldAABB)

Test if the collider overlaps with a given AABB

PARAMETERS

• worldAABB (AABB)

RETURN

• (bool)

---

Collider:testPointInside(worldPoint)

Return true if a point is inside the collision shape.

PARAMETERS

• worldPoint (vector3)

RETURN

• (bool)

---

Collider:raycast(ray)

Raycast method with feedback information. Retun (nil) if the ray not hits the collision shape

PARAMETERS

• ray (Ray)

RETURN

• (RaycastInfo|nil)

---

Collider:getCollideWithMaskBits()

Return the collision bits mask.

RETURN

• (number)

---

Collider:setCollideWithMaskBits(collideWithMaskBits)

Return the collision bits mask.

PARAMETERS

• collideWithMaskBits (number)

---

Collider:getCollisionCategoryBits()

Return the collision category bits.

RETURN

• (number)

---

Collider:setCollisionCategoryBits(collisionCategoryBits)

Set the collision category bits.

PARAMETERS

• collisionCategoryBits (number)

---

Collider:getBroadPhaseId()

Return the broad-phase id.

RETURN

• (number)

---

Collider:getMaterial()

Return a material properties of the collider.

RETURN

• (Material)

---

Collider:setMaterial(material)

Set a new material for this collider.

PARAMETERS

• material (Material)

---

Collider:getMaterialBounciness()

Return a bounciness properties of material.

RETURN

• (number)

---

Collider:setMaterialBounciness(bounciness)

Set a bounciness properties of material.

PARAMETERS

• bounciness (number)

---

Collider:getMaterialFrictionCoefficient()

Return a frictionCoefficient properties of material.

RETURN

• (number)

---

Collider:setMaterialFrictionCoefficient(frictionCoefficient)

Set a frictionCoefficient properties of material.

PARAMETERS

• frictionCoefficient (number)

---

Collider:getMaterialMassDensity()

Return a massDensity properties of material.

RETURN

• (number)

---

Collider:setMaterialMassDensity(massDensity)

Set a massDensity properties of material.

PARAMETERS

• massDensity (number)

---

Collider:getIsTrigger()

Return true if the collider is a trigger.

RETURN

• (bool)

---

Collider:setIsTrigger(isTrigger)

Set whether the collider is a trigger.

PARAMETERS

• isTrigger (bool)