Header file for menu callback functions used for base and aircraft equip menu. More...

#include "../../cl_shared.h"
#include "../../ui/ui_dataids.h"
#include "cp_campaign.h"
#include "cp_fightequip_callbacks.h"
#include "cp_mapfightequip.h"
#include "cp_ufo.h"

Macros
#define	AIM_LOADING_OK 0

#define	AIM_LOADING_NOSLOTSELECTED 1

#define	AIM_LOADING_NOTECHNOLOGYSELECTED 2

#define	AIM_LOADING_ALIENTECH 3

#define	AIM_LOADING_TECHNOLOGYNOTRESEARCHED 4

#define	AIM_LOADING_TOOHEAVY 5

#define	AIM_LOADING_UNKNOWNPROBLEM 6

#define	AIM_LOADING_NOWEAPON 7

#define	AIM_LOADING_NOTUSABLEWITHWEAPON 8

Functions
static void	AIM_CheckAirequipID (void)
	Check airequipID value and set the correct values for aircraft items. More...

static void	AIM_CheckAirequipSelectedSlot (const aircraft_t *aircraft)
	Check that airequipSelectedSlot is the indice of an existing slot in the aircraft. More...

aircraftSlot_t *	AII_SelectAircraftSlot (aircraft_t *aircraft, aircraftItemType_t type)
	Returns a pointer to the selected slot. More...

static void	AIM_CheckAirequipSelectedZone (aircraftSlot_t *slot)
	Check that airequipSelectedZone is available. More...

static const char *	AIM_AircraftItemtypeName (const int equiptype)
	Returns the userfriendly name for craftitem types (shown in aircraft equip menu) More...

static bool	AIM_CrafttypeFilter (const base_t base, aircraftItemType_t filterType, const technology_t tech)

static void	AIM_UpdateAircraftItemList (const aircraftSlot_t *slot)
	Update the list of item you can choose. More...

static void	AIM_DrawAircraftSlots (const aircraft_t *aircraft)
	Draw only slots existing for this aircraft, and emphases selected one. More...

static void	AIM_EmphazeAmmoSlotText (void)
	Write in red the text in zone ammo (zone 2) More...

static void	AIM_NoEmphazeAmmoSlotText (void)
	Write in white the text in zone ammo (zone 2) More...

static void	AIM_AircraftEquipMenuUpdate (void)

static int	AIM_CheckTechnologyIntoSlot (const aircraftSlot_t slot, const technology_t tech)

static void	AIM_UpdateItemDescription (bool fromList, bool fromSlot)
	Update the item description according to the tech and the slot selected. More...

static void	AIM_AircraftEquipMenuUpdate_f (void)
	Fills the weapon and shield list of the aircraft equip menu. More...

static void	AIM_AircraftEquipSlotSelect_f (void)
	Select the current slot you want to assign the item to. More...

static void	AIM_AircraftEquipZoneSelect_f (void)
	Select the current zone you want to assign the item to. More...

static void	AIM_AircraftEquipAddItem_f (void)
	Add selected item to current zone. More...

static void	AIM_AircraftEquipRemoveItem_f (void)
	Delete an object from a zone. More...

static void	AIM_AircraftEquipMenuClick_f (void)
	Set AIM_selectedTechnology to the technology of current selected aircraft item. More...

static void	AIM_AircraftItemtypeByName_f (void)
	Update the GUI with a named itemtype. More...

void	AIM_InitCallbacks (void)

void	AIM_ShutdownCallbacks (void)

Variables
static aircraftItemType_t	airequipID = MAX_ACITEMS

static int	airequipSelectedZone = ZONE_NONE

static int	airequipSelectedSlot = ZONE_NONE

static technology_t *	aimSelectedTechnology = nullptr

static const cmdList_t	airequipCmds []

Detailed Description

Header file for menu callback functions used for base and aircraft equip menu.

Definition in file cp_fightequip_callbacks.cpp.

Macro Definition Documentation

#define AIM_LOADING_ALIENTECH 3

Definition at line 408 of file cp_fightequip_callbacks.cpp.

Referenced by AIM_CheckTechnologyIntoSlot(), and AIM_UpdateItemDescription().

#define AIM_LOADING_NOSLOTSELECTED 1

Definition at line 406 of file cp_fightequip_callbacks.cpp.

Referenced by AIM_CheckTechnologyIntoSlot(), and AIM_UpdateItemDescription().

#define AIM_LOADING_NOTECHNOLOGYSELECTED 2

Definition at line 407 of file cp_fightequip_callbacks.cpp.

Referenced by AIM_CheckTechnologyIntoSlot(), and AIM_UpdateItemDescription().

#define AIM_LOADING_NOTUSABLEWITHWEAPON 8

Definition at line 413 of file cp_fightequip_callbacks.cpp.

Referenced by AIM_CheckTechnologyIntoSlot(), and AIM_UpdateItemDescription().

#define AIM_LOADING_NOWEAPON 7

Definition at line 412 of file cp_fightequip_callbacks.cpp.

Referenced by AIM_CheckTechnologyIntoSlot(), and AIM_UpdateItemDescription().

#define AIM_LOADING_OK 0

Definition at line 405 of file cp_fightequip_callbacks.cpp.

Referenced by AIM_CheckTechnologyIntoSlot(), and AIM_UpdateItemDescription().

#define AIM_LOADING_TECHNOLOGYNOTRESEARCHED 4

Definition at line 409 of file cp_fightequip_callbacks.cpp.

Referenced by AIM_CheckTechnologyIntoSlot(), and AIM_UpdateItemDescription().

#define AIM_LOADING_TOOHEAVY 5

Definition at line 410 of file cp_fightequip_callbacks.cpp.

Referenced by AIM_CheckTechnologyIntoSlot(), and AIM_UpdateItemDescription().

#define AIM_LOADING_UNKNOWNPROBLEM 6

Definition at line 411 of file cp_fightequip_callbacks.cpp.

Referenced by AIM_CheckTechnologyIntoSlot(), and AIM_UpdateItemDescription().

Function Documentation

aircraftSlot_t* AII_SelectAircraftSlot	(	aircraft_t *	aircraft,
		aircraftItemType_t	type
	)

Returns a pointer to the selected slot.

Parameters

[in]	aircraft	Pointer to the aircraft
[in]	type	Type of slot we want to select

Note: also used by BDEF_ functions

Returns: Pointer to the slot corresponding to airequipID

Definition at line 86 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AC_ITEM_ELECTRONICS, AC_ITEM_SHIELD, AC_ITEM_WEAPON, AIM_CheckAirequipSelectedSlot(), airequipSelectedSlot, cgi, aircraft_s::electronics, aircraft_s::shield, and aircraft_s::weapons.

Referenced by AIM_AircraftEquipAddItem_f(), AIM_AircraftEquipMenuUpdate(), AIM_AircraftEquipRemoveItem_f(), AIM_AircraftEquipZoneSelect_f(), and AIM_UpdateItemDescription().

static void AIM_AircraftEquipAddItem_f ( void )

static

Add selected item to current zone.

Note: Called from airequip menu

See also: aircraftItemType_t

Definition at line 732 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AII_AddAmmoToSlot(), AII_AddItemToSlot(), AII_AutoAddAmmo(), AII_RemoveItemFromSlot(), AII_RemoveNextItemFromSlot(), AII_SelectAircraftSlot(), AII_UpdateAircraftStats(), AIM_AircraftEquipMenuUpdate(), base_s::aircraftCurrent, airequipID, airequipSelectedZone, B_GetCurrentSelectedBase(), objDef_s::craftitem, aircraft_s::homebase, aircraftSlot_s::installationTime, craftitem_s::installationTime, INVSH_GetItemByID(), aircraftSlot_s::item, aircraftSlot_s::nextItem, technology_s::provides, ZONE_AMMO, ZONE_MAIN, and ZONE_MAX.

static void AIM_AircraftEquipMenuClick_f ( void )

static

Set AIM_selectedTechnology to the technology of current selected aircraft item.

See also: AIM_AircraftEquipMenuUpdate_f

Definition at line 884 of file cp_fightequip_callbacks.cpp.

References AIM_UpdateItemDescription(), cgi, cgame_import_s::Cmd_Argv(), and RS_GetTechByIDX().

static void AIM_AircraftEquipMenuUpdate ( void )

static

Definition at line 300 of file cp_fightequip_callbacks.cpp.

References _, AC_ITEM_AMMO, AC_ITEM_ELECTRONICS, AC_ITEM_SHIELD, AC_ITEM_WEAPON, AII_SelectAircraftSlot(), AII_WeightToName(), AIM_AircraftItemtypeName(), AIM_CheckAirequipSelectedSlot(), AIM_CheckAirequipSelectedZone(), AIM_DrawAircraftSlots(), AIM_EmphazeAmmoSlotText(), AIM_NoEmphazeAmmoSlotText(), AIM_UpdateAircraftItemList(), base_s::aircraftCurrent, airequipID, aircraftSlot_s::ammo, B_GetCurrentSelectedBase(), cgi, Com_sprintf(), objDef_s::craftitem, cgame_import_s::Cvar_Set(), aircraftSlot_s::installationTime, craftitem_s::installationTime, objDef_s::isVirtual, aircraftSlot_s::item, technology_s::name, aircraftSlot_s::nextAmmo, aircraftSlot_s::nextItem, ngettext, Q_strcat(), Q_strncpyz(), RS_GetTechForItem(), aircraftSlot_s::size, TEXT_AIREQUIP_1, TEXT_AIREQUIP_2, TEXT_ITEMDESCRIPTION, and TEXT_LIST.

Referenced by AIM_AircraftEquipAddItem_f(), AIM_AircraftEquipMenuUpdate_f(), AIM_AircraftEquipRemoveItem_f(), AIM_AircraftEquipSlotSelect_f(), and AIM_AircraftEquipZoneSelect_f().

static void AIM_AircraftEquipMenuUpdate_f ( void )

static

Fills the weapon and shield list of the aircraft equip menu.

See also: AIM_AircraftEquipMenuClick_f

Definition at line 567 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AC_ITEM_ELECTRONICS, AC_ITEM_SHIELD, AC_ITEM_WEAPON, AIM_AircraftEquipMenuUpdate(), AIM_CheckAirequipID(), airequipID, cgi, cgame_import_s::Cmd_Argv(), MAX_ACITEMS, and type.

static void AIM_AircraftEquipRemoveItem_f ( void )

static

Delete an object from a zone.

Definition at line 818 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AII_RemoveItemFromSlot(), AII_RemoveNextItemFromSlot(), AII_SelectAircraftSlot(), AII_UpdateAircraftStats(), AIM_AircraftEquipMenuUpdate(), base_s::aircraftCurrent, airequipID, B_GetCurrentSelectedBase(), objDef_s::craftitem, aircraftSlot_s::installationTime, craftitem_s::installationTime, aircraftSlot_s::item, aircraftSlot_s::nextAmmo, aircraftSlot_s::nextItem, ZONE_AMMO, and ZONE_MAIN.

static void AIM_AircraftEquipSlotSelect_f ( void )

static

Select the current slot you want to assign the item to.

Note: This function is only for aircraft and not far bases.

Definition at line 601 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AC_ITEM_ELECTRONICS, AC_ITEM_WEAPON, AIM_AircraftEquipMenuUpdate(), AIM_UpdateItemDescription(), base_s::aircraftCurrent, airequipID, airequipSelectedSlot, B_GetCurrentSelectedBase(), cgi, cgame_import_s::Cmd_Argv(), aircraft_s::electronics, i, aircraft_s::maxElectronics, aircraft_s::maxWeapons, aircraftSlot_s::pos, Q_streq, aircraft_s::weapons, and ZONE_NONE.

static void AIM_AircraftEquipZoneSelect_f ( void )

static

Select the current zone you want to assign the item to.

Definition at line 676 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AC_ITEM_WEAPON, AII_SelectAircraftSlot(), AIM_AircraftEquipMenuUpdate(), AIM_CheckAirequipSelectedZone(), AIM_UpdateItemDescription(), base_s::aircraftCurrent, airequipID, airequipSelectedZone, B_GetCurrentSelectedBase(), cgi, cgame_import_s::Cmd_Argv(), aircraftSlot_s::item, and ZONE_AMMO.

static void AIM_AircraftItemtypeByName_f ( void )

static

Update the GUI with a named itemtype.

Definition at line 902 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AC_ITEM_ELECTRONICS, AC_ITEM_SHIELD, AC_ITEM_WEAPON, airequipID, cgi, cgame_import_s::Cmd_Argv(), i, name, and Q_streq.

static const char* AIM_AircraftItemtypeName ( const int equiptype )

inlinestatic

Returns the userfriendly name for craftitem types (shown in aircraft equip menu)

Definition at line 132 of file cp_fightequip_callbacks.cpp.

References _, AC_ITEM_AMMO, AC_ITEM_ELECTRONICS, AC_ITEM_SHIELD, and AC_ITEM_WEAPON.

Referenced by AIM_AircraftEquipMenuUpdate().

static void AIM_CheckAirequipID ( void )

static

Check airequipID value and set the correct values for aircraft items.

Definition at line 41 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AC_ITEM_ELECTRONICS, AC_ITEM_SHIELD, AC_ITEM_WEAPON, and airequipID.

Referenced by AIM_AircraftEquipMenuUpdate_f().

static void AIM_CheckAirequipSelectedSlot ( const aircraft_t * aircraft )

static

Check that airequipSelectedSlot is the indice of an existing slot in the aircraft.

Note: airequipSelectedSlot concerns only weapons and electronics

See also: aircraft Pointer to the aircraft

Definition at line 60 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AC_ITEM_ELECTRONICS, AC_ITEM_WEAPON, airequipID, airequipSelectedSlot, aircraft_s::maxElectronics, and aircraft_s::maxWeapons.

Referenced by AII_SelectAircraftSlot(), and AIM_AircraftEquipMenuUpdate().

static void AIM_CheckAirequipSelectedZone ( aircraftSlot_t * slot )

static

Check that airequipSelectedZone is available.

See also: slot Pointer to the slot

Definition at line 114 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AC_ITEM_WEAPON, airequipID, airequipSelectedZone, aircraftSlot_s::item, ZONE_AMMO, and ZONE_MAIN.

Referenced by AIM_AircraftEquipMenuUpdate(), and AIM_AircraftEquipZoneSelect_f().

static int AIM_CheckTechnologyIntoSlot	(	const aircraftSlot_t *	slot,
		const technology_t *	tech
	)

static

Todo:

It is a generic function, we can move it into cp_mapfightequip.c

Parameters

[in]	slot	Pointer to an aircraft slot (can be base/installation too)
[in]	tech	Pointer to the technology to test

Returns: The status of the technology versus the slot

Definition at line 421 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AII_GetItemWeightBySize(), AIM_LOADING_ALIENTECH, AIM_LOADING_NOSLOTSELECTED, AIM_LOADING_NOTECHNOLOGYSELECTED, AIM_LOADING_NOTUSABLEWITHWEAPON, AIM_LOADING_NOWEAPON, AIM_LOADING_OK, AIM_LOADING_TECHNOLOGYNOTRESEARCHED, AIM_LOADING_TOOHEAVY, AIM_LOADING_UNKNOWNPROBLEM, aircraftSlot_s::aircraft, objDef_s::ammos, B_BaseHasItem(), aircraftSlot_s::base, objDef_s::craftitem, aircraft_s::homebase, objDef_s::idx, craftitem_s::installationTime, INVSH_GetItemByID(), aircraftSlot_s::item, aircraftSlot_s::nextItem, objDef_s::numAmmos, technology_s::provides, RS_IsResearched_ptr(), aircraftSlot_s::size, aircraftSlot_s::type, craftitem_s::type, and objDef_s::weapons.

Referenced by AIM_UpdateItemDescription().

static bool AIM_CrafttypeFilter	(	const base_t *	base,
		aircraftItemType_t	filterType,
		const technology_t *	tech
	)

static

Returns: true if the technology is available and matches the filter

Definition at line 152 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, B_BaseHasItem(), objDef_s::craftitem, craftitem_s::installationTime, INVSH_GetItemByID(), objDef_s::isVirtual, technology_s::provides, RS_IsResearched_ptr(), and craftitem_s::type.

Referenced by AIM_UpdateAircraftItemList().

static void AIM_DrawAircraftSlots ( const aircraft_t * aircraft )

static

Draw only slots existing for this aircraft, and emphases selected one.

Returns: [out] aircraft Pointer to the aircraft

Definition at line 233 of file cp_fightequip_callbacks.cpp.

References AC_ITEM_AMMO, AC_ITEM_ELECTRONICS, AC_ITEM_WEAPON, AIR_POSITIONS_MAX, airequipID, airequipSelectedSlot, cgi, cgame_import_s::Cvar_Set(), aircraft_s::electronics, i, aircraftSlot_s::item, aircraft_s::maxElectronics, aircraft_s::maxWeapons, technology_s::mdl, aircraftSlot_s::pos, RS_GetTechForItem(), va(), and aircraft_s::weapons.

Referenced by AIM_AircraftEquipMenuUpdate().

static void AIM_EmphazeAmmoSlotText ( void )

inlinestatic

Write in red the text in zone ammo (zone 2)

See also: AIM_NoEmphazeAmmoSlotText

Note: This is intended to show the player that there is no ammo in his aircraft

Definition at line 285 of file cp_fightequip_callbacks.cpp.

References cgi.

Referenced by AIM_AircraftEquipMenuUpdate().

void AIM_InitCallbacks ( void )

Definition at line 941 of file cp_fightequip_callbacks.cpp.

References cgi.

Referenced by CP_AddCampaignCallbackCommands().

static void AIM_NoEmphazeAmmoSlotText ( void )

inlinestatic

Write in white the text in zone ammo (zone 2)

See also: AIM_EmphazeAmmoSlotText

Note: This is intended to revert effects of AIM_EmphazeAmmoSlotText

Definition at line 295 of file cp_fightequip_callbacks.cpp.

References cgi.

Referenced by AIM_AircraftEquipMenuUpdate().

void AIM_ShutdownCallbacks ( void )

Definition at line 946 of file cp_fightequip_callbacks.cpp.

References cgi.

Referenced by CP_RemoveCampaignCallbackCommands().

static void AIM_UpdateAircraftItemList ( const aircraftSlot_t * slot )

static

Update the list of item you can choose.

Parameters

[in] slot Pointer to aircraftSlot where items can be equiped

Definition at line 190 of file cp_fightequip_callbacks.cpp.

References _, AII_GetCraftitemTechsByType(), AIM_CrafttypeFilter(), AIM_SelectableCraftItem(), aircraftSlot_s::aircraft, airequipID, B_ItemInBase(), cgi, count, uiNode_t::disabled, aircraft_s::homebase, INVSH_GetItemByID(), uiNode_t::name, TEXT_LIST, TEXT_LIST2, cgame_import_s::UI_AddOption(), and va().

Referenced by AIM_AircraftEquipMenuUpdate().

static void AIM_UpdateItemDescription	(	bool	fromList,
		bool	fromSlot
	)

static

Update the item description according to the tech and the slot selected.

Todo:: we should clone the text, and not using the ufopedia text

Definition at line 494 of file cp_fightequip_callbacks.cpp.

References _, AC_ITEM_AMMO, AII_SelectAircraftSlot(), AIM_CheckTechnologyIntoSlot(), AIM_LOADING_ALIENTECH, AIM_LOADING_NOSLOTSELECTED, AIM_LOADING_NOTECHNOLOGYSELECTED, AIM_LOADING_NOTUSABLEWITHWEAPON, AIM_LOADING_NOWEAPON, AIM_LOADING_OK, AIM_LOADING_TECHNOLOGYNOTRESEARCHED, AIM_LOADING_TOOHEAVY, AIM_LOADING_UNKNOWNPROBLEM, base_s::aircraftCurrent, airequipID, aircraftSlot_s::ammo, B_GetCurrentSelectedBase(), cgi, cgame_import_s::Cvar_GetString(), cgame_import_s::Cvar_Set(), INVSH_GetItemByIDSilent(), aircraftSlot_s::item, technology_s::provides, and UP_AircraftItemDescription().

Referenced by AIM_AircraftEquipMenuClick_f(), AIM_AircraftEquipSlotSelect_f(), and AIM_AircraftEquipZoneSelect_f().

Variable Documentation

technology_t* aimSelectedTechnology = nullptr

static

Selected technology in equip menu

Definition at line 36 of file cp_fightequip_callbacks.cpp.

const cmdList_t airequipCmds[]

static

Initial value:

= {
    {"airequip_updatemenu", AIM_AircraftEquipMenuUpdate_f, "Init function for the aircraft equip menu"},
    {"airequip_selectcategory", AIM_AircraftItemtypeByName_f, "Select an item category and update the GUI"},
    {"airequip_list_click", AIM_AircraftEquipMenuClick_f, nullptr},
    {"airequip_slot_select", AIM_AircraftEquipSlotSelect_f, nullptr},
    {"airequip_add_item", AIM_AircraftEquipAddItem_f, "Add item to slot"},
    {"airequip_remove_item", AIM_AircraftEquipRemoveItem_f, "Remove item from slot"},
    {"airequip_zone_select", AIM_AircraftEquipZoneSelect_f, nullptr},
    {nullptr, nullptr, nullptr}
}