cp_event.h File Reference

Header for geoscape event related stuff. More...

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

Go to the source code of this file.

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
Defines
#define	MAX_EVENTMAILS   64
#define	MAX_CAMPAIGNEVENTS   128
Typedefs
typedef struct eventMail_s	eventMail_t
	available mails for a tech - mail and mail_pre in script files
typedef struct campaignEvent_s	campaignEvent_t
	Defines campaign events when story related technologies should be researched.
typedef struct campaignEvents_s	campaignEvents_t
Functions
void	CL_EventAddMail_f (void)
void	CL_ParseEventMails (const char *name, const char **text)
eventMail_t *	CL_GetEventMail (const char *id, qboolean createCopy)
	Searches all event mails for a given id.
eventMail_t *	CL_NewEventMail (const char *id, const char *newID, const char *body)
	Use this function to create new eventmails with dynamic body content.
void	CL_FreeDynamicEventMail (void)
	Make sure, that the linked list is freed with every new game.
void	CP_CheckCampaignEvents (void)
void	CL_ParseCampaignEvents (const char *name, const char **text)
const campaignEvents_t *	CP_GetEventsByID (const char *name)

---

Detailed Description

Header for geoscape event related stuff.

Definition in file cp_event.h.

---

Define Documentation

#define MAX_CAMPAIGNEVENTS   128

Definition at line 30 of file cp_event.h.

Referenced by CL_ParseCampaignEvents().

#define MAX_EVENTMAILS   64

Definition at line 29 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>'

---

Function Documentation

void CL_EventAddMail_f

(

void

)

See also:

UP_OpenMail_f

MS_AddNewMessage

UP_SetMailHeader

UP_OpenEventMail

Definition at line 331 of file cp_event.c.

References _, eventMail_s::body, ccs, CL_DateConvertLong(), CL_GetEventMail(), Cmd_Argc(), Cmd_Argv(), Com_Printf(), Com_sprintf(), cp_campaignPool, ccs_s::date, eventMail_s::date, Date_GetMonthName(), dateLong_s::day, message_s::eventMail, eventMail_s::from, m, MAX_VAR, Mem_PoolStrDup, dateLong_s::month, MS_AddNewMessage(), MSG_EVENT, qfalse, eventMail_s::subject, eventMail_s::to, va(), and dateLong_s::year.

void CL_FreeDynamicEventMail

(

void

)

Make sure, that the linked list is freed with every new game.

See also:

CL_ResetSinglePlayerData

Definition at line 95 of file cp_event.c.

References LIST_Delete().

Referenced by CL_ResetSinglePlayerData().

eventMail_t* CL_GetEventMail	(	const char *	id,
		qboolean	createCopy
	)

Searches all event mails for a given id.

Note:

Might also return NULL - always check the return value

If you want to create mails that base on a script defintion but have differnet body messages, set createCopy to true

Parameters:

[in]	id	The id from the script files
[in]	createCopy	Don't return the link to ccs.eventMails but allocate memory and copy the gd.eventMail memory over to the newly allocated. Don't use createCopy on dynamic mails

See also:

UP_SetMailHeader

CL_NewEventMail

Definition at line 45 of file cp_event.c.

References ccs, cp_campaignPool, linkedList_s::data, ccs_s::eventMails, i, eventMail_s::id, LIST_AddPointer(), Mem_PoolAlloc, linkedList_s::next, and ccs_s::numEventMails.

Referenced by CL_EventAddMail_f(), CL_NewEventMail(), MS_LoadXML(), and UP_OpenEventMail().

eventMail_t* CL_NewEventMail	(	const char *	id,
		const char *	newID,
		const char *	body
	)

Use this function to create new eventmails with dynamic body content.

See also:

CL_GetEventMail

Note:

The pointers in the original eventmail are not freed - we still need this memory later!!

See also:

CL_ResetSinglePlayerData

UR_SendMail

Parameters:

[in]	id	eventmail id of the source mail parsed from events.ufo
[in]	newID	the new id for the dynamic mail (needed to seperate the new mail from the source mail to let CL_GetEventMail be able to find it afterwards)
[in]	body	The body of the new mail - this may also be NULL if you need the original body of the source mail that was parsed from events.ufo

Definition at line 114 of file cp_event.c.

References eventMail_s::body, CL_GetEventMail(), cp_campaignPool, eventMail_s::id, Mem_PoolStrDup, and qtrue.

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

See also:

CL_ParseScriptFirst

Note:

write into cp_campaignPool - free on every game restart and reparse

Definition at line 269 of file cp_event.c.

References campaignEvents_s::campaignEvents, ccs_s::campaignEvents, ccs, Com_DPrintf(), Com_EParse(), Com_EParseValue(), Com_Printf(), cp_campaignPool, DEBUG_CLIENT, events, campaignEvents_s::id, campaignEvent_s::interest, MAX_CAMPAIGNEVENTS, MAX_CAMPAIGNS, Mem_PoolStrDup, Mem_PoolStrDupTo, ccs_s::numCampaignEventDefinitions, campaignEvents_s::numCampaignEvents, Sys_Error(), campaignEvent_s::tech, and V_INT.

Referenced by CL_ParseScriptFirst().

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

See also:

CL_ParseScriptFirst

Note:

write into cp_campaignPool - free on every game restart and reparse

Definition at line 153 of file cp_event.c.

References ccs, Com_DPrintf(), Com_EParse(), Com_EParseValue(), Com_Parse(), Com_Printf(), cp_campaignPool, DEBUG_CLIENT, ccs_s::eventMails, eventMail_s::id, MAX_EVENTMAILS, Mem_PoolStrDup, Mem_PoolStrDupTo, ccs_s::numEventMails, value_s::ofs, value_s::size, value_s::string, value_s::type, V_CLIENT_HUNK_STRING, and V_TRANSLATION_STRING.

Referenced by CL_ParseScriptFirst().

void CP_CheckCampaignEvents

(

void

)

Definition at line 216 of file cp_event.c.

References campaignEvents_s::campaignEvents, ccs, ccs_s::curCampaign, campaign_s::events, events, i, campaignEvents_s::numCampaignEvents, ccs_s::overallInterest, and RS_MarkStoryLineEventResearched().

Referenced by CL_CampaignRun().

const campaignEvents_t* CP_GetEventsByID

(

const char *

name

)

Will return the campaign related events

Note:

Also performs some sanity check

Parameters:

name

The events id

Definition at line 245 of file cp_event.c.

References campaignEvents_s::campaignEvents, ccs_s::campaignEvents, ccs, events, i, campaignEvents_s::id, ccs_s::numCampaignEventDefinitions, campaignEvents_s::numCampaignEvents, RS_GetTechByID(), and Sys_Error().

Referenced by CL_ParseCampaign().