FS2_Open
Open source remastering of the Freespace 2 engine
missionmessage.h File Reference

Go to the source code of this file.

Classes

struct  message_extra
 
struct  builtin_message
 
struct  MissionMessage
 
struct  pmessage
 
struct  persona_s
 

Macros

#define MESSAGE_PRIORITY_LOW   1
 
#define MESSAGE_PRIORITY_NORMAL   2
 
#define MESSAGE_PRIORITY_HIGH   3
 
#define MESSAGE_TIME_IMMEDIATE   1
 
#define MESSAGE_TIME_SOON   2
 
#define MESSAGE_TIME_ANYTIME   3
 
#define MESSAGE_SOURCE_SHIP   1
 
#define MESSAGE_SOURCE_WINGMAN   2
 
#define MESSAGE_SOURCE_COMMAND   3
 
#define MESSAGE_SOURCE_SPECIAL   4
 
#define MESSAGE_SOURCE_NONE   5
 
#define DEFAULT_COMMAND   "Command"
 
#define MAX_BUILTIN_MESSAGE_TYPES   45
 
#define MESSAGE_ARRIVE_ENEMY   0
 
#define MESSAGE_ATTACK_TARGET   1
 
#define MESSAGE_BETA_ARRIVED   2
 
#define MESSAGE_CHECK_6   3
 
#define MESSAGE_ENGAGE   4
 
#define MESSAGE_GAMMA_ARRIVED   5
 
#define MESSAGE_HELP   6
 
#define MESSAGE_PRAISE   7
 
#define MESSAGE_REINFORCEMENTS   8
 
#define MESSAGE_IGNORE   9
 
#define MESSAGE_NOSIR   10
 
#define MESSAGE_OOPS   11
 
#define MESSAGE_PERMISSION   12
 
#define MESSAGE_STRAY   13
 
#define MESSAGE_WARP_OUT   14
 
#define MESSAGE_YESSIR   15
 
#define MESSAGE_REARM_ON_WAY   16
 
#define MESSAGE_ON_WAY   17
 
#define MESSAGE_REARM_WARP   18
 
#define MESSAGE_NO_TARGET   19
 
#define MESSAGE_DOCK_YES   20
 
#define MESSAGE_REPAIR_DONE   21
 
#define MESSAGE_REPAIR_ABORTED   22
 
#define MESSAGE_HAMMER_SWINE   23
 
#define MESSAGE_REARM_REQUEST   24
 
#define MESSAGE_DISABLE_TARGET   25
 
#define MESSAGE_DISARM_TARGET   26
 
#define MESSAGE_PLAYER_DIED   27
 
#define MESSAGE_WINGMAN_SCREAM   28
 
#define MESSAGE_SUPPORT_KILLED   29
 
#define MESSAGE_ALL_CLEAR   30
 
#define MESSAGE_ALL_ALONE   31
 
#define MESSAGE_REPAIR_REQUEST   32
 
#define MESSAGE_DELTA_ARRIVED   33
 
#define MESSAGE_EPSILON_ARRIVED   34
 
#define MESSAGE_INSTRUCTOR_HIT   35
 
#define MESSAGE_INSTRUCTOR_ATTACK   36
 
#define MESSAGE_STRAY_WARNING   37
 
#define MESSAGE_STRAY_WARNING_FINAL   38
 
#define MESSAGE_AWACS_75   39
 
#define MESSAGE_AWACS_25   40
 
#define MESSAGE_PRAISE_SELF   41
 
#define MESSAGE_HIGH_PRAISE   42
 
#define MESSAGE_REARM_PRIMARIES   43
 
#define MESSAGE_PRIMARIES_LOW   44
 
#define MAX_PERSONA_TYPES   4
 
#define PERSONA_FLAG_WINGMAN   (1<<0)
 
#define PERSONA_FLAG_SUPPORT   (1<<1)
 
#define PERSONA_FLAG_LARGE   (1<<2)
 
#define PERSONA_FLAG_COMMAND   (1<<3)
 
#define PERSONA_FLAG_VASUDAN   (1<<30)
 
#define PERSONA_FLAG_USED   (1<<31)
 

Typedefs

typedef struct message_extra message_extra
 
typedef struct builtin_message builtin_message
 
typedef struct MissionMessage MMessage
 
typedef struct pmessage pmessage
 
typedef struct persona_s Persona
 

Functions

void message_parse (bool importing_from_fsm=false)
 
void persona_parse ()
 
void messages_init ()
 
void message_mission_shutdown ()
 
void message_mission_close ()
 
void message_queue_process ()
 
int message_is_playing ()
 
void message_maybe_distort ()
 
int message_anim_is_playing ()
 
void message_kill_all (int kill_all)
 
void message_queue_message (int message_num, int priority, int timing, char *who_from, int source, int group, int delay, int builtin_type=-1)
 
void message_send_unique_to_player (char *id, void *data, int source, int priority, int group, int delay)
 
void message_send_builtin_to_player (int type, ship *shipp, int priority, int timing, int group, int delay, int multi_target, int multi_team_filter)
 
int message_persona_name_lookup (char *name)
 
void message_pagein_mission_messages ()
 
int message_filter_multi (int id)
 
bool message_filename_is_generic (char *filename)
 
void message_load_wave (int index, const char *filename)
 
bool add_message (char *name, char *message, int persona_index, int multi_team)
 
bool change_message (char *name, char *message, int persona_index, int multi_team)
 

Variables

SCP_vector< message_extraMessage_avis
 
SCP_vector< message_extraMessage_waves
 
SCP_vector< SCP_stringBuiltin_moods
 
int Current_mission_mood
 
builtin_message Builtin_messages []
 
SCP_vector< MMessageMessages
 
pmessage Playing_messages [2]
 
int Num_messages_playing
 
int Num_messages
 
int Num_builtin_messages
 
int Message_shipnum
 
PersonaPersonas
 
int Num_personas
 
int Default_command_persona
 
int Praise_self_percentage
 

Macro Definition Documentation

#define DEFAULT_COMMAND   "Command"

Definition at line 54 of file missionmessage.h.

#define MAX_BUILTIN_MESSAGE_TYPES   45

Definition at line 70 of file missionmessage.h.

#define MAX_PERSONA_TYPES   4

Definition at line 166 of file missionmessage.h.

#define MESSAGE_ALL_ALONE   31

Definition at line 105 of file missionmessage.h.

#define MESSAGE_ALL_CLEAR   30

Definition at line 104 of file missionmessage.h.

#define MESSAGE_ARRIVE_ENEMY   0

Definition at line 74 of file missionmessage.h.

#define MESSAGE_ATTACK_TARGET   1

Definition at line 75 of file missionmessage.h.

#define MESSAGE_AWACS_25   40

Definition at line 114 of file missionmessage.h.

#define MESSAGE_AWACS_75   39

Definition at line 113 of file missionmessage.h.

#define MESSAGE_BETA_ARRIVED   2

Definition at line 76 of file missionmessage.h.

#define MESSAGE_CHECK_6   3

Definition at line 77 of file missionmessage.h.

#define MESSAGE_DELTA_ARRIVED   33

Definition at line 107 of file missionmessage.h.

#define MESSAGE_DISABLE_TARGET   25

Definition at line 99 of file missionmessage.h.

#define MESSAGE_DISARM_TARGET   26

Definition at line 100 of file missionmessage.h.

#define MESSAGE_DOCK_YES   20

Definition at line 94 of file missionmessage.h.

#define MESSAGE_ENGAGE   4

Definition at line 78 of file missionmessage.h.

#define MESSAGE_EPSILON_ARRIVED   34

Definition at line 108 of file missionmessage.h.

#define MESSAGE_GAMMA_ARRIVED   5

Definition at line 79 of file missionmessage.h.

#define MESSAGE_HAMMER_SWINE   23

Definition at line 97 of file missionmessage.h.

#define MESSAGE_HELP   6

Definition at line 80 of file missionmessage.h.

#define MESSAGE_HIGH_PRAISE   42

Definition at line 116 of file missionmessage.h.

#define MESSAGE_IGNORE   9

Definition at line 83 of file missionmessage.h.

#define MESSAGE_INSTRUCTOR_ATTACK   36

Definition at line 110 of file missionmessage.h.

#define MESSAGE_INSTRUCTOR_HIT   35

Definition at line 109 of file missionmessage.h.

#define MESSAGE_NO_TARGET   19

Definition at line 93 of file missionmessage.h.

#define MESSAGE_NOSIR   10

Definition at line 84 of file missionmessage.h.

#define MESSAGE_ON_WAY   17

Definition at line 91 of file missionmessage.h.

#define MESSAGE_OOPS   11

Definition at line 85 of file missionmessage.h.

#define MESSAGE_PERMISSION   12

Definition at line 86 of file missionmessage.h.

#define MESSAGE_PLAYER_DIED   27

Definition at line 101 of file missionmessage.h.

#define MESSAGE_PRAISE   7

Definition at line 81 of file missionmessage.h.

#define MESSAGE_PRAISE_SELF   41

Definition at line 115 of file missionmessage.h.

#define MESSAGE_PRIMARIES_LOW   44

Definition at line 118 of file missionmessage.h.

#define MESSAGE_PRIORITY_HIGH   3

Definition at line 39 of file missionmessage.h.

#define MESSAGE_PRIORITY_LOW   1

Definition at line 37 of file missionmessage.h.

#define MESSAGE_PRIORITY_NORMAL   2

Definition at line 38 of file missionmessage.h.

#define MESSAGE_REARM_ON_WAY   16

Definition at line 90 of file missionmessage.h.

#define MESSAGE_REARM_PRIMARIES   43

Definition at line 117 of file missionmessage.h.

#define MESSAGE_REARM_REQUEST   24

Definition at line 98 of file missionmessage.h.

#define MESSAGE_REARM_WARP   18

Definition at line 92 of file missionmessage.h.

#define MESSAGE_REINFORCEMENTS   8

Definition at line 82 of file missionmessage.h.

#define MESSAGE_REPAIR_ABORTED   22

Definition at line 96 of file missionmessage.h.

#define MESSAGE_REPAIR_DONE   21

Definition at line 95 of file missionmessage.h.

#define MESSAGE_REPAIR_REQUEST   32

Definition at line 106 of file missionmessage.h.

#define MESSAGE_SOURCE_COMMAND   3

Definition at line 49 of file missionmessage.h.

#define MESSAGE_SOURCE_NONE   5

Definition at line 51 of file missionmessage.h.

#define MESSAGE_SOURCE_SHIP   1

Definition at line 47 of file missionmessage.h.

#define MESSAGE_SOURCE_SPECIAL   4

Definition at line 50 of file missionmessage.h.

#define MESSAGE_SOURCE_WINGMAN   2

Definition at line 48 of file missionmessage.h.

#define MESSAGE_STRAY   13

Definition at line 87 of file missionmessage.h.

#define MESSAGE_STRAY_WARNING   37

Definition at line 111 of file missionmessage.h.

#define MESSAGE_STRAY_WARNING_FINAL   38

Definition at line 112 of file missionmessage.h.

#define MESSAGE_SUPPORT_KILLED   29

Definition at line 103 of file missionmessage.h.

#define MESSAGE_TIME_ANYTIME   3

Definition at line 44 of file missionmessage.h.

#define MESSAGE_TIME_IMMEDIATE   1

Definition at line 42 of file missionmessage.h.

#define MESSAGE_TIME_SOON   2

Definition at line 43 of file missionmessage.h.

#define MESSAGE_WARP_OUT   14

Definition at line 88 of file missionmessage.h.

#define MESSAGE_WINGMAN_SCREAM   28

Definition at line 102 of file missionmessage.h.

#define MESSAGE_YESSIR   15

Definition at line 89 of file missionmessage.h.

#define PERSONA_FLAG_COMMAND   (1<<3)

Definition at line 173 of file missionmessage.h.

#define PERSONA_FLAG_LARGE   (1<<2)

Definition at line 172 of file missionmessage.h.

#define PERSONA_FLAG_SUPPORT   (1<<1)

Definition at line 171 of file missionmessage.h.

#define PERSONA_FLAG_USED   (1<<31)

Definition at line 177 of file missionmessage.h.

#define PERSONA_FLAG_VASUDAN   (1<<30)

Definition at line 176 of file missionmessage.h.

#define PERSONA_FLAG_WINGMAN   (1<<0)

Definition at line 170 of file missionmessage.h.

Typedef Documentation

typedef struct message_extra message_extra
typedef struct MissionMessage MMessage
typedef struct persona_s Persona
typedef struct pmessage pmessage

Function Documentation

bool add_message ( char *  name,
char *  message,
int  persona_index,
int  multi_team 
)

Definition at line 2311 of file missionmessage.cpp.

bool change_message ( char *  name,
char *  message,
int  persona_index,
int  multi_team 
)

Definition at line 2326 of file missionmessage.cpp.

int message_anim_is_playing ( )

Definition at line 2274 of file missionmessage.cpp.

bool message_filename_is_generic ( char *  filename)

Definition at line 1015 of file missionmessage.cpp.

int message_filter_multi ( int  id)

Definition at line 1798 of file missionmessage.cpp.

int message_is_playing ( )

Definition at line 2145 of file missionmessage.cpp.

void message_kill_all ( int  kill_all)

Definition at line 828 of file missionmessage.cpp.

void message_load_wave ( int  index,
const char *  filename 
)

Definition at line 993 of file missionmessage.cpp.

void message_maybe_distort ( )

Definition at line 2167 of file missionmessage.cpp.

void message_mission_close ( )

Definition at line 792 of file missionmessage.cpp.

void message_mission_shutdown ( )

Definition at line 753 of file missionmessage.cpp.

void message_pagein_mission_messages ( )

Definition at line 2288 of file missionmessage.cpp.

void message_parse ( bool  importing_from_fsm = false)

Definition at line 355 of file missionmessage.cpp.

int message_persona_name_lookup ( char *  name)

Definition at line 2153 of file missionmessage.cpp.

void message_queue_message ( int  message_num,
int  priority,
int  timing,
char *  who_from,
int  source,
int  group,
int  delay,
int  builtin_type = -1 
)

Definition at line 1618 of file missionmessage.cpp.

void message_queue_process ( )

process the message queue – called once a frame

Definition at line 1281 of file missionmessage.cpp.

void message_send_builtin_to_player ( int  type,
ship shipp,
int  priority,
int  timing,
int  group,
int  delay,
int  multi_target,
int  multi_team_filter 
)

Definition at line 1925 of file missionmessage.cpp.

void message_send_unique_to_player ( char *  id,
void data,
int  source,
int  priority,
int  group,
int  delay 
)

Definition at line 1838 of file missionmessage.cpp.

void messages_init ( )

Definition at line 657 of file missionmessage.cpp.

void persona_parse ( )

Definition at line 234 of file missionmessage.cpp.

Variable Documentation

builtin_message Builtin_messages[]

Definition at line 48 of file missionmessage.cpp.

SCP_vector<SCP_string> Builtin_moods

Definition at line 39 of file missionmessage.cpp.

int Current_mission_mood

Definition at line 40 of file missionmessage.cpp.

int Default_command_persona

Definition at line 185 of file missionmessage.cpp.

SCP_vector<message_extra> Message_avis

Definition at line 106 of file missionmessage.cpp.

int Message_shipnum

Definition at line 138 of file missionmessage.cpp.

SCP_vector<message_extra> Message_waves

Definition at line 107 of file missionmessage.cpp.

SCP_vector<MMessage> Messages

Definition at line 99 of file missionmessage.cpp.

int Num_builtin_messages

Definition at line 102 of file missionmessage.cpp.

int Num_messages

Definition at line 101 of file missionmessage.cpp.

int Num_messages_playing

Definition at line 122 of file missionmessage.cpp.

int Num_personas

Definition at line 172 of file missionmessage.cpp.

Persona* Personas

Definition at line 173 of file missionmessage.cpp.

pmessage Playing_messages[2]

Definition at line 136 of file missionmessage.cpp.

int Praise_self_percentage