OpenTTD Source  20241108-master-g80f628063a
gamelog.cpp File Reference

Definition of functions used for logging of fundamental changes to the game. More...

#include "stdafx.h"
#include "saveload/saveload.h"
#include "string_func.h"
#include "settings_type.h"
#include "gamelog_internal.h"
#include "console_func.h"
#include "debug.h"
#include "timer/timer_game_calendar.h"
#include "timer/timer_game_tick.h"
#include "rev.h"
#include "safeguards.h"

Go to the source code of this file.

Functions

static std::string GetGamelogRevisionString ()
 Return the revision string for the current client version, for use in gamelog.
 
static void AddGrfInfo (std::back_insert_iterator< std::string > &output_iterator, uint32_t grfid, const MD5Hash *md5sum, const GRFConfig *gc)
 Adds the GRF ID, checksum and filename if found to the output iterator. More...
 
static bool IsLoggableGrfConfig (const GRFConfig *g)
 Decides if GRF should be logged. More...
 
static std::vector< const GRFConfig * > GenerateGRFList (const GRFConfig *grfc)
 Generates GRFList. More...
 

Variables

const SaveLoadVersion SAVEGAME_VERSION
 current savegame version
 
SavegameType _savegame_type
 type of savegame we are loading
 
uint32_t _ttdp_version
 version of TTDP savegame (if applicable)
 
SaveLoadVersion _sl_version
 the major savegame version identifier
 
uint8_t _sl_minor_version
 the minor savegame version, DO NOT USE!
 
Gamelog _gamelog
 Gamelog instance.
 
static const char *const la_text []
 Text messages for various logged actions. More...
 

Detailed Description

Definition of functions used for logging of fundamental changes to the game.

Definition in file gamelog.cpp.

Function Documentation

◆ AddGrfInfo()

static void AddGrfInfo ( std::back_insert_iterator< std::string > &  output_iterator,
uint32_t  grfid,
const MD5Hash *  md5sum,
const GRFConfig gc 
)
static

Adds the GRF ID, checksum and filename if found to the output iterator.

Parameters
output_iteratorThe iterator to add the GRF info to.
lastThe end of the buffer
grfidGRF ID
md5sumarray of md5sum to print, if known
gcGrfConfig, if known

Definition at line 109 of file gamelog.cpp.

References BSWAP32(), FGCM_ANY, GRFConfig::filename, FindGRFConfig(), and FormatArrayAsHex().

◆ GenerateGRFList()

static std::vector<const GRFConfig *> GenerateGRFList ( const GRFConfig grfc)
static

Generates GRFList.

Parameters
grfchead of GRF linked list

Definition at line 591 of file gamelog.cpp.

References IsLoggableGrfConfig(), and GRFConfig::next.

Referenced by Gamelog::GRFUpdate().

◆ IsLoggableGrfConfig()

static bool IsLoggableGrfConfig ( const GRFConfig g)
inlinestatic

Decides if GRF should be logged.

Parameters
ggrf to determine
Returns
true iff GRF is not static and is loaded

Definition at line 508 of file gamelog.cpp.

References GRFConfig::flags, GCF_STATIC, GCS_NOT_FOUND, HasBit(), and GRFConfig::status.

Referenced by GenerateGRFList(), and Gamelog::GRFAdd().

Variable Documentation

◆ la_text

const char* const la_text[]
static
Initial value:
= {
"new game started",
"game loaded",
"GRF config changed",
"cheat was used",
"settings changed",
"GRF bug triggered",
"emergency savegame",
}

Text messages for various logged actions.

Definition at line 131 of file gamelog.cpp.

Referenced by Gamelog::Print().