Logs are used to add a growing knowledgebase to your game.
A log consists of one or more log texts, which can be added to a log over time – e.g. increasing the information about something in your game as the player progresses through it.
Log Settings #
The log settings define the default log notifications. They can be found in Game > Log Settings & Types > General Settings.
Learn more about notifications in this documentation.
Log Types #
Log types are used to organize logs by separating them into different types.
You’ll mainly use them to filter logs in the editor and in-game menus (menu screens). Log types can be sub-types of other log types for a more detailed organization.
Log types are set up in Game > Log Settings & Types.
Logs #
A log is a collection of log texts that contain it’s content. Logs are set up in Game > Logs.
The log also defines the (default) name/title of a log – log texts can optionally override the name/title.
UI #
Define UI related settings for the log.
Portraits #
Add portraits to log and display them in menu screens.
Information Overrides #
Logs can override the default notifications and console texts.
Log Texts #
The log texts contain the actual information. They are set up in Game > Log Texts.
All log texts of a log are displayed in order they are listed in the editor. Optionally a log text can also replace all previous log texts, restarting the log’s content from that log text forward.
UI #
Define UI related settings for the log text.
Portraits #
Add portraits to log text and display them in menu screens.
Information Overrides #
Logs can override the default console texts.
Learning Logs #
The player can learn new logs and log texts in different ways.
Learning a log will learn all log texts of the log, i.e. complete the log.
Schematics #
Schematics can learn new logs and log texts (Learn Log Text node).
Additionally, schematics can also forget (Forget Log Text node) and check logs (Knows Log Text node).
Combatant Death #
A dying combatant can optionally learn a new log or log text.
This is set up in the combatant’s death settings – either the default defined in the general settings of combatants or in the individual combatant’s override.
Quests, Quest Tasks #
Quests and quest tasks can learn new log texts when their state changes.
E.g. learn a new log text when a quest or quest task was finished.
Displaying Logs #
Logs are displayed using a Log menu part in menu screens.
The logs can optionally be separated by log types. The log types also allow you to set up different log menus, e.g. creating different knowledgebases.
