How to add a key binding?

[_selfishPerson]

I'm trying to create a mod that adds a keybinding to toggle brakes, but I'm not sure how to add one. I've found a KeyBinding class, but it doesn't seem immediately obvious how to use it. Can someone please enlighten me? Thanks

[Crzyrndm]

Write your own code to monitor for the keypress and toggle the action group

// put this in Update
if (Input.GetKeyDown(KeyCode.Key)) // put your KeyCode here
{
    vessel.ActionGroups.ToggleGroup(KSPActionGroup.Brakes)
}

[_selfishPerson]

Write your own code to monitor for the keypress and toggle the action group

// put this in Update
if (Input.GetKeyDown(KeyCode.Key)) // put your KeyCode here
{
    vessel.ActionGroups.ToggleGroup(KSPActionGroup.Brakes)
}

Is there any way to integrate this to the KSP key binding system or do I need to create my own?

[Crzyrndm]

If you want to tie it to a KSP binding (yaw left, brakes, etc.) instead of a specific key, you use

if (GameSettings.*Action*.GetKeyDown()) // where action would probably be brakes in your case
// do things

Edited April 12, 2015 by Crzyrndm

[_selfishPerson]

If you want to tie it to a KSP binding (yaw left, brakes, etc.) instead of a specific key, you use

if (GameSettings.*Action*.GetKeyDown()) // where action would probably be brakes in your case
// do things

I mean, is there a way to add my keybinding to the KSP keybinding system? Or do I just have to make my own keybinding system?

[Crzyrndm]

To my knowledge, no, you can only add a bunch of your own monitoring code. Even if you could, there isn't much/any chance of it being simpler than the first snippet above.

If the issue is making it configurable, yes, you're going to have to write your own save/load method to remember which KeyCode was needed.

[_selfishPerson]

To my knowledge, no, you can only add a bunch of your own monitoring code. Even if you could, there isn't much/any chance of it being simpler than the first snippet above.

If the issue is making it configurable, yes, you're going to have to write your own save/load method to remember which KeyCode was needed.

Alright, thanks!

[Diazo]

Welcome to my world.

I can confirm that there is no way to add your own stuff to KSP's keybinding system, you have to write your own system completely if you want to do this.

I've done this to differently levels for 3 different mods if you want to check those out.

The trickiest thing is that you have to save KeyCode data to disk as strings, so when you save use "KeyCodeObject.ToString()" and then convert that from a string back to a KeyCode when loading with "KeyCodeObject = (KeyCode)Enum.Parse(typeof(KeyCode), KeyCodeObejctString);

Hope that helps,

D.

Edited April 12, 2015 by Diazo

[xEvilReeperx]

One trick with types that implement IConfigNode is that you can get persistence practically for free inside certain types (ScenarioModules and PartModules):

[KSPScenario(ScenarioCreationOptions.AddToAllGames, new[] { GameScenes.SPACECENTER })]
public class ScenarioModuleKeyBindingPersistence : ScenarioModule
{
    [KSPField(isPersistant = true)] // note: must be marked KSPField, persistent
    private KeyBinding myBinding = new KeyBinding();


    // note: none of the persistent fields have been set yet
    public override void OnAwake()
    {
        base.OnAwake();
    }

    // persistent fields have been serialized by now
    private void Start()
    {
        print("Start - KeyBindingPersistence - key is set to " + myBinding.primary);
    }
}

Otherwise you'd want to be using KeyBinding.Save/Load. A verbose example:

public class AddonKeyBindingPersistence : MonoBehaviour
{
private KeyBinding myBinding = new KeyBinding();


private void Start()
{
if (File.Exists(GetConfigFilePath()))
LoadSettings();

print("myBinding is currently " + myBinding);
}

private void OnDestroy()
{
SaveSettings();
}

private void LoadSettings()
{
var config = ConfigNode.Load(GetConfigFilePath());
myBinding.Load(config.GetNode("MyBinding") ?? DefaultKeyBindingNode()); // KeyBinding will throw an exception on badly formed ConfigNodes
}

private void SaveSettings()
{
var config = new ConfigNode("MyAddonSettings");
myBinding.Save(config.AddNode("MyBinding"));
}


private string GetConfigFilePath()
{
var dllDir = Path.GetDirectoryName(AssemblyLoader.GetPathByType(typeof(AddonKeyBindingPersistence)));

if (!Directory.Exists(dllDir))
Directory.CreateDirectory(dllDir);

return Path.Combine(dllDir, "settings.cfg");
}

private static ConfigNode DefaultKeyBindingNode()
{
var node = new ConfigNode();
new KeyBinding(KeyCode.None).Save(node);
return node;
}
}

[KSPAddon(KSPAddon.Startup.SpaceCentre, false)]

[_selfishPerson]

Why can't you cast it to an int and then save that? That's what I was thinking of doing!!!