PlayersCanPickupObject(Entity, number, number)

server
Checks if any player can pickup this type of object.

Arguments

  • entity Entity The entity that is being checked.
  • massLimit number The mass limit of the object.
  • sizeLimit number The size limit of the object.

Returns

  • boolean Whether or not the object can be picked up.

Note: Returning is not required

Returning from hooks is not required. Only do so if you mean to override behaviour. The first hook that returns a value will be the final value, skipping all following hooks.

Examples

hook PlayersCanPickupObject – "Checks if any player can pickup this type of object."