Type Index Pages
- BillboardGui
- CanvasGroup
- Frame
- Hint
- ImageButton
- ImageLabel
- PlayerGui
- ScreenGui
- ScrollingFrame
- StarterGui
- SurfaceGui
- TextBox
- TextButton
- TextLabel
- UIAspectRatioConstraint
- UIGradient
- UIGridLayout
- UIListLayout
- UIPadding
- UIPageLayout
- UIScale
- UISizeConstraint
- UITableLayout
- UITextSizeConstraint
- VideoFrame
- ViewportFrame
- ChangeHistoryService
- CoreGui
- DataModelSession
- DockWidgetPluginGui
- MultipleDocumentInterfaceInstance
- Plugin
- PluginAction
- PluginGui
- PluginGuiService
- PluginManager
- PluginMenu
- PluginMouse
- PluginToolbar
- PluginToolbarButton
- QWidgetPluginGui
- Selection
- StandalonePluginScripts
- StatsItem
- StudioService
- StudioTheme
No results found!
-
Instance
- GameSettings
- DebugSettings
- BodyMover
- WeldConstraint
- HttpRbxApiService
- NotificationService
- Translator
- Lighting
- Beam
- GuiService
- UserInputService
- Studio
- Plugin
- HttpService
- Mouse
- BindableEvent
- RunService
- Pages
- Humanoid
- TestService
- PathfindingService
- Chat
- NetworkPeer
- Feature
- CharacterAppearance
- Constraint
- NetworkReplicator
- JointInstance
- Light
- BasePlayerGui
- AnalyticsService
- NetworkMarker
- BinaryStringValue
- FlyweightService
- Geometry
- LoginService
- InstancePacketCache
- ThirdPartyUserService
- TouchInputService
- RuntimeScriptService
- GuidRegistryService
- PartOperationAsset
- DialogChoice
- PhysicsService
- AdService
- TextService
- MarketplaceService
- TeleportService
- Accoutrement
- GamePassService
- AssetService
- InsertService
- PointsService
- ChangeHistoryService
- ServerScriptService
- JointsService
- LogService
- InputObject
- Toolbar
- LuaSettings
- RenderSettings
- AnimationTrack
- PhysicsSettings
- NetworkSettings
- CFrameValue
- Animation
- Color3Value
- BoolValue
- BrickColorValue
- Vector3Value
- AnimationController
- BindableFunction
- Button
- Trail
- LocalizationTable
- LocalizationService
- DebuggerBreakpoint
- DebuggerWatch
- ScriptDebugger
- Animator
- Attachment
- RemoteFunction
- RemoteEvent
- PluginManager
- Camera
- Stats
- Sky
- StarterPlayer
- Dragger
- TerrainRegion
- Path
- TextFilterResult
- Dialog
- StatsItem
- GoogleAnalyticsConfiguration
- ScriptContext
- ControllerService
- CacheableContentProvider
- ReflectionMetadataClasses
- ReflectionMetadataEnums
- DebuggerManager
- GuiBase
- UIBase
- LuaSourceContainer
- GuiItem
- DataModelMesh
- ServiceProvider
- ReflectionMetadataItem
- PostEffect
- PhysicsPacketCache
- TouchTransmitter
- RobloxReplicatedStorage
- Visit
- LuaWebService
- ScriptService
- FlagStandService
- VirtualUser
- SpawnerService
- TimerService
- CookiesService
- Team
- GroupService
- StarterGear
- Message
- PlayerScripts
- Configuration
- ContentProvider
- CollectionService
- Debris
- ReplicatedFirst
- ServerStorage
- ReplicatedStorage
- Folder
- TweenService
- Players
- ContextActionService
- StarterPlayerScripts
- SoundService
- KeyframeSequenceProvider
- VRService
- PluginGuiService
- Player
- Teams
- Pose
- Keyframe
- KeyframeSequence
- IntConstrainedValue
- DoubleConstrainedValue
- ForceField
- RayValue
- Fire
- Smoke
- Sparkles
- ParticleEmitter
- IntValue
- StringValue
- NumberValue
- Explosion
- ObjectValue
- SoundGroup
- UserGameSettings
- ClickDetector
- Sound
- Selection
- BadgeService
- TaskScheduler
- GlobalDataStore
- DataStoreService
- CustomEvent
- CustomEventReceiver
- VirtualInputManager
- FunctionalTest
- TweenBase
- SoundEffect
- ReflectionMetadataEvents
- ClusterPacketCache
- PVInstance
- FaceInstance
- Controller
- ReflectionMetadataCallbacks
- ReflectionMetadataFunctions
- ReflectionMetadataYieldFunctions
- ReflectionMetadataProperties
- ReflectionMetadata
- AdvancedDragger
- HapticService
- FriendService
- GamepadService
No Result Found !!!
Icon
Icon is a property that determines the image used as the pointer. If blank, a default arrow is used. While the cursor hovers over a GuiButton, this property is temporarily ignored.
To hide the cursor entirely, do not use a transparent image – instead, set UserInputService/MouseIconEnabled to false. For more information on how to change the mouse’s icon, please see Articles/Mouse Icon Appearance|this tutorial.
Designing a Cursor
The following guidelines may prove useful when creating your own mouse cursors:
- The dimensions of the image used determines the size of the cursor.
- The center of the image is where mouse inputs are issued.
- The default mouse image is 64x64 pixels, with the mouse taking up 17x24 pixels of space.
System Cursors for PluginMouse
When using a PluginMouse retrieved from Plugin/GetMouse, you can use the following icons similar to your system’s default cursors, such as hands, arrows, I-beams, etc. You can use these with GUI events like GuiObject/MouseEnter|MouseEnter, GuiObject/MouseLeave|MouseLeave, and GuiButton/MouseButton1Down|MouseButton1Down to provide a consistent studio experience when interacting with certain kinds of GUI components. Note that these only work for studio plugins; they will not work for other Mouse objects.
| Look* | Asset | Suggested Use |
|---|---|---|
rbxasset://SystemCursors/Arrow |
Default clicking and selection. | |
rbxasset://SystemCursors/PointingHand |
Hovering over an active link/button. | |
rbxasset://SystemCursors/OpenHand |
Hovering over a draggable item. | |
rbxasset://SystemCursors/ClosedHand |
Dragging an item. | |
rbxasset://SystemCursors/IBeam |
Hovering in a text field. | |
rbxasset://SystemCursors/SizeNS |
Hovering over a vertical resize handle. | |
rbxasset://SystemCursors/SizeEW |
Hovering over a horizontal resize handle. | |
rbxasset://SystemCursors/SizeNESW |
Hovering over a corner resize handle. | |
rbxasset://SystemCursors/SizeNWSE |
Hovering over a corner resize handle. | |
rbxasset://SystemCursors/SizeAll |
Hovering over a multi-direction resize handle. | |
rbxasset://SystemCursors/SplitNS |
Hovering over a vertical "split" handle. | |
rbxasset://SystemCursors/SplitEW |
Hovering over a horizontal "split" handle. | |
rbxasset://SystemCursors/Forbidden |
Hovering over a locked/forbidden item. | |
rbxasset://SystemCursors/Wait |
Indicating an action is in progress. | |
rbxasset://SystemCursors/Busy |
Indicating the system is busy. | |
rbxasset://SystemCursors/Cross |
Hovering over a pinpoint selection area. |
* These appearances are approximations – the actual look is dependent on your operating system.
Code Samples
Dragon Mouse Icon
This example changes the Players/LocalPlayer mouse icon to look like the dragon image shown below.
![]()
local mouse = game.Players.LocalPlayer:GetMouse() mouse.Icon = "http://www.roblox.com/asset?id=163023520"
How this site use cookies
This Platform uses cookies to offer you a better experience, to personalize content, to provide social media features and to analyse the traffic on our site. For further information, including information on how to prevent or manage the use of cookies on this Platform, please refer to our Privacy and Cookie Policy.