Geoscape event implementation. More...

#include "../../DateTime.h"
#include "../../cl_shared.h"
#include "../../../shared/parse.h"
#include "../../../common/binaryexpressionparser.h"
#include "cp_campaign.h"
#include "cp_time.h"
#include "cp_xvi.h"
#include "cp_event_callbacks.h"
#include "save/save_triggerevents.h"

Include dependency graph for cp_event.cpp:

Go to the source code of this file.

Macros
#define	EVENTCONSTANTS_NAMESPACE "eventTrigger::"

Functions
eventMail_t *	CL_GetEventMail (const char *id)
	Searches all event mails for a given id.
void	CP_FreeDynamicEventMail (void)
	Make sure, that the linked list is freed with every new game.
void	CL_ParseEventMails (const char name, const char *text)
void	CP_CheckCampaignEvents (campaign_t *campaign)
const campaignEvents_t *	CP_GetEventsByID (const char *name)
static int	CP_CheckTriggerEvent (const char expression, const void userdata)
void	CP_TriggerEvent (campaignTriggerEventType_t type, const void *userdata)
	Triggers a campaign event with a special type.
void	CP_ParseEventTrigger (const char name, const char *text)
bool	CP_TriggerEventSaveXML (xmlNode_t *p)
bool	CP_TriggerEventLoadXML (xmlNode_t *p)
void	CL_ParseCampaignEvents (const char name, const char *text)
void	CL_EventAddMail (const char *eventMailId)
	Adds the event mail to the message stack. This message is going to be added to the savegame.
void	CL_EventAddMail_f (void)

Variables
static linkedList_t *	eventMails = nullptr
static const value_t	eventMail_vals []
	Valid event mail parameters.
static const value_t	event_vals []
	Valid event mail parameters.
static const constListEntry_t	eventConstants []

Detailed Description

Geoscape event implementation.

Definition in file cp_event.cpp.

Macro Definition Documentation

◆ EVENTCONSTANTS_NAMESPACE

#define EVENTCONSTANTS_NAMESPACE "eventTrigger::"

Definition at line 348 of file cp_event.cpp.

Function Documentation

◆ CL_EventAddMail()

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 507 of file cp_event.cpp.

References _, eventMail_t::body, ccs, cgi, CL_GetEventMail(), Com_sprintf(), cp_campaignPool, CP_DateConvertLong(), eventMail_t::date, Date_GetMonthName(), dateLong_t::day, eventMail_t::from, m, MAX_VAR, dateLong_t::month, MS_AddNewMessage(), MSG_EVENT, eventMail_t::sent, eventMail_t::skipMessage, eventMail_t::subject, eventMail_t::to, UP_OpenEventMail(), va(), and dateLong_t::year.

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

◆ CL_EventAddMail_f()

void CL_EventAddMail_f ( void )

See also: UP_OpenMail_f; MS_AddNewMessage; UP_SetMailHeader; UP_OpenEventMail

Definition at line 553 of file cp_event.cpp.

References cgi, and CL_EventAddMail().

◆ CL_GetEventMail()

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 45 of file cp_event.cpp.

References ccs, eventMails, i, eventMail_t::id, LIST_Foreach, and Q_streq.

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

◆ CL_ParseCampaignEvents()

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 448 of file cp_event.cpp.

References ccs, cgi, cp_campaignPool, DEBUG_CLIENT, events, campaignEvent_t::interest, MAX_CAMPAIGNEVENTS, MAX_CAMPAIGNS, name, OBJZERO, Sys_Error(), campaignEvent_t::tech, and V_INT.

Referenced by CP_ParseScriptFirst().

◆ CL_ParseEventMails()

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 93 of file cp_event.cpp.

References ccs, cgi, cp_campaignPool, DEBUG_CLIENT, eventMail_vals, eventMail_t::id, MAX_EVENTMAILS, name, and OBJZERO.

Referenced by CP_ParseScriptFirst().

◆ CP_CheckCampaignEvents()

void CP_CheckCampaignEvents ( campaign_t * campaign )

Definition at line 113 of file cp_event.cpp.

References ccs, campaign_t::events, events, i, and RS_MarkStoryLineEventResearched().

Referenced by CP_CampaignRun().

◆ CP_CheckTriggerEvent()

int CP_CheckTriggerEvent	(	const char *	expression,
		const void *	userdata )

static

Definition at line 156 of file cp_event.cpp.

References aircraftSlot_t::ammoLeft, ccs, cgi, CP_GetAverageXVIRate(), nationInfo_t::happiness, i, INS_ForeachOfType, INS_GetType(), INS_HasType(), INSTALLATION_DEFENCE, INSTALLATION_NOT_USED, INSTALLATION_WORKING, MAX_VAR, NAT_Foreach, NAT_GetCurrentMonthInfo(), Q_streq, Q_strncpyz(), Q_strnull(), Q_strstart(), RS_GetTechByID(), RS_IsResearched_ptr(), type, and nationInfo_t::xviInfection.

Referenced by CP_TriggerEvent().

◆ CP_FreeDynamicEventMail()

void CP_FreeDynamicEventMail ( void )

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

See also: CP_ResetCampaignData

Definition at line 67 of file cp_event.cpp.

References cgi, and eventMails.

Referenced by CP_ResetCampaignData().

◆ CP_GetEventsByID()

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 139 of file cp_event.cpp.

References ccs, events, i, name, Q_streq, RS_GetTechByID(), and Sys_Error().

Referenced by CP_ParseCampaign().

◆ CP_ParseEventTrigger()

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

Definition at line 359 of file cp_event.cpp.

References ccs, cgi, cp_campaignPool, DEBUG_CLIENT, event_vals, eventConstants, MAX_CAMPAIGN_TRIGGER_EVENTS, name, and OBJZERO.

Referenced by CP_ParseScriptFirst().

◆ CP_TriggerEvent()

void CP_TriggerEvent	(	campaignTriggerEventType_t	type,
		const void *	userdata )

Triggers a campaign event with a special type.

Parameters

[in]	type	the event type
[in]	userdata	Any userdata that is passed to the bep checker function

Definition at line 310 of file cp_event.cpp.

References ccs, cgi, CP_CampaignTriggerFunctions(), CP_CheckTriggerEvent(), i, Q_strvalid, and type.

Referenced by AL_AddAliens(), CP_CampaignRun(), CP_SpawnAlienBaseMission(), TEST_F(), and UFO_DetectNewUFO().

◆ CP_TriggerEventLoadXML()

bool CP_TriggerEventLoadXML ( xmlNode_t * p )

Definition at line 419 of file cp_event.cpp.

References ccs, cgi, i, Q_streq, SAVE_TRIGGEREVENTS_NAME, SAVE_TRIGGEREVENTS_STATE, SAVE_TRIGGEREVENTS_TRIGGEREVENT, SAVE_TRIGGEREVENTS_TRIGGEREVENTS, and xmlNode_t.

Referenced by SAV_Init().

◆ CP_TriggerEventSaveXML()

bool CP_TriggerEventSaveXML ( xmlNode_t * p )

Definition at line 401 of file cp_event.cpp.

References ccs, cgi, i, SAVE_TRIGGEREVENTS_NAME, SAVE_TRIGGEREVENTS_STATE, SAVE_TRIGGEREVENTS_TRIGGEREVENT, SAVE_TRIGGEREVENTS_TRIGGEREVENTS, and xmlNode_t.

Referenced by SAV_Init().

Variable Documentation

◆ event_vals

const value_t event_vals[]

static

Initial value:

                                = {
    {"type", V_INT, offsetof(campaignTriggerEvent_t, type), MEMBER_SIZEOF(campaignTriggerEvent_t, type)},
    {"require", V_HUNK_STRING, offsetof(campaignTriggerEvent_t, require), 0},
    {"reactivate", V_HUNK_STRING, offsetof(campaignTriggerEvent_t, reactivate), 0},
    {"command", V_HUNK_STRING, offsetof(campaignTriggerEvent_t, command), 0},
    {"once", V_BOOL, offsetof(campaignTriggerEvent_t, once), MEMBER_SIZEOF(campaignTriggerEvent_t, once)},
 
    {nullptr, V_NULL, 0, 0}
}

Valid event mail parameters.

Definition at line 338 of file cp_event.cpp.

Referenced by CP_ParseEventTrigger().

◆ eventConstants

const constListEntry_t eventConstants[]

static

Initial value:

                                             = {
    {EVENTCONSTANTS_NAMESPACE "new_day", NEW_DAY},
    {EVENTCONSTANTS_NAMESPACE "ufo_detection", UFO_DETECTION},
    {EVENTCONSTANTS_NAMESPACE "captured_aliens_died", CAPTURED_ALIENS_DIED},
    {EVENTCONSTANTS_NAMESPACE "captured_aliens", CAPTURED_ALIENS},
    {EVENTCONSTANTS_NAMESPACE "alienbase_discovered", ALIENBASE_DISCOVERED},
 
    {nullptr, -1}
}

Definition at line 349 of file cp_event.cpp.

Referenced by CP_ParseEventTrigger().

◆ eventMail_vals

const value_t eventMail_vals[]

static

Initial value:

                                    = {
    {"subject", V_TRANSLATION_STRING, offsetof(eventMail_t, subject), 0},
    {"from", V_TRANSLATION_STRING, offsetof(eventMail_t, from), 0},
    {"to", V_TRANSLATION_STRING, offsetof(eventMail_t, to), 0},
    {"cc", V_TRANSLATION_STRING, offsetof(eventMail_t, cc), 0},
    {"date", V_TRANSLATION_STRING, offsetof(eventMail_t, date), 0},
    {"body", V_TRANSLATION_STRING, offsetof(eventMail_t, body), 0},
    {"icon", V_HUNK_STRING, offsetof(eventMail_t, icon), 0},
    {"model", V_HUNK_STRING, offsetof(eventMail_t, model), 0},
    {"skipmessage", V_BOOL, offsetof(eventMail_t, skipMessage), MEMBER_SIZEOF(eventMail_t, skipMessage)},
 
    {nullptr, V_NULL, 0, 0}
}

Valid event mail parameters.

Definition at line 75 of file cp_event.cpp.

Referenced by CL_ParseEventMails().

◆ eventMails

linkedList_t* eventMails = nullptr

static

Definition at line 36 of file cp_event.cpp.

Referenced by CL_GetEventMail(), and CP_FreeDynamicEventMail().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ EVENTCONSTANTS_NAMESPACE

Function Documentation

◆ CL_EventAddMail()

◆ CL_EventAddMail_f()

◆ CL_GetEventMail()

◆ CL_ParseCampaignEvents()

◆ CL_ParseEventMails()

◆ CP_CheckCampaignEvents()

◆ CP_CheckTriggerEvent()

◆ CP_FreeDynamicEventMail()

◆ CP_GetEventsByID()

◆ CP_ParseEventTrigger()

◆ CP_TriggerEvent()

◆ CP_TriggerEventLoadXML()

◆ CP_TriggerEventSaveXML()

Variable Documentation

◆ event_vals

◆ eventConstants

◆ eventMail_vals

◆ eventMails