Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Mouse

Summary

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable]

Member index 24

HistoryMember
553Hit: CFrame
553Icon: Content
553Origin: CFrame
553Target: BasePart
553TargetFilter: Instance
553TargetSurface: NormalId
553UnitRay: Ray
553ViewSizeX: int
553ViewSizeY: int
553X: int
553Y: int
553target: BasePart
462Button1Down()
462Button1Up()
462Button2Down()
462Button2Up()
462Idle()
553KeyDown(key: string)
553KeyUp(key: string)
462Move()
462WheelBackward()
462WheelForward()
553keyDown(key: string)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

History 89

Members 24

Button1Down

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

Button1Up

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

Button2Down

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

Button2Up

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

Hit

TypeDefault
CFrame
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

  • 553 Change Default of Hit from to
  • 486 Change ThreadSafety of Hit from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Hit from to ReadOnly
  • 47 Add Hit
Tags: [ReadOnly, NotReplicated]

Icon

TypeDefault
Content
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

  • 553 Change Default of Icon from to
  • 486 Change ThreadSafety of Icon from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Icon from to ReadOnly
  • 47 Add Icon

Idle

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

KeyDown

Parameters (1)
keystring
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. InputBegan should be used instead.
Thread safetyUnsafe

History 5

Tags: [Deprecated]

KeyUp

Parameters (1)
keystring
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. InputEnded should be used instead.
Thread safetyUnsafe

History 5

Tags: [Deprecated]

Move

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

Origin

TypeDefault
CFrame
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

Target

TypeDefault
BasePart
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 5

Tags: [ReadOnly, NotReplicated]

TargetFilter

TypeDefault
Instance
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 5

TargetSurface

TypeDefault
NormalId
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

UnitRay

TypeDefault
Ray
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

ViewSizeX

TypeDefault
int
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

ViewSizeY

TypeDefault
int
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

WheelBackward

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

WheelForward

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

X

TypeDefault
int
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

  • 553 Change Default of X from to
  • 486 Change ThreadSafety of X from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of X from to ReadOnly
  • 47 Add X
Tags: [ReadOnly, NotReplicated]

Y

TypeDefault
int
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 4

  • 553 Change Default of Y from to
  • 486 Change ThreadSafety of Y from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Y from to ReadOnly
  • 47 Add Y
Tags: [ReadOnly, NotReplicated]

keyDown

Parameters (1)
keystring
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. InputBegan should be used instead.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

target

TypeDefault
BasePart
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. Target should be used instead.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 6

Tags: [ReadOnly, NotReplicated, Deprecated]

Settings