Mouse

Easy access for the mouse.

• position()
• left
• left_pressed
• left_released
• right
• right_pressed
• right_released
• middle
• middle_pressed
• middle_released

position

static position(camera)

Parameters

• camera -> Camera or null Camera to check mouse relative to.

Returns the mouse position relative to a given camera, or null for the mouse position relative to the window. The mouse position is returned as a list with the values [x, y].

This method adjusts the mouse position to the camera to make the position relative to the game world if you want, but it does not work properly with rotated cameras or cameras that use zoom instead of width/height.

left

Read Only: static left

Variable Type: Bool - True if the left mouse buttons is currently held down.

left_pressed

Read Only: static left_pressed

Variable Type: Bool - True if the left mouse button was just pressed this frame.

left_released

Read Only: static left_released

Variable Type: Bool - True if the left mouse button was just released this frame.

right

Read Only: static right

Variable Type: Bool - True if the right mouse buttons is currently held down.

right_pressed

Read Only: static right_pressed

Variable Type: Bool - True if the right mouse button was just pressed this frame.

right_released

Read Only: static right_released

Variable Type: Bool - True if the right mouse button was just released this frame.

middle

Read Only: static middle

Variable Type: Bool - True if the middle mouse buttons is currently held down.

middle_pressed

Read Only: static middle_pressed

Variable Type: Bool - True if the middle mouse button was just pressed this frame.

middle_released

Read Only: static middle_released

Variable Type: Bool - True if the middle mouse button was just released this frame.