funkin.Preferences

A core class which provides a store of user-configurable, globally relevant values.

Static variables

`staticautoFullscreen:Bool`

If enabled, the game will automatically launch in fullscreen on startup.

`staticautoPause:Bool`

If enabled, the game will automatically pause when tabbing out. Always enabled on mobile.

`staticdebugDisplay:DebugDisplayMode`

If enabled, an FPS and memory counter will be displayed even if this is not a debug build. Always disabled on release mobile builds.

`staticdebugDisplayBGOpacity:Int`

Opacity of the debug display's background.

`staticdownscroll:Bool`

If enabled, the strumline is at the bottom of the screen rather than the top.

`staticfancyPreview:Bool`

If enabled, the game will show a preview after taking a screenshot.

`staticflashingLights:Bool`

If disabled, flashing lights in the main menu and other areas will be less intense.

`staticframerate:Int`

FPS Always the refresh rate of the display on mobile, or 60 on web.

`staticglobalOffset:Int`

A global audio offset in milliseconds. This is used to sync the audio.

`statichapticsIntensityMultiplier:Float`

Multiplier of intensity for all the haptic feedback effects.

`statichapticsMode:HapticsMode`

If enabled, haptic feedback will be enabled.

`staticnaughtyness:Bool`

Whether some particularly foul language is displayed.

`staticpreviewOnSave:Bool`

If enabled, the game will show the preview only after a screenshot is saved.

`staticshouldHideMouse:Bool`

If enabled, the game will hide the mouse when taking a screenshot.

`staticstrumlineBackgroundOpacity:Int`

If >0, the game will display a semi-opaque background under the notes. 0 for no background, 100 for solid black if you're freaky like that

`staticsubtitles:Bool`

If enabled, subtitles will appear during some songs and cutscenes.

`staticunlockedFramerate:Bool`

`staticvsyncMode:WindowVSyncMode`

If enabled, the game will utilize VSync (or adaptive VSync) on startup.

`staticzoomCamera:Bool`

If disabled, the camera bump synchronized to the beat.

Static methods

`staticinit():Void`

Loads the user's preferences from the save data and apply them.

class Preferences

package funkin