ModalEnabled

Deprecated

This item is deprecated. Do not use it for new work.

Value Type: bool

Description:

ModalEnabled property determines whether character controls are hidden on UserInputService/TouchEnabled|TouchEnabled devices. By default, this property is false and controls are visible.

ModalEnabled = false

ModalEnabled = true

This property will only work when used in a LocalScript running for the player whose character controls are to be hidden.

Even if mobile controls are hidden for a player on a mobile device, other UserInputService events such as UserInputService/InputBegan and UserInputService/TouchSwipe can still be used to process other forms of user input on mobile devices with an enabled touch screen (see the main UserInputService class page for a full list).

Code Samples

UserInputService.ModalEnabled

This example toggles between hiding and showing the user’s Roblox mobile controls every 5 seconds.

			
				UserInputService.ModalEnabled

				Expected Output
			
				Expand
				
			local UserInputService = game:GetService("UserInputService")

while true do
	UserInputService.ModalEnabled = not UserInputService.ModalEnabled
	wait(5)
end
		
				Copy Code
			
				Light Theme