cp_messages.h File Reference

Go to the source code of this file.

Data Structures
struct	uiMessageListNodeMessage_s

Macros
#define	MAX_MESSAGE_TEXT   256
#define	TIMESTAMP_TEXT   24

Typedefs
typedef struct uiMessageListNodeMessage_s	uiMessageListNodeMessage_t

Enumerations
enum	messageType_t {   MSG_DEBUG, MSG_INFO, MSG_STANDARD, MSG_RESEARCH_PROPOSAL,   MSG_RESEARCH_HALTED, MSG_RESEARCH_FINISHED, MSG_CONSTRUCTION, MSG_UFOSPOTTED,   MSG_UFOLOST, MSG_TERRORSITE, MSG_BASEATTACK, MSG_TRANSFERFINISHED,   MSG_PROMOTION, MSG_PRODUCTION, MSG_NEWS, MSG_DEATH,   MSG_CRASHSITE, MSG_EVENT, MSG_MAX }

Functions
uiMessageListNodeMessage_t *	MS_AddNewMessage (const char *title, const char *text, messageType_t type=MSG_STANDARD, struct technology_s *pedia=nullptr, bool popup=false, bool playSound=true)
	Adds a new message to message stack. More...
void	MS_MessageInit (void)

Variables
char	cp_messageBuffer [MAX_MESSAGE_TEXT]

Macro Definition Documentation

#define MAX_MESSAGE_TEXT   256

Definition at line 27 of file cp_messages.h.

Referenced by MS_LoadXML().

#define TIMESTAMP_TEXT   24

Definition at line 55 of file cp_messages.h.

Typedef Documentation

typedef struct uiMessageListNodeMessage_s uiMessageListNodeMessage_t

Definition at line 71 of file cp_messages.h.

Enumeration Type Documentation

enum messageType_t

Enumerator
MSG_DEBUG	only save them in debug mode
MSG_INFO	don't save these messages
MSG_STANDARD
MSG_RESEARCH_PROPOSAL
MSG_RESEARCH_HALTED
MSG_RESEARCH_FINISHED
MSG_CONSTRUCTION
MSG_UFOSPOTTED
MSG_UFOLOST
MSG_TERRORSITE
MSG_BASEATTACK
MSG_TRANSFERFINISHED
MSG_PROMOTION
MSG_PRODUCTION
MSG_NEWS
MSG_DEATH
MSG_CRASHSITE
MSG_EVENT	Eventmail only! used by CL_EventAddMail
MSG_MAX

Definition at line 30 of file cp_messages.h.

Function Documentation

uiMessageListNodeMessage_t* MS_AddNewMessage	(	const char *	title,
		const char *	text,
		messageType_t	type,
		technology_t *	pedia,
		bool	popup,
		bool	playSound
	)

Adds a new message to message stack.

Note

These are the messages that are displayed at geoscape

Parameters

[in]	title	Already translated message/mail title
[in]	text	Already translated message/mail body
[in]	popup	Show this as a popup, too?
[in]	type	The message type
[in]	pedia	Pointer to technology (only if needed)
[in]	playSound	Whether the sound associated with the message type should be played

Returns

message_t pointer

See also

UP_OpenMail_f

CL_EventAddMail_f

Note

this method forwards to MS_AddNewMessageSound with

playSound = true 

< only save them in debug mode

< don't save these messages

Definition at line 61 of file cp_messages.cpp.

References ccs, cgi, cp_campaignPool, CP_GameTimeStop(), CP_Popup(), uiMessageListNodeMessage_s::date, ccs_s::date, f, uiMessageListNodeMessage_s::iconName, Mem_PoolAllocType, MS_TimestampedText(), MSG_BASEATTACK, MSG_CONSTRUCTION, MSG_CRASHSITE, MSG_DEATH, MSG_DEBUG, MSG_EVENT, MSG_INFO, MSG_MAX, MSG_NEWS, MSG_PRODUCTION, MSG_PROMOTION, MSG_RESEARCH_FINISHED, MSG_RESEARCH_HALTED, MSG_RESEARCH_PROPOSAL, MSG_STANDARD, MSG_TERRORSITE, MSG_TRANSFERFINISHED, MSG_UFOLOST, MSG_UFOSPOTTED, ccs_s::numUnreadMails, uiMessageListNodeMessage_s::pedia, cgame_import_s::PoolStrDup(), Q_strncpyz(), uiMessageListNodeMessage_s::text, uiMessageListNodeMessage_s::timestamp, uiMessageListNodeMessage_s::title, uiMessageListNodeMessage_s::type, and type.

Referenced by AIM_AircraftStart_f(), AIR_CampaignRun(), AIR_NewAircraft(), AIR_SendAircraftPursuingUFO(), AIR_SendAircraftToMission(), AIRFIGHT_ActionsAfterAirfight(), AIRFIGHT_ExecuteActions(), AL_AddAliens(), AM_AlienCollect(), AM_DisplayResults(), AM_Go_f(), B_BuildBase_f(), B_Destroy_AntimaterStorage_f(), B_SellOrAddItems(), B_SetBaseTitle_f(), CHAR_UpdateStats(), CL_EventAddMail(), CP_BaseAttackMissionDestroyBase(), CP_MissionAddToGeoscape(), CP_MissionEndActions(), MS_LoadXML(), MSO_CheckAddNewMessage(), NAT_HandleBudget(), SAV_GameQuickLoad_f(), SAV_GameQuickSave_f(), UR_DialogStartSell_f(), and UR_DialogStartStore_f().

void MS_MessageInit

(

void

)

Definition at line 329 of file cp_messages.cpp.

References MSO_Init().

Referenced by CP_InitStartup().

Variable Documentation

char cp_messageBuffer[MAX_MESSAGE_TEXT]

Definition at line 31 of file cp_messages.cpp.

Referenced by AII_UpdateOneInstallationDelay(), AIR_Move(), AIR_NewAircraft(), AIR_Refuel(), B_BuildBase_f(), B_SellOrAddItems(), B_UpdateBuildingConstructions(), CHAR_UpdateStats(), CP_BaseAttackMissionDestroyBase(), CP_MissionEndActions(), CP_MissionGetMessage(), INS_BuildInstallation_f(), INS_DestroyInstallation(), INS_UpdateInstallationData(), NAT_SetHappiness(), PR_CheckFrame(), PR_FinishDisassembly(), PR_FinishProduction(), PR_ProductionIncrease_f(), PR_QueueNext(), RS_CheckRequirements(), RS_MarkCollected(), RS_MarkOneResearchable(), RS_ResearchFinish(), RS_ResearchRun(), TR_EmptyTransferCargo(), UR_DialogStartSell_f(), UR_DialogStartStore_f(), UR_ProcessActive(), and US_TransferUFO().