GameOptions_t Struct Reference

Stores information on the current game's options. More...

#include <gameconfig.h>

Data Fields
Uint32	duration
	The maximum length of the game in milliseconds, or -1 to indicate no imposed length.
Uint8	flags
	A set of bit flags used to modify the game.
Uint8	goalAreas [TEAM_MAX]
	The number of goal areas on the battle field for each team.
Uint16	height
	The height of the battle field in logical pixels (the kind that make up the tanks).
Uint16	obstacles
	The number of obstacles on the battle field.
Uint16	rcvdMsgs
	The number of network messages describing the game configuration that have been received.
Uint8	spawnAreas [TEAM_MAX]
	The number of spawn areas on the battle field for each team.
Sint16	teamScore [TEAM_MAX]
	The score for each team.
Uint16	totalMsgs
	The total number of network messages that describe the game configuration.
Uint16	width
	The width of the battle field in logical pixels (the kind that make up the tanks).
Sint16	winScore
	The winning score.

---

Detailed Description

Stores information on the current game's options.

Todo:

Put this in a different file?

Author:

Jeff Jackowski

Definition at line 36 of file gameconfig.h.

---

Field Documentation

Uint32 GameOptions_t::duration

The maximum length of the game in milliseconds, or -1 to indicate no imposed length.

Definition at line 41 of file gameconfig.h.

Referenced by HandleGameOption(), and MakeBuffers().

Uint8 GameOptions_t::flags

A set of bit flags used to modify the game.

The valid flags are defined in GAME_OPT_FLAGS.

Note:

Since this field is sent over the network, a bit field struct cannot be used without breaking big to little endian compatibility.

Definition at line 89 of file gameconfig.h.

Referenced by ErrorOut(), GameRun(), HandleArea(), HandleGameOption(), HandleObstacle(), HandleScoreUpdate(), InitGameConfig(), MakeBuffers(), and ServiceGameConfig().

Uint8 GameOptions_t::goalAreas[TEAM_MAX]

The number of goal areas on the battle field for each team.

Definition at line 81 of file gameconfig.h.

Referenced by HandleArea(), MakeBuffers(), and UninitGameConfig().

Uint16 GameOptions_t::height

The height of the battle field in logical pixels (the kind that make up the tanks).

Definition at line 59 of file gameconfig.h.

Referenced by GameInit(), HandleGameOption(), MakeBuffers(), MoveShell(), MoveTank(), ReadInts(), SetupScrolling(), and StartLoadConfig().

Uint16 GameOptions_t::obstacles

The number of obstacles on the battle field.

Definition at line 63 of file gameconfig.h.

Referenced by HandleObstacle(), MakeBuffers(), ObstacleInit(), and ObstacleUninit().

Uint16 GameOptions_t::rcvdMsgs

The number of network messages describing the game configuration that have been received.

On the server, this should be set to the same value as totalMsgs.

Definition at line 73 of file gameconfig.h.

Referenced by MakeBuffers(), and MessageSrvToCli().

Uint8 GameOptions_t::spawnAreas[TEAM_MAX]

The number of spawn areas on the battle field for each team.

Definition at line 77 of file gameconfig.h.

Referenced by HandleArea(), MakeBuffers(), SpawnTank(), and UninitGameConfig().

Sint16 GameOptions_t::teamScore[TEAM_MAX]

The score for each team.

Definition at line 45 of file gameconfig.h.

Referenced by HandleGameOption(), HandleScoreUpdate(), MakeBuffers(), RenderScore(), and SendScoreUpdate().

Uint16 GameOptions_t::totalMsgs

The total number of network messages that describe the game configuration.

Definition at line 67 of file gameconfig.h.

Referenced by FlagCfgMsg(), MakeBuffers(), and MessageSrvToCli().

Uint16 GameOptions_t::width

The width of the battle field in logical pixels (the kind that make up the tanks).

Definition at line 54 of file gameconfig.h.

Referenced by GameInit(), HandleGameOption(), MakeBuffers(), MoveShell(), MoveTank(), ReadInts(), SetupScrolling(), and StartLoadConfig().

Sint16 GameOptions_t::winScore

The winning score.

This is modified by the isWinScoreAbs flag.

Definition at line 49 of file gameconfig.h.

Referenced by HandleGameOption(), and MakeBuffers().

---

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

• gameconfig.h

---