Script type & expression. #6702
Open
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
Moderocky
requested review from
sovdeeth,
AyhamAl-Ali,
Pikachu920,
APickledWalrus,
TPGamesNL and
UnderscoreTud
APickledWalrus
requested changes
May 17, 2024
Moderocky
force-pushed
the
script-object-type
branch
from
609bac0
to
064f1ce
Compare
Moderocky
commented
May 18, 2024
| "\t\tsend \"Unloaded Scripts: %disabled scripts%\" to player" | ||
| }) | ||
| @Since("INSERT VERSION") | ||
| public class ExprScriptsNew extends SimpleExpression<Script> { |
There was a problem hiding this comment.
I couldn't think of an appropriate name for this, any ideas would be welcome.
Moderocky
commented
May 18, 2024
| @Name("Script") | ||
| @Description({"The current script, or a script from its (file) name.", | ||
| "If the script is enabled or disabled (or reloaded) this reference will become invalid.", | ||
| "Therefore, it is recommended to obtain a script reference <em>when needed</em>."}) |
There was a problem hiding this comment.
If you disable/reload a script, the data in the old Script reference will be discarded. I'd quite like to add some kind of valid()/invalidate() thing to the Script object to help track that (i.e. is the reference safe to keep?) but it's not essential. Looking for feedback.
There was a problem hiding this comment.
Added this via a subsequent PR.
Co-authored-by: Patrick Miller <apickledwalrus@gmail.com>
This was referenced May 19, 2024
Draft
sovdeeth
approved these changes
May 29, 2024
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
The first step towards supporting proper reflection & introspection: a type and object handles for scripts.
This adds:
scripttype.Scriptobjects for disabled/unlinked scripts.[script] reflectionfor most linked features & breaking changes.Validatedinterface to be used by scripts and other resources that could become obsolete. This is purely a testing API right now.[the] [current] script,[the] script[s] [named] %strings%.nameproperty of scripts.name of scriptdid, e.g.scripts/folder/MyScript.sk->folder/MyScript.scripts/folder/MyScript.sk->MyScript.Scriptdummy object for disabled scripts.enable skript "hello.sk"skriptandscriptto be unhelpful and confusing, people might mistakereload skript ...to mean reloading Skript, when it was actually for files.skript file ..., orscript...to make that clearer.Breaking Changes
The
enable|disable skript %string%pattern variation was removed. You can still useskript fileorscript.Resource safety has been significantly improved: there were basically zero checks on what you tried to reload/disable previously. If it wasn't a valid file it would throw huge exceptions, and if it was it would just get processed without any kind of safety checks.
scripts/directory (unless you're running in Test mode!)With the experiment enabled, unloading is now considered different from disabling in syntax: disabling a script will unload it and prepend
-to its file name. Unloading it will just unload it from memory (but not disable it, so it would load normally upon next restart).Where Next?
This could be the start of some reflection.
I'd like to see a bit of introspection in the future (maybe looking at what structures are in a script, some features from Config, etc.)
There was some discussion about some other reflective stuff (like dynamic function calls) which would probably tie into this quite nicely. I've opened a branch for anybody who wants it.
This could move in the direction of runtime-parsed scripts, anonymous scripts, etc.
I'm also wondering about abstracting some kind of loadable interface (or maybe just use Config) so that we can permit the [re]loading of other Skript-related things that can be loaded (aliases, config, etc.)
I don't have any plans for the loading of non-script-provided files (e.g. a user-provided config
.skfile) at this point, but if I abstracted this back a layer then it would be really easy (for an addon) to provide that in the future if somebody wants to.Target Minecraft Versions: any
Requirements: none
Related Issues: none