Skip to content

Commit

Permalink
Merge pull request #69629 from ehughsbaird/item-spawn-document-flags
Browse files Browse the repository at this point in the history
Add documentation for adding flags in itemgroups
  • Loading branch information
Maleclypse authored Nov 24, 2023
2 parents f2c4287 + 75c3bbc commit a707f04
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/ITEM_SPAWN.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ Each entry can have more values (shown above as `...`). They allow further prop
"container-group": "<group-id>",
"entry-wrapper": "<item-id>",
"sealed": <boolean>
"custom-flags": <array of string>,
"variant": <string>
"artifact": <object>
"event": <string>
Expand All @@ -108,6 +109,8 @@ Each entry can have more values (shown above as `...`). They allow further prop

`sealed`: If true, a container will be sealed when the item spawns. Default is `true`.

`custom-flags`: An array of flags that will be applied to this item.

`variant`: A valid itype variant id for this item.

`event`: A reference to a holiday in the `holiday` enum. If specified, the entry only spawns during the specified real holiday. This works the same way as the seasonal title screens, where the holiday is checked against the current system's time. If the holiday matches, the item's spawn probability is taken from the `prob` field. Otherwise, the spawn probability becomes 0.
Expand Down

0 comments on commit a707f04

Please sign in to comment.