object.shape_contains

This function checks whether the context object contains other's pivot point. An object's pivot point is usually its centerpoint or center of mass, but there are exceptions; for example, a Sabre's pivot point is located roughly at the bottom of its landing gear, while a Dice's pivot point is located very slightly off-center on the "six" face.

If other is attached to some parent object, then this function tests the parent object's pivot point rather than other's pivot point.

Arguments

other

An object in the game world.

Example

--
-- Drain the shields of all players in the hill.
--
for each player do
   if current_hill.shape_contains(current_player.biped) then
      current_player.biped.shields = 0
   end
end

See also