InputEventMouseButton Properties

State of the Alt modifier.

The mouse button identifier, one of the ButtonList button or button wheel constants.

The mouse button mask identifier, one of or a bitwise combination of the ButtonList button masks.

State of the Command modifier.

State of the Ctrl modifier.

The event's device ID.

Note: This device ID will always be -1 for emulated mouse input from a touchscreen. This can be used to distinguish emulated mouse input from physical mouse input.

If true, the mouse button's state is a double-click.

The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be 0 if not supported.

The global mouse position relative to the current Viewport when used in _GuiInput(InputEvent), otherwise is at 0,0.

State of the Meta modifier.

The local mouse position relative to the Viewport. If used in _GuiInput(InputEvent), the position is relative to the current Control which is under the mouse.

If true, the mouse button's state is pressed. If false, the mouse button's state is released.

If true, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

The name of the resource. This is an optional identifier. If ResourceName is not empty, its value will be displayed to represent the current resource in the editor inspector. For built-in scripts, the ResourceName will be displayed as the tab name in the script editor.

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

State of the Shift modifier.