Reserved OIDs
When creating your own objects with the Modding API, there are certain words that could be considered "reserved" as they have hard-coded interactions in the game.
Some of these can be used to your benefit (for example using "frame" in an item OID will give you a usable frame item), however others will outright crash you and should be avoided.
This also applies to your MOD_ID, because for a lot of items your MOD_ID will be prepended automatically onto the OIDs of your items!
Modding
Reserved OIDs
OID | Reserved Usage | Description |
---|---|---|
"bee" | Exact Match | All items and slots with a bee in have an "item" prop of "bee" (the details are stored in the stats prop). This is used to identify and draw bees. |
"beehive" | Contains | All beehives use this OID, and it's used to run a bunch of extra logic on beehives directly so avoid using an OID that contains "beehive" (an alternative you could use is "apiary"!) |
"canister" | Contains | All canisters use this OID, and anything with "canister" in the name will be able to be used as an actual canister! If you're trying to make your own canisters you can simply use "canister420" as the OID or similar and it'll be usable in machines and fill/drain with tanks (just make sure you keep the same stats) |
"dye" | Contains | All dyes in the game use the OID "dye" - on it's own it seems harmless but if trying to use a paintbrush when you have a modded item with "dye" in it's oid will prevent the brush from being used properly as it'll try (and fail) to convert your modded item into a valid dye to paint with |
"flower" | Contains | All flowers use this OID, and it's used by beehives and a few other places to run extra flower specific logic (like the flower spread), so avoid using an OID that contains "flower". |
"pot" | Contains | All flower pots use this OID - on it's own it won't do much but if you have both "flower" and "pot" in the same OID then you will see issues as it'll try and run the extra flowerpot logic on your item, so avoid using an OID that contains both "flower" and "pot" |
"frame" | Contains | All frames use this OID, and anything with "frame" in the name will be able to be used like an actual frame! If you're trying to make your own frames you can simply use "frame69" as the OID or similar and it'll be usable in machines and get filled by bees (just make sure you keep the same stats) |
"gate" | Contains | All Hivemother Gates use this and extra logic is added to menu objects with it in the name so avoid using an OID that contains "gate". |
"hive" | Contains | Same as "beehives", all apiaries use this OID, and it's used to run a bunch of extra logic on the hives directly so avoid using an OID that contains "hive" (an alternative you could use is "apiary"!) |
"mead" | Contains | All mead items use this OID - by itself it might not give you any trouble at first but you'll see issues with right-clicking it as it'll try and "drink" the item if it's in the form "meadX" and then will crash because X won't be a valid spice. |
"npc" | Contains | All NPCs have this in their OID, along with a matching "npcXs" OID for the shop. So much extra logic is applied to OIDs with NPCs so definitely avoid this in your OIDs at all costs. |
"spice" | Contains | All spice items use this OID, and technically by making say "spice7" you'd be able to make a spice you could put in the bottler, however it will crash when trying to bottle your spice as it won't know what mead to make with it! |