Skip to main content

MLGrab.OnPrimaryGrabBegin

"Read-Only"

This property is Read-Only

NameType
OnPrimaryGrabBeginEventHandler

Event callback function requirement​

info

This property is an event. It means that you need to add a listener function to it. Here how that function needs to look like.

function();

Usage​

--- @type 
local mlgrab;

--- callback function called when event triggers

local function CallBack()
    -- code to handle event call back
end


-- Regsiter callback function
mlgrab.OnPrimaryGrabBegin.Add(CallBack);

Description​

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.