useFreeCursor
useFreeCursor(
active?):void
Frees the cursor while the calling component is mounted and active
holds, so a player can click what it draws, as Roblox frees the mouse
while a Modal button shows and CommonUI’s menu input config does in
Unreal. A captured cursor is let go with no menu, and the camera takes
it back when the last thing holding it free closes. Two open at once
keep it free until both close. A Modal and a Panel with
freeCursor call it for you.
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
active |
boolean |
true |
Returns
Section titled “Returns”void