Skip to main content

ClientPrefs

Kindclass
Packagebackend
Full namebackend.ClientPrefs
Sourcesource/backend/ClientPrefs.hx

Public fields​

NameTypeStaticDefaultNotes
controllerModeBoolyesfalseGameplay Settings
downScrollBoolyesfalse—
middleScrollBoolyesfalse—
opponentStrumsBoolyestrue—
ghostTappingBoolyestrue—
autoPauseBoolyestrue—
complexAccuracyBoolyesfalse—
noMarvJudgeBoolyesfalse—
noResetBoolyesfalse—
antiCheatEnableBoolyesfalse—
ezSpamBoolyesfalse—
spaceVPoseBoolyestrue—
ghostTapAnimBoolyestrue—
hitsoundVolumeFloatyes0—
hitsoundTypeStringyes'osu!mania'—
voiidTrollModeBoolyesfalse—
trollMaxSpeedStringyes'Medium'—
missSoundEnabledBoolyesfalse—
crossFadeLimitNull<Int>yes4—
boyfriendCrossFadeLimitNull<Int>yes1—
crossFadeModeStringyes'Mid-Fight Masses'—
noteSkinStringyes'Default'Visuals & UI
splashTypeStringyes'Default'—
noteSplashesBoolyestrue—
oppNoteSplashesBoolyestrue—
showNPSBoolyestrue—
showComboInfoBoolyestrue—
maxSplashLimitIntyes16—
oppNoteAlphaFloatyes0.65—
hideHudBoolyesfalse—
tauntOnGoBoolyestrue—
oldSusStyleBoolyesfalse—
showRenderedBoolyesfalse—
botWatermarkBoolyestrue—
missRatingBoolyesfalse—
noteColorStyleStringyes'Normal'—
enableColorShaderBoolyestrue—
rateNameStuffStringyes'Quotes'—
timeBarTypeStringyes'Time Left'—
scoreStyleStringyes'Psych Engine'—
timeBarStyleStringyes'Vanilla'—
healthBarStyleStringyes'Vanilla'—
watermarkStyleStringyes'Vanilla'—
botTxtStyleStringyes'Vanilla'—
strumLitStyleStringyes'Full Anim'—
bfIconStyleStringyes'Default'—
ratingTypeStringyes'Default'—
simplePopupsBoolyesfalse—
iconBounceTypeStringyes'New Psych'—
smoothHealthBoolyestrue—
smoothHPBugBoolyesfalse—
flashingBoolyestrue—
camZoomsBoolyestrue—
showNotesBoolyestrue—
scoreZoomBoolyestrue—
healthBarAlphaFloatyes1—
showFPSBoolyestrue—
botTxtFadeBoolyestrue—
pauseMusicStringyes'Tea Time'—
daMenuMusicStringyes'Default'—
checkForUpdatesBoolyestrue—
comboStacking—yestrue—
showRamUsageBoolyestrue—
showMaxRamUsageBoolyestrue—
debugInfoBoolyesfalse—
frameProfilerBoolyesfalse—
tipTextsBoolyestrue—
discordRPCBoolyestrue—
peOGCrashBoolyesfalse—
respectCutoutBoolyestrueMobile Settings
mobileCAlphaFloatyes#if mobile 0.6 #else 0 #end—
mobileCExBoolyesfalse—
mobileCPlayStateVpadBoolyesfalse—
mobileCExTauntBoolyestrue—
screensaverBoolyesfalse—
hitboxTypeStringyes"Gradient"—
hitboxPosBoolyestrue—
widescreenBoolyesfalseGraphics Opt in to expanding the viewport; existing 16:9 presentation is the default.
lowQualityBoolyesfalse—
globalAntialiasingBoolyestrue—
shadersBoolyestrue—
cacheOnGPUBoolyesfalse—
dynamicSpawnTimeBoolyesfalse—
noteSpawnTimeFloatyes1—
resolutionStringyes'1280x720'—
framerateIntyes60—
charsAndBGBoolyestrueOptimization
enableGCBoolyestrue—
opponentLightStrumBoolyestrue—
botLightStrumBoolyestrue—
playerLightStrumBoolyestrue—
ratingPopupsBoolyestrue—
comboPopupsBoolyestrue—
showMSBoolyesfalse—
noSpawnFuncBoolyesfalse—
noHitFuncsBoolyesfalse—
noSkipFuncsBoolyesfalse—
lessBotLagBoolyesfalse—
maxNotesIntyes0—
noGunsRNGBoolyesfalseSecret Debug
rainbowFPSBoolyesfalse—
noRenderGCBoolyesfalse—
cursingBoolyestrueUnused
violenceBoolyestrue—
noPausingBoolyesfalse—
arrowRGBArray<Array<FlxColor>>yes[Note Colors
arrowRGBPixelArray<Array<FlxColor>>yes[Pixel
quantRGBArray<Array<FlxColor>>yes[Quants
ffmpegModeBoolyesfalseGame Renderer
targetFPSFloatyes60—
unlockFPSBoolyesfalse—
renderBitrateFloatyes5.0—
vidEncoderStringyes'libx264'—
oldFFmpegModeBoolyesfalse—
losslessBoolyesfalse—
qualityIntyes50—
renderGCRateFloatyes5.0—
showRemainingTimeBoolyesfalse—
renderPathStringyes'assets/gameRenders/'—
JSEngineRechartsBoolyesfalseMisc
alwaysTriggerCutsceneBoolyesfalse—
disableSplashBoolyesfalse—
disableAprilFoolsBoolyesfalse—
rainbowTimeFloatyes5.0—
autosaveChartsBoolyestrue—
autosaveTimeIntyes240—
deeplinkEnabledBoolyesfalseWhether this copy claimed the phoenix:// scheme (Windows: Options -> Misc).
gameplaySettingsMap<String, Dynamic>yes[Gameplay Modifiers
ratingOffsetIntyes0Gameplay Offset and Window stuff
perfectWindowFloatyes15.0—
sickWindowFloatyes45.0—
goodWindowFloatyes90.0—
badWindowFloatyes135.0—
safeFramesFloatyes10.0—
comboOffsetArray<Int>yes[0, 0, 0, 0]—
noteOffsetIntyes0—
keyBindsMap<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
defaultKeysMap<String, Array<FlxKey>>yesnull—
defaultArrowRGBArray<Array<FlxColor>>yes——
defaultPixelRGBArray<Array<FlxColor>>yes——
defaultQuantRGBArray<Array<FlxColor>>yes——

Public methods​

loadDefaultStuff​

static function loadDefaultStuff()

View source

saveSettings​

static function saveSettings()

View source

loadPrefs​

static function loadPrefs()

Only compiled when #if ACHIEVEMENTS_ALLOWED Achievements.save(); #end.

View source

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.

View source

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.

View source

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.

ParameterTypeDefault
nameString—
defaultValueDynamic—

View source

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.

View source

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.

ParameterTypeDefault
arrayToCopyArray<FlxKey>—

View source

Internals​

Private / internal members
FieldTypeStatic
importantMapMap<String, Array<String>>yes