Rewrite Custom Syntax by UnderscoreTud · Pull Request #165 · SkriptLang/skript-reflect

UnderscoreTud · 2026-02-06T11:47:27Z

Problem

The current custom syntax implementation is built on very old Skript API, when modifying syntax registries at runtime wasn't natively supported. This led to code relying on hacky methods and workarounds to achieve this type of behavior, as a byproduct, the codebase for this system was extremely hard to follow, fragmented and difficult to maintain.

Solution

Rewrite the custom syntax system from the ground up to use the registration API, significantly improving its readability, maintainability and consistency.

Testing Completed

Manual testing

Supporting Information

This rewrite should not introduce any user-facing breaking changes

Review Notice

If you are reviewing this pull request, I suggest starting from the org.skriptlang.reflect.syntax.custom.shared package, as everything is built on top of the base classes found there.

Completes: none
Related: none
AI assistance: none

# Conflicts: # build.gradle # src/main/java/com/btk5h/skriptmirror/ParseOrderWorkarounds.java # src/main/java/com/btk5h/skriptmirror/SkriptMirror.java # src/main/java/com/btk5h/skriptmirror/skript/custom/ExprExpression.java # src/main/java/com/btk5h/skriptmirror/skript/custom/ExprParseTags.java # src/main/java/com/btk5h/skriptmirror/skript/custom/ExprRawExpression.java # src/main/java/com/btk5h/skriptmirror/skript/reflect/ExprJavaCall.java # src/main/java/org/skriptlang/reflect/syntax/custom/event/EventValuesEntryData.java # src/main/java/org/skriptlang/reflect/syntax/custom/expression/ChangerEntryData.java # src/main/java/org/skriptlang/reflect/syntax/event/elements/CustomEvent.java # src/main/java/org/skriptlang/reflect/syntax/event/elements/EffCallEvent.java # src/main/java/org/skriptlang/reflect/syntax/event/elements/ExprCustomEvent.java # src/main/java/org/skriptlang/reflect/syntax/event/elements/ExprCustomEventValue.java # src/main/java/org/skriptlang/reflect/syntax/event/elements/ExprEventData.java # src/main/java/org/skriptlang/reflect/syntax/event/elements/ExprReplacedEventValue.java # src/main/java/org/skriptlang/reflect/syntax/event/elements/StructCustomEvent.java # src/main/java/org/skriptlang/reflect/syntax/expression/elements/ExprChangeValue.java # src/main/java/org/skriptlang/reflect/syntax/expression/elements/StructCustomExpression.java

…r than the ParserInstance

sovdeeth

I haven't looked through super closely but this seems fantastic from skimming it
No glaring issues (except the lack of docs annotations!)
origins and priorities should probably be handled automatically for the most part (may want to use an origin-applying registry)
The logic for the custom events looks great, good usage of ERS

…lues

# Conflicts: # build.gradle

APickledWalrus

Truly excellent work!

I'm going to ask that you add Documentation annotations for all of these elements. It would be nice to include skript-reflect on the new docs website 🙂

Side question: Shouldn't the new package be something like org.skriptlang.skriptreflect? (akin to org.skriptlang.skriptworldguard). I feel like the organization is a bit odd in general too. I think it might make sense to have a single subpackage like elements with further subpackages java, syntax, etc.

…lled

APickledWalrus

Looks great. Just about ready!

...but docs 🥺

APickledWalrus · 2026-06-17T18:12:11Z

+	public static void register(SyntaxRegistry registry) {
+		registry.register(SyntaxRegistry.EXPRESSION, SyntaxInfo.Expression.builder(ExprParseTags.class, String.class)
+			.supplier(ExprParseTags::new)
+			.addPattern("[the] [parse[r]] tags")


Suggested change

.addPattern("[the] [parse[r]] tags")

.addPattern("[the] [:parse[r]] tags")

Forgot this

APickledWalrus · 2026-06-17T18:22:30Z

+			return getNext();
+
+		Object locals = Variables.copyLocalVariables(effectEvent.getDirectEvent());
+		new Thread(() -> {


What's this doing or what's the purpose?

honestly not sure, i just ported it from the old custom effect logic. im guessing its a way to preserve local variables in async effects?

So this is to restore local variables for delays effects when re-starting the code after the effect call, but it ends up with a memory leak if the user never calls continue.

What we should do instead is store the localvariables in the EffectTriggerEvent and use Variables.withLocalVariables when walking next in setContinue

sovdeeth · 2026-06-22T02:22:12Z

+					Variables.setLocalVariables(effectEvent.getDirectEvent(), locals);
+			} catch (InterruptedException ignored) {}
+		}).start();
+		return null;


Delayed effects do not ever run the code after them, if you don't continue. Is this intended? I think it should either have an implicit continue if it reaches the end without continue, or have an error of some sort.

> test-reflect [19:20:57 INFO]: 1 [19:20:57 INFO]: a [19:20:57 INFO]: b

effect run after this please: trigger: broadcast "a" delay the effect broadcast "b" command test-reflecT: trigger: broadcast "1" run after this please broadcast "2"

sovdeeth · 2026-06-22T02:36:36Z

+			return getNext();
+
+		Object locals = Variables.copyLocalVariables(effectEvent.getDirectEvent());
+		new Thread(() -> {


So this is to restore local variables for delays effects when re-starting the code after the effect call, but it ends up with a memory leak if the user never calls continue.

What we should do instead is store the localvariables in the EffectTriggerEvent and use Variables.withLocalVariables when walking next in setContinue

UnderscoreTud added 13 commits October 27, 2025 13:52

Update build.gradle and switch to jetbrains annotations

45d203d

Remove unused import and extra trailing line

a59dec3

Rewrite custom syntaxes

106bab3

Make ExprChangeValue return the possible return types

25a57af

Register ChangerData

02a4ad8

Check for array types in accepted classes and add a plurality check

78160ae

Improve return type and plurality handling for ExprExpression

8653bea

Resolve conflicts

5a3b907

Finish up the custom event implementation

86aaefb

Remove debug statements

aae2dc4

Add an expression to reference 'self' for custom syntax

00d4fb5

Optimize imports

f37f449

UnderscoreTud added the enhancement New feature or request label Feb 6, 2026

UnderscoreTud requested review from APickledWalrus and sovdeeth February 6, 2026 12:21

UnderscoreTud added 5 commits February 6, 2026 16:58

Store ExpressionsData and ChangerData directly on the structure rathe…

78ebcc0

…r than the ParserInstance

Fix parse error in custom condition.sk

841e0b1

Fix index handling in ExprExpression

93d233a

Fix plurality handling for custom property expressions

11bb490

Fix 'parse' and 'check' sections load order for custom events

a6e30f1

sovdeeth requested changes Feb 7, 2026

View reviewed changes

UnderscoreTud added 8 commits February 9, 2026 07:16

Infer custom expression plurality from return type

fd36d30

Implement ReturnHandler for reflect sections

2889fb9

Store the original context of lazy expressions

09d14ef

Allow the 'get' section of property expressions to return multiple va…

cf2b2af

…lues

Fix accepted classes for a changer getting flattened from array type

e90d67b

Refactor custom syntax classes to use info classes

41e3383

Store origin on custom syntaxes

8f8d7d9

Merge branch '2.x' into feature/custom-syntax-rewrite

5865211

# Conflicts: # build.gradle

Remove deprecated raw expression pattern

d44e88f

APickledWalrus requested changes May 28, 2026

View reviewed changes

UnderscoreTud added 18 commits May 29, 2026 01:40

Reintroduce custom syntax tracking

7a09d77

Replace reflection with proper API call for unloading options

992f766

Replace useless TriggerEntryData with Skript's equivalent

998503c

Replace getEnglishPlural with non deprecated method

c8d9fca

Replace ExprEventClasses with proper event value

bb6b140

Delete unused priority constants and ExprEventClasses registration

6595aff

Cache script variable outside loop

583f282

Migrate ExprRawExpression to using infoBuilder

dbd1950

Move isSingle before getReturnType

4853c6c

Delete unused syntax registry class

b7ec66f

Cache result of Utils.getSuperType(possibleReturnTypes)

e39f093

Annotate custom syntax classes with NoDoc

5b70c69

Make isMarkedContinue a part of the Continuable interface

ef1b72b

Use pattern matching for instanceof in check method of CondEventCance…

17f34a1

…lled

Fix effect sync handling

24bed03

Store return type in ExprChangeValue to optimize getReturnType method

6ed522b

Add deprecation warning for missing 'parse' in expressions

0d78476

Rename variable

ef687f9

UnderscoreTud requested review from APickledWalrus and sovdeeth May 29, 2026 00:23

APickledWalrus requested changes Jun 17, 2026

View reviewed changes

UnderscoreTud added 6 commits June 18, 2026 00:50

Update Skript dependency to 2.15.3

58c4494

Rename LazyExpression to CachingExpression

0a84dea

Add clarifying comment for custom event registration

400de64

Add 'raw expression %objects%' back as a valid pattern

a2197ea

Improve local variable tracking

0ce9079

Cleanup ExprCustomEvent toString

c50f858

sovdeeth requested changes Jun 22, 2026

View reviewed changes

	.addPattern("[the] [parse[r]] tags")
	.addPattern("[the] [:parse[r]] tags")

Uh oh!

Uh oh!

Conversation

UnderscoreTud commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Testing Completed

Supporting Information

Review Notice

Uh oh!

sovdeeth left a comment

Choose a reason for hiding this comment

Uh oh!

APickledWalrus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

APickledWalrus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

APickledWalrus Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

APickledWalrus Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

UnderscoreTud Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

sovdeeth Jun 22, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sovdeeth Jun 22, 2026

Choose a reason for hiding this comment

Uh oh!

sovdeeth Jun 22, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

UnderscoreTud commented Feb 6, 2026 •

edited

Loading