Item Stages

Table of Contents

Item Stages

This mod is an addon for the GameStages API. It allows for items and blocks to be placed into custom progression systems. You should check out the GameStage API mod's description for more info. To give a brief run down, stages are parts of the progression system set up by the modpack or server. Stages are given to players through a command, which is typically ran by a questing mod, advancement, or even a Command Block.

This project is sponsored by Nodecraft. Use code Darkhax for 30% off your first month of service!

Setup

This mod uses CraftTweaker for configuration.

This mod adds one new ZenScript method for adding item stage restrictions. You can use a specific item/block id, or an ore dictionary entry. If an ore dictionary is used, all entries for that oredict will be restricted. mods.ItemStages.addItemStage(String stage, Item/Block/OreDict);

Effects

When something is restricted by this mod, several things will happen to prevent the player from using the item.

Holding a restricted item will cause it to be dropped immediately. (Configurable)
Equipping the item to offhand, armor, or bauble slot will cause it to be dropped. (Configurable)
Players can not right click or left click with the item. (Configurable)
The tooltip will be replaced with a restricted message.
The item will not be visible in JEI

Example Script

// Example Script

// Locks stone to stage one
mods.ItemStages.addItemStage("one", <minecraft:stone>);

// Locks all registered records to stage two
mods.ItemStages.addItemStage("two", <ore:record>);

// Locks all items from a mod to a stage
mods.ItemStages.stageModItems("one", "minecraft");

// Locks a liquid to a stage. This only affects JEI
mods.ItemStages.stageLiquid("nine", <liquid:water>);

Comments

falizure
- Join Date: 10/21/2016
- Posts: 2
- Member Details
#22 falizure

View User Profile

Send Message

Posted Mar 16, 2019
just submitted a PR for a new example script to the readme, it might be useful to add that to the examples here on the curse page as well assuming the length is not a issue.

Rollback Post to Revision RollBack
Chaos2341
- Join Date: 5/12/2013
- Posts: 31
- Member Details
#21 Chaos2341

View User Profile

Send Message

Posted Mar 6, 2019
Is there a way to only unlock one item from a compleate staged mod, if the quest (better questing mod) and/or stage for it is reached so that the "real unlocking" can start or must this then be seperated per item?

Rollback Post to Revision RollBack
Mortercowy
- Join Date: 1/24/2018
- Posts: 2
- Member Details
#17 Mortercowy

View User Profile

Send Message

Posted Jan 4, 2019
Is there any way to stage all items from a certain mod to a stage without having to write every single one of them?

Rollback Post to Revision RollBack
clubpetey58622
- Join Date: 5/10/2018
- Posts: 5
- Member Details
#18 clubpetey58622

View User Profile

Send Message

Posted Jan 5, 2019
In reply to Mortercowy:

Not in the mod specifically, but I use this function to do that...

function stageMod(stage as string, mod as string) { for item in loadedMods[mod].items { mods.ItemStages.addItemStage(stage, item); } }
Rollback Post to Revision RollBack
Darkhax
Curse Premium
- Location: Canada.
- Join Date: 6/5/2011
- Posts: 434
- Member Details
#19 Darkhax

View User Profile

Send Message

Posted Jan 5, 2019
In reply to clubpetey58622:

I provide a method to stage all the items of a given mod. My version of the method will actually be significantly faster than one written in ZS due to caching I do inside of GameStages. The zenscript code for accessing this is documented in the main mod post.

// Locks all items from a mod to a stage mods.ItemStages.stageModItems("one", "minecraft");
Rollback Post to Revision RollBack
teagan75
Curse Premium
- Join Date: 7/28/2014
- Posts: 115
- Member Details
#14 teagan75

View User Profile

Send Message

Posted Oct 28, 2018
I set the left click/right click to default in configs. I thought that would prevent a player from opening up an inventory or GUI of a machine/chest/furnace etc. Am I not understanding the config option?

Edit: I can still equip restricted items to Galacticraft inventory slots.

Last edited by teagan75: Oct 28, 2018

Rollback Post to Revision RollBack
Darkhax
Curse Premium
- Location: Canada.
- Join Date: 6/5/2011
- Posts: 434
- Member Details
#15 Darkhax

View User Profile

Send Message

Posted Oct 28, 2018
In reply to teagan75:

left/right click is for interacting with an item, not a block. Also Galactricraft is not supported right now.

Rollback Post to Revision RollBack
teagan75
Curse Premium
- Join Date: 7/28/2014
- Posts: 115
- Member Details
#16 teagan75

View User Profile

Send Message

Posted Oct 29, 2018
In reply to Darkhax:

Ok thank you

Rollback Post to Revision RollBack
ihatethatcreeper
- Join Date: 2/3/2018
- Posts: 17
- Member Details
#12 ihatethatcreeper

View User Profile

Send Message

Posted Aug 31, 2018
item stages is broken when using mod staging it doesnt hide things in jei when you do mod staging

Rollback Post to Revision RollBack
offworld1992
- Join Date: 6/18/2018
- Posts: 10
- Member Details
#9 offworld1992

View User Profile

Send Message

Posted Aug 11, 2018
I'm trying to stage [Enchanted Books]. Since they're not ore dictionary'd I'm having a tough time.

Does anyone have any ideas? Maybe a function that I'm overlooking?

Rollback Post to Revision RollBack
kindlich
- Join Date: 10/4/2014
- Posts: 28
- Member Details
#10 kindlich

View User Profile

Send Message

Posted Aug 17, 2018
In reply to offworld1992:

You could try to use the getSubItems method as that should give you a list of enchanted books with each having one enchant from the enchantment registry. Though just staging the enchantedBook item itself should prevent all of them from being useable, as the actual enchant is only NBT-Data

Rollback Post to Revision RollBack
Darkhax
Curse Premium
- Location: Canada.
- Join Date: 6/5/2011
- Posts: 434
- Member Details
#11 Darkhax

View User Profile

Send Message

Posted Aug 18, 2018
In reply to offworld1992:

You can use a :* for wildcard which will get all of them. :* can be used to get all meta values and sub items that are in creative tabs.

Rollback Post to Revision RollBack
eman_not_ava
- Join Date: 6/27/2014
- Posts: 13
- Member Details
#13 eman_not_ava

View User Profile

Send Message

Posted Oct 8, 2018
In reply to offworld1992:

i've actually been trying the same thing for a modpack i'm making and the "subitems method" that kindlich suggested didn't work for me, so i've actually done each and every enchanted book manually which includes the enchanted books added by COFH Core/EnderIO.

if you want you can have the script, but it's a bit long to post here, so should i send it in PM(Personal Message)?

Rollback Post to Revision RollBack
MKTim
Curse Premium
- Location: Aalsmeer
- Join Date: 3/21/2016
- Posts: 37
- Member Details
#8 MKTim

View User Profile

Send Message

Posted Jul 4, 2018
Could the liquid stage also blocks the bucket pickup?

that would be AWESOME!

Rollback Post to Revision RollBack
golrith
- Join Date: 4/8/2018
- Posts: 137
- Member Details
#7 golrith

View User Profile

Send Message

Posted Jul 3, 2018
If I assign a stage to a mod, can I remove that stage from specific items within that mod?

aka is mods.ItemStages.removeItemStage("one", <minecraft:stone>); such a thing?

Rollback Post to Revision RollBack
Migmag789
Curse Premium
- Join Date: 12/20/2016
- Posts: 59
- Member Details
#5 Migmag789

View User Profile

Send Message

Posted Apr 27, 2018
Hey ! I have a question : a stage can be unlocked by simply getting an item or crafting a item ? :D

Rollback Post to Revision RollBack
Amoncipal
- Join Date: 8/31/2016
- Posts: 178
- Member Details
#6 Amoncipal

View User Profile

Send Message

Posted Jul 2, 2018
In reply to Migmag789:

https://minecraft.curseforge.com/projects/gamestage-books

If that's not too late.

Rollback Post to Revision RollBack
Stormiyo
- Join Date: 2/4/2017
- Posts: 7
- Member Details
#1 Stormiyo

View User Profile

Send Message

Posted Mar 4, 2018
I am having trouble understanding how exactly this addon (and the base Game Stages mod) works. Would this allow me to prevent players from acquiring an item based on the following conditions?

Item cannot be broken, crafted, or picked up until xx amount of stone (or other item) is mined

Mod plants from Botania and Pam's Harvestcraft can be broken, but not gathered, until xx amount of vanilla plants are gathered

Also, are stages unlocked per player or per world?

Thanks for all your hard work with this mod!
Last edited by Stormiyo: Mar 4, 2018

Rollback Post to Revision RollBack
Darkhax
Curse Premium
- Location: Canada.
- Join Date: 6/5/2011
- Posts: 434
- Member Details
#3 Darkhax

View User Profile

Send Message

Posted Mar 4, 2018
In reply to Stormiyo:

The mod GameStages provides the base API and systems for other mods to hook into. It is what a modpack uses to give/take stages from players. Other mods like Item Stages can then hook into it and change how things work if a player doesn't have a certain stage.

This mod specifically does the following

If they don't have the required stage, they can't hold the item or equip it in the offhand, armor or baubles slots.

They can't right click or left click with the item.

The item will not be visible in JEI
Rollback Post to Revision RollBack
mortismorte
Curse Premium
- Location: Florida
- Join Date: 3/6/2015
- Posts: 4
- Member Details
#4 mortismorte

View User Profile

Send Message

Posted Mar 12, 2018
In reply to Stormiyo:

From what I have seen I don't think game/item stages themselves will unlock a stage after you collect x amount of items. For that ability combined with hqm or better questing, the quest is to gather x amount, one of the rewards is to run the command to unlock the stage for that player. (not sure how well that would work for teams tho, haven't tried it with teams myself.

Last edited by mortismorte: Mar 12, 2018

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.