Grabbable

Inherits Instance

Grabbable represents a object that can be dragged by user. It can be parented to Physical to give user ability to drag that object.

Properties

Force : number

Determines the force used to drag this object.

MaxRange : number

Determines the max range that this object can be dragged.

PermissionMode : GrabbablePermissionMode

Determines the permission mode for this grabber

Dragger : Player

Returns the current dragger

PermissionPredicate : function

A predicate function deciding whenever this player can grab this object. PermissionMode must be set to GrabbablePermissionMode.Scripted

Example usage:

grabbable.PermissionMode = Enums.GrabbablePermissionMode.Scripted
grabbable.PermissionPredicate = function(player)
  return player.Name == "Player1"
end

Events

Grabbed

Parameters: grabber [ Player ]

Fires when this object has been grabbed

Released

Parameters: ``

Fires when this object has been released