mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-07 22:56:30 -10:00
Goober5000andClaude Fable 5.1
37b0b6ea82
* Automatically generate the isValid() Lua API function for handle types If an ADE object's stored type has an isValid() member, ade_obj now registers an isValid function for it automatically. An explicit ADE_FUNC(isValid, ...) declared after the ADE_OBJ replaces the generated one, so types with special semantics (e.g. sound) keep their own. The 67 hand-written functions that merely delegated to the member are removed, and 26 types that previously exposed no isValid() gain one. Co-Authored-By: Claude Fable 5.1 <[email protected]> * Add ADE_OBJ_VALIDATOR for index-based Lua handles Int-index handles (shipclass, weaponclass, team, etc.) can now declare their validity predicate with a single ADE_OBJ_VALIDATOR or ADE_OBJ_VALIDATOR_RANGE line after the ADE_OBJ. The registered validator drives the generated isValid() function and is also honored by ade_set_args when the mod table asks for nil instead of invalid objects, which previously never applied to these handles. The 19 hand-written range-check functions are replaced, and loadout_ship, default_primary, default_secondary, and support_rearm_pool_team gain isValid(). Add a validator to HudGauge while we're at it. Also fully qualify the scripting namespace in LuaConvert.h so its templates can be instantiated from the unit tests. Co-Authored-By: Claude Fable 5.1 <[email protected]> --------- Co-authored-by: Claude Fable 5.1 <[email protected]>
72 lines
2.2 KiB
C++
72 lines
2.2 KiB
C++
//
|
|
//
|
|
|
|
#include "wingformation.h"
|
|
|
|
#include "ship/ship.h"
|
|
|
|
namespace scripting {
|
|
namespace api {
|
|
|
|
// NOTE: the wing formation index runs 1 through Wing_formations.size(), offset by 1 from the internal contents. Index 0 is Default.
|
|
// This is necessary because the first formation is Default, but Default isn't actually stored internally as a formation.
|
|
|
|
//**********HANDLE: WingFormation
|
|
ADE_OBJ(l_WingFormation, int, "wingformation", "Wing formation handle");
|
|
ADE_OBJ_VALIDATOR_RANGE(l_WingFormation, sz2i(Wing_formations.size()) + 1); // + 1 admits the default formation
|
|
|
|
ADE_FUNC(__tostring, l_WingFormation, nullptr, "Wing formation name", "string", "Wing formation name, or an empty string if handle is invalid")
|
|
{
|
|
int formation_id;
|
|
if (!ade_get_args(L, "o", l_WingFormation.Get(&formation_id)))
|
|
return ade_set_error(L, "s", "");
|
|
|
|
if (formation_id == 0)
|
|
return ade_set_args(L, "s", "Default");
|
|
|
|
formation_id--; // offset from Default
|
|
|
|
if (formation_id < 0 || formation_id >= (int)Wing_formations.size())
|
|
return ade_set_error(L, "s", "");
|
|
|
|
return ade_set_args(L, "s", Wing_formations[formation_id].name);
|
|
}
|
|
|
|
ADE_FUNC(__eq, l_WingFormation, "wingformation, wingformation", "Checks if the two formations are equal", "boolean", "true if equal, false otherwise")
|
|
{
|
|
int idx1, idx2;
|
|
if (!ade_get_args(L, "oo", l_WingFormation.Get(&idx1), l_WingFormation.Get(&idx2)))
|
|
return ade_set_error(L, "b", false);
|
|
|
|
if (idx1 < 0 || idx1 >= (int)Wing_formations.size() + 1)
|
|
return ade_set_error(L, "b", false);
|
|
|
|
if (idx2 < 0 || idx2 >= (int)Wing_formations.size() + 1)
|
|
return ade_set_error(L, "b", false);
|
|
|
|
return ade_set_args(L, "b", idx1 == idx2);
|
|
}
|
|
|
|
ADE_VIRTVAR(Name, l_WingFormation, "string", "Wing formation name", "string", "Wing formation name, or empty string if handle is invalid")
|
|
{
|
|
int formation_id;
|
|
if (!ade_get_args(L, "o", l_WingFormation.Get(&formation_id)))
|
|
return ade_set_error(L, "s", "");
|
|
|
|
if (formation_id == 0)
|
|
return ade_set_args(L, "s", "Default");
|
|
|
|
formation_id--; // offset from Default
|
|
|
|
if (formation_id < 0 || formation_id >= (int)Wing_formations.size())
|
|
return ade_set_error(L, "s", "");
|
|
|
|
if (ADE_SETTING_VAR)
|
|
LuaError(L, "This property is read-only");
|
|
|
|
return ade_set_args(L, "s", Wing_formations[formation_id].name);
|
|
}
|
|
|
|
}
|
|
}
|