Fix riding, spawning and inventory drop (#67)

* Update ridingTransport.ts

* Update ridingTransport.ts

* fix spawn variant and inventory drop

* form now saves options & fix terminator dupe names

* sanitize nametags

* Update index.ts

* Update initialization.ts

Author: JaylyDev

src/commands/index.ts

@@ -1,41 +1,38 @@
-import { world, system, Player, Vector3 } from "@minecraft/server";
+import { system, Player, Vector3 } from "@minecraft/server";
 import { ModalFormData } from "@minecraft/server-ui";
-import { MinecraftDimensionTypes } from "@minecraft/vanilla-data";
 import {
   spawnTerminator,
   TerminatorInputParam,
   TerminatorSkinModel,
 } from "./summon.js";
+import { debugEnabled } from "../config.js";
 
 function generateModalForm(settings: TerminatorInputParam) {
-  let dimensionIndex = 0;
   let skinModelIndex = 0;
-  switch (settings.dimension.id) {
-    case MinecraftDimensionTypes.Overworld:
-      dimensionIndex = 0;
-      break;
-    case MinecraftDimensionTypes.Nether:
-      dimensionIndex = 1;
-      break;
-    case MinecraftDimensionTypes.TheEnd:
-      dimensionIndex = 2;
-      break;
-  }
   switch (settings.skinmodel) {
     case TerminatorSkinModel.Steve:
       skinModelIndex = 0;
       break;
     case TerminatorSkinModel.Alex:
       skinModelIndex = 1;
       break;
+    case TerminatorSkinModel.Custom:
+      skinModelIndex = 2;
+      break;
+    case TerminatorSkinModel.CustomSlim:
+      skinModelIndex = 3;
+      break;
   }
 
   return new ModalFormData()
     .title("Spawn Terminator")
-    .textField("Name Tag", "Terminator", "Terminator")
+    .textField("Name Tag", settings.nametag, settings.nametag)
     .textField("Spawn Coordinates", "x y z", "~ ~ ~")
-    .dropdown("Dimension", ["Overworld", "Nether", "The End"], dimensionIndex)
-    .dropdown("Skin Model", ["Steve", "Alex"], skinModelIndex)
+    .dropdown(
+      "Skin Model",
+      ["Steve", "Alex", "Custom (Steve Model)", "Custom (Alex Model)"],
+      skinModelIndex
+    )
     .toggle("Enable Custom Skin", settings.customskin)
     .toggle("Enable Bossbar", settings.bossbar)
     .toggle("Enable Immunity", settings.invulnerable)
@@ -75,18 +72,17 @@ function parseCoordinates(paramString: string, playerLocation: Vector3) {
 }
 
 type TerminatorSpawnFormValues = [
-  string,
-  string,
-  number,
-  number,
-  boolean,
-  boolean,
-  boolean,
-  boolean,
-  boolean,
-  boolean,
-  boolean,
-  boolean
+  string, // nameTag
+  string, // locationString
+  number, // skinModelIndex
+  boolean, // customSkin
+  boolean, // bossbar
+  boolean, // invulnerable
+  boolean, // deathEvent
+  boolean, // physics
+  boolean, // regeneration
+  boolean, // respawn
+  boolean // breedable
 ];
 
 const getDefaultSpawnOptions = (player: Player): TerminatorInputParam => ({
@@ -100,12 +96,24 @@ const getDefaultSpawnOptions = (player: Player): TerminatorInputParam => ({
   respawn: true,
   breedable: false,
   coords: player.location,
-  dimension: player.dimension,
   skinmodel: TerminatorSkinModel.Steve,
 });
 
+function getPlayerSpawnOptions(player: Player): TerminatorInputParam {
+  const playerOptionString = player.getDynamicProperty(
+    "terminator:spawn_options"
+  ) as string | undefined;
+  if (!playerOptionString) return getDefaultSpawnOptions(player);
+  try {
+    return JSON.parse(playerOptionString);
+  } catch (error) {
+    if (debugEnabled) console.error(error);
+    return getDefaultSpawnOptions(player);
+  }
+}
+
 export function showSpawnTerminatorForm(player: Player) {
-  const spawnOptions: TerminatorInputParam = getDefaultSpawnOptions(player);
+  const spawnOptions = getPlayerSpawnOptions(player);
   const form = generateModalForm(spawnOptions);
   form
     .show(player)
@@ -114,7 +122,6 @@ export function showSpawnTerminatorForm(player: Player) {
       const [
         nameTag,
         locationString,
-        dimensionIndex,
         skinModelIndex,
         customSkin,
         bossbar,
@@ -125,26 +132,20 @@ export function showSpawnTerminatorForm(player: Player) {
         respawn,
         breedable,
       ] = result.formValues as TerminatorSpawnFormValues;
-      let dimension = world.getDimension("overworld");
       let skinmodel: TerminatorSkinModel = TerminatorSkinModel.Steve;
-      switch (dimensionIndex) {
-        case 0:
-          dimension = world.getDimension("overworld");
-          break;
-        case 1:
-          dimension = world.getDimension("nether");
-          break;
-        case 2:
-          dimension = world.getDimension("the_end");
-          break;
-      }
       switch (skinModelIndex) {
         case 0:
           skinmodel = TerminatorSkinModel.Steve;
           break;
         case 1:
           skinmodel = TerminatorSkinModel.Alex;
           break;
+        case 2:
+          skinmodel = TerminatorSkinModel.Custom;
+          break;
+        case 3:
+          skinmodel = TerminatorSkinModel.CustomSlim;
+          break;
       }
 
       const jsonInput: TerminatorInputParam = {
@@ -158,10 +159,9 @@ export function showSpawnTerminatorForm(player: Player) {
         respawn: respawn,
         breedable: breedable,
         coords: parseCoordinates(locationString, player.location),
-        dimension,
         skinmodel,
       };
-      spawnTerminator(jsonInput);
+      spawnTerminator(jsonInput, player);
     })
     .catch((error) => console.error(error + "\n" + error.stack));
 }

src/commands/summon.ts

@@ -1,8 +1,11 @@
-import { Dimension, Vector3, system } from "@minecraft/server";
+import { Player, Vector3, system } from "@minecraft/server";
+import { debugEnabled } from "../config";
 
 export enum TerminatorSkinModel {
   Steve = "steve",
   Alex = "alex",
+  Custom = "custom",
+  CustomSlim = "custom_slim",
 }
 
 export interface TerminatorInputParam {
@@ -16,13 +19,15 @@ export interface TerminatorInputParam {
   respawn: boolean;
   breedable: boolean;
   coords: Vector3;
-  dimension: Dimension;
   skinmodel: TerminatorSkinModel;
 }
 
-export function spawnTerminator(user_input: TerminatorInputParam) {
+export function spawnTerminator(
+  user_input: TerminatorInputParam,
+  sourcePlayer: Player
+) {
   // target: string, user_input: object
-  const entity = user_input.dimension.spawnEntity(
+  const entity = sourcePlayer.dimension.spawnEntity(
     "entity:terminator",
     user_input.coords
   );
@@ -33,6 +38,7 @@ export function spawnTerminator(user_input: TerminatorInputParam) {
      * If the option is undefined in user_input
      * Script Engine will replace key values with 'default_nbt' variable
      */
+    user_input.nametag = user_input.nametag.replace(/[^a-zA-Z0-9_ ]/g, '').substring(0, 15);
     entity.nameTag = user_input.nametag;
 
     if (user_input.customskin == true) {
@@ -59,10 +65,19 @@ export function spawnTerminator(user_input: TerminatorInputParam) {
     if (user_input.respawn == false) {
       entity.triggerEvent("terminator:disable_respawn");
     }
-    if (user_input.skinmodel == "alex") {
+    if (user_input.skinmodel == TerminatorSkinModel.Alex) {
+      entity.triggerEvent("terminator:switch_skin_to_alex");
+    } else if (user_input.skinmodel == TerminatorSkinModel.Custom) {
+      entity.triggerEvent("terminator:enable_custom_skin");
+    } else if (user_input.skinmodel == TerminatorSkinModel.CustomSlim) {
       entity.triggerEvent("terminator:enable_customSlim_skin");
     }
 
-    console.log("User input: " + JSON.stringify(user_input));
+    const userInputString = JSON.stringify(user_input);
+    if (debugEnabled) console.log("User input: " + userInputString);
+    sourcePlayer.setDynamicProperty(
+      "terminator:spawn_options",
+      userInputString
+    );
   }, 2);
 }

src/terminator-death/dropInventory.ts

@@ -0,0 +1,22 @@
+import { Entity, EntityInventoryComponent } from "@minecraft/server";
+
+export function dropEntityInventory(entity: Entity): boolean {
+  const inventory = entity.getComponent(
+    "inventory"
+  ) as EntityInventoryComponent;
+
+  if (!inventory.container) return false;
+  for (let slot = 0; slot < inventory.inventorySize; slot++) {
+    const item = inventory.container.getItem(slot);
+    if (item) {
+      const itemEntity = entity.dimension.spawnItem(item, entity.location);
+      itemEntity.applyImpulse({
+        x: Math.random() - 0.5,
+        y: 0,
+        z: Math.random() - 0.5,
+      });
+    }
+  }
+  inventory.container.clearAll();
+  return true;
+}

src/terminator-death/index.ts

@@ -6,6 +6,7 @@ import {
 import { terminatorDie } from "../terminator-events/onTerminatorDie";
 import { sendDeathMessageCallback } from "./deathMessage";
 import { MinecraftColor } from "../minecraft-color";
+import { dropEntityInventory } from "./dropInventory";
 
 enum TerminatorVariant {
   SteveDefault = 0,
@@ -34,6 +35,8 @@ terminatorDie.subscribe((event) => {
     variant.value === TerminatorVariant.Custom ||
     variant.value === TerminatorVariant.CustomSlim;
 
+  dropEntityInventory(deadEntity);
+
   // First Death
   if (allowRespawn && triggerRespawnEvent && cause !== EntityDamageCause.void) {
     const dummyEntity = deadEntity.dimension.spawnEntity(

src/terminator/initialization.ts

@@ -10,19 +10,27 @@ import { MinecraftEffectTypes } from "@minecraft/vanilla-data";
 import { MinecraftColor } from "../minecraft-color";
 
 // naming tag
-terminatorSpawn.subscribe(({ entity }) => {
-  const terminatorPopulation = world
-    .getDimension("overworld")
-    .getEntities({ type: "entity:terminator" }).length;
-
-  if (terminatorPopulation > 1)
-    entity.nameTag = `Terminator (${terminatorPopulation - 1})`;
-  else entity.nameTag = "Terminator";
-});
-
-// broadcast to world
 terminatorSpawn.subscribe(({ entity }) => {
   system.runTimeout(() => {
+    const nameTag = entity.nameTag || "Terminator";
+    entity.nameTag = nameTag;
+    const terminators = entity.dimension.getEntities({
+      type: "entity:terminator",
+    });
+    // Check if existing terminator has the same nameTag, if there one set the entity nameTag to "[name] (1)"
+    // If there's more than one with the same name, increment the index
+    if (terminators.some((entity) => entity.nameTag === nameTag)) {
+      const nameTagRegex = new RegExp(`^${nameTag} \\(\\d+\\)$`);
+      const terminatorsWithSameName = terminators.filter(
+        (terminator) =>
+          (terminator.nameTag === nameTag && terminator !== entity) ||
+          nameTagRegex.test(terminator.nameTag)
+      );
+      if (terminatorsWithSameName.length > 0)
+        entity.nameTag = `${nameTag} (${terminatorsWithSameName.length})`;
+    }
+    
+    // broadcast to world
     const rawtext: RawText = {
       rawtext: [
         { text: MinecraftColor.yellow },

src/terminator/ridingTransport.ts

@@ -1,10 +1,13 @@
-import { TicksPerSecond, system, world } from "@minecraft/server";
+import { ItemStack, TicksPerSecond, system, world } from "@minecraft/server";
 import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
 
+const overworld = world.getDimension("overworld");
+
 // Replacement of controller.animation.terminator.sitting
 system.runInterval(() => {
-  const overworld = world.getDimension("overworld");
   const terminators = overworld.getEntities({ type: "entity:terminator" });
+  if (terminators.length === 0) return;
+
   const boats = overworld.getEntities({ type: MinecraftEntityTypes.Boat });
   const chestBoats = overworld.getEntities({
     type: MinecraftEntityTypes.ChestBoat,
@@ -14,16 +17,18 @@ system.runInterval(() => {
   });
 
   for (const terminator of terminators) {
-    let rideableCooldown: number =
-      (terminator.getDynamicProperty("rideableCooldown") as
-        | number
-        | undefined) || -1;
+    let rideableCooldown = terminator.getDynamicProperty(
+      "terminator:rideable_cooldown"
+    ) as number | undefined;
     const isSitting = terminator.getProperty(
       "terminator:is_sitting"
     ) as boolean;
 
+    if (!isSitting) continue;
+    if (typeof rideableCooldown === "undefined") rideableCooldown = -1;
+
     // If the rideable cooldown is -1 but terminator is sitting, then ride for 10 - 20 seconds then leave
-    if (rideableCooldown === -1 && isSitting) {
+    if (rideableCooldown === -1) {
       const rideDuration = Math.floor(Math.random() * 10 + 10) * TicksPerSecond;
 
       rideableCooldown = rideDuration;
@@ -34,7 +39,7 @@ system.runInterval(() => {
     }
     // If the rideable cooldown is 0 and terminator is sitting, then leave the transport they're riding in
     // Note: Rideable component is not released to stable, kill the transport entity
-    else if (rideableCooldown === 0 && isSitting) {
+    else if (rideableCooldown === 0) {
       const nearbyBoats = boats.filter(
         (boat) =>
           boat.matches({ maxDistance: 1, location: terminator.location }) &&
@@ -58,6 +63,10 @@ system.runInterval(() => {
         ...nearbyMinecarts,
       ];
       for (const transport of nearbyTransport) {
+        transport.dimension.spawnItem(
+          new ItemStack(transport.typeId, 1),
+          transport.location
+        );
         transport.kill();
       }
     }