Roblox Api Mouse

Roblox api mouse. The mouse object houses various api for pointers primarily for buttons and raycasting. It can be accessed through playergetmouse called on the playerslocalplayer in a localscript. It is also passed by the toolequipped event. It is most notable for the mouseiconicon property which changes the cursors appearance.

The x property describes the horizontal component of the mouses position on the screen. The position is measured in pixels relative to the top left corner under the topbar. This property can be used in conjunction with mousey to produce a datatypevector2 representing the mouses position. Local position vector2newmousex mousey.

Mouse origin vs mouse hit vs currentcamera position. The code below visualizes the difference between mousehit and mouseoriginin order to do this the code uses the datatypevector3 positions of the hit and origin datatypecframe values using p. The difference is that the origin is where the mouse came from its origin and the hit is the position where the mouse hits is when the. The mouse moves freely around the users screen.

The mouse is locked and cannot move from the center of the users screen. The mouse is locked and cannot move from its current position on the users screen at the time of locking. Developers can find out the position of the mouse in world space and if it is pointing at any basepart using the mousehit and mousetarget properties. For information on how to obtain the mouse object please see the mouse page.

Note developers are recommended to use userinputservice instead of the mouse object in new work. Code samples handling user clicks on a gui button. The code sample below demonstrates how to use the guibuttonmousebutton1click and guibuttonmousebutton2click events to handle user left and right mouse button input on a guibutton. For the example to work expected the localscript containing the code should be a child of the gui button.