Fullscreen

RobloxScriptSecurity

This member can only be accessed by CoreScripts. Attempting to access this member outside of a CoreScript will cause an error.

Property of: UserGameSettings

Value Type: bool

Description:

Indicates whether or not this game should run in full-screen.
This property cannot be read by LocalScripts, you should use the UserGameSettings/InFullScreen function to detect it instead.

Code Samples

Full Screen Mode Detection

A LocalScript that demonstrates how you can detect whether a game is in full screen or not.

Expand

local GameSettings = UserSettings().GameSettings

local function checkFullScreenMode()
	local inFullscreen = GameSettings:InFullScreen()
	if inFullscreen then
		print("Full Screen mode enabled!")
	else
		print("Full Screen mode disabled!")
	end
end

checkFullScreenMode()
GameSettings.FullscreenChanged:Connect(checkFullScreenMode)

Copy Code Light Theme