Custom Museum Framework

Mail Flags

The purpose of this page is to document any and all mail flags that might be set for the player by Custom Museum Framework. Some mail flags will be unique while others will contain placeholders; the latter will have explanations alongside them to explain the format of the mail flag so you know what to actually check for in your mod.

This page will be split into two sections: global flags and player flags. Global flags are always sent to every player in all cases, regardless of which player caused a flag-triggering event to happen. Player flags are only sent to individual players who have fulfilled whatever requirements the flag needs and are not shared between players (but of course multiple players may earn the mail flags individually).

Global Flags

The following table describes every mail flag that is always sent to every player and the situation in which the flag is sent:

FLAG	CONDITION
<MuseumId>_MuseumCompletion	Sent when your museum has received every possible donation and thus is considered complete.
<MuseumId>_MuseumMilestone_<Milestone>	Sent when your museum has reached a milestone number. `Milestone` will be the relevant number e.g. `MyMuseum_MuseumMilestone_50`
<MuseumId>_MuseumReward_<RewardId>	Sent when the player has earned (not collected!) the museum reward with a matching `RewardId`

Player Flags

The following table describes every mail flag that is only sent to specific players and the situation in which the flag is sent:

FLAG	CONDITION
<MuseumId>_RewardCollected_<RewardId>	Sent when the player has collected any item from the museum reward with a matching `RewardId`. Any item from the reward may be collected for this flag to be sent.
<MuseumId>_MuseumRewardItem_<ItemId>_<Stack>	Sent when the player has collected a reward item from any reward whose qualified item Id matches `ItemId` and whose stack size matches `Stack`. This can be used to track whether or not the player has collected specific individual items from a reward that includes multiple items.
<MuseumId>_SomethingToDonate	Sent when the player enters your museum for the first time and has something that they could possibly donate in their inventory.
<MuseumId>_SomethingWasDonated	Sent when the player enters your museum and your museum has at least one item donated to it.
<MuseumId>_FoundLostBook_<BooksetId>	Sent when the player finds their first Lost Book of the bookset with a matching `BooksetId`
<MuseumId>_ReadLostBook_<BooksetId>_<BookId>	Sent when the player reads a Lost Book with a matching `BookId` from the bookset with a matching `BooksetId`