Shared game type headers. More...

#include "../cl_shared.h"
#include "../ui/ui_main.h"
#include "cgame.h"

Include dependency graph for cl_game.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	GAME_IsSingleplayer()
#define	CGAME_HARD_LINKED_FUNCTIONS

Functions
bool	GAME_IsMultiplayer (void)
void	GAME_ParseModes (const char name, const char *text)
void	GAME_InitStartup (void)
void	GAME_Shutdown (void)
void	GAME_InitUIData (void)
	Fills the game mode list entries with the parsed values from the script.
void	GAME_UnloadGame (void)
void	GAME_SetMode (const struct cgame_export_s *gametype)
void	GAME_ReloadMode (void)
void	GAME_Init (bool load)
void	GAME_DisplayItemInfo (uiNode_t node, const char string)
	Shows game type specific item information (if it's not resolvable via `objDef_t`).
bool	GAME_ItemIsUseable (const objDef_t *od)
void	GAME_HandleResults (dbuffer msg, int winner, int numSpawned, int *numAlive, int numKilled[][MAX_TEAMS], int numStunned[][MAX_TEAMS], bool nextmap)
	After a mission was finished this function is called.
void	GAME_SpawnSoldiers (void)
	Called during startup of mission to send team info.
void	GAME_StartMatch (void)
const char *	GAME_GetRelativeSavePath (char *buf, size_t bufSize)
const char *	GAME_GetAbsoluteSavePath (char *buf, size_t bufSize)
equipDef_t *	GAME_GetEquipmentDefinition (void)
bool	GAME_HandleServerCommand (const char command, dbuffer msg)
void	GAME_AddChatMessage (const char *format,...)
void	GAME_CharacterCvars (const character_t *chr)
character_t *	GAME_GetCharacter (int index)
	Returns a character that can be used to store the game type specific character values.
character_t *	GAME_GetCharacterByUCN (int ucn)
	Returns a character that can be used to store the game type specific character values.
size_t	GAME_GetCharacterArraySize (void)
const char *	GAME_GetCurrentName (void)
void	GAME_ResetCharacters (void)
	Reset all characters in the static character array.
void	GAME_GenerateTeam (const char teamDefID, const equipDef_t ed, int teamMembers)
void	GAME_AppendTeamMember (int memberIndex, const char teamDefID, const equipDef_t ed)
void	GAME_StartBattlescape (bool isTeamPlay)
	Called when the server sends the `EV_START` event.
void	GAME_InitMissionBriefing (const char *title)
void	GAME_EndBattlescape (void)
	This is called when a client quits the battlescape.
void	GAME_EndRoundAnnounce (int playerNum, int team)
	Send end round announcements.
bool	GAME_TeamIsKnown (const teamDef_t *teamDef)
void	GAME_NotifyEvent (event_t eventType)
const char *	GAME_GetTeamDef (void)
void	GAME_Drop (void)
void	GAME_Frame (void)
	Called every frame and allows us to hook into the current running game mode.
void	GAME_DrawBaseLayout (int baseIdx, int x, int y, int totalMarge, int w, int h, int padding, const vec4_t bgcolor, const vec4_t color)
void	GAME_DrawBaseLayoutTooltip (int baseIdx, int x, int y)
	Cgame callback to draw tooltip for baselayout UI node.
const char *	GAME_GetModelForItem (const objDef_t od, struct uiModel_s *menuModel)
const mapDef_t *	GAME_GetCurrentSelectedMap (void)
void	GAME_SwitchCurrentSelectedMap (int step)
bool	GAME_IsTeamEmpty (void)
int	GAME_GetCurrentTeam (void)
void	GAME_DrawMap (geoscapeData_t *data)
void	GAME_DrawMapMarkers (uiNode_t *node)
void	GAME_MapClick (uiNode_t *node, int x, int y, const vec2_t pos)
void	GAME_SetServerInfo (const char server, const char serverport)
character_t *	GAME_GetSelectedChr (void)
	Returns the currently selected character.
int	GAME_GetChrMaxLoad (const character_t *chr)
	Returns the max weight the given character can carry.
const equipDef_t *	GAME_ChangeEquip (const linkedList_t equipmentList, changeEquipType_t changeType, const char equipID)
	Changed the given cvar to the next/prev equipment definition.

Variables
geoscapeData_t	geoscapeData

Detailed Description

Shared game type headers.

Definition in file cl_game.h.

Macro Definition Documentation

◆ CGAME_HARD_LINKED_FUNCTIONS

#define CGAME_HARD_LINKED_FUNCTIONS

Value:

void Sys_Error (const char* error, ...) \
{ \
    va_list argptr; \
    char text[1024]; \
    va_start(argptr, error); \
    Q_vsnprintf(text, sizeof(text), error, argptr); \
    va_end(argptr); \
    cgi->Sys_Error("%s", text); \
} \
\
void Com_Printf (const char* msg, ...) \
{ \
    va_list argptr; \
    char text[1024]; \
    va_start(argptr, msg); \
    Q_vsnprintf(text, sizeof(text), msg, argptr); \
    va_end(argptr); \
    cgi->Com_Printf("%s", text); \
} \
\
void Com_DPrintf (int level, const char* msg, ...) \
{ \
    va_list argptr; \
    char text[1024]; \
    va_start(argptr, msg); \
    Q_vsnprintf(text, sizeof(text), msg, argptr); \
    va_end(argptr); \
    cgi->Com_DPrintf(level, "%s", text); \
}

Definition at line 91 of file cl_game.h.

◆ GAME_IsSingleplayer

#define GAME_IsSingleplayer ( )

Value:

(!GAME_IsMultiplayer())

GAME_IsMultiplayer

bool GAME_IsMultiplayer(void)

Definition cl_game.cpp:299

Definition at line 36 of file cl_game.h.

Referenced by CL_FixActorSkinIDX().

Function Documentation

◆ GAME_AddChatMessage()

void GAME_AddChatMessage	(	const char *	format,
			... )

Definition at line 370 of file cl_game.cpp.

References format(), GAME_GetCurrentType(), Q_vsnprintf(), S_StartLocalSample(), and SND_VOLUME_DEFAULT.

Referenced by CL_ParseServerMessage(), Irc_AppendToBuffer(), and Irc_Client_CmdPrivmsg().

◆ GAME_AppendTeamMember()

void GAME_AppendTeamMember	(	int	memberIndex,
		const char *	teamDefID,
		const equipDef_t *	ed )

Definition at line 252 of file cl_game.cpp.

References chrDisplayList, CL_GenerateCharacter(), cls, Com_Error(), Com_GetUGVByIDSilent(), ERR_DROP, GAME_GetCharacter(), GAME_GetChrMaxLoad(), character_t::head, character_t::headSkin, teamDef_t::id, INVSH_GetItemByID(), LIST_AddPointer(), character_t::name, teamDef_t::onlyWeapon, character_t::path, teamDef_t::robot, character_t::teamDef, UI_ExecuteConfunc(), and ugv_t::weapon.

Referenced by GAME_GenerateTeam(), and GAME_GetImportData().

◆ GAME_ChangeEquip()

const equipDef_t * GAME_ChangeEquip	(	const linkedList_t *	equipmentList,
		changeEquipType_t	changeType,
		const char *	equipID )

Changed the given cvar to the next/prev equipment definition.

Definition at line 1592 of file cl_game.cpp.

References BACKWARD, Com_Error(), csi, linkedList_t::data, ERR_DROP, FORWARD, index, INV_GetEquipmentDefinitionByID(), LIST_ContainsString(), LIST_Foreach, LIST_IsEmpty(), linkedList_t::next, and Q_streq.

Referenced by GAME_GetImportData().

◆ GAME_CharacterCvars()

void GAME_CharacterCvars ( const character_t * chr )

Definition at line 1451 of file cl_game.cpp.

References GAME_GetCurrentType().

Referenced by CL_UpdateCharacterValues().

◆ GAME_DisplayItemInfo()

void GAME_DisplayItemInfo	(	uiNode_t *	node,
		const char *	string )

Shows game type specific item information (if it's not resolvable via objDef_t).

Parameters

[in]	node	The menu node to show the information in.
[in]	string	The id of the 'thing' to show information for.

Definition at line 338 of file cl_game.cpp.

References GAME_GetCurrentType(), cgame_export_t::GetModelForItem(), and UI_DrawModelNode().

Referenced by uiItemNode::draw().

◆ GAME_DrawBaseLayout()

void GAME_DrawBaseLayout	(	int	baseIdx,
		int	x,
		int	y,
		int	totalMarge,
		int	w,
		int	h,
		int	padding,
		const vec4_t	bgcolor,
		const vec4_t	color )

Definition at line 1508 of file cl_game.cpp.

References GAME_GetCurrentType().

Referenced by uiBaseLayoutNode::draw().

◆ GAME_DrawBaseLayoutTooltip()

void GAME_DrawBaseLayoutTooltip	(	int	baseIdx,
		int	x,
		int	y )

Cgame callback to draw tooltip for baselayout UI node.

Parameters

[in]	baseIdx	Numeric index of the base
[in]	x	Horizontal screen position
[in]	y	Vertical screen position

Definition at line 1521 of file cl_game.cpp.

References GAME_GetCurrentType().

Referenced by uiBaseLayoutNode::drawTooltip().

◆ GAME_DrawMap()

void GAME_DrawMap ( geoscapeData_t * data )

Definition at line 931 of file cl_game.cpp.

References data, and GAME_GetCurrentType().

Referenced by uiGeoscapeNode::draw().

◆ GAME_DrawMapMarkers()

void GAME_DrawMapMarkers ( uiNode_t * node )

Definition at line 938 of file cl_game.cpp.

References GAME_GetCurrentType().

Referenced by uiGeoscapeNode::draw().

◆ GAME_Drop()

void GAME_Drop ( void )

Definition at line 1467 of file cl_game.cpp.

References GAME_GetCurrentType(), GAME_SetMode(), GAME_UnloadGame(), SV_Shutdown(), and UI_InitStack().

Referenced by CL_Drop().

◆ GAME_EndBattlescape()

void GAME_EndBattlescape ( void )

This is called when a client quits the battlescape.

See also: GAME_StartBattlescape

Definition at line 314 of file cl_game.cpp.

References cls, Com_Printf(), and Cvar_Set().

Referenced by CL_Disconnect().

◆ GAME_EndRoundAnnounce()

void GAME_EndRoundAnnounce	(	int	playerNum,
		int	team )

Send end round announcements.

Parameters

playerNum	The server player number of the player that has ended the round
team	The team the player is in

Todo: do we need the team number here? isn't the playernum enough to get the team?

Definition at line 325 of file cl_game.cpp.

References GAME_GetCurrentType().

Referenced by CL_EndRoundAnnounce().

◆ GAME_Frame()

void GAME_Frame ( void )

Called every frame and allows us to hook into the current running game mode.

Definition at line 1496 of file cl_game.cpp.

References cls, GAME_GetCurrentType(), and key_console.

Referenced by CL_Frame().

◆ GAME_GenerateTeam()

void GAME_GenerateTeam	(	const char *	teamDefID,
		const equipDef_t *	ed,
		int	teamMembers )

Definition at line 276 of file cl_game.cpp.

References Com_Error(), ERR_DROP, GAME_AppendTeamMember(), GAME_GetCharacterArraySize(), GAME_ResetCharacters(), and i.

Referenced by GAME_AutoTeam(), and GAME_Spawn().

◆ GAME_GetAbsoluteSavePath()

const char * GAME_GetAbsoluteSavePath	(	char *	buf,
		size_t	bufSize )

Definition at line 1417 of file cl_game.cpp.

References bufSize, Com_sprintf(), FS_Gamedir(), and GAME_GetCurrentName().

Referenced by GAME_GetImportData(), GAME_TeamDelete_f(), and GAME_TeamSlotComments_f().

◆ GAME_GetCharacter()

character_t * GAME_GetCharacter ( int index )

Returns a character that can be used to store the game type specific character values.

Note: The returned pointer is a reference to static memory

Parameters

index The index of the character array. This value must be greater than 0 and not bigger than the value GAME_GetCharacterArraySize returned

See also: GAME_GetCharacterArraySize; GAME_ResetCharacters

Returns: A character slot

Definition at line 197 of file cl_game.cpp.

References characters, Com_Error(), ERR_DROP, index, and lengthof.

Referenced by GAME_AppendTeamMember(), and GAME_LoadTeamInfo().

◆ GAME_GetCharacterArraySize()

size_t GAME_GetCharacterArraySize ( void )

Returns: The size of the static character array

See also: GAME_GetCharacter; GAME_ResetCharacters

Definition at line 227 of file cl_game.cpp.

References characters, and lengthof.

Referenced by GAME_AutoTeam_f(), GAME_GenerateTeam(), GAME_GetImportData(), GAME_LoadTeamInfo(), GAME_Spawn(), and cgame_import_t::size_t().

◆ GAME_GetCharacterByUCN()

character_t * GAME_GetCharacterByUCN ( int ucn )

Returns a character that can be used to store the game type specific character values.

Note: The returned pointer is a reference to static memory

Parameters

ucn	The unique character number

Returns: null if no character with the specified ucn was found.

Definition at line 211 of file cl_game.cpp.

References characters, i, lengthof, and character_t::ucn.

◆ GAME_GetChrMaxLoad()

int GAME_GetChrMaxLoad ( const character_t * chr )

Returns the max weight the given character can carry.

Parameters

[in] chr The character to find the max load for.

Returns: The max load the character can carry or NONE.

Definition at line 1577 of file cl_game.cpp.

References ABILITY_POWER, GAME_GetCurrentType(), NONE, character_t::score, and chrScoreGlobal_t::skills.

Referenced by CL_ActorInvMove(), GAME_AppendTeamMember(), GAME_GetImportData(), GAME_LoadCharacter(), HUD_UpdateActorLoad_f(), cgame_import_t::int(), INV_MoveItem(), and INV_UpdateActorLoad_f().

◆ GAME_GetCurrentName()

const char * GAME_GetCurrentName ( void )

Definition at line 232 of file cl_game.cpp.

References GAME_GetCurrentType(), and cgame_export_t::menu.

Referenced by GAME_GetAbsoluteSavePath(), GAME_GetRelativeSavePath(), GAME_WebDelete(), GAME_WebDownloadFromUser(), GAME_WebListForUser(), GAME_WebUpload(), WEB_DeleteCGame_f(), WEB_DownloadCGame_f(), WEB_ListCGame_f(), and WEB_UploadCGame_f().

◆ GAME_GetCurrentSelectedMap()

const mapDef_t * GAME_GetCurrentSelectedMap ( void )

Definition at line 921 of file cl_game.cpp.

References cls, and Com_GetMapDefByIDX().

Referenced by GAME_GetImportData().

◆ GAME_GetCurrentTeam()

int GAME_GetCurrentTeam ( void )

Definition at line 926 of file cl_game.cpp.

References cls.

Referenced by GAME_GetImportData(), and cgame_import_t::int().

◆ GAME_GetEquipmentDefinition()

equipDef_t * GAME_GetEquipmentDefinition ( void )

Definition at line 1423 of file cl_game.cpp.

References equipDefStandard, GAME_GetCurrentType(), and cgame_export_t::GetEquipmentDefinition().

Referenced by CL_InvReload(), GAME_GetEquipment(), GAME_LoadTeam(), and GAME_SaveTeam().

◆ GAME_GetModelForItem()

const char * GAME_GetModelForItem	(	const objDef_t *	od,
		struct uiModel_s **	menuModel )

References data.

◆ GAME_GetRelativeSavePath()

const char * GAME_GetRelativeSavePath	(	char *	buf,
		size_t	bufSize )

Definition at line 1411 of file cl_game.cpp.

References bufSize, Com_sprintf(), and GAME_GetCurrentName().

Referenced by GAME_GetImportData(), GAME_GetTeamFileName(), GAME_TeamGetFreeFilename(), GAME_TeamSlotComments_f(), WEB_CGameDownloadFromUser(), and WEB_UploadCGame_f().

◆ GAME_GetSelectedChr()

character_t * GAME_GetSelectedChr ( void )

Returns the currently selected character.

Returns: The selected character or nullptr.

Definition at line 1555 of file cl_game.cpp.

References chrDisplayList, Cvar_GetInteger(), GAME_GetCurrentType(), cgame_export_t::GetSelectedChr(), and LIST_Foreach.

Referenced by INV_MoveItem(), and INV_UpdateActorLoad_f().

◆ GAME_GetTeamDef()

const char * GAME_GetTeamDef ( void )

Definition at line 1251 of file cl_game.cpp.

References Cvar_GetString(), GAME_GetCurrentType(), and cgame_export_t::GetTeamDef().

Referenced by GAME_AutoTeam(), GAME_ItemIsUseable(), and GAME_Spawn().

◆ GAME_HandleResults()

void GAME_HandleResults	(	dbuffer *	msg,
		int	winner,
		int *	numSpawned,
		int *	numAlive,
		int	numKilled[][MAX_TEAMS],
		int	numStunned[][MAX_TEAMS],
		bool	nextmap )

After a mission was finished this function is called.

Parameters

msg	The network message buffer
winner	The winning team or -1 if it was a draw
numSpawned	The amounts of all spawned actors per team
numAlive	The amount of survivors per team
numKilled	The amount of killed actors for all teams. The first dimension contains the attacker team, the second the victim team
numStunned	The amount of stunned actors for all teams. The first dimension contains the attacker team, the second the victim team
nextmap	Indicates if there is another map to follow within the same msission