Skip to content

PreferencesService

Inherits Instance

PreferencesService is a service that allows scripts to access some of the user preferences

Static Class

This object is a static class. It can be accessed by using its name as a keyword.

Additionally, it cannot be created in the creator menu or with Instance.New().

Not newable

This object cannot be created by scripts using Instance.New().

Properties

UsePhotoMode : boolean

Determines whether the player has photo mode enabled.

UsePostProcessing : boolean

Determines whether the player has post-processing effects enabled.

Events

SettingChanged

Parameters

settingName [ string ]

setTo [ any ]

Fired when a user preference setting is changed.