Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GameSettings

A container for miscellaneous in-game options.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a settings container. It contains settings that affect the behavior of the peer.
This class is not browsable. It is not visible in Studio's object browser.
Memory categoryInstances
Tags: [NotCreatable, Settings, NotReplicated, NotBrowsable]

Member index 3

HistoryMember
653VideoCaptureEnabled: bool
653VideoRecording: bool
462VideoRecordingChangeRequest(recording: bool)
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
680UniqueId: UniqueId
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
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 15

HistoryMember
526AdditionalCoreIncludeDirs: string
448BubbleChatLifetime: float
448BubbleChatMaxBubbles: int
450ChatHistory: int
448ChatScrollLength: int
448CollisionSoundEnabled: bool
448CollisionSoundVolume: float
448HardwareMouse: bool
135ImageUploadPromptBehavior: UploadSetting
448MaxCollisionSounds: int
526OverrideStarterScript: string
450ReportAbuseChatHistory: int
448SoftwareSound: bool
306SoundEnabled: bool
450VideoQuality: VideoQualitySettings

Description

Various miscellaneous in-game options.

History 55

Members 3

VideoCaptureEnabled

TypeDefault
bool

Toggles whether or not video capture is enabled.

Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 5

VideoRecording

TypeDefault
bool
This property is not replicated. Its interface does not cross the network boundary.
Read securityRobloxScriptSecurity
Write securityRobloxSecurity
Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue/false

History 5

Tags: [NotReplicated]

VideoRecordingChangeRequest

Parameters (1)
recordingbool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

Removed members 15

AdditionalCoreIncludeDirs

TypeDefault
string
Write securityRobloxScriptSecurity
Thread safetyReadSafe
CategoryDirectories
Loaded/Savedtrue

History 5

BubbleChatLifetime

TypeDefault
float
CategoryOnline
Loaded/Savedtrue

History 2

BubbleChatMaxBubbles

TypeDefault
int
CategoryOnline
Loaded/Savedtrue

History 2

ChatHistory

TypeDefault
int
CategoryOnline
Loaded/Savedtrue

History 2

ChatScrollLength

TypeDefault
int
CategoryOnline
Loaded/Savedtrue

History 2

CollisionSoundEnabled

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
CategorySound
Loaded/Savedtrue/false

History 3

Tags: [NotReplicated, Deprecated]

CollisionSoundVolume

TypeDefault
float
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
CategorySound
Loaded/Savedtrue/false

History 3

Tags: [NotReplicated, Deprecated]

HardwareMouse

TypeDefault
bool
CategoryInput
Loaded/Savedtrue

History 2

ImageUploadPromptBehavior

TypeDefault
UploadSetting
Category
Loaded/Savedfalse

History 2

MaxCollisionSounds

TypeDefault
int
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
CategorySound
Loaded/Savedtrue/false

History 3

Tags: [NotReplicated, Deprecated]

OverrideStarterScript

TypeDefault
string
Write securityRobloxScriptSecurity
Thread safetyReadSafe
CategoryScript
Loaded/Savedtrue

History 5

ReportAbuseChatHistory

TypeDefault
int
CategoryOnline
Loaded/Savedtrue

History 2

SoftwareSound

TypeDefault
bool
CategorySound
Loaded/Savedtrue

History 2

SoundEnabled

TypeDefault
bool
Category
Loaded/Savedfalse

History 2

VideoQuality

TypeDefault
VideoQualitySettings
CategoryVideo
Loaded/Savedtrue

History 2

Settings