Guides

Examples

Modules

Objects

Callbacks

Collider:getUserData

Edit

Returns the Lua value associated with the Collider.

data = Collider:getUserData()

Arguments

None

Returns

NameTypeDescription
data* The custom value associated with the Collider.

Notes

The userdata is useful for linking a Collider with custom data:

local collider = world:raycast(origin, direction, 'enemy')

if collider then
  -- Get the enemy object from its Collider
  local enemy = collider:getUserData()
  enemy.health = 0
end

The user data is not shared between threads. Each thread has its own user data for the Collider.

See also