mission_s Struct Reference

mission definition More...

#include <cp_missions.h>

Data Structures
union	missionData_t

Data Fields
int	idx
char	id [MAX_VAR]
mapDef_t *	mapDef
bool	active
union mission_s::missionData_t	data
interestCategory_t	category
missionStage_t	stage
int	initialOverallInterest
int	initialIndividualInterest
date_t	startDate
date_t	finalDate
vec2_t	pos
aircraft_t *	ufo
bool	onGeoscape
bool	crashed
char	onwin [256]
char	onlose [256]
bool	posAssigned
missionResults_t	missionResults

Detailed Description

mission definition

Note

A mission is different from a map: a mission is the whole set of actions aliens will carry. For example, coming with a UFO on earth, land, explore earth, and leave with UFO

Definition at line 85 of file cp_missions.h.

Field Documentation

bool mission_s::active

aircraft at place?

Definition at line 89 of file cp_missions.h.

Referenced by AIR_Move(), AIR_SendAircraftToMission(), AM_Go_f(), CP_BaseAttackPrepareBattle(), CP_StartSelectedMission(), GEO_DrawMapOneMission(), MIS_LoadXML(), and MIS_SaveXML().

interestCategory_t mission_s::category

The category of the event

Definition at line 97 of file cp_missions.h.

Referenced by BATTLE_Start(), BDEF_AutoTarget(), CP_CheckMissionVisibleOnGeoscape(), CP_ChooseMap(), CP_CreateBattleParameters(), CP_CreateNewMission(), CP_MissionChooseUFO(), CP_MissionEndActions(), CP_MissionGetMessage(), CP_MissionIsOver(), CP_MissionRemoveFromGeoscape(), CP_MissionStageEnd(), CP_SetAlienTeamByInterest(), CP_SetMissionName(), CP_UFOProceedMission(), MIS_GetModel(), MIS_GetName(), MIS_IsSpawnedFromGround(), MIS_LoadXML(), and MIS_SaveXML().

bool mission_s::crashed

is UFO crashed ? (only used if mission is spawned from a UFO

Definition at line 107 of file cp_missions.h.

Referenced by BATTLE_Start(), CP_CheckMissionVisibleOnGeoscape(), CP_ChooseMap(), CP_CreateBattleParameters(), CP_MapIsSelectable(), CP_MissionGetMessageLevel(), CP_MissionStageEnd(), CP_SpawnCrashSiteMission(), GAME_CP_InitMissionBriefing(), MIS_GetModel(), MIS_GetName(), MIS_LoadXML(), and MIS_SaveXML().

union mission_s::missionData_t mission_s::data

may be related to mission type (like pointer to base attacked, or to alien base)

Referenced by BATTLE_Start(), BDEF_AutoTarget(), CP_BaseAttackGoToBase(), CP_BaseAttackMissionDestroyBase(), CP_BaseAttackMissionIsFailure(), CP_BaseAttackPrepareBattle(), CP_BaseAttackStartMission(), CP_BuildBaseMissionBaseDestroyed(), CP_BuildBaseMissionIsSuccess(), CP_BuildBaseMissionLeave(), CP_BuildBaseSetUpBase(), CP_CreateBattleParameters(), CP_EndRescueMission(), CP_InterceptAttackInstallation(), CP_InterceptGoToInstallation(), CP_InterceptMissionLeave(), CP_InterceptNextStage(), CP_MissionEnd(), CP_MissionGetMessage(), CP_SpawnAlienBaseMission(), CP_SpawnRescueMission(), CP_SupplyGoToBase(), CP_SupplyMissionIsSuccess(), CP_SupplyMissionLeave(), CP_SupplySetStayAtBase(), CP_TerrorMissionGo(), CP_UFOProceedMission(), MIS_GetName(), MIS_LoadXML(), MIS_SaveXML(), and UFO_CampaignRunUFOs().

date_t mission_s::finalDate

Date when the event should finish (e.g. for aerial recon) if finaleDate.day == 0, then delay is not a limitating factor for next stage

Definition at line 102 of file cp_missions.h.

Referenced by CP_BaseAttackGoToBase(), CP_BaseAttackMissionLeave(), CP_BeginRescueMission(), CP_BuildBaseSetUpBase(), CP_BuildBaseSubvertGovernment(), CP_CheckMissionLimitedInTime(), CP_CreateNewMission(), CP_EndRescueMission(), CP_HarvestMissionGo(), CP_HarvestMissionStart(), CP_InterceptAircraftMissionSet(), CP_InterceptAttackInstallation(), CP_InterceptNextStage(), CP_LeaveRescueMission(), CP_MissionBegin(), CP_MissionDisableTimeLimit(), CP_ReconMissionAerial(), CP_ReconMissionGround(), CP_ReconMissionGroundGo(), CP_ReconMissionLeave(), CP_SpawnCrashSiteMission(), CP_SupplySetStayAtBase(), CP_TerrorMissionGo(), CP_TerrorMissionStart(), CP_UFOCarrierMissionStart(), CP_UFOCarrierMissionUpdate(), CP_XVIMissionStart(), MIS_LoadXML(), and MIS_SaveXML().

char mission_s::id[MAX_VAR]

script id

Definition at line 87 of file cp_missions.h.

Referenced by AIR_SaveAircraftXML(), BATTLE_Start(), CP_BaseAttackPrepareBattle(), CP_MissionBegin(), CP_MissionRemove(), CP_MissionStageEnd(), CP_SetAlienEquipmentByInterest(), CP_SetAlienTeamByInterest(), CP_SetMissionName(), CP_SpawnRescueMission(), MIS_GetModel(), MIS_LoadXML(), and MIS_SaveXML().

int mission_s::idx

unique id of this mission

Definition at line 86 of file cp_missions.h.

Referenced by B_BuildingDestroy(), B_SaveXML(), CP_CreateNewMission(), CP_MissionBegin(), CP_UFOCarrierMissionStart(), INS_GetInstallationTemplateByID(), INS_GetInstallationTemplateByType(), MIS_GetIdx(), MIS_LoadXML(), and MIS_SaveXML().

int mission_s::initialIndividualInterest

The individual interest value (of type type) when this event has been created

Definition at line 100 of file cp_missions.h.

Referenced by CP_CreateNewMission(), MIS_LoadXML(), and MIS_SaveXML().

int mission_s::initialOverallInterest

The overall interest value when this event has been created

Definition at line 99 of file cp_missions.h.

Referenced by CP_BasemissionIsSubvertingGovernmentMission(), CP_CreateNewMission(), CP_IsAlienEquipmentSelectable(), CP_SetAlienTeamByInterest(), CP_SetMissionName(), MIS_LoadXML(), and MIS_SaveXML().

mapDef_t* mission_s::mapDef

mapDef used for this mission

Definition at line 88 of file cp_missions.h.

Referenced by AM_Check_f(), AM_Go(), AM_Go_f(), BATTLE_Start(), CP_AttackUFOCarrier_f(), CP_BaseAttackGoToBase(), CP_BeginRescueMission(), CP_ChooseMap(), CP_CreateBattleParameters(), CP_CreateCivilianTeam(), CP_ExecuteMissionTrigger(), CP_HandleNationData(), CP_HarvestMissionGo(), CP_ReconMissionGroundGo(), CP_SpawnAlienBaseMission(), CP_SpawnCrashSiteMission(), CP_SpawnRescueMission(), GAME_CP_InitMissionBriefing(), GEO_GetMissionText(), MIS_CreateAlienTeam(), MIS_GetModel(), MIS_LoadXML(), MIS_SaveXML(), and TEST_F().

missionResults_t mission_s::missionResults

Definition at line 112 of file cp_missions.h.

Referenced by AII_CollectingItems(), AM_Go_f(), CP_MissionEnd(), CP_StartSelectedMission(), and GAME_CP_Results().

bool mission_s::onGeoscape

Should the mission be displayed on geoscape

Definition at line 106 of file cp_missions.h.

Referenced by CP_MissionAddToGeoscape(), CP_MissionRemoveFromGeoscape(), MIS_LoadXML(), and MIS_SaveXML().

char mission_s::onlose[256]

trigger command after you've lost a battle,

See also

CP_ExecuteMissionTrigger

Definition at line 110 of file cp_missions.h.

Referenced by CP_ExecuteMissionTrigger(), MIS_LoadXML(), and MIS_SaveXML().

char mission_s::onwin[256]

trigger command after you've won a battle,

See also

CP_ExecuteMissionTrigger

Definition at line 109 of file cp_missions.h.

Referenced by CP_CreateBattleParameters(), CP_ExecuteMissionTrigger(), MIS_LoadXML(), and MIS_SaveXML().

vec2_t mission_s::pos

Position of the mission

Definition at line 104 of file cp_missions.h.

Referenced by AIR_SendAircraftToMission(), B_BuildFromTemplate(), B_BuildingDestroy(), B_ParseBaseTemplate(), BATTLE_Start(), CL_DisplayPopupInterceptMission(), CP_BaseAttackGoToBase(), CP_BaseAttackPrepareBattle(), CP_BuildBaseGoToBase(), CP_BuildBaseGovernmentLeave(), CP_BuildBaseSetUpBase(), CP_ChangeNationHappiness_f(), CP_CheckMissionVisibleOnGeoscape(), CP_CreateBattleParameters(), CP_CreateCivilianTeam(), CP_HarvestMissionGo(), CP_InterceptAttackInstallation(), CP_InterceptGoToInstallation(), CP_InterceptMissionLeave(), CP_MissionAddToGeoscape(), CP_MissionGetMessage(), CP_ReconMissionGroundGo(), CP_SpawnAlienBaseMission(), CP_SpawnCrashSiteMission(), CP_SpawnRescueMission(), CP_SupplyGoToBase(), CP_TerrorMissionGo(), CP_UFOProceedMission(), GEO_DrawMapOneMission(), GEO_GetMissionAngle(), MIS_GetName(), MIS_LoadXML(), MIS_SaveXML(), TEST_F(), and UFO_CampaignRunUFOs().

bool mission_s::posAssigned

is the position of this mission already set?

Definition at line 111 of file cp_missions.h.

Referenced by CP_BaseAttackGoToBase(), CP_BeginRescueMission(), CP_CheckMissionVisibleOnGeoscape(), CP_CreateBattleParameters(), CP_CreateCivilianTeam(), CP_HarvestMissionGo(), CP_InterceptGoToInstallation(), CP_ReconMissionGround(), CP_ReconMissionGroundGo(), CP_SpawnAlienBaseMission(), CP_SpawnCrashSiteMission(), CP_TerrorMissionGo(), MIS_CreateAlienTeam(), MIS_LoadXML(), MIS_SaveXML(), and TEST_F().

missionStage_t mission_s::stage

in which stage is this event?

Definition at line 98 of file cp_missions.h.

Referenced by AM_Go_f(), CP_BaseAttackGoToBase(), CP_BaseAttackMissionLeave(), CP_BaseAttackMissionNextStage(), CP_BaseAttackStartMission(), CP_BeginRescueMission(), CP_BuildBaseGoToBase(), CP_BuildBaseGovernmentLeave(), CP_BuildBaseMissionLeave(), CP_BuildBaseMissionNextStage(), CP_BuildBaseSetUpBase(), CP_BuildBaseSubvertGovernment(), CP_CheckMissionVisibleOnGeoscape(), CP_CheckNextStageDestination(), CP_CreateNewMission(), CP_HarvestMissionGo(), CP_HarvestMissionNextStage(), CP_HarvestMissionStart(), CP_InterceptAircraftMissionSet(), CP_InterceptAttackInstallation(), CP_InterceptGoToInstallation(), CP_InterceptMissionLeave(), CP_InterceptNextStage(), CP_LeaveRescueMission(), CP_MissionAddToGeoscape(), CP_MissionBegin(), CP_MissionEnd(), CP_MissionEndActions(), CP_MissionGetMessageLevel(), CP_MissionIsOver(), CP_MissionStageEnd(), CP_ReconMissionAerial(), CP_ReconMissionGround(), CP_ReconMissionGroundGo(), CP_ReconMissionLeave(), CP_ReconMissionNextStage(), CP_ReconMissionSelect(), CP_RescueNextStage(), CP_SpawnAlienBaseMission(), CP_SpawnRescueMission(), CP_SupplyGoToBase(), CP_SupplyMissionCreate(), CP_SupplyMissionLeave(), CP_SupplyMissionNextStage(), CP_SupplySetStayAtBase(), CP_TerrorMissionGo(), CP_TerrorMissionNextStage(), CP_TerrorMissionStart(), CP_UFOCarrierMissionStart(), CP_UFOCarrierNextStage(), CP_UFOProceedMission(), CP_XVIMissionNextStage(), CP_XVIMissionStart(), MIS_GetName(), MIS_LoadXML(), MIS_SaveXML(), TEST_F(), UFO_CampaignRunUFOs(), and UFO_SearchAircraftTarget().

date_t mission_s::startDate

Date when the event should start

Definition at line 101 of file cp_missions.h.

Referenced by CP_CreateNewMission(), MIS_LoadXML(), and MIS_SaveXML().

aircraft_t* mission_s::ufo

UFO on geoscape fulfilling the mission (may be nullptr)

Definition at line 105 of file cp_missions.h.

Referenced by AIR_PostLoadInitMissions(), CP_AttackUFOCarrier_f(), CP_BaseAttackGoToBase(), CP_BaseAttackMissionLeave(), CP_BaseAttackStartMission(), CP_BeginRescueMission(), CP_BuildBaseGoToBase(), CP_BuildBaseGovernmentLeave(), CP_BuildBaseMissionLeave(), CP_BuildBaseSetUpBase(), CP_BuildBaseSubvertGovernment(), CP_CheckMissionVisibleOnGeoscape(), CP_ChooseMap(), CP_ChooseNation(), CP_CreateBattleParameters(), CP_CreateNewMission(), CP_HarvestMissionGo(), CP_HarvestMissionStart(), CP_InterceptAttackInstallation(), CP_InterceptGoToInstallation(), CP_InterceptMissionLeave(), CP_InterceptMissionSet(), CP_InterceptNextStage(), CP_LeaveRescueMission(), CP_MapIsSelectable(), CP_MissionAddToGeoscape(), CP_MissionBegin(), CP_MissionRemove(), CP_ReconMissionAerial(), CP_ReconMissionChoose(), CP_ReconMissionGround(), CP_ReconMissionGroundGo(), CP_ReconMissionLeave(), CP_SpawnRescueMission(), CP_SupplyGoToBase(), CP_SupplyMissionCreate(), CP_SupplyMissionLeave(), CP_SupplySetStayAtBase(), CP_TerrorMissionGo(), CP_TerrorMissionStart(), CP_UFORemoveFromGeoscape(), CP_XVIMissionStart(), MIS_CreateAlienTeam(), MIS_GetName(), and TEST_F().

---

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

• src/client/cgame/campaign/cp_missions.h