Reserve variable starting characters. #6609
Open
+54
−13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Moderocky
added
enhancement
sovdeeth
approved these changes
Apr 25, 2024
AyhamAl-Ali
approved these changes
Apr 25, 2024
APickledWalrus
requested changes
Sep 22, 2024
| } | ||
| } | ||
| Skript.warning("The character '" + token + "' is reserved at the start of variable names, " + | ||
| "and may be restricted in future versions"); |
There was a problem hiding this comment.
It appears that tabs and spaces are being mixed on this line. Two standard indents should suffice
APickledWalrus
approved these changes
Nov 20, 2024
| continue check_reserved_tokens; | ||
| } | ||
| } | ||
| Skript.warning("The character '" + token + "' is reserved at the start of variable names, " + |
There was a problem hiding this comment.
I would like to see this message in english.lang. I think it is reasonable for us to provide translation support for these internal messages.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In an upcoming version, we're looking at instituting new special variable types (e.g. unsaved, reference).
No plans are finalised for this, but the first step is reserving the starting characters (like
_for local variables).The current characters reserved are:
{~variable} {.variable} {$variable} {!variable} {&variable} {^variable} {*variable} # See note 2 {+variable} {-variable} # See note 1Currently, this will only issue a warning when they're used (but it won't prevent anything loading).
Presumably, in some future version, this will become an error (or the variable will have some special functionality)!
Why these characters?
It was a pretty arbitrary choice, we just picked a handful of special characters to give us some freedom for future changes.
Note 1:
-minus variableA lot of people use the
(?!-).*pattern in the config to prevent{-variable}from being saved at all (i.e. to vanish when Skript terminates).We'd like to institute proper behaviour for an 'ephemeral variable' in the future (rather than just using the config pattern as a patchwork), so that's why we're reserving this character.
However, I've tried to skip the warning IFF you're using this pattern in the config (since there's nothing to warn you about).
Note 2:
*starStars are already prohibited in variable names (other than in a
list::*) so this one shouldn't affect anybody.Target Minecraft Versions: any
Requirements: none
Related Issues: none