RBX.lua.Mouse (Object): Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
new format
>Sncplay42
(Added Local template, clarified usage)
>Camoy
(new format)
Line 1: Line 1:
__NOTOC__ {{CatUp|Class reference}}
{{ObjectPage|name=Mouse|{{Local}}
 
<div class="tabber">
<div class="tabbertab" title="Info">
{| cellspacing=2 cellpadding=4 border=0 width=100%
 
|style="vertical-align:top"|{{:Object:Mouse}}
|style="vertical-align:top"|{{Local}}{{LeftNoticeStart}}
 
The '''Mouse''' object is the code interface for the computer mouse, including buttons and mouse position.
The '''Mouse''' object is the code interface for the computer mouse, including buttons and mouse position.


A Mouse object is not creatable, but can be obtained using the [[Selected]] event of [[HopperBin]]s or the [[Equipped]] event of [[Tool]]s. A Mouse object is only usable while the [[Player]] has the Tool or HopperBin selected. Once they are deselected, the Mouse's events will no longer be triggered and reading the properties will cause an error.  
A Mouse object is not creatable, but can be obtained using the [[Selected]] event of [[HopperBin]]s or the [[Equipped]] event of [[Tool]]s. A Mouse object is only usable while the [[Player]] has the Tool or HopperBin selected. Once they are deselected, the Mouse's events will no longer be triggered and reading the properties will cause an error.}}
 
|}
|}
</div>
<div class="tabbertab" title="Methods">
{{:Clone (Function)}}
{{:FindFirstChild (Function)}}
{{:GetChildren (Function)}}
{{:GetFullName (Function)}}
{{:IsA (Function)}}
{{:IsAncestorOf (Function)}}
{{:IsDescendantOf (Function)}}
{{:Remove (Function)}}
</div>
<div class="tabbertab" title="Properties">
{{:Name (Property)}}{{:Parent (Property)}}
{{:Archivable (Property)}}
{{:ClassName (Property)}}
{{:Hit (Property)}}
{{:Icon (Property)}}
{{:Origin (Property)}}
{{:Target (Property)}}
{{:TargetFilter (Property)/mouse}}
{{:TargetSurface (Property)}}
{{:UnitRay (Property)}}
{{:ViewSizeX (Property)}}
{{:ViewSizeY (Property)}}
{{:X (Property)}}
{{:Y (Property)}}
</div>
<div class="tabbertab" title="Events">
{{:AncestryChanged (Event)}}
{{:Changed (Event)/property}}
{{:ChildAdded (Event)}}
{{:ChildRemoved (Event)}}
{{:DescendantAdded (Event)}}
{{:DescendantRemoving (Event)}}
{{:Button1Down (Event)}}
{{:Button1Up (Event)}}
{{:Button2Down (Event)}}
{{:Button2Up (Event)}}
{{:Idle (Event)}}
{{:KeyDown (Event)}}
{{:KeyUp (Event)}}
{{:Move (Event)}}
{{:WheelBackward (Event)}}
{{:WheelForward (Event)}}
</div>
</div>
 
[[Category:ROBLOX Lua Objects]]
Anonymous user

Navigation menu