Consumable Components #8216

Absolutionism · 2025-10-02T02:24:02Z

Problem

Skript does not have support for Consumable Components yet. Leaving players unable to modify items to be consumable and other correlating data.

Solution

Adds Consumable Components and all correlating data to Skript following the backend of the component system locked behind a experiment. Allows players to modify items regarding consumption sound, consumption time, consume effects and many more.
Additionally adds ConsumeEffects with a custom ConsumeEffectType enum

Testing Completed

ConsumableComponents.sk

Supporting Information

N/A

Completes: none
Related: none

# src/main/java/ch/njol/skript/registrations/Feature.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/ComponentWrapper.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/EquippableModule.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/EquippableWrapper.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompDamage.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompDispensable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompInteract.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompShearable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompSwapEquipment.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompDamageable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompDispensable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompInteract.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompShearable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompSwapEquipment.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompCameraOverlay.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompEntities.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompEquipSound.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompModel.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompShearSound.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompSlot.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquippableComponent.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprSecBlankEquipComp.java # src/main/resources/lang/default.lang

…leComponent # Conflicts: # src/main/java/ch/njol/skript/Skript.java # src/main/java/ch/njol/skript/registrations/Feature.java # src/main/java/ch/njol/skript/util/ItemSource.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/ComponentUtils.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/ComponentWrapper.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/ItemComponentModule.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/EquippableModule.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/EquippableWrapper.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompDamage.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompDispensable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompInteract.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompShearable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/CondEquipCompSwapEquipment.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompDamageable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompDispensable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompInteract.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompShearable.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/EffEquipCompSwapEquipment.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompCameraOverlay.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompEntities.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompEquipSound.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompModel.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompShearSound.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquipCompSlot.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprEquippableComponent.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/ExprSecBlankEquipComp.java # src/main/java/org/skriptlang/skript/bukkit/itemcomponents/generic/ExprItemCompCopy.java # src/main/resources/lang/default.lang

sovdeeth

The parser rework would be needed, but thoughts on something akin to

when {x} is consumed:
    clear all potion effects
    teleport randomly in a radius of 10
    play sound "xyz"
    
or
add the following consumption effects to {x}:
    ....

?

sovdeeth · 2025-11-07T06:32:13Z

...a/org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/ExprConsCompAnimation.java

+
+	@Override
+	public Class<?> @Nullable [] acceptChange(ChangeMode mode) {
+		if (mode == ChangeMode.SET)


pretty much all of these attributes need RESET support and their default values spelled out in the description.
This one should also support DELETE

sovdeeth · 2025-11-07T06:32:50Z

...ava/org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/ExprConsCompEffects.java

+	public static void register(SyntaxRegistry registry) {
+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			infoBuilder(ExprConsCompEffects.class, ConsumeEffect.class, "consum(e|ption) effects", "consumablecomponents", true)


Suggested change

infoBuilder(ExprConsCompEffects.class, ConsumeEffect.class, "consum(e|ption) effects", "consumablecomponents", true)

infoBuilder(ExprConsCompEffects.class, ConsumeEffect.class, "consum(e|ption) [potion] effects", "consumablecomponents", true)

sovdeeth · 2025-11-07T06:33:10Z

...ava/org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/ExprConsCompEffects.java

+
+@Name("Consumable Component - Consume Effects")
+@Description("""
+	The consume effects that should activate when the item is consumed.


Suggested change

The consume effects that should activate when the item is consumed.

The potion effects that should activate when the item is consumed.

sovdeeth · 2025-11-07T06:35:35Z

...n/java/org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/ExprConsCompTime.java

+	public static void register(SyntaxRegistry registry) {
+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			infoBuilder(ExprConsCompTime.class, Timespan.class, "consum(e|ption) time", "consumablecomponents", true)


Suggested change

infoBuilder(ExprConsCompTime.class, Timespan.class, "consum(e|ption) time", "consumablecomponents", true)

infoBuilder(ExprConsCompTime.class, Timespan.class, "consum(e|ption) duration", "consumablecomponents", true)

sovdeeth · 2025-11-07T06:36:49Z

.../org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/ExprConsumeEffectApply.java

+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			SyntaxInfo.Expression.builder(ExprConsumeEffectApply.class, ConsumeEffect.class)
+				.addPatterns("[a] consume effect to apply %potioneffects% with [a] probability of %number%")


Suggested change

.addPatterns("[a] consume effect to apply %potioneffects% with [a] probability of %number%")

.addPatterns("[a] consume effect that applies %potioneffects% with [a] probability of %number%")

or [a] chance to apply %potioneffects% with [a] probability of %number% if you want to get a bit more fluid with the syntax.

sovdeeth · 2025-11-07T06:37:14Z

.../org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/ExprConsumeEffectApply.java

+		//noinspection unchecked
+		effects = (Expression<PotionEffect>) exprs[0];
+		//noinspection unchecked


you can suppress with annotation instead

sovdeeth · 2025-11-07T06:38:00Z

...org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/ExprConsumeEffectRemove.java

+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			SyntaxInfo.Expression.builder(ExprConsumeEffectRemove.class, ConsumeEffect.class)
+				.addPatterns("[a] consume effect to remove %potioneffecttypes%")


Suggested change

.addPatterns("[a] consume effect to remove %potioneffecttypes%")

.addPatterns("[a] consume effect that (removes|clears|cures) %potioneffecttypes%")

sovdeeth · 2025-11-07T06:39:02Z

.../org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/ExprConsumeEffectSound.java

+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			SyntaxInfo.Expression.builder(ExprConsumeEffectSound.class, ConsumeEffect.class)
+				.addPatterns("[a] consume effect to play [[the] sound] %string%")


Suggested change

.addPatterns("[a] consume effect to play [[the] sound] %string%")

.addPatterns("[a] consume effect that plays [[the] sound] %string%")

sovdeeth · 2025-11-07T06:40:33Z

...va/org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/ExprSecBlankConsComp.java

+
+@Name("Blank Consumable Component")
+@Description("""
+	Gets a blank consumable component.


DEFAULTS!!!!

sovdeeth · 2025-11-07T06:40:53Z

...a/org/skriptlang/skript/bukkit/itemcomponents/consumable/elements/LitConsumeEffectClear.java

+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			SyntaxInfo.Expression.builder(LitConsumeEffectClear.class, ConsumeEffect.class)
+				.addPatterns("[a] consume effect to clear all (potion|status) effects")


Suggested change

.addPatterns("[a] consume effect to clear all (potion|status) effects")

.addPatterns("[a] consume effect that clears all (potion|status) effects")

Absolutionism added 9 commits September 6, 2025 18:02

Merge dev/EquippableComponents

1073742

Initial Commit

285a2d3

Consume Effects

6af0787

Javadocs

3c78c6d

Update

543ab56

Update ExprSecBlankConsComp.java

1ceb0ce

Update

09fa940

Absolutionism added this to 2.14 Releases Oct 2, 2025

Absolutionism requested a review from a team as a code owner October 2, 2025 02:24

Absolutionism added the feature Pull request adding a new feature. label Oct 2, 2025

Absolutionism requested review from cheeezburga and erenkarakal and removed request for a team October 2, 2025 02:24

skriptlang-automation bot added the needs reviews A PR that needs additional reviews label Oct 2, 2025

Merge branch 'dev/feature' into dev/ConsumableComponent

ba8175e

Absolutionism moved this to In Review in 2.14 Releases Oct 2, 2025

Absolutionism added the 2.14 Targeting a 2.14.X version release. label Nov 2, 2025

sovdeeth requested changes Nov 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Consumable Components #8216

Consumable Components #8216

Uh oh!

Absolutionism commented Oct 2, 2025 •

edited

Loading

Uh oh!

sovdeeth left a comment •

edited

Loading

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

sovdeeth Nov 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	infoBuilder(ExprConsCompEffects.class, ConsumeEffect.class, "consum(e\|ption) effects", "consumablecomponents", true)
	infoBuilder(ExprConsCompEffects.class, ConsumeEffect.class, "consum(e\|ption) [potion] effects", "consumablecomponents", true)

	The consume effects that should activate when the item is consumed.
	The potion effects that should activate when the item is consumed.

	infoBuilder(ExprConsCompTime.class, Timespan.class, "consum(e\|ption) time", "consumablecomponents", true)
	infoBuilder(ExprConsCompTime.class, Timespan.class, "consum(e\|ption) duration", "consumablecomponents", true)

	.addPatterns("[a] consume effect to apply %potioneffects% with [a] probability of %number%")
	.addPatterns("[a] consume effect that applies %potioneffects% with [a] probability of %number%")

	.addPatterns("[a] consume effect to remove %potioneffecttypes%")
	.addPatterns("[a] consume effect that (removes\|clears\|cures) %potioneffecttypes%")

	.addPatterns("[a] consume effect to play [[the] sound] %string%")
	.addPatterns("[a] consume effect that plays [[the] sound] %string%")

	.addPatterns("[a] consume effect to clear all (potion\|status) effects")
	.addPatterns("[a] consume effect that clears all (potion\|status) effects")

Uh oh!

Consumable Components #8216

Are you sure you want to change the base?

Consumable Components #8216

Uh oh!

Conversation

Absolutionism commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Testing Completed

Supporting Information

Uh oh!

sovdeeth left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Absolutionism commented Oct 2, 2025 •

edited

Loading

sovdeeth left a comment •

edited

Loading