/tg/ Station 13 - Modules - TypesVar Details - Proc Details

log_category

The main datum that contains all log entries for a category

Vars

categoryThe category name
category_headerThe list of header information for this category. Used for log file re-initialization
config_flagIf set this config flag is checked to enable this log category
entriesList of log entries for this category
entry_countTotal number of entries this round so far
entry_flagsFlags to apply to our /datum/log_entry's See code/__DEFINES/logging/dm
internal_formattingWhether the readable version of the log message is formatted internally instead of by rustg IF YOU CHANGE THIS VERIFY LOGS ARE STILL PARSED CORRECTLY
master_categoryThe master category that contains this category
schema_versionThe schema version of this log category. Expected format of "Major.Minor.Patch"
secretWhether or not this log should not be publically visible

Procs

create_entryAdd an entry to this category. It is very important that any data you provide doesn't hold references to anything!
get_output_fileAllows for category specific file splitting. Needs to accept a null entry for the default file. If master_category it will always return the output of master_category.get_output_file(entry)
write_entryWrites an entry to the output file(s) for the category

Var Details

category

The category name

category_header

The list of header information for this category. Used for log file re-initialization

config_flag

If set this config flag is checked to enable this log category

entries

List of log entries for this category

entry_count

Total number of entries this round so far

entry_flags

Flags to apply to our /datum/log_entry's See code/__DEFINES/logging/dm

internal_formatting

Whether the readable version of the log message is formatted internally instead of by rustg IF YOU CHANGE THIS VERIFY LOGS ARE STILL PARSED CORRECTLY

master_category

The master category that contains this category

schema_version

The schema version of this log category. Expected format of "Major.Minor.Patch"

secret

Whether or not this log should not be publically visible

Proc Details

create_entry

Add an entry to this category. It is very important that any data you provide doesn't hold references to anything!

get_output_file

Allows for category specific file splitting. Needs to accept a null entry for the default file. If master_category it will always return the output of master_category.get_output_file(entry)

write_entry

Writes an entry to the output file(s) for the category