fs2open.github.com/code/scripting/api/objs/control_config.cpp

#include "control_config.h"

#include "controlconfig/controlsconfig.h"
#include "io/key.h"
#include "controlconfig/presets.h"

namespace scripting {
namespace api {

control_h::control_h() : control(-1) {}
control_h::control_h(int l_control) : control(l_control) {}

CCI* control_h::getControl() const
{
	return &Control_config[control];
}

conflict* control_h::getConflict() const
{
	return &Conflicts[control];
}

int control_h::getIndex() const
{
	return control;
}

preset_h::preset_h() : preset(-1) {}
preset_h::preset_h(int l_preset) : preset(l_preset) {}

CC_preset* preset_h::getPreset() const
{
	return &Control_config_presets[preset];
}

//**********HANDLE: preset
ADE_OBJ(l_Preset, preset_h, "preset", "Control Preset handle");

ADE_VIRTVAR(Name, l_Preset, nullptr, "The name of the preset", "string", "The name")
{
	preset_h current;
	if (!ade_get_args(L, "o", l_Preset.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	if (ADE_SETTING_VAR) {
		LuaError(L, "This property is read only.");
	}

	return ade_set_args(L, "s", current.getPreset()->name.c_str());
}

ADE_FUNC(clonePreset,
	l_Preset,
	"string Name, [boolean overwrite]",
	"Clones the preset into a new preset with the specified name. Sets it as the active preset",
	"boolean",
	"Returns true if successful, false otherwise")
{
	preset_h current;
	const char* newName;
	bool overwrite = false;
	if (!ade_get_args(L, "os|b", l_Preset.Get(&current), &newName, &overwrite)) {
		return ADE_RETURN_FALSE;
	}

	return ade_set_args(L, "b", control_config_clone_preset(*current.getPreset(), newName, overwrite));
}

ADE_FUNC(deletePreset,
	l_Preset,
	nullptr,
	"Deletes the preset file entirely. Cannot delete a currently active preset.",
	"boolean",
	"Returns true if successful, false otherwise")
{
	preset_h current;
	if (!ade_get_args(L, "o", l_Preset.Get(&current))) {
		return ADE_RETURN_FALSE;
	}

	return ade_set_args(L, "b", control_config_delete_preset(*current.getPreset()));
}

//**********HANDLE: control
ADE_OBJ(l_Control, control_h, "control", "Control handle");

ADE_VIRTVAR(Name, l_Control, nullptr, "The name of the control", "string", "The name")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	if (ADE_SETTING_VAR) {
		LuaError(L, "This property is read only.");
	}

	CCI* item = current.getControl();
	SCP_string name;

	if (item->indexXSTR > 1) {
		name = XSTR(item->text.c_str(), item->indexXSTR, true);
	} else if (item->indexXSTR == 1) {
		name = XSTR(item->text.c_str(), CONTROL_CONFIG_XSTR + current.getIndex(), true);
	} else {
		name = item->text.c_str();
	}

	return ade_set_args(L, "s", name.c_str());
}

ADE_VIRTVAR(Bindings,
	l_Control,
	nullptr,
	"Gets a table of bindings for the control",
	"{ number => string ... }",
	"The keys table")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	auto table = luacpp::LuaTable::create(L);

	// Using a table so that if the number of bindings is ever increased the API
	// will only need minimal adjustments.
	table.addValue(1, current.getControl()->first.textify().c_str());
	table.addValue(2, current.getControl()->second.textify().c_str());

	return ade_set_args(L, "t", &table);
}

ADE_FUNC(isBindInverted,
	l_Control,
	"number Bind",
	"Returns if the selected bind is inverted. Number is 1 for first bind 2 for second.",
	"boolean",
	"True if inverted, false otherwise. False if the bind is not an axis.")
{
	control_h current;
	int item;
	if (!ade_get_args(L, "oi", l_Control.Get(&current), &item)) {
		return ADE_RETURN_NIL;
	}

	bool inverted = false;

	if (current.getControl()->is_axis()) {
		switch (item) {
		case (1):
			if (current.getControl()->first.is_inverted()) {
				inverted = true;
			}
			break;
		case (2):
			if (current.getControl()->second.is_inverted()) {
				inverted = true;
			}
			break;
		default:
			break;
		}
	}

	return ade_set_args(L, "b", inverted);
}

ADE_VIRTVAR(Shifted,
	l_Control,
	nullptr,
	"Returns whether or not the keybind is Shifted",
	"boolean",
	"True if shifted, false otherwise.")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	int k = current.getControl()->get_btn(CID_KEYBOARD);
	bool shifted = false;

	if (k >= 0) {
		if (k & KEY_SHIFTED) {
			shifted = true;
		}
	}

	return ade_set_args(L, "b", shifted);
}

ADE_VIRTVAR(Alted,
	l_Control,
	nullptr,
	"Returns whether or not the keybind is Alted",
	"boolean",
	"True if alted, false otherwise.")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	int k = current.getControl()->get_btn(CID_KEYBOARD);
	bool alted = false;

	if (k >= 0) {
		if (k & KEY_ALTED) {
			alted = true;
		}
	}

	return ade_set_args(L, "b", alted);
}

ADE_VIRTVAR(Tab,
	l_Control,
	nullptr,
	"The tab the control belongs in. 0 = Target Tab, 1 = Ship Tab, 2 = Weapon Tab, 3 = Computer Tab",
	"number",
	"The tab number")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	if (ADE_SETTING_VAR) {
		LuaError(L, "This property is read only.");
	}

	return ade_set_args(L, "i", current.getControl()->tab);
}

ADE_VIRTVAR(Disabled,
	l_Control,
	nullptr,
	"Whether or not the control is disabled and should be hidden.",
	"boolean",
	"True for disabled, false otherwise")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	if (ADE_SETTING_VAR) {
		LuaError(L, "This property is read only.");
	}

	return ade_set_args(L, "b", current.getControl()->disabled);
}

ADE_VIRTVAR(IsAxis,
	l_Control,
	nullptr,
	"Whether or not the bound control is an axis control.",
	"boolean",
	"True for axis, false otherwise")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	if (ADE_SETTING_VAR) {
		LuaError(L, "This property is read only.");
	}

	return ade_set_args(L, "b", current.getControl()->is_axis());
}

ADE_VIRTVAR(IsModifier,
	l_Control,
	nullptr,
	"Whether or not the bound control is a modifier.",
	"boolean",
	"True for modifier, false otherwise")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	if (ADE_SETTING_VAR) {
		LuaError(L, "This property is read only.");
	}

	bool mod = false;

	int k = current.getControl()->get_btn(CID_KEYBOARD);
	if ((k == KEY_LALT) || (k == KEY_RALT) || (k == KEY_LSHIFT) || (k == KEY_RSHIFT))
		mod = true;

	return ade_set_args(L, "b", mod);
}

ADE_VIRTVAR(Conflicted,
	l_Control,
	nullptr,
	"Whether or not the bound control has a conflict.",
	"string",
	"Returns the conflict string if true, nil otherwise")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_NIL;
	}

	if (ADE_SETTING_VAR) {
		LuaError(L, "This property is read only.");
	}

	if (!current.getControl()->is_axis() &&
		((current.getConflict()->first >= 0) || (current.getConflict()->second >= 0))) {
		int i = current.getConflict()->first;
		if (i < 0) {
			i = current.getConflict()->second;
		}

		SCP_string str = XSTR("Control conflicts with:", 209);
		str += " ";

		if (Control_config[i].indexXSTR > 1) {
			str += XSTR(Control_config[i].text.c_str(), Control_config[i].indexXSTR, true);
		} else if (Control_config[i].indexXSTR == 1) {
			str += XSTR(Control_config[i].text.c_str(), CONTROL_CONFIG_XSTR + i, true);
		} else {
			str += Control_config[i].text.c_str();
		}

		return ade_set_args(L, "s", str.c_str());
	}

	return ADE_RETURN_NIL;
}

ADE_FUNC(detectKeypress,
	l_Control,
	"number Item",
	"Waits for a keypress to use as a keybind. Binds the key if found. Will need to disable UI input if enabled first. Should run On Frame. Item is first bind (1) or second bind (2)",
	"number",
	"1 if successful or ESC was pressed, 0 otherwise. Returns -1 if the keypress is invalid")
{
	control_h current;
	int item;
	if (!ade_get_args(L, "oi", l_Control.Get(&current), &item)) {
		return ADE_RETURN_FALSE;
	}

	int idx = current.getIndex();

	return ade_set_args(L, "i", control_config_bind_key_on_frame(idx, (selItem)item, true));
}

ADE_FUNC(clearBind,
	l_Control,
	"number Item",
	"Clears the control binding. Item is all controls (1), first control (2), or second control (3)",
	"boolean",
	"Returns true if successful, false otherwise")
{
	control_h current;
	int item;
	if (!ade_get_args(L, "oi", l_Control.Get(&current), &item)) {
		return ADE_RETURN_FALSE;
	}

	int idx = current.getIndex();

	return ade_set_args(L, "b", control_config_remove_binding(idx, (selItem)item, true));
}

ADE_FUNC(clearConflicts,
	l_Control,
	nullptr,
	"Clears all binds that conflict with the selected bind index.",
	"boolean",
	"Returns true if successful, false otherwise")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_FALSE;
	}

	int idx = current.getIndex();

	return ade_set_args(L, "b", control_config_clear_other(idx, true));
}

ADE_FUNC(toggleShifted,
	l_Control,
	nullptr,
	"Toggles whether or not the current bind uses SHIFT modifier.",
	"boolean",
	"Returns true if successful, false otherwise")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_FALSE;
	}

	int idx = current.getIndex();

	return ade_set_args(L, "b", control_config_toggle_modifier(KEY_SHIFTED, idx, true));
}

ADE_FUNC(toggleAlted,
	l_Control,
	nullptr,
	"Toggles whether or not the current bind uses ALT modifier.",
	"boolean",
	"Returns true if successful, false otherwise")
{
	control_h current;
	if (!ade_get_args(L, "o", l_Control.Get(&current))) {
		return ADE_RETURN_FALSE;
	}

	int idx = current.getIndex();

	return ade_set_args(L, "b", control_config_toggle_modifier(KEY_ALTED, idx, true));
}

ADE_FUNC(toggleInverted,
	l_Control,
	"number Item",
	"Toggles whether or not the current bind axis is inverted. Item is all controls (1), first control (2), or second "
	"control (3)",
	"boolean",
	"Returns true if successful, false otherwise")
{
	control_h current;
	int item;
	if (!ade_get_args(L, "oi", l_Control.Get(&current), &item)) {
		return ADE_RETURN_FALSE;
	}

	int idx = current.getIndex();

	return ade_set_args(L, "b", control_config_toggle_invert(idx, (selItem)item, true));
}

} // namespace api
} // namespace scripting