Dev/patch - Future Release

build.gradle.kts

@@ -25,7 +25,7 @@ repositories {
 dependencies {
     compileOnly("com.hypixel.hytale:Server:${hytaleVersion}")
     compileOnly("org.jetbrains:annotations:26.0.2")
-    implementation("com.github.SkriptDev:skript-parser:1.0.2") {
+    implementation("com.github.SkriptDev:skript-parser:1.0.3") {
         isTransitive = false
     }
     implementation("com.github.Zoltus:TinyMessage:2.0.1") {

src/main/java/com/github/skriptdev/skript/api/hytale/AssetStoreUtils.java

@@ -0,0 +1,45 @@
+package com.github.skriptdev.skript.api.hytale;
+
+import com.hypixel.hytale.server.core.asset.type.blocktype.config.BlockType;
+import com.hypixel.hytale.server.core.asset.type.item.config.Item;
+import com.hypixel.hytale.server.core.inventory.ItemStack;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Quick utility methods for working with AssetStore
+ */
+public class AssetStoreUtils {
+
+    /**
+     * Get a BlockType from ID
+     *
+     * @param blockId ID of the BlockType
+     * @return BlockType from ID if found, otherwise null
+     */
+    public static @Nullable BlockType getBlockType(@NotNull String blockId) {
+        return BlockType.getAssetMap().getAsset(blockId);
+    }
+
+    /**
+     * Get a BlockType from ItemStack
+     *
+     * @param itemStack ItemStack to get BlockType from
+     * @return BlockType from ItemStack if found, otherwise null
+     */
+    public static @Nullable BlockType getBlockType(@NotNull ItemStack itemStack) {
+        return getBlockType(itemStack.getItem());
+    }
+
+    /**
+     * Get a BlockType from Item
+     *
+     * @param item Item to get BlockType from
+     * @return BlockType from Item if found, otherwise null
+     */
+    public static @Nullable BlockType getBlockType(@NotNull Item item) {
+        if (item.hasBlockType()) return getBlockType(item.getBlockId());
+        return null;
+    }
+
+}

src/main/java/com/github/skriptdev/skript/api/hytale/Block.java

@@ -1,5 +1,6 @@
 package com.github.skriptdev.skript.api.hytale;
 
+import com.github.skriptdev.skript.api.utils.Utils;
 import com.hypixel.hytale.component.Ref;
 import com.hypixel.hytale.component.Store;
 import com.hypixel.hytale.math.util.ChunkUtil;
@@ -13,51 +14,45 @@
 import com.hypixel.hytale.server.core.universe.world.chunk.section.FluidSection;
 import com.hypixel.hytale.server.core.universe.world.storage.ChunkStore;
 import org.jetbrains.annotations.NotNull;
-
-import java.util.Objects;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Represents a block in a world.
- * Hytale doesn't appear to have a representation of a block in a world.
+ * Hytale doesn't appear to have a representation of a block in the world.
  * This class provides a wrapper around Hytale's block system, allowing for easy interaction with blocks in a world.
  * This may be changed/removed in the future.
  */
 @SuppressWarnings("unused")
 public class Block {
 
     private final @NotNull World world;
-    private @NotNull BlockType type;
     private final @NotNull Vector3i pos;
 
     public Block(@NotNull World world, @NotNull Vector3i pos) {
         this.world = world;
         this.pos = pos;
-        this.type = Objects.requireNonNull(world.getBlockType(pos));
-    }
-
-    public Block(@NotNull World world, @NotNull Vector3i pos, @NotNull BlockType type) {
-        this.world = world;
-        this.pos = pos;
-        this.type = type;
     }
 
     public Block(@NotNull Location location) {
         World world = Universe.get().getWorld(location.getWorld());
         if (world == null) {
             throw new IllegalArgumentException("World '" + location.getWorld() + "' not found.");
         }
-        BlockType blockType = world.getBlockType(location.getPosition().toVector3i());
-        assert blockType != null;
-        this(world, location.getPosition().toVector3i(), blockType);
+        this(world, location.getPosition().toVector3i());
     }
 
     public @NotNull BlockType getType() {
-        return this.type;
+        BlockType blockType = this.world.getBlockType(this.pos);
+        return blockType != null ? blockType : BlockType.EMPTY;
     }
 
     public void setType(@NotNull BlockType type, int settings) {
-        this.type = type;
-        this.world.setBlock(this.pos.getX(), this.pos.getY(), this.pos.getZ(), type.getId(), settings);
+        Runnable r = () -> Block.this.world.setBlock(Block.this.pos.getX(), Block.this.pos.getY(), Block.this.pos.getZ(), type.getId(), settings);
+        if (this.world.isInThread()) {
+            r.run();
+        } else {
+            this.world.execute(r);
+        }
     }
 
     public byte getFluidLevel() {
@@ -91,10 +86,10 @@ public void setFluidLevel(byte level) {
                     return null;
                 }
 
-
                 Fluid fluid = fluidSection.getFluid(this.pos.getX(), this.pos.getY(), this.pos.getZ());
                 if (fluid == null) return null;
-                fluidSection.setFluid(this.pos.getX(), this.pos.getY(), this.pos.getZ(), fluid, level);
+                byte fluidLevel = (byte) Math.clamp((int) level, 0, fluid.getMaxFluidLevel());
+                fluidSection.setFluid(this.pos.getX(), this.pos.getY(), this.pos.getZ(), fluid, fluidLevel);
             }
             return chunk;
         });
@@ -108,7 +103,7 @@ public Fluid getFluid() {
         return Fluid.getAssetMap().getAsset(fluidId);
     }
 
-    public void setFluid(@NotNull Fluid fluid) {
+    public void setFluid(@NotNull Fluid fluid, @Nullable Integer level) {
         long index = ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ());
         this.world.getChunkAsync(index).thenApply((chunk) -> {
             Ref<ChunkStore> columnRef = chunk.getReference();
@@ -126,9 +121,16 @@ public void setFluid(@NotNull Fluid fluid) {
                 }
 
 
-                byte level = fluidSection.getFluidLevel(this.pos.getX(), this.pos.getY(), this.pos.getZ());
-                if (level <= 0) level = 8;
-                fluidSection.setFluid(this.pos.getX(), this.pos.getY(), this.pos.getZ(), fluid, level);
+                byte fluidLevel;
+                if (level != null) {
+                    fluidLevel = level.byteValue();
+                } else {
+                    fluidLevel = fluidSection.getFluidLevel(this.pos.getX(), this.pos.getY(), this.pos.getZ());
+                    if (fluidLevel <= 0) fluidLevel = (byte) fluid.getMaxFluidLevel();
+                }
+                fluidLevel = (byte) Math.clamp((int) fluidLevel, 0, fluid.getMaxFluidLevel());
+                Utils.log("Set fluid level to %s", fluidLevel);
+                fluidSection.setFluid(this.pos.getX(), this.pos.getY(), this.pos.getZ(), fluid, fluidLevel);
             }
             return chunk;
         });
@@ -152,15 +154,15 @@ public void breakBlock(int settings) {
 
     public String toTypeString() {
         return String.format("[%s] block at (%s,%s,%s) in '%s'",
-            this.type.getId(), this.pos.getX(), this.pos.getY(), this.pos.getZ(), this.world.getName());
+            this.getType().getId(), this.pos.getX(), this.pos.getY(), this.pos.getZ(), this.world.getName());
     }
 
     @Override
     public String toString() {
         return "Block{" +
-            "world=" + world.getName() +
-            ", type=" + type +
-            ", pos=" + pos +
+            "world=" + this.world.getName() +
+            ", type=" + this.getType() +
+            ", pos=" + this.pos +
             '}';
     }
 

src/main/java/com/github/skriptdev/skript/api/hytale/EntityComponentUtils.java

@@ -1,6 +1,8 @@
 package com.github.skriptdev.skript.api.hytale;
 
 import com.hypixel.hytale.component.AddReason;
+import com.hypixel.hytale.component.Component;
+import com.hypixel.hytale.component.ComponentType;
 import com.hypixel.hytale.component.Holder;
 import com.hypixel.hytale.component.Ref;
 import com.hypixel.hytale.component.Store;
@@ -27,6 +29,24 @@
 @SuppressWarnings("UnusedReturnValue")
 public class EntityComponentUtils {
 
+    /**
+     * Get a component from an Entity
+     *
+     * @param entity     Entity to get component from
+     * @param type       Component type to get
+     * @param <ECS_TYPE> EntityStore Type
+     * @param <T>        Type of returned component
+     * @return Component from entity if available otherwise null
+     */
+    @SuppressWarnings("unchecked")
+    public static <ECS_TYPE, T extends Component<ECS_TYPE>> @Nullable T getComponent(Entity entity, ComponentType<ECS_TYPE, T> type) {
+        Ref<ECS_TYPE> reference = (Ref<ECS_TYPE>) entity.getReference();
+        if (reference == null) return null;
+
+        Store<ECS_TYPE> store = reference.getStore();
+        return store.getComponent(reference, type);
+    }
+
     /**
      * Get the EntityStatMap component of an entity.
      *

src/main/java/com/github/skriptdev/skript/api/skript/docs/JsonDocPrinter.java

@@ -164,10 +164,10 @@ private void printStructures(BsonDocument mainDocs, SkriptRegistration registrat
             Documentation documentation = event.getDocumentation();
             if (documentation.isNoDoc()) return;
 
-            BsonDocument structureDoc = new BsonDocument();
-
             if (Structure.class.isAssignableFrom(event.getSyntaxClass())) {
+                BsonDocument structureDoc = new BsonDocument();
                 printDocumentation("structure", structureDoc, event);
+                structuresArray.add(structureDoc);
             }
         });
 
@@ -307,18 +307,23 @@ private void printEffects(BsonDocument mainDocs, SkriptRegistration registration
     private void printTypes(BsonDocument mainDocs, SkriptRegistration registration) {
         BsonArray typesArray = mainDocs.getArray("types", new BsonArray());
 
-        String addonName = registration.getRegisterer().getAddonName().toLowerCase(Locale.ROOT).replace(" ", "_");
-
         registration.getTypes().forEach(type -> {
             Documentation documentation = type.getDocumentation();
             if (documentation.isNoDoc()) return;
 
             BsonDocument syntaxDoc = new BsonDocument();
+
+            // NAME and ID
             String baseName = type.getBaseName();
             String docName = documentation.getName();
             syntaxDoc.put("name", new BsonString(docName != null ? docName : baseName));
             syntaxDoc.put("id", getId("type", baseName));
 
+            // EXPERIMENTAL
+            if (documentation.isExperimental()) {
+                syntaxDoc.put("experimental", new BsonString(documentation.getExperimentalMessage()));
+            }
+
             // DESCRIPTION
             BsonArray descriptionArray = new BsonArray();
             for (String s : documentation.getDescription()) {
@@ -349,6 +354,9 @@ private void printTypes(BsonDocument mainDocs, SkriptRegistration registration)
                 syntaxDoc.put("examples", exampleArray);
             }
 
+            // SERIALIZABLE
+            syntaxDoc.put("serializable", new BsonBoolean(type.getSerializer().isPresent()));
+
             // SINCE
             String since = documentation.getSince();
             if (since != null) {
@@ -385,7 +393,9 @@ private void printDocumentation(String type, BsonDocument syntaxDoc, SyntaxInfo<
         syntaxDoc.put("id", getId(type, syntaxInfo));
 
         // EXPERIMENTAL
-        // TODO
+        if (documentation.isExperimental()) {
+            syntaxDoc.put("experimental", new BsonString(documentation.getExperimentalMessage()));
+        }
 
         // DESCRIPTION
         BsonArray descriptionArray = new BsonArray();
@@ -402,7 +412,7 @@ private void printDocumentation(String type, BsonDocument syntaxDoc, SyntaxInfo<
 
         // PATTERNS
         List<PatternElement> patterns = syntaxInfo.getPatterns();
-        if (patterns.isEmpty()) {
+        if (!patterns.isEmpty()) {
             BsonArray patternArray = new BsonArray();
             patterns.forEach(pattern -> patternArray.add(new BsonString(pattern.toString())));
             syntaxDoc.put("patterns", patternArray);

src/main/java/com/github/skriptdev/skript/api/skript/docs/MarkdownDocPrinter.java

@@ -277,7 +277,7 @@ private static void printDocumentation(String type, PrintWriter writer, Document
         if (documentation.isExperimental()) {
             writer.println("> [!WARNING]");
             writer.println("> **This is an experimental feature!**  ");
-            writer.println("> Things may not work as expected and may change without notice.  ");
+            writer.println("> " + documentation.getExperimentalMessage());
         }
         String[] description = documentation.getDescription();
         if (description.length > 0) {

src/main/java/com/github/skriptdev/skript/api/skript/event/BlockContext.java

@@ -0,0 +1,13 @@
+package com.github.skriptdev.skript.api.skript.event;
+
+import com.github.skriptdev.skript.api.hytale.Block;
+import io.github.syst3ms.skriptparser.lang.TriggerContext;
+
+/**
+ * Represents a {@link TriggerContext} which includes a {@link Block}
+ */
+public interface BlockContext extends TriggerContext {
+
+    Block getBlock();
+
+}

src/main/java/com/github/skriptdev/skript/api/skript/event/PlayerContext.java

@@ -8,6 +8,6 @@
  */
 public interface PlayerContext extends TriggerContext {
 
-    Player[] getPlayer();
+    Player getPlayer();
 
 }

src/main/java/com/github/skriptdev/skript/api/skript/variables/JsonVariableStorage.java

@@ -119,11 +119,17 @@ private void loadVariablesFromFile() {
             if (this.bsonDocument.containsKey("variables")) {
                 variablesDocument = this.bsonDocument.getDocument("variables");
             } else {
-                // Legacy file format (TODO remove before first release)
-                this.logger.warn("Your variables file is outdated. HySkript will create a backup then convert for you.");
-                Files.move(this.file.toPath(), this.file.toPath().resolveSibling(this.file.getName() + ".bak"));
-                variablesDocument = this.bsonDocument.clone();
-                this.bsonDocument = new BsonDocument();
+                if (!this.bsonDocument.isEmpty() && !this.bsonDocument.containsKey("data")) {
+                    // Legacy file format (TODO remove before first release)
+                    this.logger.warn("Your variables file is outdated. HySkript will create a backup then convert for you.");
+                    Files.move(this.file.toPath(), this.file.toPath().resolveSibling(this.file.getName() + ".bak"));
+                    variablesDocument = this.bsonDocument.clone();
+                    this.bsonDocument.clear();
+                    this.bsonDocument.put("variables", variablesDocument);
+                } else {
+                    variablesDocument = this.bsonDocument.getDocument("variables", new BsonDocument());
+                }
+                //this.bsonDocument = new BsonDocument();
             }
             JsonElement jsonElement = BsonUtil.translateBsonToJson(variablesDocument);
             if (jsonElement instanceof JsonObject jsonObject) {

src/main/java/com/github/skriptdev/skript/plugin/command/EffectCommands.java

@@ -26,7 +26,7 @@
 public class EffectCommands {
 
     public static void register(Skript skript, String token, boolean allowOps, String permission) {
-        skript.getSkriptRegistration().newContextValue(PlayerEffectContext.class, Player.class, true, "me", PlayerEffectContext::getPlayer)
+        skript.getSkriptRegistration().newSingleContextValue(PlayerEffectContext.class, Player.class, "me", PlayerEffectContext::getPlayer)
             .setUsage(Usage.EXPRESSION_OR_ALONE)
             .register();
 
@@ -99,8 +99,8 @@ public static void register(Skript skript, String token, boolean allowOps, Strin
 
     private record PlayerEffectContext(Player player) implements PlayerContext {
 
-        public Player[] getPlayer() {
-            return new Player[]{this.player};
+        public Player getPlayer() {
+            return this.player;
         }
 
         @Override

src/main/java/com/github/skriptdev/skript/plugin/elements/conditions/CondPlayerIsCrouching.java

@@ -14,7 +14,7 @@ public class CondPlayerIsCrouching extends ConditionalExpression {
 
     public static void register(SkriptRegistration reg) {
         reg.newExpression(CondPlayerIsCrouching.class, Boolean.class, true,
-                "%players% (is|are)[neg:( not|n't)] crouching",
+                "%players% (is|are) crouching",
                 "%players% (isn't|is not|aren't|are not) crouching")
             .name("Player is Crouching")
             .description("Checks if the player is crouching.")