OpenTTD Source 20241224-master-gf74b0cf984
Public Member Functions | Data Fields
GRFIdentifier Struct Reference

Basic data to distinguish a GRF. More...

#include <newgrf_config.h>

Inheritance diagram for GRFIdentifier:
LoggedChangeGRFAdd LoggedChangeGRFChanged

Public Member Functions

 GRFIdentifier (const GRFIdentifier &other)=default
 
 GRFIdentifier (GRFIdentifier &&other)=default
 
 GRFIdentifier (uint32_t grfid, const MD5Hash &md5sum)
 
GRFIdentifier & operator= (const GRFIdentifier &other)=default
 
bool HasGrfIdentifier (uint32_t grfid, const MD5Hash *md5sum) const
 Does the identification match the provided values?
 

Data Fields

uint32_t grfid
 GRF ID (defined by Action 0x08)
 
MD5Hash md5sum
 MD5 checksum of file to distinguish files with the same GRF ID (eg. newer version of GRF)
 

Detailed Description

Basic data to distinguish a GRF.

Used in the server list window

Definition at line 82 of file newgrf_config.h.

Constructor & Destructor Documentation

◆ GRFIdentifier()

GRFIdentifier::GRFIdentifier ( uint32_t  grfid,
const MD5Hash &  md5sum 
)
inline

Definition at line 89 of file newgrf_config.h.

Member Function Documentation

◆ HasGrfIdentifier()

bool GRFIdentifier::HasGrfIdentifier ( uint32_t  grfid,
const MD5Hash *  md5sum 
) const
inline

Does the identification match the provided values?

Parameters
grfidExpected grfid.
md5sumExpected md5sum, may be nullptr (in which case, do not check it).
Returns
the object has the provided grfid and md5sum.

Definition at line 99 of file newgrf_config.h.

References grfid, and md5sum.

Field Documentation

◆ grfid

uint32_t GRFIdentifier::grfid

GRF ID (defined by Action 0x08)

Definition at line 83 of file newgrf_config.h.

Referenced by GRFFileScanner::AddFile(), ChangeGRFDescription(), ChangeGRFName(), ChangeGRFParamDescription(), ChangeGRFParamName(), ChangeGRFParamValueNames(), ChangeGRFURL(), FillGRFDetails(), FillGrfidMap(), GetGRFConfig(), Gamelog::GetOverriddenIdentifier(), GRFFile::GRFFile(), GRFLoadConfig(), Gamelog::GRFUpdate(), HasGrfIdentifier(), IsGoodGRFConfigList(), LoadNewGRF(), NewGRFWindow::OnInvalidateData(), ClientNetworkGameSocketHandler::Receive_SERVER_CHECK_NEWGRFS(), RemoveDuplicatesFromGRFConfigList(), and ShowMissingContentWindow().

◆ md5sum

MD5Hash GRFIdentifier::md5sum

MD5 checksum of file to distinguish files with the same GRF ID (eg. newer version of GRF)

Definition at line 84 of file newgrf_config.h.

Referenced by GRFFileScanner::AddFile(), CalcGRFMD5Sum(), Gamelog::GRFUpdate(), HandleSavegameLoadCrash(), HasGrfIdentifier(), IsGoodGRFConfigList(), NewGRFWindow::NameSorter(), NewGRFWindow::OnInvalidateData(), ClientNetworkGameSocketHandler::Receive_SERVER_CHECK_NEWGRFS(), and ShowMissingContentWindow().

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