Dev/Feature - Future Feature Release

.github/ISSUE_TEMPLATE/config.yml

@@ -1,7 +1,7 @@
 blank_issues_enabled: false
 contact_links:
   - name: 📖 HySkript Docs
-    url: https://github.com/SkriptDev/HySkript/wiki
+    url: https://skripthub.net/hyskript/docs/
     about: Find HySkript's docs and 100's of examples
   - name: 💻 Support
     url: https://discord.gg/phpWHGU

build.gradle.kts

@@ -32,6 +32,11 @@ dependencies {
     compileOnly("com.hypixel.hytale:Server:${hytaleVersion}")
     compileOnly("org.jetbrains:annotations:26.0.2")
     testImplementation("com.google.code.gson:gson:2.13.2")
+
+    // bStats
+    implementation("org.bstats:bstats-hytale:3.2.1")
+
+    // Skript-Parser
     implementation("com.github.SkriptDev:skript-parser:1.0.10") {
         isTransitive = false
     }
@@ -77,6 +82,7 @@ tasks {
         archiveClassifier.set("")
         relocate("io.github.syst3ms", "com.github.skriptdev.skript")
         relocate("fi.sulku.hytale", "com.github.skriptdev.skript.tinymessage")
+        relocate("org.bstats", "com.github.skriptdev.skript.bstats")
     }
     jar {
         dependsOn(shadowJar)

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

@@ -8,6 +8,8 @@
 import com.hypixel.hytale.math.vector.Location;
 import com.hypixel.hytale.math.vector.Vector3i;
 import com.hypixel.hytale.server.core.asset.type.blocktype.config.BlockType;
+import com.hypixel.hytale.server.core.asset.type.blocktype.config.Rotation;
+import com.hypixel.hytale.server.core.asset.type.blocktype.config.RotationTuple;
 import com.hypixel.hytale.server.core.asset.type.fluid.Fluid;
 import com.hypixel.hytale.server.core.entity.LivingEntity;
 import com.hypixel.hytale.server.core.inventory.ItemStack;
@@ -18,11 +20,13 @@
 import com.hypixel.hytale.server.core.universe.PlayerRef;
 import com.hypixel.hytale.server.core.universe.Universe;
 import com.hypixel.hytale.server.core.universe.world.World;
+import com.hypixel.hytale.server.core.universe.world.chunk.BlockChunk;
 import com.hypixel.hytale.server.core.universe.world.chunk.ChunkColumn;
 import com.hypixel.hytale.server.core.universe.world.chunk.WorldChunk;
 import com.hypixel.hytale.server.core.universe.world.chunk.section.FluidSection;
 import com.hypixel.hytale.server.core.universe.world.storage.ChunkStore;
 import com.hypixel.hytale.server.core.universe.world.storage.EntityStore;
+import io.github.syst3ms.skriptparser.util.color.Color;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -54,6 +58,14 @@ public Block(@NotNull Location location) {
         this(world, location.getPosition().toVector3i());
     }
 
+    public long getChunkIndex() {
+        return ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ());
+    }
+
+    public WorldChunk getChunk() {
+        return this.world.getChunk(getChunkIndex());
+    }
+
     public @NotNull BlockType getType() {
         BlockType blockType = this.world.getBlockType(this.pos);
         return blockType != null ? blockType : BlockType.EMPTY;
@@ -68,9 +80,88 @@ public void setType(@NotNull BlockType type, int settings) {
         }
     }
 
+    public void updateChunk() {
+        getWorld().getNotificationHandler().updateChunk(getChunkIndex());
+    }
+
+    /**
+     * Set the rotation of this block.
+     *
+     * @param rotation Rotation of block represented by a Vector3i(yaw, pitch, roll).
+     */
+    public void setRotation(Vector3i rotation) {
+        int blockId = BlockType.getAssetMap().getIndex(getType().getId());
+        WorldChunk chunk = getChunk();
+        BlockChunk blockChunk = chunk.getBlockChunk();
+        if (blockChunk == null) return;
+
+        Rotation pitch = getRotationFromInt(rotation.getX());
+        Rotation yaw = getRotationFromInt(rotation.getY());
+        Rotation roll = getRotationFromInt(rotation.getZ());
+        int rotationIndex = RotationTuple.of(yaw, pitch, roll).index();
+        blockChunk.setBlock(this.pos.getX(), this.pos.getY(), this.pos.getZ(),
+            blockId, rotationIndex, 0);
+    }
+
+    /**
+     * Get the rotation of this block.
+     *
+     * @return Rotation of block represented as a Vector3i(yaw, pitch, roll).
+     */
+    public Vector3i getRotation() {
+        int blockRotationIndex = getWorld().getBlockRotationIndex(this.pos.getX(), this.pos.getY(), this.pos.getZ());
+        RotationTuple rotationTuple = RotationTuple.get(blockRotationIndex);
+
+        int yaw = getIntFromRotation(rotationTuple.yaw());
+        int pitch = getIntFromRotation(rotationTuple.pitch());
+        int roll = getIntFromRotation(rotationTuple.roll());
+        return new Vector3i(pitch, yaw, roll);
+    }
+
+    private Rotation getRotationFromInt(int v) {
+        if (v < 90) return Rotation.None;
+        else if (v < 180) return Rotation.Ninety;
+        else if (v < 270) return Rotation.OneEighty;
+        else return Rotation.TwoSeventy;
+    }
+
+    private int getIntFromRotation(Rotation rotation) {
+        return switch (rotation) {
+            case None -> 0;
+            case Ninety -> 90;
+            case OneEighty -> 180;
+            case TwoSeventy -> 270;
+        };
+    }
+
+    public Color getTint() {
+        BlockChunk blockChunk = getChunk().getBlockChunk();
+        if (blockChunk == null) return null;
+
+        int x = this.pos.getX() % 32;
+        int z = this.pos.getZ() % 32;
+        int tintInt = blockChunk.getTint(x, z);
+        return Color.of(tintInt);
+    }
+
+    public void setTint(Color color) {
+        setTint(color, true);
+    }
+
+    public void setTint(Color color, boolean updateChunk) {
+        BlockChunk blockChunk = getChunk().getBlockChunk();
+        if (blockChunk == null) return;
+
+        int x = this.pos.getX() % 32;
+        int z = this.pos.getZ() % 32;
+        blockChunk.setTint(x, z, color.toJavaColor().getRGB());
+        if (updateChunk) {
+            updateChunk();
+        }
+    }
+
     public byte getFluidLevel() {
-        long index = ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ());
-        WorldChunk chunk = this.world.getChunk(index);
+        WorldChunk chunk = this.world.getChunk(getChunkIndex());
         if (chunk == null) return 0;
 
         Ref<ChunkStore> columnRef = chunk.getReference();
@@ -90,8 +181,7 @@ public byte getFluidLevel() {
     }
 
     public void setFluidLevel(byte level) {
-        long index = ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ());
-        this.world.getChunkAsync(index).thenApply((chunk) -> {
+        this.world.getChunkAsync(getChunkIndex()).thenApply((chunk) -> {
             Ref<ChunkStore> columnRef = chunk.getReference();
             Store<ChunkStore> store = columnRef.getStore();
             ChunkColumn column = store.getComponent(columnRef, ChunkColumn.getComponentType());
@@ -124,8 +214,7 @@ public Fluid getFluid() {
     }
 
     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) -> {
+        this.world.getChunkAsync(getChunkIndex()).thenApply((chunk) -> {
             Ref<ChunkStore> columnRef = chunk.getReference();
             Store<ChunkStore> store = columnRef.getStore();
             ChunkColumn column = store.getComponent(columnRef, ChunkColumn.getComponentType());
@@ -160,7 +249,7 @@ public void breakBlock(int settings) {
     }
 
     public void damage(@Nullable LivingEntity performer, @Nullable ItemStack itemStack, float damage) {
-        WorldChunk chunk = this.world.getChunk(ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ()));
+        WorldChunk chunk = this.world.getChunk(getChunkIndex());
         if (chunk == null) return;
 
         Ref<ChunkStore> ref = chunk.getReference();
@@ -195,7 +284,7 @@ public void damage(@Nullable LivingEntity performer, @Nullable ItemStack itemSta
     }
 
     public float getBlockHealth() {
-        WorldChunk chunk = this.world.getChunk(ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ()));
+        WorldChunk chunk = getChunk();
         if (chunk == null) return 0;
 
         Ref<ChunkStore> ref = chunk.getReference();
@@ -208,7 +297,7 @@ public float getBlockHealth() {
     }
 
     public void setBlockHealth(float health) {
-        WorldChunk chunk = this.world.getChunk(ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ()));
+        WorldChunk chunk = getChunk();
         if (chunk == null) return;
 
         Ref<ChunkStore> ref = chunk.getReference();

src/main/java/com/github/skriptdev/skript/api/hytale/utils/EntityReferenceUtils.java

@@ -0,0 +1,102 @@
+package com.github.skriptdev.skript.api.hytale.utils;
+
+import com.hypixel.hytale.component.Component;
+import com.hypixel.hytale.component.ComponentType;
+import com.hypixel.hytale.component.Ref;
+import com.hypixel.hytale.component.Store;
+import com.hypixel.hytale.component.spatial.SpatialResource;
+import com.hypixel.hytale.math.vector.Vector3d;
+import com.hypixel.hytale.server.core.entity.entities.Player;
+import com.hypixel.hytale.server.core.modules.entity.EntityModule;
+import com.hypixel.hytale.server.core.modules.entity.item.ItemComponent;
+import com.hypixel.hytale.server.core.universe.world.storage.EntityStore;
+import com.hypixel.hytale.server.npc.entities.NPCEntity;
+import it.unimi.dsi.fastutil.objects.ObjectList;
+import org.jetbrains.annotations.Nullable;
+
+import javax.annotation.Nonnull;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Utilities for {@link EntityStore} {@link Ref References}
+ */
+@SuppressWarnings("unused")
+public class EntityReferenceUtils {
+
+    private static final List<ReferenceType<?>> TYPES = new ArrayList<>();
+    private static final Map<Class<? extends Component<?>>, ReferenceType<?>> TYPES_MAP = new HashMap<>();
+
+    public static final ReferenceType<Player> PLAYER = new ReferenceType<>(
+        "player", Player.class, Player.getComponentType());
+    public static final ReferenceType<NPCEntity> NPC_ENTITY = new ReferenceType<>(
+        "npcentity", NPCEntity.class, NPCEntity.getComponentType());
+    public static final ReferenceType<ItemComponent> ITEM = new ReferenceType<>(
+        "item", ItemComponent.class, ItemComponent.getComponentType());
+
+    public static List<ReferenceType<?>> getTypes() {
+        return TYPES;
+    }
+
+    public static ReferenceType<?> getType(Class<? extends Component<?>> componentClass) {
+        return TYPES_MAP.get(componentClass);
+    }
+
+    public static List<Ref<EntityStore>> getRefsInSphere(@Nonnull Vector3d pos, double radius, @Nonnull Store<EntityStore> store) {
+        ObjectList<Ref<EntityStore>> results = SpatialResource.getThreadLocalReferenceList();
+        EntityModule entityModule = EntityModule.get();
+        SpatialResource<Ref<EntityStore>, EntityStore> entities = store.getResource(entityModule.getEntitySpatialResourceType());
+        entities.getSpatialStructure().collect(pos, (float) radius, results);
+        SpatialResource<Ref<EntityStore>, EntityStore> players = store.getResource(entityModule.getPlayerSpatialResourceType());
+        players.getSpatialStructure().collect(pos, (float) radius, results);
+        SpatialResource<Ref<EntityStore>, EntityStore> items = store.getResource(entityModule.getItemSpatialResourceType());
+        items.getSpatialStructure().collect(pos, (float) radius, results);
+        return results;
+    }
+
+    @Nonnull
+    public static List<Ref<EntityStore>> getRefsInBox(@Nonnull Vector3d min, @Nonnull Vector3d max, @Nonnull Store<EntityStore> store) {
+        ObjectList<Ref<EntityStore>> results = SpatialResource.getThreadLocalReferenceList();
+        EntityModule entityModule = EntityModule.get();
+        SpatialResource<Ref<EntityStore>, EntityStore> entities = store.getResource(entityModule.getEntitySpatialResourceType());
+        entities.getSpatialStructure().collectBox(min, max, results);
+        SpatialResource<Ref<EntityStore>, EntityStore> players = store.getResource(entityModule.getPlayerSpatialResourceType());
+        players.getSpatialStructure().collectBox(min, max, results);
+        SpatialResource<Ref<EntityStore>, EntityStore> items = store.getResource(entityModule.getItemSpatialResourceType());
+        items.getSpatialStructure().collectBox(min, max, results);
+        return results;
+    }
+
+    public static class ReferenceType<E extends Component<EntityStore>> {
+
+
+        private final String name;
+        private final Class<E> componentClass;
+        private final ComponentType<EntityStore, ?> componentType;
+
+        public ReferenceType(String name, Class<E> componentClass, ComponentType<EntityStore, ?> componentType) {
+            this.name = name;
+            this.componentClass = componentClass;
+            this.componentType = componentType;
+            EntityReferenceUtils.TYPES.add(this);
+            EntityReferenceUtils.TYPES_MAP.put(componentClass, this);
+        }
+
+        public String getName() {
+            return this.name;
+        }
+
+        public Class<E> getComponentClass() {
+            return this.componentClass;
+        }
+
+        @SuppressWarnings("unchecked")
+        public @Nullable E getComponent(Ref<EntityStore> ref) {
+            Store<EntityStore> store = ref.getStore();
+            return (E) store.getComponent(ref, this.componentType);
+        }
+    }
+
+}