Container for any change that we deem needs to be logged. More...
#include <gamelog_internal.h>
Public Member Functions | |
| LoggedChange (GamelogChangeType type=GamelogChangeType::None) | |
| Create the log entry. | |
| virtual | ~LoggedChange ()=default |
| Ensure the destructor of the sub classes are called as well. | |
| virtual void | FormatTo (std::back_insert_iterator< std::string > &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type)=0 |
| Format the content of this change into the given output. | |
Data Fields | |
| GamelogChangeType | ct {} |
| The type of change. | |
Detailed Description
Container for any change that we deem needs to be logged.
Definition at line 40 of file gamelog_internal.h.
Constructor & Destructor Documentation
◆ LoggedChange()
|
inline |
Create the log entry.
- Parameters
-
type The type of change to log.
Definition at line 45 of file gamelog_internal.h.
Referenced by LoggedChangeEmergencySave::LoggedChangeEmergencySave(), LoggedChangeGRFAdd::LoggedChangeGRFAdd(), LoggedChangeGRFAdd::LoggedChangeGRFAdd(), LoggedChangeGRFBug::LoggedChangeGRFBug(), LoggedChangeGRFBug::LoggedChangeGRFBug(), LoggedChangeGRFChanged::LoggedChangeGRFChanged(), LoggedChangeGRFChanged::LoggedChangeGRFChanged(), LoggedChangeGRFMoved::LoggedChangeGRFMoved(), LoggedChangeGRFMoved::LoggedChangeGRFMoved(), LoggedChangeGRFParameterChanged::LoggedChangeGRFParameterChanged(), LoggedChangeGRFParameterChanged::LoggedChangeGRFParameterChanged(), LoggedChangeGRFRemoved::LoggedChangeGRFRemoved(), LoggedChangeGRFRemoved::LoggedChangeGRFRemoved(), LoggedChangeMode::LoggedChangeMode(), LoggedChangeMode::LoggedChangeMode(), LoggedChangeOldVersion::LoggedChangeOldVersion(), LoggedChangeOldVersion::LoggedChangeOldVersion(), LoggedChangeRevision::LoggedChangeRevision(), LoggedChangeRevision::LoggedChangeRevision(), LoggedChangeSettingChanged::LoggedChangeSettingChanged(), and LoggedChangeSettingChanged::LoggedChangeSettingChanged().
Member Function Documentation
◆ FormatTo()
|
pure virtual |
Format the content of this change into the given output.
- Parameters
-
output_iterator Destination of the formatted content. grf_names Cache/mapping of names of NewGRFs seen in the logs. action_type The context in which this method was called.
Implemented in LoggedChangeEmergencySave, LoggedChangeGRFAdd, LoggedChangeGRFBug, LoggedChangeGRFChanged, LoggedChangeGRFMoved, LoggedChangeGRFParameterChanged, LoggedChangeGRFRemoved, LoggedChangeMode, LoggedChangeOldVersion, LoggedChangeRevision, and LoggedChangeSettingChanged.
Field Documentation
◆ ct
| GamelogChangeType LoggedChange::ct {} |
The type of change.
Definition at line 58 of file gamelog_internal.h.
Referenced by SlGamelogEmergency::Load(), SlGamelogGrfadd::Load(), SlGamelogGrfbug::Load(), SlGamelogGrfcompat::Load(), SlGamelogGrfmove::Load(), SlGamelogGrfparam::Load(), SlGamelogGrfrem::Load(), SlGamelogMode::Load(), SlGamelogOldver::Load(), SlGamelogRevision::Load(), SlGamelogSetting::Load(), LoggedChange(), SlGamelogEmergency::Save(), SlGamelogGrfadd::Save(), SlGamelogGrfbug::Save(), SlGamelogGrfcompat::Save(), SlGamelogGrfmove::Save(), SlGamelogGrfparam::Save(), SlGamelogGrfrem::Save(), SlGamelogMode::Save(), SlGamelogOldver::Save(), SlGamelogRevision::Save(), and SlGamelogSetting::Save().
The documentation for this struct was generated from the following file:
