ClientPrefs
| Kind | class |
| Package | backend |
| Full name | backend.ClientPrefs |
| Source | source/backend/ClientPrefs.hx |
Public fields
| Name | Type | Static | Default | Notes |
|---|---|---|---|---|
controllerMode | Bool | yes | false | Gameplay Settings |
downScroll | Bool | yes | false | — |
middleScroll | Bool | yes | false | — |
opponentStrums | Bool | yes | true | — |
ghostTapping | Bool | yes | true | — |
autoPause | Bool | yes | true | — |
complexAccuracy | Bool | yes | false | — |
noMarvJudge | Bool | yes | false | — |
noReset | Bool | yes | false | — |
antiCheatEnable | Bool | yes | false | — |
ezSpam | Bool | yes | false | — |
spaceVPose | Bool | yes | true | — |
ghostTapAnim | Bool | yes | true | — |
hitsoundVolume | Float | yes | 0 | — |
hitsoundType | String | yes | 'osu!mania' | — |
voiidTrollMode | Bool | yes | false | — |
trollMaxSpeed | String | yes | 'Medium' | — |
missSoundEnabled | Bool | yes | false | — |
crossFadeLimit | Null<Int> | yes | 4 | — |
boyfriendCrossFadeLimit | Null<Int> | yes | 1 | — |
crossFadeMode | String | yes | 'Mid-Fight Masses' | — |
noteSkin | String | yes | 'Default' | Visuals & UI |
splashType | String | yes | 'Default' | — |
noteSplashes | Bool | yes | true | — |
oppNoteSplashes | Bool | yes | true | — |
showNPS | Bool | yes | true | — |
showComboInfo | Bool | yes | true | — |
maxSplashLimit | Int | yes | 16 | — |
oppNoteAlpha | Float | yes | 0.65 | — |
hideHud | Bool | yes | false | — |
tauntOnGo | Bool | yes | true | — |
oldSusStyle | Bool | yes | false | — |
showRendered | Bool | yes | false | — |
botWatermark | Bool | yes | true | — |
missRating | Bool | yes | false | — |
noteColorStyle | String | yes | 'Normal' | — |
enableColorShader | Bool | yes | true | — |
rateNameStuff | String | yes | 'Quotes' | — |
timeBarType | String | yes | 'Time Left' | — |
scoreStyle | String | yes | 'Psych Engine' | — |
timeBarStyle | String | yes | 'Vanilla' | — |
healthBarStyle | String | yes | 'Vanilla' | — |
watermarkStyle | String | yes | 'Vanilla' | — |
botTxtStyle | String | yes | 'Vanilla' | — |
strumLitStyle | String | yes | 'Full Anim' | — |
bfIconStyle | String | yes | 'Default' | — |
ratingType | String | yes | 'Default' | — |
simplePopups | Bool | yes | false | — |
iconBounceType | String | yes | 'New Psych' | — |
smoothHealth | Bool | yes | true | — |
smoothHPBug | Bool | yes | false | — |
flashing | Bool | yes | true | — |
camZooms | Bool | yes | true | — |
showNotes | Bool | yes | true | — |
scoreZoom | Bool | yes | true | — |
healthBarAlpha | Float | yes | 1 | — |
showFPS | Bool | yes | true | — |
botTxtFade | Bool | yes | true | — |
pauseMusic | String | yes | 'Tea Time' | — |
daMenuMusic | String | yes | 'Default' | — |
checkForUpdates | Bool | yes | true | — |
comboStacking | — | yes | true | — |
showRamUsage | Bool | yes | true | — |
showMaxRamUsage | Bool | yes | true | — |
debugInfo | Bool | yes | false | — |
frameProfiler | Bool | yes | false | — |
tipTexts | Bool | yes | true | — |
discordRPC | Bool | yes | true | — |
peOGCrash | Bool | yes | false | — |
respectCutout | Bool | yes | true | Mobile Settings |
mobileCAlpha | Float | yes | #if mobile 0.6 #else 0 #end | — |
mobileCEx | Bool | yes | false | — |
mobileCPlayStateVpad | Bool | yes | false | — |
mobileCExTaunt | Bool | yes | true | — |
screensaver | Bool | yes | false | — |
hitboxType | String | yes | "Gradient" | — |
hitboxPos | Bool | yes | true | — |
widescreen | Bool | yes | false | Graphics Opt in to expanding the viewport; existing 16:9 presentation is the default. |
lowQuality | Bool | yes | false | — |
globalAntialiasing | Bool | yes | true | — |
shaders | Bool | yes | true | — |
cacheOnGPU | Bool | yes | false | — |
dynamicSpawnTime | Bool | yes | false | — |
noteSpawnTime | Float | yes | 1 | — |
resolution | String | yes | '1280x720' | — |
framerate | Int | yes | 60 | — |
charsAndBG | Bool | yes | true | Optimization |
enableGC | Bool | yes | true | — |
opponentLightStrum | Bool | yes | true | — |
botLightStrum | Bool | yes | true | — |
playerLightStrum | Bool | yes | true | — |
ratingPopups | Bool | yes | true | — |
comboPopups | Bool | yes | true | — |
showMS | Bool | yes | false | — |
noSpawnFunc | Bool | yes | false | — |
noHitFuncs | Bool | yes | false | — |
noSkipFuncs | Bool | yes | false | — |
lessBotLag | Bool | yes | false | — |
maxNotes | Int | yes | 0 | — |
noGunsRNG | Bool | yes | false | Secret Debug |
rainbowFPS | Bool | yes | false | — |
noRenderGC | Bool | yes | false | — |
cursing | Bool | yes | true | Unused |
violence | Bool | yes | true | — |
noPausing | Bool | yes | false | — |
arrowRGB | Array<Array<FlxColor>> | yes | [ | Note Colors |
arrowRGBPixel | Array<Array<FlxColor>> | yes | [ | Pixel |
quantRGB | Array<Array<FlxColor>> | yes | [ | Quants |
ffmpegMode | Bool | yes | false | Game Renderer |
targetFPS | Float | yes | 60 | — |
unlockFPS | Bool | yes | false | — |
renderBitrate | Float | yes | 5.0 | — |
vidEncoder | String | yes | 'libx264' | — |
oldFFmpegMode | Bool | yes | false | — |
lossless | Bool | yes | false | — |
quality | Int | yes | 50 | — |
renderGCRate | Float | yes | 5.0 | — |
showRemainingTime | Bool | yes | false | — |
renderPath | String | yes | 'assets/gameRenders/' | — |
JSEngineRecharts | Bool | yes | false | Misc |
alwaysTriggerCutscene | Bool | yes | false | — |
disableSplash | Bool | yes | false | — |
disableAprilFools | Bool | yes | false | — |
rainbowTime | Float | yes | 5.0 | — |
autosaveCharts | Bool | yes | true | — |
autosaveTime | Int | yes | 240 | — |
deeplinkEnabled | Bool | yes | false | Whether this copy claimed the phoenix:// scheme (Windows: Options -> Misc). |
gameplaySettings | Map<String, Dynamic> | yes | [ | Gameplay Modifiers |
ratingOffset | Int | yes | 0 | Gameplay Offset and Window stuff |
perfectWindow | Float | yes | 15.0 | — |
sickWindow | Float | yes | 45.0 | — |
goodWindow | Float | yes | 90.0 | — |
badWindow | Float | yes | 135.0 | — |
safeFrames | Float | yes | 10.0 | — |
comboOffset | Array<Int> | yes | [0, 0, 0, 0] | — |
noteOffset | Int | yes | 0 | — |
keyBinds | Map<String, Array<FlxKey>> | yes | [ | Every key has two binds, add your key bind down here and then add your control on options/ControlsSubState.hx and Controls.hx |
defaultKeys | Map<String, Array<FlxKey>> | yes | null | — |
defaultArrowRGB | Array<Array<FlxColor>> | yes | — | — |
defaultPixelRGB | Array<Array<FlxColor>> | yes | — | — |
defaultQuantRGB | Array<Array<FlxColor>> | yes | — | — |
Public methods
loadDefaultStuff
static function loadDefaultStuff()
saveSettings
static function saveSettings()
loadPrefs
static function loadPrefs()
Only compiled when #if ACHIEVEMENTS_ALLOWED Achievements.save(); #end.
applyCutoutPreference
static function applyCutoutPreference():Void
Only compiled when #if ACHIEVEMENTS_ALLOWED Achievements.save(); #end + #if ACHIEVEMENTS_ALLOWED Achievements.load(); #end + #if DISCORD_ALLOWED DiscordClient.check(); #end.
Apply immediately; Android owns window layout and inset recomputation.
applyWidescreenPreference
static function applyWidescreenPreference():Void
Only compiled when #if ACHIEVEMENTS_ALLOWED Achievements.save(); #end + #if ACHIEVEMENTS_ALLOWED Achievements.load(); #end + #if DISCORD_ALLOWED DiscordClient.check(); #end.
Re-measure the live window after loading or changing the widescreen option.
getGameplaySetting
static inline function getGameplaySetting(name:String, defaultValue:Dynamic):Dynamic
Only compiled when #if ACHIEVEMENTS_ALLOWED Achievements.save(); #end + #if ACHIEVEMENTS_ALLOWED Achievements.load(); #end + #if DISCORD_ALLOWED DiscordClient.check(); #end.
| Parameter | Type | Default |
|---|---|---|
name | String | — |
defaultValue | Dynamic | — |
reloadControls
static function reloadControls()
Only compiled when #if ACHIEVEMENTS_ALLOWED Achievements.save(); #end + #if ACHIEVEMENTS_ALLOWED Achievements.load(); #end + #if DISCORD_ALLOWED DiscordClient.check(); #end.
copyKey
static function copyKey(arrayToCopy:Array<FlxKey>):Array<FlxKey>
Only compiled when #if ACHIEVEMENTS_ALLOWED Achievements.save(); #end + #if ACHIEVEMENTS_ALLOWED Achievements.load(); #end + #if DISCORD_ALLOWED DiscordClient.check(); #end.
| Parameter | Type | Default |
|---|---|---|
arrayToCopy | Array<FlxKey> | — |
Internals
Private / internal members
| Field | Type | Static |
|---|---|---|
importantMap | Map<String, Array<String>> | yes |