Header for geoscape event related stuff. More...

Data Structures
struct	eventMail_s
	available mails for a tech - mail and mail_pre in script files More...

struct	campaignEvent_s
	Defines campaign events when story related technologies should be researched. More...

struct	campaignEvents_s

struct	campaignTriggerEvent_t

Macros
#define	MAX_EVENTMAILS 64

#define	MAX_CAMPAIGNEVENTS 128

#define	MAX_CAMPAIGN_TRIGGER_EVENTS 32

Typedefs
typedef struct eventMail_s	eventMail_t
	available mails for a tech - mail and mail_pre in script files More...

typedef struct campaignEvent_s	campaignEvent_t
	Defines campaign events when story related technologies should be researched. More...

typedef struct campaignEvents_s	campaignEvents_t

Enumerations
enum	campaignTriggerEventType_t { NEW_DAY, UFO_DETECTION, CAPTURED_ALIENS_DIED, CAPTURED_ALIENS, ALIENBASE_DISCOVERED }
	events that are triggered by the campaign More...

Functions
void	CL_EventAddMail_f (void)

void	CL_ParseEventMails (const char name, const char *text)

eventMail_t *	CL_GetEventMail (const char *id)
	Searches all event mails for a given id. More...

void	CP_FreeDynamicEventMail (void)
	Make sure, that the linked list is freed with every new game. More...

void	CL_EventAddMail (const char *eventMailId)
	Adds the event mail to the message stack. This message is going to be added to the savegame. More...

void	CP_CheckCampaignEvents (struct campaign_s *campaign)

void	CL_ParseCampaignEvents (const char name, const char *text)

void	CP_ParseEventTrigger (const char name, const char *text)

bool	CP_TriggerEventLoadXML (xmlNode_t *p)

bool	CP_TriggerEventSaveXML (xmlNode_t *p)

void	CP_TriggerEvent (campaignTriggerEventType_t type, const void *userdata=nullptr)
	Triggers a campaign event with a special type. More...

const campaignEvents_t *	CP_GetEventsByID (const char *name)

Detailed Description

Header for geoscape event related stuff.

Definition in file cp_event.h.

Macro Definition Documentation

#define MAX_CAMPAIGN_TRIGGER_EVENTS 32

Definition at line 96 of file cp_event.h.

Referenced by CP_ParseEventTrigger().

#define MAX_CAMPAIGNEVENTS 128

Definition at line 29 of file cp_event.h.

Referenced by CL_ParseCampaignEvents().

#define MAX_EVENTMAILS 64

Definition at line 28 of file cp_event.h.

Referenced by CL_ParseEventMails().

Typedef Documentation

typedef struct campaignEvent_s campaignEvent_t

Defines campaign events when story related technologies should be researched.

typedef struct campaignEvents_s campaignEvents_t

typedef struct eventMail_s eventMail_t

available mails for a tech - mail and mail_pre in script files

See also: techMail_t

Note: Parsed via CL_ParseEventMails; You can add a mail to the message system and mail client by using e.g. the mission triggers with the script command 'addeventmail <id>'

Enumeration Type Documentation

enum campaignTriggerEventType_t

events that are triggered by the campaign

Enumerator
NEW_DAY
UFO_DETECTION
CAPTURED_ALIENS_DIED
CAPTURED_ALIENS
ALIENBASE_DISCOVERED

Definition at line 78 of file cp_event.h.

Function Documentation

void CL_EventAddMail ( const char * eventMailId )

Adds the event mail to the message stack. This message is going to be added to the savegame.

Definition at line 508 of file cp_event.cpp.

References _, eventMail_s::body, ccs, cgi, CL_GetEventMail(), Com_sprintf(), cp_campaignPool, CP_DateConvertLong(), eventMail_s::date, ccs_s::date, Date_GetMonthName(), dateLong_s::day, uiMessageListNodeMessage_s::eventMail, eventMail_s::from, m, MAX_VAR, dateLong_s::month, MS_AddNewMessage(), MSG_EVENT, cgame_import_s::PoolStrDup(), eventMail_s::sent, eventMail_s::skipMessage, eventMail_s::subject, eventMail_s::to, UP_OpenEventMail(), va(), and dateLong_s::year.

Referenced by CL_EventAddMail_f(), CP_CampaignInit(), and CP_SpawnUFOCarrier_f().

void CL_EventAddMail_f ( void )

See also: UP_OpenMail_f; MS_AddNewMessage; UP_SetMailHeader; UP_OpenEventMail

Definition at line 554 of file cp_event.cpp.

References cgi, CL_EventAddMail(), and cgame_import_s::Cmd_Argv().

eventMail_t* CL_GetEventMail ( const char * id )

Searches all event mails for a given id.

Note: Might also return nullptr - always check the return value; If you want to create mails that base on a script definition but have different body messages, set createCopy to true

Parameters

[in] id The id from the script files

Definition at line 44 of file cp_event.cpp.

References ccs, ccs_s::eventMails, i, eventMail_s::id, LIST_Foreach, ccs_s::numEventMails, and Q_streq.

Referenced by CL_EventAddMail(), MS_LoadXML(), and UP_OpenEventMail().