Restrictions
You have your stage, now let's lock something behind it!
The restrictions can be added in the same JSON file where the stage was previously created. Here's an example of all the possible restrictions a mod pack developer may use:
Something that's important to remember is that the contents of this file are COMPLETELY optional. This makes the stage/restriction file modular. If you wanna make a file just for item restrictions for a certain mod, you can do it. You wanna do it just for mob restrictions? Totally possible!
Simple Restrictions
Let's cover what some of these objects mean. We recommend using a mod like Kubejs to find all of these ids:
"itemList" - This is a list. Here you can add item ids. This will gate the correspondent items to the stage created. If block item id's are added here, special restrictions will be applied to the in-world blocks if desired. Check the Settings page for more info.
The "itemList" object also allows for item restrictions based on item NBT data. Here's how you would lock a chest with the display name 'Magic Chest' behind a stage:
"modList" - This is a list. Here you can add mod ids. This will gate the correspondent mod's items to the stage created. Use it if you wanna gate a mod's items entirely:
"tagList" - This is a list. Here you can add item tags. This will gate all the items included in that tag.
"exceptionList" - This is a list. This is a bit of a different object, as it is primarily meant to be used with the "modList" restriction. Here's how it works. Let's say you wanna gate every item from Botania, except for the Mana Pool (for some reason). You'll have to add the Mana Pool's id to this list. You can even do these with more mods and items!
You can even use tags, intead of item ids!
"containerList" - This is a list where you can add container IDs to restrict them. A restricted container will behave as follows: when the player opens the container, any restricted items in their inventory will be dropped on the ground, preventing interaction with the container while holding restricted items. To find a container's ID, use the mod's debug feature.
"dimensionList" - This is a list. Here you can add dimension IDs so they can be restricted. The player won't be able to enter the restricted dimension(s) until they obtain the proper stage. Access will be restricted even through commands or teleport. Unlike other restrictions in this category, this one has a message setting. For each dimension restricted, you can make a custom message to be display on the action bar when a player attempts to enter that said dimension.
Advanced Restrictions
Structure Gating
"structureList" - Yet another list. EACH STRUCTURE you wanna add, has to be listed under curly braces {}. For each structure, you can apply different settings:
"structure" - Here you'll add the ID of the structure you wanna gate. Use a mod such as WITS to easily find this ID
"can_use_block" - This is a Boolean value. It defines weather or not a player is allowed to right click the blocks in the structure. Useful if you wanna restrict access to the furnaces in a Village for example.
"can_place_block" - This is also a Boolean value. It defines weather or not a player is allowed to place blocks in the structure.
"can_break_block" - Also a Boolean value. It defines weather or not a player is allowed to break the blocks in the structure.
"can_use_block_list" - This acts as an exception list. If "can_use_block" is set to false, here you can add a player will be allowed to right click. Let's say you wanna allow the player to interact only with the Chests present in a Village. You'll have to add the chest's ID to this list.
"can_place_block_list" - This is a list where you can add item block IDs to define the blocks a player may place in this structure IF the "can_place_block" setting is set to false. Let's say you have some custom structure. To progress in this structure, the player has to place a Redstone Block somewhere. You'll have to add the Redstone Block's ID to this list in order to allow the player to place it in the structure.
"can_break_block_list" - Similar to can_place_block_list. It's used if the "can_break_block" setting is false. Here you can add item block IDs to define the blocks a player may break in a structure. Let's say you have some custom structure where a player can only break Ceramic Pots in order to get loot. You'll have to add the pot's ID to this list.
Mob Gating
The "mobList" allows you to restrict mob spawns based on the mob's ID, tag, or the mod ID. This list is flexible, meaning you can include only the settings that matter to you. If certain settings aren’t relevant, you can simply omit them. To clarify how this works, we’ll go through a few potential scenarios.
Example:
Let's say you want to restrict a single mob. Here’s how your restriction file might look:
Key Elements:
"spawnType"- This list will specify which spawn types your configuration will apply to. The possible values are:
NATURAL
CHUNK_GENERATION
SPAWNER
STRUCTURE
BREEDING
MOB_SUMMONED
JOCKEY
EVENT
CONVERSION
REINFORCEMENT
TRIGGERED
BUCKET
SPAWN_EGG
COMMAND
DISPENSER
PATROL
"whitelist_blacklist"- A string. Whether the configured mob should be spawned when the player has the stage, or stopped from spawning when the player has the stage. The possible values are:
"WHITELIST"- Will allow the zombie to spawn under the specified conditions when the player has the stage."BLACKLIST"- Prevents the zombie from spawning under the specified conditions (with 500 HP, strength effect, and an egg in its hand) when triggered by a spawn type likeNATURAL,SPAWNER,MOB_SUMMONED,SPAWN_EGG, orCOMMAND.
"entityID"- A string. The id of the mob these conditions should apply to. This is a single id. You can find it in the game with the F3 menu.
"health"- This is an integer. Set the health the mob will spawn with.
WIP
Now, let's see some situational examples, just so you can get a proper idea of how you can efficiently use this mod.
Last updated
