UFO: Alien Invasion
cgame_export_t Struct Reference

#include <cgame.h>

Collaboration diagram for cgame_export_t:
Collaboration graph

Public Member Functions

 void (EXPORT *Init)(void)
 
 void (EXPORT *Shutdown)(void)
 
 bool (EXPORT *Spawn)(linkedList_t **chrList)
 
const mapDef_t *EXPORTMapInfo (int step)
 
 void (EXPORT *Results)(dbuffer *msg
 
 bool (EXPORT *IsItemUseable)(const objDef_t *od)
 
const char *EXPORTGetModelForItem (const char *string)
 
equipDef_t *EXPORTGetEquipmentDefinition (void)
 
 void (EXPORT *UpdateCharacterValues)(const character_t *chr)
 
 bool (EXPORT *IsTeamKnown)(const teamDef_t *teamDef)
 
character_t *EXPORTGetSelectedChr (void)
 
 int (EXPORT *GetChrMaxLoad)(const character_t *chr)
 
 void (EXPORT *Drop)(void)
 
 void (EXPORT *InitializeBattlescape)(dbuffer *msg
 
 void (EXPORT *RunFrame)(float secondsSinceLastFrame)
 
 void (EXPORT *DrawBaseLayout)(int baseIdx
 
 void (EXPORT *DrawBaseLayoutTooltip)(int baseIdx
 
 void (EXPORT *EndRoundAnnounce)(int playerNum
 
 void (EXPORT *StartBattlescape)(bool isTeamPlay)
 
 void (EXPORT *InitMissionBriefing)(const char **title
 
const char *EXPORTGetTeamDef (void)
 
 void (EXPORT *NotifyEvent)(event_t eventType)
 
 void (EXPORT *AddChatMessage)(const char *message)
 
 bool (EXPORT *HandleServerCommand)(const char *command
 
 void (EXPORT *MapDraw)(geoscapeData_t *data)
 
 void (EXPORT *MapDrawMarkers)(const uiNode_t *node)
 
 bool (EXPORT *MapClick)(const uiNode_t *node
 

Data Fields

const char * name
 
const char * menu
 
int isMultiplayer
 
 int
 
int int int [][MAX_TEAMS]
 
int int bool nextmap
 
const linkedList_tteam
 
int x
 
int int y
 
int int int totalMarge
 
int int int int w
 
int int int int int h
 
int int int int int int padding
 
int int int int int int const vec4_t bgcolor
 
int int int int int int const vec4_t const vec4_t color
 
int team
 
linkedList_t ** victoryConditionsMsgIDs
 
linkedList_t linkedList_t ** missionBriefingMsgIDs
 
dbuffermsg
 
int int const vec2_t pos
 

Detailed Description

Definition at line 36 of file cgame.h.

Member Function Documentation

◆ bool() [1/5]

cgame_export_t::bool ( EXPORT HandleServerCommand) const

◆ bool() [2/5]

cgame_export_t::bool ( EXPORT IsItemUseable) const

check whether the given item is usable in the current game mode

◆ bool() [3/5]

cgame_export_t::bool ( EXPORT IsTeamKnown) const

checks whether the given team is known in the particular gamemode

◆ bool() [4/5]

cgame_export_t::bool ( EXPORT MapClick) const

◆ bool() [5/5]

cgame_export_t::bool ( EXPORT Spawn)

soldier spawn functions may differ between the different gametypes

◆ GetEquipmentDefinition()

equipDef_t *EXPORT * cgame_export_t::GetEquipmentDefinition ( void  )

returns the equipment definition the game mode is using

Referenced by GAME_GetEquipmentDefinition(), and GetCGameAPI().

◆ GetModelForItem()

const char *EXPORT * cgame_export_t::GetModelForItem ( const char *  string)

if you want to display a different model for the given object in your game mode, implement this function

Referenced by GAME_DisplayItemInfo(), GAME_GetModelForItem(), and GetCGameAPI().

◆ GetSelectedChr()

character_t *EXPORT * cgame_export_t::GetSelectedChr ( void  )

returns the selected character

Referenced by GAME_GetSelectedChr(), and GetCGameAPI().

◆ GetTeamDef()

const char *EXPORT * cgame_export_t::GetTeamDef ( void  )

Referenced by GAME_GetTeamDef(), and GetCGameAPI().

◆ int()

cgame_export_t::int ( EXPORT GetChrMaxLoad) const

if you want to have a different control on how much a soldier can carry implement this (but max is still limited to actor strength)

◆ MapInfo()

const mapDef_t *EXPORT * cgame_export_t::MapInfo ( int  step)

some gametypes only support special maps

Referenced by GetCGameAPI(), and UI_MapInfo().

◆ void() [1/16]

cgame_export_t::void ( EXPORT AddChatMessage) const

◆ void() [2/16]

cgame_export_t::void ( EXPORT DrawBaseLayout)

◆ void() [3/16]

cgame_export_t::void ( EXPORT DrawBaseLayoutTooltip)

◆ void() [4/16]

cgame_export_t::void ( EXPORT Drop)

called on errors

◆ void() [5/16]

cgame_export_t::void ( EXPORT EndRoundAnnounce)

◆ void() [6/16]

cgame_export_t::void ( EXPORT Init)

◆ void() [7/16]

cgame_export_t::void ( EXPORT InitializeBattlescape)

called after the team spawn messages where send, can e.g. be used to set initial actor states

◆ void() [8/16]

cgame_export_t::void ( EXPORT InitMissionBriefing) const

◆ void() [9/16]

cgame_export_t::void ( EXPORT MapDraw)

◆ void() [10/16]

cgame_export_t::void ( EXPORT MapDrawMarkers) const

◆ void() [11/16]

cgame_export_t::void ( EXPORT NotifyEvent)

◆ void() [12/16]

cgame_export_t::void ( EXPORT Results)

some gametypes require extra data in the results parsing (like e.g. campaign mode)

◆ void() [13/16]

cgame_export_t::void ( EXPORT RunFrame)

callback that is executed every frame

◆ void() [14/16]

cgame_export_t::void ( EXPORT Shutdown)

◆ void() [15/16]

cgame_export_t::void ( EXPORT StartBattlescape)

◆ void() [16/16]

cgame_export_t::void ( EXPORT UpdateCharacterValues) const

update character display values for game type dependent stuff

Field Documentation

◆ bgcolor

int int int int int int const vec4_t cgame_export_t::bgcolor

Definition at line 69 of file cgame.h.

◆ color

int int int int int int const vec4_t const vec4_t cgame_export_t::color

Definition at line 69 of file cgame.h.

◆ h

int int int int int cgame_export_t::h

Definition at line 69 of file cgame.h.

◆ int [1/2]

int int cgame_export_t::int

Definition at line 48 of file cgame.h.

◆ int [2/2]

int int cgame_export_t::int[][MAX_TEAMS]

Definition at line 48 of file cgame.h.

◆ isMultiplayer

int cgame_export_t::isMultiplayer

Definition at line 40 of file cgame.h.

Referenced by GAME_InitUIData(), GAME_IsMultiplayer(), and GetCGameAPI().

◆ menu

const char* cgame_export_t::menu

Definition at line 39 of file cgame.h.

Referenced by GAME_GetCurrentName(), GAME_SetMode(), and GetCGameAPI().

◆ missionBriefingMsgIDs

linkedList_t linkedList_t** cgame_export_t::missionBriefingMsgIDs

Definition at line 73 of file cgame.h.

◆ msg

dbuffer* cgame_export_t::msg

Definition at line 77 of file cgame.h.

◆ name

const char* cgame_export_t::name

the name of this cgame mode - only for console output

Definition at line 38 of file cgame.h.

Referenced by GAME_SetMode(), GetCGameAPI(), GAMECvarListener::onGameModeChange(), and GAMECmdListener::onGameModeChange().

◆ nextmap

int int bool cgame_export_t::nextmap

Definition at line 48 of file cgame.h.

◆ padding

int int int int int int cgame_export_t::padding

Definition at line 69 of file cgame.h.

◆ pos

int int const vec2_t cgame_export_t::pos

Definition at line 81 of file cgame.h.

◆ team [1/2]

const linkedList_t* cgame_export_t::team

Definition at line 66 of file cgame.h.

◆ team [2/2]

int cgame_export_t::team

Definition at line 71 of file cgame.h.

◆ totalMarge

int int int cgame_export_t::totalMarge

Definition at line 69 of file cgame.h.

◆ victoryConditionsMsgIDs

linkedList_t** cgame_export_t::victoryConditionsMsgIDs

Definition at line 73 of file cgame.h.

◆ w

int int int int cgame_export_t::w

Definition at line 69 of file cgame.h.

◆ x

int cgame_export_t::x

Definition at line 69 of file cgame.h.

◆ y

int int cgame_export_t::y

Definition at line 69 of file cgame.h.


The documentation for this struct was generated from the following file: