PlayerMouse
Provides the mouse input interface returned for a local player.
Behavior
PlayerMouse provides the mouse input interface returned for a local player.
Summary
The world-space transform at the pointer's intersection with scene geometry.
The content identifier of the pointer icon.
The world-space origin transform of the pointer ray.
The BasePart under the pointer, or nil when no Part is hit.
The Instance hierarchy ignored when finding the pointer target.
The face of the Part hit by the pointer ray.
The world-space unit ray through the pointer position.
The viewport width in pixels.
The viewport height in pixels.
The pointer X coordinate in pixels.
The pointer Y coordinate in pixels.
Fires when the primary mouse button is pressed.
Fires when the primary mouse button is released.
Fires when the secondary mouse button is pressed.
Fires when the secondary mouse button is released.
Fires while the pointer is idle.
Fires when a keyboard key is pressed through the mouse interface.
Fires when a keyboard key is released through the mouse interface.
Fires when the pointer moves.
Fires when the mouse wheel scrolls backward.
Fires when the mouse wheel scrolls forward.
Properties
Hit
PlayerMouse.Hit: CFrameThe world-space transform at the pointer's intersection with scene geometry.
Icon
PlayerMouse.Icon: stringThe content identifier of the pointer icon.
Origin
PlayerMouse.Origin: CFrameThe world-space origin transform of the pointer ray.
Target
PlayerMouse.Target: BasePart?The BasePart under the pointer, or nil when no Part is hit.
TargetFilter
PlayerMouse.TargetFilter: Instance?The Instance hierarchy ignored when finding the pointer target.
TargetSurface
PlayerMouse.TargetSurface: EnumItemThe face of the Part hit by the pointer ray.
UnitRay
PlayerMouse.UnitRay: RayThe world-space unit ray through the pointer position.
ViewSizeX
PlayerMouse.ViewSizeX: numberThe viewport width in pixels.
ViewSizeY
PlayerMouse.ViewSizeY: numberThe viewport height in pixels.
X
PlayerMouse.X: numberThe pointer X coordinate in pixels.
Y
PlayerMouse.Y: numberThe pointer Y coordinate in pixels.
Events
Button1Down
PlayerMouse.Button1Down: RBXScriptSignalFires when the primary mouse button is pressed.
Button1Up
PlayerMouse.Button1Up: RBXScriptSignalFires when the primary mouse button is released.
Button2Down
PlayerMouse.Button2Down: RBXScriptSignalFires when the secondary mouse button is pressed.
Button2Up
PlayerMouse.Button2Up: RBXScriptSignalFires when the secondary mouse button is released.
Idle
PlayerMouse.Idle: RBXScriptSignalFires while the pointer is idle.
KeyDown
PlayerMouse.KeyDown: RBXScriptSignalFires when a keyboard key is pressed through the mouse interface.
KeyUp
PlayerMouse.KeyUp: RBXScriptSignalFires when a keyboard key is released through the mouse interface.
Move
PlayerMouse.Move: RBXScriptSignalFires when the pointer moves.
WheelBackward
PlayerMouse.WheelBackward: RBXScriptSignalFires when the mouse wheel scrolls backward.
WheelForward
PlayerMouse.WheelForward: RBXScriptSignalFires when the mouse wheel scrolls forward.
Inherited members
- Methods
- GetExecutionGroup()
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying