-
Notifications
You must be signed in to change notification settings - Fork 3
Log writing
Some operations allows writing to the log. This can be done with the following string tags:
- MessageSuccess
- MessageFail
- WarningSuccess
- WarningFail
- ErrorSuccess
- ErrorFail
- VerboseMessageSuccess
- VerboseMessageFail
- VerboseWarningSuccess
- VerboseWarningFail
- VerboseErrorSuccess
- VerboseErrorFail
The main part of the name is the type of log entry. They are
| Type | Color |
|---|---|
| Message | White |
| Warning | Yellow |
| Error | Red |
This is followed by the trigger condition, which is either Success or Fail. This is the result of the operation itself before applying the Success tag. In other words setting Success to Invert will not have an effect on the log output.
The Verbose prefix indicates the text will only be written to the log if verbose logging is enabled in the game settings.
ModCheck applies some arguments to the string, meaning you get some "keywords", which will be replaced while printing.
| What you write | What enters the log | Version | Note |
|---|---|---|---|
| {0} | Name of mod being patched | B18 only | FindFile modName |
| {1} | Name of file being patched | B18 only | FindFile file |
| {2} | Name of mod the patch file is from | ||
| {3} | patchName from root of this patch | ||
| {4} | patchName from the operation writing this |
Note: the last 3 will often be obvious while writing the patch. They are added because the error message system relies on the same system and that one benefits from being able to tell where the patch is located.
Operations supporting these tags: