Skip to content

KeybindsOptions: Default categories accessible outside of the state, translation support for custom options #780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

KeybindsOptions: Default categories accessible outside of the state, translation support for custom options #780

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
231 changes: 120 additions & 111 deletions source/funkin/options/keybinds/KeybindsOptions.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ class KeybindsOptions extends MusicBeatSubstate {
public static var instance:KeybindsOptions;

public function translate(id:String, ?args:Array<Dynamic>)
return TU.translate("KeybindsOptions." + id, args);

public var categories:Array<ControlsCategory> = [];
return TU.translate(id, args);

public var settingCam:FlxCamera;

Expand All @@ -29,126 +27,127 @@ class KeybindsOptions extends MusicBeatSubstate {
];
public var camFollow:FlxObject = new FlxObject(0, 0, 2, 2);

var isSubState:Bool = false;

public override function create() {
categories = [
{
name: translate("category.notes"),
settings: [
{
sparrowIcon: "game/notes/default",
sparrowAnim: "purple0",
name: translate("left"),
control: 'NOTE_LEFT'
},
{
sparrowIcon: "game/notes/default",
sparrowAnim: "blue0",
name: translate("down"),
control: 'NOTE_DOWN'
},
{
sparrowIcon: "game/notes/default",
sparrowAnim: "green0",
name: translate("up"),
control: 'NOTE_UP'
},
{
sparrowIcon: "game/notes/default",
sparrowAnim: "red0",
name: translate("right"),
control: 'NOTE_RIGHT'
},
]
},
{
name: translate("category.ui"),
settings: [
{
name: translate("left"),
control: 'LEFT'
},
{
name: translate("down"),
control: 'DOWN'
},
{
name: translate("up"),
control: 'UP'
},
{
name: translate("right"),
control: 'RIGHT'
},
{
name: translate("ui.accept"),
control: 'ACCEPT'
},
{
name: translate("ui.back"),
control: 'BACK'
},
{
name: translate("ui.reset"),
control: 'RESET'
},
{
name: translate("ui.pause"),
control: 'PAUSE'
},
{
name: translate("ui.changeMode"),
control: 'CHANGE_MODE'
},
]
},
public var categories:Array<ControlsCategory> = [];
public static var defaultCategories:Array<ControlsCategory> = [
{
name: "category.notes",
settings: [
{
sparrowIcon: "game/notes/default",
sparrowAnim: "purple0",
name: "left",
control: 'NOTE_LEFT'
},
{
sparrowIcon: "game/notes/default",
sparrowAnim: "blue0",
name: "down",
control: 'NOTE_DOWN'
},
{
sparrowIcon: "game/notes/default",
sparrowAnim: "green0",
name: "up",
control: 'NOTE_UP'
},
{
sparrowIcon: "game/notes/default",
sparrowAnim: "red0",
name: "right",
control: 'NOTE_RIGHT'
},
]
},
{
name: "category.ui",
settings: [
{
name: "left",
control: 'LEFT'
},
{
name: "down",
control: 'DOWN'
},
{
name: "up",
control: 'UP'
},
{
name: "right",
control: 'RIGHT'
},
{
name: "ui.accept",
control: 'ACCEPT'
},
{
name: "ui.back",
control: 'BACK'
},
{
name: "ui.reset",
control: 'RESET'
},
{
name: "ui.pause",
control: 'PAUSE'
},
{
name: "ui.changeMode",
control: 'CHANGE_MODE'
},
]
},
{
name: translate("category.volume"),
name: "category.volume",
settings: [
{
name: translate("volume.up"),
name: "volume.up",
control: 'VOLUME_UP'
},
{
name: translate("volume.down"),
name: "volume.down",
control: 'VOLUME_DOWN'
},
{
name: translate("volume.mute"),
name: "volume.mute",
control: 'VOLUME_MUTE'
},
]
},
{
name: translate("category.engine"),
settings: [
{
name: translate("engine.switchMod"),
control: 'SWITCHMOD'
},
]
},
{
name: translate("category.developer"),
devModeOnly: true,
settings: [
{
name: translate("developer.devMenus"),
control: 'DEV_ACCESS'
},
{
name: translate("developer.openConsole"),
control: 'DEV_CONSOLE'
},
{
name: translate("developer.reloadState"),
control: 'DEV_RELOAD'
},
]
}
];
{
name: "category.engine",
settings: [
{
name: "engine.switchMod",
control: 'SWITCHMOD'
},
]
},
{
name: "category.developer",
devModeOnly: true,
settings: [
{
name: "developer.devMenus",
control: 'DEV_ACCESS'
},
{
name: "developer.openConsole",
control: 'DEV_CONSOLE'
},
{
name: "developer.reloadState",
control: 'DEV_RELOAD'
},
]
}
];

public var isSubState:Bool = false;

public override function create() {
super.create();
instance = this;

Expand Down Expand Up @@ -180,6 +179,8 @@ class KeybindsOptions extends MusicBeatSubstate {
FlxG.camera.follow(camFollow, LOCKON, 0.125);
}

for (category in defaultCategories) categories.push(category);

var customCategories = loadCustomCategories();
for (i in customCategories) categories.push(i);

Expand All @@ -188,7 +189,11 @@ class KeybindsOptions extends MusicBeatSubstate {
if (category.devModeOnly && !Options.devMode) continue;

k++;
var title = new Alphabet(0, k * 75, category.name, "bold");
var translationPrefix:String = (category.custom != null) ? '' : 'KeybindsOptions.';

var categoryToTranslate:String = translationPrefix + category.name;
var translatedCategory:String = TU.exists(categoryToTranslate) ? translate(categoryToTranslate) : category.name;
var title = new Alphabet(0, k * 75, translatedCategory, "bold");
title.screenCenter(X);
add(title);

Expand All @@ -199,7 +204,9 @@ class KeybindsOptions extends MusicBeatSubstate {
if (e.sparrowIcon != null) sparrowIcon = e.sparrowIcon;
if (e.sparrowAnim != null) sparrowAnim = e.sparrowAnim;

var text = new KeybindSetting(100, k * 75, e.name, e.control, sparrowIcon, sparrowAnim, e.custom == null ? false : e.custom);
var nameToTranslate:String = translationPrefix + e.name;
var translatedName:String = TU.exists(nameToTranslate) ? translate(nameToTranslate) : e.name;
var text = new KeybindSetting(100, k * 75, translatedName, e.control, sparrowIcon, sparrowAnim, e.custom == null ? false : e.custom);
if (!isSubState)
text.bind1.color = text.bind2.color = FlxColor.BLACK;
alphabets.add(text);
Expand Down Expand Up @@ -318,6 +325,7 @@ class KeybindsOptions extends MusicBeatSubstate {

var cat:ControlsCategory = {
name: category.getAtt("name"),
custom: true,
settings: []
};

Expand Down Expand Up @@ -354,4 +362,5 @@ typedef ControlsCategory = {
var name:String;
var settings:Array<KeybindSettingData>;
var ?devModeOnly:Bool;
var ?custom:Bool;
}