API > MLGrab

MLGrab⚓︎

MLGrab inherits from Component

API for MLGrab component. You can use this API to create your own grab mechanics or implement extra functionality to grabbing in Massive Loop.

Members⚓︎

Properties⚓︎

Name	Description
`MLGrab`.`CurrentUser`	Current player who is grabbing the object. Nil if no one is holding to the object.
`MLGrab`.`ExpectedObjectPosition`	The calculated, expected position of the grabbed object based on the players hands and grab points using the default grab mechanics.
`MLGrab`.`ExpectedObjectRotation`	The calculated, expected rotation of the grabbed object based on the players hands and grab points using the default grab mechanics.
`MLGrab`.`OnPrimaryGrabBegin`	The Event handler which gets invoked when the object is grabbed by the primary hand. This event is invoked in all the clients if the grabbable object synchronized through the MLSynchronizer component.
`MLGrab`.`OnPrimaryGrabEnd`	The Event handler which gets invoked when the object is released by the primary hand. This event is invoked in all the clients if the grabbable object synchronized through the MLSynchronizer component.
`MLGrab`.`OnPrimaryTriggerDown`	The Event handler which gets invoked when the triggered button pressed down for the primary hand. This event is invoked in all the clients if the grabbable object synchronized through the MLSynchronizer component.
`MLGrab`.`OnPrimaryTriggerDownLocal`	Similar to the `OnPrimaryTriggerDown` which gets invoked with the trigger button pressed down for the primary hand, however, this event handler only gets invoked if the local player is performing this action.
`MLGrab`.`OnPrimaryTriggerUp`	The Event handler which gets invoked when the triggered button released for the primary hand. This event is invoked in all the clients if the grabbable object synchronized through the MLSynchronizer component.
`MLGrab`.`OnPrimaryTriggerUpLocal`	Similar to the `OnPrimaryTriggeUp` which gets invoked with the trigger button released for the primary hand, however, this event handler only gets invoked if the local player is performing this action.
`MLGrab`.`OnSecondaryGrabBegin`	The Event handler which gets invoked when the object is grabbed by the secondary hand. This event is invoked in all the clients if the grabbable object synchronized through the MLSynchronizer component.
`MLGrab`.`OnSecondaryGrabEnd`	The Event handler which gets invoked when the object is released by the secondary hand. This event is invoked in all the clients if the grabbable object synchronized through the MLSynchronizer component.
`MLGrab`.`OnSecondaryTriggerDown`	The Event handler which gets invoked when the triggered button pressed down for the secondary hand. This event is invoked in all the clients if the grabbable object synchronized through the MLSynchronizer component.
`MLGrab`.`OnSecondaryTriggerDownLocal`	Similar to the `OnSecondaryTriggerDown` which gets invoked with the trigger button pressed down for the secondary hand, however, this event handler only gets invoked if the local player is performing this action.
`MLGrab`.`OnSecondaryTriggerUp`	The Event handler which gets invoked when the triggered button released for the secondary hand. This event is invoked in all the clients if the grabbable object synchronized through the MLSynchronizer component.
`MLGrab`.`OnSecondaryTriggerUpLocal`	Similar to the `OnSecondaryTriggerUp` which gets invoked with the trigger button released for the secondary hand, however, this event handler only gets invoked if the local player is performing this action.
`MLGrab`.`PrimaryGrabPoint`	The transform the of the current Primary grab point. Can be used to create a custom grab mechanics.
`MLGrab`.`PrimaryHand`	The transform the of the current player’s primary hand. Can be used to create a custom grab mechanics.
`MLGrab`.`SecondaryGrabPoint`	The transform the of the current Secondary grab point. Can be used to create a custom grab mechanics.
`MLGrab`.`SecondaryHand`	The transform the of the current player’s secondary hand. Can be used to create a custom grab mechanics.

Methods⚓︎

Name	Description
`MLGrab`.`CaptureInput()`	Captures some of the user input to be used while the object is grabbed by local user. The default actions bind to captured controls disabled until the input released. The Input can be released by calling Release input, or dropping object automatically releases the input.
`MLGrab`.`ForceRelease()`	Force releases the object if it is grabbed.
`MLGrab`.`ReleaseInput()`	Releases the captured input back to normal function.

Inherited Members⚓︎

Inherited Properties⚓︎

Name	Description
`MLGrab`.`gameObject`	The game object this component is attached to. A component is always attached to a game object.
`MLGrab`.`tag`	The tag of this game object.
`MLGrab`.`transform`	The Transform attached to this GameObject.
`MLGrab`.`hideFlags`	Should the object be hidden, saved with the Scene or modifiable by the user?
`MLGrab`.`name`	The name of the object.

Inherited Methods⚓︎

Name	Description
`MLGrab`.`BroadcastMessage(methodName, parameter=nil)`	Calls the method named methodName on every Lua Script in this game object or any of its children.
`MLGrab`.`CompareTag(tag)`	Is this game object tagged with tag ?
`MLGrab`.`GetAllLuaScripts()`	Returns an array of all Lua scripts that attached to the game object.
`MLGrab`.`GetComponent(type)`	Returns the component of Type type if the game object has one attached, nil if it doesn't.
`MLGrab`.`GetComponentInChildren(t)`	Returns the component of Type type in the GameObject or any of its children using depth first search.
`MLGrab`.`GetComponentInParent(t)`	Returns the component of Type type in the GameObject or any of its parents.
`MLGrab`.`GetComponents(type)`	Returns all components of Type type in the GameObject.
`MLGrab`.`GetComponentsInChildren(t)`	Returns all components of Type type in the GameObject or any of its children.
`MLGrab`.`GetComponentsInParent(t)`	Returns all components of Type type in the GameObject or any of its parents.
`MLGrab`.`SendMessage(methodName, value=nil)`	Calls the method named methodName on every Lua Script in this game object.
`MLGrab`.`SendMessageUpwards(methodName, value=nil)`	Calls the method named methodName on every LuaScript in this game object and on every ancestor of the behaviour.
`MLGrab`.`TryGetComponent(type)`	Gets the component of the specified type, if it exists.
`MLGrab`.`GetInstanceID()`	Returns the instance id of the object.