Reference API Roblox

Engine API

Website

Related

Reference API Roblox

UserGameSettings

Summary

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

Member index 77

HistoryMember
553AllTutorialsDisabled: bool
553CameraMode: CustomCameraMode
553ChatVisible: bool
553ComputerCameraMovementMode: ComputerCameraMovementMode
553ComputerMovementMode: ComputerMovementMode
578ControlMode: ControlMode
553Fullscreen: bool
553GamepadCameraSensitivity: float
553GraphicsQualityLevel: int
553HasEverUsedVR: bool
553MasterVolume: float
619MasterVolumeStudio: float
553MouseSensitivity: float
553OnboardingsCompleted: string
553RCCProfilerRecordFrameRate: int
553RCCProfilerRecordTimeFrame: int
553RotationType: RotationType
553SavedQualityLevel: SavedQualitySetting
553StartMaximized: bool
553StartScreenPosition: Vector2
553StartScreenSize: Vector2
553TouchCameraMovementMode: TouchCameraMovementMode
553TouchMovementMode: TouchMovementMode
553UsedCoreGuiIsVisibleToggle: bool
553UsedCustomGuiIsVisibleToggle: bool
553UsedHideHudShortcut: bool
553VREnabled: bool
553VRRotationIntensity: int
553VRSmoothRotationEnabled: bool
553VignetteEnabled: bool
462GetCameraYInvertValue(): int
623GetDefaultFramerateCap(): int
462GetOnboardingCompleted(onboardingId: string): bool
462GetTutorialState(tutorialId: string): bool
462InFullScreen(): bool
462InStudioMode(): bool
573ResetOnboardingCompleted(onboardingId: string): null
573SetCameraYInvertVisible(): null
573SetGamepadCameraSensitivityVisible(): null
573SetOnboardingCompleted(onboardingId: string): null
573SetTutorialState(tutorialId: string, value: bool): null
462FullscreenChanged(isFullscreen: bool)
462PerformanceStatsVisibleChanged(isPerformanceStatsVisible: bool)
462StudioModeChanged(isStudioMode: bool)
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)

Removed member index 5

HistoryMember
304ImageUploadPromptBehavior: UploadSetting
304VideoUploadPromptBehavior: UploadSetting

History 263

Members 77

AllTutorialsDisabled

TypeDefault
bool

History 6

CameraMode

TypeDefault
CustomCameraMode

History 7

ChatVisible

TypeDefault
bool

History 4

ComputerCameraMovementMode

TypeDefault
ComputerCameraMovementMode

History 4

ComputerMovementMode

TypeDefault
ComputerMovementMode

History 4

ControlMode

TypeDefault
ControlMode

History 14

Fullscreen

TypeDefault
bool

History 6

FullscreenChanged

Parameters (1)
isFullscreenbool

History 2

GamepadCameraSensitivity

TypeDefault
float

History 6

GetCameraYInvertValue

Parameters (0)
No parameters.
Returns (1)
int

History 2

GetDefaultFramerateCap

Parameters (0)
No parameters.
Returns (1)
int

History 1

GetOnboardingCompleted

Parameters (1)
onboardingIdstring
Returns (1)
bool

History 2

GetTutorialState

Parameters (1)
tutorialIdstring
Returns (1)
bool

History 2

GraphicsQualityLevel

TypeDefault
int

History 4

HasEverUsedVR

TypeDefault
bool

History 4

InFullScreen

Parameters (0)
No parameters.
Returns (1)
bool

History 2

InStudioMode

Parameters (0)
No parameters.
Returns (1)
bool

History 2

MasterVolume

TypeDefault
float

History 8

MasterVolumeStudio

TypeDefault
float

History 1

MouseSensitivity

TypeDefault
float

History 4

OnboardingsCompleted

TypeDefault
string

History 4

PerformanceStatsVisibleChanged

Parameters (1)
isPerformanceStatsVisiblebool

History 2

RCCProfilerRecordFrameRate

TypeDefault
int

History 4

RCCProfilerRecordTimeFrame

TypeDefault
int

History 4

ResetOnboardingCompleted

Parameters (1)
onboardingIdstring
Returns (1)
null

History 3

RotationType

TypeDefault
RotationType

History 4

SavedQualityLevel

TypeDefault
SavedQualitySetting

History 8

SetCameraYInvertVisible

Parameters (0)
No parameters.
Returns (1)
null

History 3

SetGamepadCameraSensitivityVisible

Parameters (0)
No parameters.
Returns (1)
null

History 5

SetOnboardingCompleted

Parameters (1)
onboardingIdstring
Returns (1)
null

History 3

SetTutorialState

Parameters (2)
tutorialIdstring
valuebool
Returns (1)
null

History 3

StartMaximized

TypeDefault
bool
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated, NotScriptable]

StartScreenPosition

TypeDefault
Vector2
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated, NotScriptable]

StartScreenSize

TypeDefault
Vector2
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated, NotScriptable]

StudioModeChanged

Parameters (1)
isStudioModebool

History 2

TouchCameraMovementMode

TypeDefault
TouchCameraMovementMode

History 4

TouchMovementMode

TypeDefault
TouchMovementMode

History 4

UsedCoreGuiIsVisibleToggle

TypeDefault
bool

History 4

UsedCustomGuiIsVisibleToggle

TypeDefault
bool

History 4

UsedHideHudShortcut

TypeDefault
bool

History 4

VREnabled

TypeDefault
bool

History 4

VRRotationIntensity

TypeDefault
int

History 6

VRSmoothRotationEnabled

TypeDefault
bool

History 2

VignetteEnabled

TypeDefault
bool

History 4

Removed members 5

ImageUploadPromptBehavior

TypeDefault
UploadSetting

History 4

VideoUploadPromptBehavior

TypeDefault
UploadSetting

History 4

Settings