GameOptions.java

/*
 * Copyright 2018 MovingBlocks
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.destinationsol;

import com.badlogic.gdx.Gdx;
import com.badlogic.gdx.Input;
import com.google.common.base.Enums;
import org.destinationsol.menu.Resolution;
import org.destinationsol.menu.ResolutionProvider;
import org.terasology.gestalt.module.sandbox.API;

import static java.util.Arrays.asList;

@API
public class GameOptions {
    public enum ControlType {
        KEYBOARD("Keyboard"),
        MIXED("KB + Mouse"),
        MOUSE("Mouse"),
        CONTROLLER("Controller");

        private String humanName; // String used in the options menu.

        ControlType(String humanName) {
            this.humanName = humanName;
        }

        public String getHumanName() {
            return this.humanName;
        }

        public ControlType nextType(boolean isMobile) {
            switch (this) {
                case MIXED:
                    return CONTROLLER;
                case CONTROLLER:
                case MOUSE:
                    return KEYBOARD;
                case KEYBOARD:
                default:
                    return isMobile ? MOUSE : MIXED;
            }
        }
    }

    public enum Volume {
        OFF("Off", 0f),
        LOW("Low", 0.25f),
        MEDIUM("Medium", 0.5f),
        HIGH("High", 0.75f),
        MAX("Max", 1f);

        private final String name;

        private final float volume;

        Volume(String name, float volume) {
            this.name = name;
            this.volume = volume;
        }

        public String getName() {
            return name;
        }

        public float getVolume() {
            return volume;
        }

        public Volume advance() {
            switch (this) {
                case OFF:
                    return LOW;
                case LOW:
                    return MEDIUM;
                case MEDIUM:
                    return HIGH;
                case HIGH:
                    return MAX;
                case MAX:
                    return OFF;
            }
            return MAX;
        }
    }

    public static final String FILE_NAME = "settings.ini";
    public static final String DEFAULT_MOUSE_UP = "W";
    public static final String DEFAULT_MOUSE_DOWN = "S";
    public static final String DEFAULT_UP = "Up";
    public static final String DEFAULT_DOWN = "Down";
    public static final String DEFAULT_LEFT = "Left";
    public static final String DEFAULT_RIGHT = "Right";
    public static final String DEFAULT_SHOOT = "Space";
    public static final String DEFAULT_SHOOT2 = "L-Ctrl";
    public static final String DEFAULT_ABILITY = "L-Shift";
    public static final String DEFAULT_ESCAPE = "Escape";
    public static final String DEFAULT_MAP = "Tab";
    public static final String DEFAULT_INVENTORY = "I";
    public static final String DEFAULT_TALK = "T";
    public static final String DEFAULT_PAUSE = "P";
    public static final String DEFAULT_DROP = "D";
    public static final String DEFAULT_SELL = "S";
    public static final String DEFAULT_BUY = "B";
    public static final String DEFAULT_CHANGE_SHIP = "C";
    public static final String DEFAULT_HIRE_SHIP = "H";
    public static final String DEFAULT_MERCENARY_INTERACTION = "M";
    public static final String DEFAULT_FREE_CAMERA_MOVEMENT = "V";
    public static final String DEFAULT_ZOOM_IN = "Page Up";
    public static final String DEFAULT_ZOOM_OUT = "Page Down";
    public static final int DEFAULT_AXIS_SHOOT = 1;
    public static final int DEFAULT_AXIS_SHOOT2 = 0;
    public static final int DEFAULT_AXIS_ABILITY = -1;
    public static final int DEFAULT_AXIS_LEFT_RIGHT = 2;
    public static final boolean DEFAULT_AXIS_LEFT_RIGHT_INVERTED = false;
    public static final int DEFAULT_AXIS_UP_DOWN = 5;
    public static final boolean DEFAULT_AXIS_UP_DOWN_INVERTED = false;
    public static final int DEFAULT_BUTTON_SHOOT = -1;
    public static final int DEFAULT_BUTTON_SHOOT2 = -1;
    public static final int DEFAULT_BUTTON_ABILITY = 14;
    public static final int DEFAULT_BUTTON_UP = -1;
    public static final int DEFAULT_BUTTON_DOWN = -1;
    public static final int DEFAULT_BUTTON_LEFT = -1;
    public static final int DEFAULT_BUTTON_RIGHT = -1;
    public static final int DEFAULT_MAP_SCROLL_SPEED = 10;
    public static final int DEFAULT_MOBILE_MAP_SCROLL_SPEED = 5;
    private static final float DEFAULT_NUI_UI_SCALE = 1.0f;

    public int x;
    public int y;
    public boolean fullscreen;
    public ControlType controlType;
    public Volume sfxVolume;
    public Volume musicVolume;
    public boolean canSellEquippedItems;
    private String keyUpMouseName;
    private String keyDownMouseName;
    private String keyUpName;
    private String keyDownName;
    private String keyLeftName;
    private String keyRightName;
    private String keyShootName;
    private String keyShoot2Name;
    private String keyAbilityName;
    private String keyEscapeName;
    private String keyMapName;
    private String keyInventoryName;
    private String keyTalkName;
    private String keyPauseName;
    private String keyDropName;
    private String keySellMenuName;
    private String keyBuyMenuName;
    private String keyChangeShipMenuName;
    private String keyHireShipMenuName;
    private String keyMercenaryInteractionName;
    private String keyFreeCameraMovementName;
    private String keyZoomInName;
    private String keyZoomOutName;
    private int controllerAxisShoot;
    private int controllerAxisShoot2;
    private int controllerAxisAbility;
    private int controllerAxisLeftRight;
    private boolean isControllerAxisLeftRightInverted;
    private int controllerAxisUpDown;
    private boolean isControllerAxisUpDownInverted;
    private int controllerButtonShoot;
    private int controllerButtonShoot2;
    private int controllerButtonAbility;
    private int controllerButtonLeft;
    private int controllerButtonRight;
    private int controllerButtonUp;
    private int controllerButtonDown;
    private int mapScrollSpeed;
    public float nuiUiScale;

    private ResolutionProvider resolutionProvider;

    public GameOptions(boolean mobile, SolFileReader solFileReader) {

        IniReader reader = new IniReader(FILE_NAME, solFileReader);
        x = reader.getInt("x", 1366);
        y = reader.getInt("y", 768);
        fullscreen = reader.getBoolean("fullscreen", false);
        controlType = mobile ? ControlType.KEYBOARD : Enums.getIfPresent(ControlType.class,  reader.getString("controlType", "MIXED")).or(ControlType.MIXED);
        sfxVolume = Enums.getIfPresent(Volume.class, reader.getString("sfxVolume", "MAX")).or(Volume.MAX);
        musicVolume = Enums.getIfPresent(Volume.class, reader.getString("musicVolume", "MAX")).or(Volume.MAX);
        keyUpMouseName = reader.getString("keyUpMouse", DEFAULT_MOUSE_UP);
        keyDownMouseName = reader.getString("keyDownMouse", DEFAULT_MOUSE_DOWN);
        keyUpName = reader.getString("keyUp", DEFAULT_UP);
        keyDownName = reader.getString("keyDown", DEFAULT_DOWN);
        keyLeftName = reader.getString("keyLeft", DEFAULT_LEFT);
        keyRightName = reader.getString("keyRight", DEFAULT_RIGHT);
        keyShootName = reader.getString("keyShoot", DEFAULT_SHOOT);
        keyShoot2Name = reader.getString("keyShoot2", DEFAULT_SHOOT2);
        keyAbilityName = reader.getString("keyAbility", DEFAULT_ABILITY);
        keyEscapeName = reader.getString("keyEscape", DEFAULT_ESCAPE);
        keyMapName = reader.getString("keyMap", DEFAULT_MAP);
        keyInventoryName = reader.getString("keyInventory", DEFAULT_INVENTORY);
        keyTalkName = reader.getString("keyTalk", DEFAULT_TALK);
        keyPauseName = reader.getString("keyPause", DEFAULT_PAUSE);
        keyDropName = reader.getString("keyDrop", DEFAULT_DROP);
        keySellMenuName = reader.getString("keySellMenu", DEFAULT_SELL);
        keyBuyMenuName = reader.getString("keyBuyMenu", DEFAULT_BUY);
        keyChangeShipMenuName = reader.getString("keyChangeShipMenu", DEFAULT_CHANGE_SHIP);
        keyHireShipMenuName = reader.getString("keyHireShipMenu", DEFAULT_HIRE_SHIP);
        keyMercenaryInteractionName = reader.getString("keyMercenaryInteraction", DEFAULT_MERCENARY_INTERACTION);
        keyFreeCameraMovementName = reader.getString("keyFreeCameraMovement", DEFAULT_FREE_CAMERA_MOVEMENT);
        keyZoomInName = reader.getString("keyZoomIn", DEFAULT_ZOOM_IN);
        keyZoomOutName = reader.getString("keyZoomOut", DEFAULT_ZOOM_OUT);
        controllerAxisShoot = reader.getInt("controllerAxisShoot", DEFAULT_AXIS_SHOOT);
        controllerAxisShoot2 = reader.getInt("controllerAxisShoot2", DEFAULT_AXIS_SHOOT2);
        controllerAxisAbility = reader.getInt("controllerAxisAbility", DEFAULT_AXIS_ABILITY);
        controllerAxisLeftRight = reader.getInt("controllerAxisLeftRight", DEFAULT_AXIS_LEFT_RIGHT);
        isControllerAxisLeftRightInverted = reader.getBoolean("isControllerAxisLeftRightInverted", DEFAULT_AXIS_LEFT_RIGHT_INVERTED);
        controllerAxisUpDown = reader.getInt("controllerAxisUpDown", DEFAULT_AXIS_UP_DOWN);
        isControllerAxisUpDownInverted = reader.getBoolean("isControllerAxisUpDownInverted", DEFAULT_AXIS_UP_DOWN_INVERTED);
        controllerButtonShoot = reader.getInt("controllerButtonShoot", DEFAULT_BUTTON_SHOOT);
        controllerButtonShoot2 = reader.getInt("controllerButtonShoot2", DEFAULT_BUTTON_SHOOT2);
        controllerButtonAbility = reader.getInt("controllerButtonAbility", DEFAULT_BUTTON_ABILITY);
        controllerButtonLeft = reader.getInt("controllerButtonLeft", DEFAULT_BUTTON_LEFT);
        controllerButtonRight = reader.getInt("controllerButtonRight", DEFAULT_BUTTON_RIGHT);
        controllerButtonUp = reader.getInt("controllerButtonUp", DEFAULT_BUTTON_UP);
        controllerButtonDown = reader.getInt("controllerButtonDown", DEFAULT_BUTTON_DOWN);
        canSellEquippedItems = reader.getBoolean("canSellEquippedItems", false);
        mapScrollSpeed = reader.getInt("mapScrollSpeed", mobile ? DEFAULT_MOBILE_MAP_SCROLL_SPEED : DEFAULT_MAP_SCROLL_SPEED);
        nuiUiScale = reader.getFloat("nuiUiScale", DEFAULT_NUI_UI_SCALE);
    }

    public void advanceResolution() {
        //lazy initialize provider because graphics is not available at the constructor
        if (resolutionProvider == null) {
            resolutionProvider = new ResolutionProvider(asList(Gdx.graphics.getDisplayModes()));
        }
        Resolution nextResolution = resolutionProvider.increase();

        x = nextResolution.getWidth();
        y = nextResolution.getHeight();

        save();
    }

    public void advanceControlType(boolean mobile) {
        controlType = controlType.nextType(mobile);
        save();
    }

    public void advanceFullscreen() {
        fullscreen = !fullscreen;
        save();
    }

    public void advanceSoundVolMul() {
        sfxVolume = sfxVolume.advance();
        save();
    }

    public void advanceMusicVolMul() {
        musicVolume = musicVolume.advance();
        save();
    }

    public void advanceMapScrollSpeed() {
        mapScrollSpeed++;
        if (mapScrollSpeed > 15) {
            mapScrollSpeed = 1;
        }
        save();
    }

    public void advanceNuiUiScale() {
        nuiUiScale += 0.25f;
        if (nuiUiScale > 2.0f) {
            nuiUiScale = 0.25f;
        }
        save();
    }

    /**
     * Save the configuration settings to file.
     */
    public void save() {
        IniReader.write(FILE_NAME, "x", x, "y", y, "fullscreen", fullscreen, "controlType", controlType,
                "sfxVolume", sfxVolume, "musicVolume", musicVolume, "canSellEquippedItems", canSellEquippedItems,
                "keyUpMouse", getKeyUpMouseName(), "keyDownMouse", getKeyDownMouseName(), "keyUp", getKeyUpName(), "keyDown", keyDownName,
                "keyLeft", keyLeftName, "keyRight", keyRightName, "keyShoot", keyShootName, "keyShoot2", getKeyShoot2Name(),
                "keyAbility", getKeyAbilityName(), "keyEscape", getKeyEscapeName(), "keyMap", keyMapName, "keyInventory", keyInventoryName,
                "keyTalk", getKeyTalkName(), "keyPause", getKeyPauseName(), "keyDrop", getKeyDropName(), "keySellMenu", getKeySellMenuName(),
                "keyBuyMenu", getKeyBuyMenuName(), "keyChangeShipMenu", getKeyChangeShipMenuName(), "keyHireShipMenu", getKeyHireShipMenuName(),
                "keyZoomIn", getKeyZoomInName(), "keyZoomOut", getKeyZoomOutName(),
                "controllerAxisShoot", getControllerAxisShoot(), "controllerAxisShoot2", getControllerAxisShoot2(),
                "controllerAxisAbility", getControllerAxisAbility(), "controllerAxisLeftRight", getControllerAxisLeftRight(),
                "isControllerAxisLeftRightInverted", isControllerAxisLeftRightInverted(), "controllerAxisUpDown", getControllerAxisUpDown(),
                "isControllerAxisUpDownInverted", isControllerAxisUpDownInverted(), "controllerButtonShoot", getControllerButtonShoot(),
                "controllerButtonShoot2", getControllerButtonShoot2(), "controllerButtonAbility", getControllerButtonAbility(),
                "controllerButtonLeft", getControllerButtonLeft(), "controllerButtonRight", getControllerButtonRight(),
                "controllerButtonUp", getControllerButtonUp(), "controllerButtonDown", getControllerButtonDown(),
                "mapScrollSpeed", getMapScrollSpeed(), "nuiUiScale", getNuiUiScale());
    }

    /**
     * Get the defined key for up when the input controlType is set to CONTROL_MIXED. This includes navigating down in menus.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyUpMouse() {
        return Input.Keys.valueOf(getKeyUpMouseName());
    }

    /**
     * Get the defined key for down when the input controlType is set to CONTROL_MIXED.
     * This includes activating the ship's thrusters and navigating up in menus.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyDownMouse() {
        return Input.Keys.valueOf(getKeyDownMouseName());
    }

    /**
     * Get the readable name of the defined key for up when the input controlType is set to CONTROL_MIXED.
     * This includes navigating down in menus.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyUpMouseName() {
        return keyUpMouseName;
    }

    public void setKeyUpMouseName(String keyUpMouseName) {
        this.keyUpMouseName = keyUpMouseName;
    }

    /**
     * Get the readable name of the defined key for down when the input controlType is set to CONTROL_MIXED.
     * This includes navigating down in menus.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyDownMouseName() {
        return keyDownMouseName;
    }

    public void setKeyDownMouseName(String keyDownMouseName) {
        this.keyDownMouseName = keyDownMouseName;
    }

    /**
     * Get the defined key for up. This includes activating the ship's thrusters and navigating up in menus.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyUp() {
        return Input.Keys.valueOf(getKeyUpName());
    }

    /**
     * Get the readable name of the defined key for  up.
     * This includes activating the ship's thrusters and navigating up in menus.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyUpName() {
        return keyUpName;
    }

    public void setKeyUpName(String keyUpName) {
        this.keyUpName = keyUpName;
    }

    /**
     * Get the defined key for down. This includes navigating down in menus.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyDown() {
        return Input.Keys.valueOf(keyDownName);
    }

    /**
     * Get the readable name of the defined key for down.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyDownName() {
        return keyDownName;
    }

    public void setKeyDownName(String keyDownName) {
        this.keyDownName = keyDownName;
    }

    /**
     * Get the defined key for left. This includes rotating the ship left and navigating left in menus.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyLeft() {
        return Input.Keys.valueOf(keyLeftName);
    }

    /**
     * Get the readable name of the defined key for left.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyLeftName() {
        return keyLeftName;
    }

    public void setKeyLeftName(String keyLeftName) {
        this.keyLeftName = keyLeftName;
    }

    /**
     * Get the defined key for right. This includes rotating the ship right and navigating right in menus.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyRight() {
        return Input.Keys.valueOf(keyRightName);
    }

    /**
     * Get the readable name of the defined key for right.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyRightName() {
        return keyRightName;
    }

    public void setKeyRightName(String keyRightName) {
        this.keyRightName = keyRightName;
    }

    /**
     * Get the defined key for shooting the primary weapon.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyShoot() {
        return Input.Keys.valueOf(keyShootName);
    }

    /**
     * Get the readable name of the defined key for shooting the primary weapon.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyShootName() {
        return keyShootName;
    }

    public void setKeyShootName(String keyShootName) {
        this.keyShootName = keyShootName;
    }

    /**
     * Get the defined key for shooting the secondary weapon.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyShoot2() {
        return Input.Keys.valueOf(getKeyShoot2Name());
    }

    /**
     * Get the readable name of the defined key for shooting the secondary weapon.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyShoot2Name() {
        return keyShoot2Name;
    }

    public void setKeyShoot2Name(String keyShoot2Name) {
        this.keyShoot2Name = keyShoot2Name;
    }

    /**
     * Get the defined key for equipping and unequipping the primary weapon.
     * This is currently set to the same key as keyShootName
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyEquip() {
        return Input.Keys.valueOf(keyShootName);
    }

    /**
     * Get the defined key for equipping and unequipping the primary weapon.
     * This is currently set to the same key as keyShootName
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyEquipName() {
        return getKeyShootName();
    }

    /**
     * Get the defined key for equipping and unequipping the secondary weapon.
     * This is currently set to the same key as keyShoot2Name
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyEquip2() {
        return Input.Keys.valueOf(getKeyShoot2Name());
    }

    /**
     * Get the defined key for activating the ship's special ability.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyAbility() {
        return Input.Keys.valueOf(getKeyAbilityName());
    }

    /**
     * Get the readable name of the defined key for activating the ship's special ability.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyAbilityName() {
        return keyAbilityName;
    }

    public void setKeyAbilityName(String keyAbilityName) {
        this.keyAbilityName = keyAbilityName;
    }

    /**
     * Get the defined key for escape. This includes bringing up the in-game menu and exiting in-game menus.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyEscape() {
        return Input.Keys.valueOf(getKeyEscapeName());
    }

    /**
     * Get the readable name of the defined key for escape.
     * This includes bringing up the in-game menu and exiting in-game menus.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyEscapeName() {
        return keyEscapeName;
    }

    public void setKeyEscapeName(String keyEscapeName) {
        this.keyEscapeName = keyEscapeName;
    }

    /**
     * Get the defined key for activating the menu.
     * This is currently set to the same key as KeyEscape
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyMenu() {
        return getKeyEscape();
    }

    /**
     * Get the defined key for closing the menu.
     * This is currently set to the same key as KeyEscape
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyClose() {
        return getKeyEscape();
    }

    /**
     * Get the readable name of the defined key for closing the menu
     * This is currently set to the same key as KeyEscape
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyCloseName() {
        return getKeyEscapeName();
    }

    /**
     * Get the defined key for buying items.
     * This is currently set to the same key as KeyShoot
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyBuyItem() {
        return getKeyShoot();
    }

    /**
     * Get the defined key for buying items.
     * This is currently set to the same key as KeyShoot
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyBuyItemName() {
        return getKeyShootName();
    }

    /**
     * Get the defined key for selling items.
     * This is currently set to the same key as KeyShoot
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeySellItem() {
        return getKeyShoot();
    }

    /**
     * Get the defined key for hiring ships.
     * This is currently set to the same key as KeyShoot
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyHireShip() {
        return getKeyShoot();
    }

    /**
     * Get the defined key for changing ships.
     * This is currently set to the same key as KeyShoot
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyChangeShip() {
        return getKeyShoot();
    }

    /**
     * Get the defined key for zooming in on the map.
     * This is currently set to Page Up
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyZoomIn() {
        return Input.Keys.valueOf(keyZoomInName);
    }

    /**
     * Get the readable name of the defined key for zooming in on the map.
     * This is currently set to Page Up
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyZoomInName() {
        return keyZoomInName;
    }

    /**
     * Get the defined key for zooming out on the map.
     * This is currently set to Page Down
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyZoomOut() {
        return Input.Keys.valueOf(keyZoomOutName);
    }

    /**
     * Get the readable name of the defined key for zooming out on the map.
     * This is currently set to Page Down
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyZoomOutName() {
        return keyZoomOutName;
    }

    /**
     * Get the defined key for opening and closing the map.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyMap() {
        return Input.Keys.valueOf(keyMapName);
    }

    /**
     * Get the readable name of the defined key for opening and closing the map.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyMapName() {
        return keyMapName;
    }

    public void setKeyMapName(String keyMapName) {
        this.keyMapName = keyMapName;
    }

    /**
     * Get the defined key for opening the inventory.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyInventory() {
        return Input.Keys.valueOf(keyInventoryName);
    }

    /**
     * Get the readable name of the defined key for opening the inventory.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyInventoryName() {
        return keyInventoryName;
    }

    public void setKeyInventoryName(String keyInventoryName) {
        this.keyInventoryName = keyInventoryName;
    }

    /**
     * Get the defined key for interacting with mercenaries.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyMercenaryInteraction() {
        return Input.Keys.valueOf(keyMercenaryInteractionName);
    }

    /**
     * Get the readable name of the defined key for interacting with mercenaries.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyMercenaryInterationName() {
        return keyMercenaryInteractionName;
    }

    public void setKeyMercenaryInteractionName(String keyMercenaryInteractionName) {
        this.keyMercenaryInteractionName = keyMercenaryInteractionName;
    }

    public int getKeyFreeCameraMovement() {
        return Input.Keys.valueOf(getKeyFreeCameraMovementName());
    }

    public String getKeyFreeCameraMovementName() {
        return keyFreeCameraMovementName;
    }

    public void setKeyFreeCameraMovementName(String keyFreeCameraMovementName) {
        this.keyFreeCameraMovementName = keyFreeCameraMovementName;
    }

    /**
     * Get the defined key for opening the talk menu.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyTalk() {
        return Input.Keys.valueOf(getKeyTalkName());
    }

    /**
     * Get the readable name of the defined key for opening the talk menu.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyTalkName() {
        return keyTalkName;
    }

    public void setKeyTalkName(String keyTalkName) {
        this.keyTalkName = keyTalkName;
    }

    /**
     * Get the defined key for pausing and continuing the game.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyPause() {
        return Input.Keys.valueOf(getKeyPauseName());
    }

    /**
     * Get the readable name of the defined key for pausing and continuing the game.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyPauseName() {
        return keyPauseName;
    }

    public void setKeyPauseName(String keyPauseName) {
        this.keyPauseName = keyPauseName;
    }

    /**
     * Get the defined key for dropping items.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyDrop() {
        return Input.Keys.valueOf(getKeyDropName());
    }

    /**
     * Get the readable name of the defined key for dropping items.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyDropName() {
        return keyDropName;
    }

    public void setKeyDropName(String keyDropName) {
        this.keyDropName = keyDropName;
    }

    /**
     * Get the defined key for the sell menu.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeySellMenu() {
        return Input.Keys.valueOf(getKeySellMenuName());
    }

    /**
     * Get the readable name of the defined key for the sell menu.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeySellMenuName() {
        return keySellMenuName;
    }

    public void setKeySellMenuName(String keySellMenuName) {
        this.keySellMenuName = keySellMenuName;
    }

    /**
     * Get the defined key for the buy menu.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyBuyMenu() {
        return Input.Keys.valueOf(getKeyBuyMenuName());
    }

    /**
     * Get the readable name of the defined key for the buy menu.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyBuyMenuName() {
        return keyBuyMenuName;
    }

    public void setKeyBuyMenuName(String keyBuyMenuName) {
        this.keyBuyMenuName = keyBuyMenuName;
    }

    /**
     * Get the defined key for the change ship menu.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyChangeShipMenu() {
        return Input.Keys.valueOf(getKeyChangeShipMenuName());
    }

    /**
     * Get the readable name of the defined key for the change ship menu.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyChangeShipMenuName() {
        return keyChangeShipMenuName;
    }

    public void setKeyChangeShipMenuName(String keyChangeShipMenuName) {
        this.keyChangeShipMenuName = keyChangeShipMenuName;
    }

    /**
     * Get the defined key for the hire ship menu.
     *
     * @return int The keycode as defined in Input.Keys
     */
    public int getKeyHireShipMenu() {
        return Input.Keys.valueOf(getKeyHireShipMenuName());
    }

    /**
     * Get the readable name of the defined key for the hire ship menu.
     *
     * @return String The readable name as defined in Input.Keys
     */
    public String getKeyHireShipMenuName() {
        return keyHireShipMenuName;
    }

    public void setKeyHireShipMenuName(String keyHireShipMenuName) {
        this.keyHireShipMenuName = keyHireShipMenuName;
    }

    public int getControllerAxisShoot() {
        return controllerAxisShoot;
    }

    public void setControllerAxisShoot(int controllerAxisShoot) {
        this.controllerAxisShoot = controllerAxisShoot;
    }

    public int getControllerAxisShoot2() {
        return controllerAxisShoot2;
    }

    public void setControllerAxisShoot2(int controllerAxisShoot2) {
        this.controllerAxisShoot2 = controllerAxisShoot2;
    }

    public int getControllerAxisAbility() {
        return controllerAxisAbility;
    }

    public void setControllerAxisAbility(int controllerAxisAbility) {
        this.controllerAxisAbility = controllerAxisAbility;
    }

    public int getControllerAxisLeftRight() {
        return controllerAxisLeftRight;
    }

    public void setControllerAxisLeftRight(int controllerAxisLeftRight) {
        this.controllerAxisLeftRight = controllerAxisLeftRight;
    }

    public int getControllerAxisUpDown() {
        return controllerAxisUpDown;
    }

    public void setControllerAxisUpDown(int controllerAxisUpDown) {
        this.controllerAxisUpDown = controllerAxisUpDown;
    }

    public int getControllerButtonShoot() {
        return controllerButtonShoot;
    }

    public void setControllerButtonShoot(int controllerButtonShoot) {
        this.controllerButtonShoot = controllerButtonShoot;
    }

    public int getControllerButtonShoot2() {
        return controllerButtonShoot2;
    }

    public void setControllerButtonShoot2(int controllerButtonShoot2) {
        this.controllerButtonShoot2 = controllerButtonShoot2;
    }

    public int getControllerButtonAbility() {
        return controllerButtonAbility;
    }

    public void setControllerButtonAbility(int controllerButtonAbility) {
        this.controllerButtonAbility = controllerButtonAbility;
    }

    public int getControllerButtonLeft() {
        return controllerButtonLeft;
    }

    public void setControllerButtonLeft(int controllerButtonLeft) {
        this.controllerButtonLeft = controllerButtonLeft;
    }

    public int getControllerButtonRight() {
        return controllerButtonRight;
    }

    public void setControllerButtonRight(int controllerButtonRight) {
        this.controllerButtonRight = controllerButtonRight;
    }

    public int getControllerButtonUp() {
        return controllerButtonUp;
    }

    public void setControllerButtonUp(int controllerButtonUp) {
        this.controllerButtonUp = controllerButtonUp;
    }

    public boolean isControllerAxisLeftRightInverted() {
        return isControllerAxisLeftRightInverted;
    }

    public boolean isControllerAxisUpDownInverted() {
        return isControllerAxisUpDownInverted;
    }

    public void setIsControllerAxisLeftRightInverted(boolean isControllerAxisLeftRightInverted) {
        this.isControllerAxisLeftRightInverted = isControllerAxisLeftRightInverted;
    }

    public void setIsControllerAxisUpDownInverted(boolean isControllerAxisUpDownInverted) {
        this.isControllerAxisUpDownInverted = isControllerAxisUpDownInverted;
    }

    public int getControllerButtonDown() {
        return controllerButtonDown;
    }

    public void setControllerButtonDown(int controllerButtonDown) {
        this.controllerButtonDown = controllerButtonDown;
    }

    public int getMapScrollSpeed() {
        return mapScrollSpeed;
    }

    public void setMapScrollSpeed(int mapScrollSpeed) {
        this.mapScrollSpeed = mapScrollSpeed;
    }

    public float getNuiUiScale() {
        return nuiUiScale;
    }

    public void setNuiUiScale(float nuiUiScale) {
        this.nuiUiScale = nuiUiScale;
    }
}