Codename LogoCodename Logo

funkin.backend.system.Flags

APIWikiTools

A class that reads the flags.ini file, allowing to read settable Flags (customs too).

Static variables

View on GitHub

staticBLACKLISTED_LANGUAGES:Array<String> = []

NOTICE: This will only contain the id of the language, not the full name. If you blacklist the default language, you will need to change DEFAULT_LANGUAGE and DEFAULT_LANGUAGE_NAME.

View on GitHub

staticCOMMIT_HASH:String = GitCommitMacro.commitHash

View on GitHub

staticCOMMIT_MESSAGE:String = "Commit $COMMIT_NUMBER ($COMMIT_HASH)"

View on GitHub

staticCOMMIT_NUMBER:Int = GitCommitMacro.commitNumber

View on GitHub

staticDEFAULT_BPM:Float = 100.0

View on GitHub

@:also(funkin.game.Character.FALLBACK_CHARACTER)staticDEFAULT_CHARACTER:String = "bf"

View on GitHub

staticDEFAULT_CHARACTER_GHOSTDISABLE_SOUND:String = "editors/character/ghostDisable"

View on GitHub

staticDEFAULT_CHARACTER_GHOSTENABLE_SOUND:String = "editors/character/ghostEnable"

View on GitHub

staticDEFAULT_CHARTER_HITSOUND_SOUND:String = "editors/charter/hitsound"

View on GitHub

staticDEFAULT_CHARTER_METRONOME_SOUND:String = "editors/charter/metronome"

View on GitHub

staticDEFAULT_CHARTER_NOTEDELETE_SOUND:String = "editors/charter/noteDelete"

View on GitHub

staticDEFAULT_CHARTER_NOTEPLACE_SOUND:String = "editors/charter/notePlace"

View on GitHub

staticDEFAULT_CHARTER_SCROLL_SOUND:String = "editors/charter/scroll"

View on GitHub

staticDEFAULT_CHARTER_SNAPPINGCHANGE_SOUND:String = "editors/charter/snappingChange"

View on GitHub

staticDEFAULT_CHARTER_STRUMLOCK_SOUND:String = "editors/charter/strumLock"

View on GitHub

staticDEFAULT_CHARTER_STRUMUNLOCK_SOUND:String = "editors/charter/strumUnlock"

View on GitHub

staticDEFAULT_CHARTER_SUSTAINADD_SOUND:String = "editors/charter/sustainAdd"

View on GitHub

staticDEFAULT_CHARTER_SUSTAINDELETE_SOUND:String = "editors/charter/sustainDelete"

View on GitHub

staticDEFAULT_COLOR:FlxColor = 0xFF9271FD

Default background colors for songs or more without bg color

View on GitHub

@:also(funkin.game.PlayState.coopMode)staticDEFAULT_COOP_MODE:Bool = false

View on GitHub

staticDEFAULT_CUTSCENE_PAUSE_ITEMS:Array<String> = ["Resume Cutscene", "Skip Cutscene", "Restart Cutscene", "Exit to menu"]

View on GitHub

@:also(funkin.game.PlayState.difficulty)staticDEFAULT_DIFFICULTY:String = "normal"

View on GitHub

staticDEFAULT_DISCORD_CLIENT_ID:String = "1383853614589673472"

View on GitHub

staticDEFAULT_DISCORD_LOGO_TEXT:String = "Codename Engine"

View on GitHub

staticDEFAULT_EDITOR_AUTOSAVE_SOUND:String = "editors/autosave"

View on GitHub

staticDEFAULT_EDITOR_BUTTONCLICK_SOUND:String = "editors/buttonClick"

View on GitHub

staticDEFAULT_EDITOR_CHECKBOXCHECKED_SOUND:String = "editors/checkboxChecked"

View on GitHub

staticDEFAULT_EDITOR_CHECKBOXUNCHECKED_SOUND:String = "editors/checkboxUnchecked"

View on GitHub

staticDEFAULT_EDITOR_CLICK_SOUND:String = "editors/click"

View on GitHub

staticDEFAULT_EDITOR_COPY_SOUND:String = "editors/copy"

View on GitHub

staticDEFAULT_EDITOR_CUT_SOUND:String = "editors/cut"

View on GitHub

staticDEFAULT_EDITOR_DELETE_SOUND:String = "editors/delete"

View on GitHub

staticDEFAULT_EDITOR_DROPDOWNAPPEAR_SOUND:String = "editors/dropdownAppear"

View on GitHub

staticDEFAULT_EDITOR_OFFSETDRAG_SOUND:String = "editors/offsetDrag"

View on GitHub

staticDEFAULT_EDITOR_PASTE_SOUND:String = "editors/paste"

View on GitHub

staticDEFAULT_EDITOR_REDO_SOUND:String = "editors/redo"

View on GitHub

staticDEFAULT_EDITOR_SAVE_SOUND:String = "editors/save"

View on GitHub

staticDEFAULT_EDITOR_TEXTREMOVE_SOUND:String = "editors/textRemove"

View on GitHub

staticDEFAULT_EDITOR_TEXTTYPE_SOUND:String = "editors/textType"

View on GitHub

staticDEFAULT_EDITOR_UNDO_SOUND:String = "editors/undo"

View on GitHub

staticDEFAULT_EDITOR_WARNING_SOUND:String = "editors/warningMenu"

View on GitHub

staticDEFAULT_EDITOR_WINDOWAPPEAR_SOUND:String = "editors/windowAppear"

View on GitHub

staticDEFAULT_EDITOR_WINDOWCLOSE_SOUND:String = "editors/windowClose"

View on GitHub

staticDEFAULT_GAMEOVEREND_SOUND:String = "gameOverEnd"

View on GitHub

staticDEFAULT_GAMEOVERSFX_SOUND:String = "gameOverSFX"

View on GitHub

@:also(funkin.game.Character.FALLBACK_DEAD_CHARACTER)staticDEFAULT_GAMEOVER_CHARACTER:String = "bf-dead"

View on GitHub

staticDEFAULT_GAMEOVER_MUSIC:String = "gameOver"

View on GitHub

@:also(funkin.game.GameOverSubstate.script)staticDEFAULT_GAMEOVER_SCRIPT:String = ""

View on GitHub

staticDEFAULT_HEALTH:Null<Null<Float>> = null

View on GitHub

staticDEFAULT_INTRO_SOUNDS:Array<String> = ["intro3", "intro2", "intro1", "introGo"]

View on GitHub

staticDEFAULT_INTRO_SPRITES:Array<String> = [null, "game/ready", "game/set", "game/go"]

View on GitHub

staticDEFAULT_LANGUAGE_NAME:String = "English"

View on GitHub

staticDEFAULT_MENU_CANCEL_SOUND:String = "menu/cancel"

View on GitHub

staticDEFAULT_MENU_CONFIRM_SOUND:String = "menu/confirm"

View on GitHub

staticDEFAULT_MENU_MUSIC:String = "freakyMenu"

Default audio paths

View on GitHub

staticDEFAULT_MENU_SCROLL_SOUND:String = "menu/scroll"

View on GitHub

staticDEFAULT_MENU_VOLUME_SOUND:String = "menu/volume"

View on GitHub

staticDEFAULT_MISS_SOUNDS:Array<String> = ["missnote1", "missnote2", "missnote3"]

View on GitHub

staticDEFAULT_OPPONENT:String = "dad"

View on GitHub

@:also(funkin.game.PlayState.opponentMode)staticDEFAULT_OPPONENT_MODE:Bool = false

View on GitHub

staticDEFAULT_PAUSE_ITEMS:Array<String> = ["Resume", "Restart Song", "Change Controls", "Change Options", "Exit to menu", "Exit to charter"]

View on GitHub

staticDEFAULT_PAUSE_MENU_MUSIC:String = "breakfast"

View on GitHub

@:also(funkin.menus.PauseSubState.script)staticDEFAULT_PAUSE_SCRIPT:String = ""

View on GitHub

staticDEFAULT_STAGE:String = "stage"

View on GitHub

@:also(funkin.backend.MusicBeatTransition.script)staticDEFAULT_TRANSITION_SCRIPT:String = ""

View on GitHub

staticDEFAULT_WEEK_COLOR:FlxColor = 0xFFF9CF51

View on GitHub

staticICON_LERP:Float = 0.33

View on GitHub

staticIMAGE_EXT:String = "png"

View on GitHub

staticMAIN_DEVS_COLOR:FlxColor = 0xFF9C35D5

View on GitHub

staticMIN_CONTRIBUTIONS_COLOR:FlxColor = 0xFFB4A7DA

View on GitHub

staticMOD_AUTHOR:String = ""

View on GitHub

staticMOD_DEPENDENCIES:Array<String> = []

View on GitHub

staticMOD_ICON:String = ""

View on GitHub

staticMOD_NAME:String = ""

View on GitHub

staticMOD_REDIRECT_STATES:Map<String, String> = []

View on GitHub

@:also(funkin.game.PlayState.daPixelZoom)staticPIXEL_ART_SCALE:Float = 6.0

View on GitHub

staticREPO_NAME:String = "CodenameEngine"

View on GitHub

staticREPO_OWNER:String = "CodenameCrew"

View on GitHub

staticREPO_URL:String = "https://github.com/$REPO_OWNER/$REPO_NAME"

@:lazystaticSAVE_NAME:String

@:lazystaticSAVE_PATH:String

View on GitHub

staticSONGS_LIST_MOD_MODE:String = "override"

View on GitHub

staticSOUND_EXT:String = "ogg"

Preferred sound extension for the game's audio files. Currently is set to mp3 for web targets, and ogg for other targets.

View on GitHub

staticSTUNNED_TIME:Float = 5 / 60

View on GitHub

staticSUPPORTED_CHART_FORMATS:Array<String> = ["BaseGame"]

View on GitHub

staticSUPPORTED_CHART_RUNTIME_FORMATS:Array<String> = ["Legacy", "Psych Engine"]

@:lazystaticTITLE:String

View on GitHub

staticUNDO_PREFIX:String = "* "

View on GitHub

staticURL_EDITOR_FALLBACK:String = "https://www.youtube.com/watch?v=9Youam7GYdQ"

View on GitHub

staticURL_FNF_ITCH:String = "https://ninja-muffin24.itch.io/funkin"

View on GitHub

staticURL_WIKI:String = "https://codename-engine.com/"

View on GitHub

@:also(funkin.backend.utils.HttpUtil.userAgent)staticUSER_AGENT:String = "request"

@:lazystaticVERSION:String

@:lazystaticVERSION_MESSAGE:String

View on GitHub

staticVIDEO_EXT:String = "mp4"

View on GitHub

staticWEEKS_LIST_MOD_MODE:String = "override"

View on GitHub

staticWHITELISTED_LANGUAGES:Array<String> = []

NOTICE: This will only contain the id of the language, not the full name. If this list is not empty, the languages listed will be the only ones able to be used.

View on GitHub

@:bypassstaticaddonFlags:Map<String, Dynamic> = []

View on GitHub

@:bypassstaticcustomFlags:Map<String, String> = []

Flags that Codename couldn't recognize as it's own defaults (they can only be string! due to them being unparsed).

Static methods

View on GitHub

staticload(?libs:Array<LimeAssetLibrary>):Void

Loads the flags from the assets.

View on GitHub

staticloadFromData(flags:Map<String, String>, data:String):Void

View on GitHub

staticloadFromDatas(datas:Array<String>):Map<String, String>

View on GitHub

staticparse(name:String, value:String):Bool

View on GitHub

staticparseFlags(flags:Map<String, String>):Void