Crossfire Client, Trunk
msgctrl_data_t Struct Reference

Descriptive message type names with pane routing and buffer enable. A single struct defines a hard-coded, player-friendly, descriptive name to use for a single message type. All other fields in the structure define routing of messages to either or both client message panels, and whether or not messages of this type are passed through the duplicate suppression buffer system. This struct is intended to be used as the base type of an array that contains one struct per message type defined in newclient.h. The hard-coding of the descriptive name for the message type here is not ideal as it would be nicer to have it alongside the MSG_TYPE_* defines. More...

+ Collaboration diagram for msgctrl_data_t:

Data Fields

const gboolean buffer
 
const char * description
 
const gboolean pane [NUM_TEXT_VIEWS]
 

Detailed Description

Descriptive message type names with pane routing and buffer enable. A single struct defines a hard-coded, player-friendly, descriptive name to use for a single message type. All other fields in the structure define routing of messages to either or both client message panels, and whether or not messages of this type are passed through the duplicate suppression buffer system. This struct is intended to be used as the base type of an array that contains one struct per message type defined in newclient.h. The hard-coding of the descriptive name for the message type here is not ideal as it would be nicer to have it alongside the MSG_TYPE_* defines.

Definition at line 245 of file info.c.

Field Documentation

◆ buffer

const gboolean msgctrl_data_t::buffer

Whether or not to consider the message type for output-count buffering. 0/1 == disable/enable duplicate suppression (output-count).

Definition at line 253 of file info.c.

Referenced by default_msgctrl_configuration().

◆ description

const char* msgctrl_data_t::description

A descriptive name to give to a message type when displaying it for a player. These values should be kept in sync with the MSG_TYPE_* declarations in ../../common/shared/newclient.h

Definition at line 246 of file info.c.

◆ pane

const gboolean msgctrl_data_t::pane[NUM_TEXT_VIEWS]

The routing instructions for a single message type. For each pane, 0/1 == disable/enable display of the message type in the associated client message pane.

Definition at line 259 of file info.c.

Referenced by default_msgctrl_configuration().


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