Examples

github-actions[bot] · github-actions[bot] · commit a7107e58efc1 · 2023-06-24T12:31:09.000+01:00
diff --git a/examples/@minecraft/server/Entity/prototype/applyDamage/damageEntity.js b/examples/@minecraft/server/Entity/prototype/applyDamage/damageEntity.js
@@ -0,0 +1,2 @@
+const damageApplied = entity.applyDamage(10);
+console.log(`Damage applied: ${damageApplied}`);
diff --git a/examples/@minecraft/server/Entity/prototype/getBlockFromViewDirection/facingBlock.js b/examples/@minecraft/server/Entity/prototype/getBlockFromViewDirection/facingBlock.js
@@ -0,0 +1,10 @@
+const blockHit = entity.getBlockFromViewDirection();
+
+if (blockHit) {
+  console.log("Block Hit:");
+  console.log("Block:", blockHit.block);
+  console.log("Face:", blockHit.face);
+  console.log("Face Location:", JSON.stringify(blockHit.faceLocation));
+} else {
+  console.log("No block in view direction.");
+}
diff --git a/examples/@minecraft/server/Entity/prototype/getComponent/getHealth.ts b/examples/@minecraft/server/Entity/prototype/getComponent/getHealth.ts
@@ -0,0 +1,6 @@
+import { EntityHealthComponent, world } from "@minecraft/server";
+
+for (const entity of world.getDimension('overworld').getEntities()) {
+  const health = entity.getComponent(EntityHealthComponent.componentId) as EntityHealthComponent;
+  entity.nameTag = health.currentValue.toString();
+}
diff --git a/examples/@minecraft/server/Entity/prototype/getComponents/getComponents.js b/examples/@minecraft/server/Entity/prototype/getComponents/getComponents.js
@@ -0,0 +1,2 @@
+const components = entity.getComponents();
+console.log(`Number of components: ${components.length}: ${components.map(component => component.typeId)}`);
diff --git a/examples/@minecraft/server/Entity/prototype/teleport/teleport.js b/examples/@minecraft/server/Entity/prototype/teleport/teleport.js
@@ -0,0 +1,4 @@
+player.teleport(
+  { x: 0, y: 0, z: 0 },
+  { dimension: world.getDimension("nether") }
+);
diff --git a/examples/@minecraft/server/Entity/prototype/teleport/teleportFacing.js b/examples/@minecraft/server/Entity/prototype/teleport/teleportFacing.js
@@ -0,0 +1,7 @@
+player.teleport(
+  { x: 0, y: 0, z: 0 },
+  {
+    dimension: world.getDimension("nether"),
+    teleportFacing: { x: 100, y: 100, z: 100 },
+  }
+);
diff --git a/examples/@minecraft/server/Player/prototype/addExperience/addXp.js b/examples/@minecraft/server/Player/prototype/addExperience/addXp.js
@@ -0,0 +1,2 @@
+const xpAdded = player.addExperience(100);
+console.log(`Player ${player.name} now has ${xpAdded} experience points.`);
diff --git a/examples/@minecraft/server/Player/prototype/addLevels/addLevels.js b/examples/@minecraft/server/Player/prototype/addLevels/addLevels.js
@@ -0,0 +1,3 @@
+const levels = player.addLevels(5);
+console.log(`Player ${player.name} now has ${levels} levels.`)
+
diff --git a/examples/@minecraft/server/Player/prototype/getItemCooldown/getEquipmentCooldown.js b/examples/@minecraft/server/Player/prototype/getItemCooldown/getEquipmentCooldown.js
@@ -0,0 +1,2 @@
+const cooldown = player.getItemCooldown("equipment");
+console.log(`Cooldown for the equipment category: ${cooldown} seconds.`);
diff --git a/examples/@minecraft/server/Player/prototype/getSpawnPoint/getSpawnPoint.js b/examples/@minecraft/server/Player/prototype/getSpawnPoint/getSpawnPoint.js
@@ -0,0 +1,6 @@
+const spawnPoint = player.getSpawnPoint();
+if (spawnPoint) {
+  console.log(`Spawn point location: ${spawnPoint.x} ${spawnPoint.y} ${spawnPoint.z} at ${spawnPoint.dimension.id}`);
+} else {
+  console.log(`No spawn point set.`);
+}
diff --git a/examples/@minecraft/server/System/prototype/clearRun/clearRun.js b/examples/@minecraft/server/System/prototype/clearRun/clearRun.js
@@ -0,0 +1,6 @@
+const runId = system.run(() => {
+  console.log("Running callback function...");
+});
+
+// Clear the run, so it will not run again.
+system.clearRun(runId);
diff --git a/examples/@minecraft/server/System/prototype/run/run.js b/examples/@minecraft/server/System/prototype/run/run.js
@@ -0,0 +1,3 @@
+const runId = system.run(() => {
+  console.log("Running callback function...");
+});
diff --git a/examples/@minecraft/server/System/prototype/runInternal/tenTimesOnly.js b/examples/@minecraft/server/System/prototype/runInternal/tenTimesOnly.js
@@ -0,0 +1,13 @@
+import { system, TicksPerSecond } from "@minecraft/server";
+
+let count = 0;
+
+const runId = system.runInterval(() => {
+  count++;
+  console.log(`Running callback function (${count} times)...`);
+
+  if (count === 10) {
+    system.clearRun(runId);
+    console.log("runInterval cleared after 10 times.");
+  }
+}, TicksPerSecond); // Runs every 20 ticks or 1 second.
diff --git a/examples/@minecraft/server/System/prototype/runTimeout/runTimeout.js b/examples/@minecraft/server/System/prototype/runTimeout/runTimeout.js
@@ -0,0 +1,5 @@
+import { TicksPerSecond } from "@minecraft/server";
+
+system.runTimeout(() => {
+  console.log("Running callback function after delay...");
+}, TicksPerSecond * 5); // Tick delay of 5 seconds
diff --git a/examples/@minecraft/server/SystemAfterEvents/prototype/scriptEventReceive/entity.js b/examples/@minecraft/server/SystemAfterEvents/prototype/scriptEventReceive/entity.js
@@ -0,0 +1,14 @@
+import { system, world } from "@minecraft/server";
+
+system.afterEvents.scriptEventReceive.subscribe((event) => {
+  const { id, message, sourceEntity, sourceType } = event;
+
+  console.log(id); // wiki:test
+  console.log(message); // Hello World
+  console.log(sourceEntity); // Player object
+  console.log(sourceType); // Entity
+});
+
+world.getPlayers().forEach(player => {
+  player.runCommand('scriptevent wiki:test Hello World');
+})
diff --git a/examples/@minecraft/server/SystemAfterEvents/prototype/scriptEventReceive/server.js b/examples/@minecraft/server/SystemAfterEvents/prototype/scriptEventReceive/server.js
@@ -0,0 +1,11 @@
+import { system, world } from "@minecraft/server";
+
+system.afterEvents.scriptEventReceive.subscribe((event) => {
+  const { id, message, sourceType } = event;
+
+  console.log(id); // wiki:test
+  console.log(message); // Hello World
+  console.log(sourceType); // Server
+});
+
+world.getDimension('overworld').runCommand('scriptevent wiki:test Hello World');
diff --git a/examples/@minecraft/server/SystemBeforeEvents/prototype/watchdogTerminate/cancelTerminate.js b/examples/@minecraft/server/SystemBeforeEvents/prototype/watchdogTerminate/cancelTerminate.js
@@ -0,0 +1,6 @@
+import { system } from '@minecraft/server';
+
+system.beforeEvents.watchdogTerminate.subscribe((event) => {
+  event.cancel = true;
+  console.warn(`[Watchdog] Canceled critical exception of type '${event.cancelationReason}`);
+});
diff --git a/examples/@minecraft/server/WorldAfterEvents/prototype/blockBreak/subscribe.js b/examples/@minecraft/server/WorldAfterEvents/prototype/blockBreak/subscribe.js
diff --git a/examples/@minecraft/server/WorldAfterEvents/prototype/buttonPush/subscribe.js b/examples/@minecraft/server/WorldAfterEvents/prototype/buttonPush/subscribe.js
@@ -0,0 +1,7 @@
+import { world } from "@minecraft/server";
+
+world.afterEvents.buttonPush.subscribe((event) => {
+  console.log('Button: ', event.block.typeId);
+  console.log('Dimension: ', event.dimension.id);
+  console.log('Source: ', event.source.typeId);
+})
diff --git a/examples/@minecraft/server/WorldAfterEvents/prototype/chatSend/subscribe.js b/examples/@minecraft/server/WorldAfterEvents/prototype/chatSend/subscribe.js
@@ -0,0 +1,11 @@
+import { WeatherType, system, world } from "@minecraft/server";
+
+const chatObjective = world.scoreboard.getObjective("chat") ?? world.scoreboard.addObjective("chat", "chat");
+
+
+world.afterEvents.chatSend.subscribe((event) => {
+  const { sender } = event;
+
+  const score = chatObjective.hasParticipant(sender) ? chatObjective.getScore(sender.scoreboardIdentity) : 0;
+  chatObjective.setScore(sender, score + 1);
+});
diff --git a/examples/@minecraft/server/WorldAfterEvents/prototype/dataDrivenEntityTriggerEvent/sheepEventListener.ts b/examples/@minecraft/server/WorldAfterEvents/prototype/dataDrivenEntityTriggerEvent/sheepEventListener.ts
@@ -0,0 +1,28 @@
+import { world, system, Entity } from "@minecraft/server";
+
+const eventId = "minecraft:entity_spawned"
+
+system.runInterval(() => {
+  for (let player of world.getAllPlayers()) {
+    let [entityRaycaseHit] = player.getEntitiesFromViewDirection({ maxDistance: 150 });
+    if (!entityRaycaseHit) continue;
+    let entity = entityRaycaseHit.entity;
+
+    if (entity?.typeId === "minecraft:sheep") {
+      listenTo(entity);
+      entity.triggerEvent(eventId)
+    }
+  }
+});
+
+function listenTo(entity: Entity) {
+  const callback = world.afterEvents.dataDrivenEntityTriggerEvent.subscribe((data) => {
+    world.afterEvents.dataDrivenEntityTriggerEvent.unsubscribe(callback);
+
+    data.getModifiers().forEach((modifier) => {
+      console.log('ComponentGroupsToAdd:', modifier.getComponentGroupsToAdd());
+      console.log('ComponentGroupsToRemove:', modifier.getComponentGroupsToRemove());
+      console.log('Triggers:', modifier.getTriggers());
+    });
+  }, { entities: [entity], eventTypes: [eventId] });
+};
diff --git a/examples/@minecraft/server/WorldAfterEvents/prototype/entityDie/subscribe.js b/examples/@minecraft/server/WorldAfterEvents/prototype/entityDie/subscribe.js
@@ -0,0 +1,5 @@
+import { world } from "@minecraft/server";
+
+world.afterEvents.entityDie.subscribe((event) => {
+  world.sendMessage(`${event.deadEntity.typeId} died from ${event.damageSource}!`);
+});
diff --git a/examples/@minecraft/server/WorldAfterEvents/prototype/entityHit/getDistance.js b/examples/@minecraft/server/WorldAfterEvents/prototype/entityHit/getDistance.js
@@ -0,0 +1,13 @@
+world.afterEvents.entityHit.subscribe((event) => {
+  const location1 = event.entity.location;
+  const location2 = event.hitEntity.location;
+
+  const distance = Math.pow(
+    Math.pow(location2.x - location1.x, 2) +
+    Math.pow(location2.y - location1.y, 2) +
+    Math.pow(location2.z - location1.z, 2),
+    0.5
+  );
+
+  console.log('Distance: ' + distance + ' blocks');
+});
diff --git a/examples/@minecraft/server/WorldAfterEvents/prototype/playerJoin/subscribe.js b/examples/@minecraft/server/WorldAfterEvents/prototype/playerJoin/subscribe.js
@@ -0,0 +1,4 @@
+import { world } from "@minecraft/server";
+world.afterEvents.playerJoin.subscribe(({ playerId, playerName }) => {
+  world.sendMessage(`Player ${playerName} (${playerId}) has just joined the world.`);
+});
diff --git a/examples/@minecraft/server/WorldAfterEvents/prototype/playerLeave/subscribe.js b/examples/@minecraft/server/WorldAfterEvents/prototype/playerLeave/subscribe.js
@@ -0,0 +1,4 @@
+import { world } from "@minecraft/server";
+world.afterEvents.playerLeave.subscribe(({ playerId, playerName }) => {
+  world.sendMessage(`Player ${playerName} (${playerId}) has just left the world.`);
+});
diff --git a/examples/@minecraft/server/WorldAfterEvents/prototype/playerSpawn/initialSpawn.js b/examples/@minecraft/server/WorldAfterEvents/prototype/playerSpawn/initialSpawn.js
@@ -0,0 +1,9 @@
+// https://github.com/JaylyDev/ScriptAPI/tree/main/scripts/player-spawn
+import { world } from "@minecraft/server";
+
+world.afterEvents.playerSpawn.subscribe((eventData) => {
+    let { player, initialSpawn } = eventData;
+    if(!initialSpawn) return;
+
+    // This runs when the player joins the game for the first time!
+})
diff --git a/examples/@minecraft/server/WorldBeforeEvents/prototype/chatSend/subscribe.js b/examples/@minecraft/server/WorldBeforeEvents/prototype/chatSend/subscribe.js
@@ -2,10 +2,12 @@ import { WeatherType, system, world } from "@minecraft/server";
 
 world.beforeEvents.chatSend.subscribe((event) => {
   const { message, sender } = event;
+  const { dimension } =sender;
 
   if (message === '!weather clear') {
+    event.cancel = true;
     system.run(() => {
-      sender.dimension.setWeather(WeatherType.clear);
+      dimension.setWeather(WeatherType.Clear);
     });
   };
 });
diff --git a/examples/@minecraft/server/WorldBeforeEvents/prototype/itemUseOn/subscribe.ts b/examples/@minecraft/server/WorldBeforeEvents/prototype/itemUseOn/subscribe.ts
@@ -0,0 +1,14 @@
+import { world, MinecraftBlockTypes, MinecraftItemTypes, Player } from "@minecraft/server";
+
+// Subscribe to the itemUseOn event before it happens
+world.beforeEvents.itemUseOn.subscribe((event) => {
+  const { source, block, itemStack } = event;
+  if (!(source instanceof Player)) return;
+
+  source.sendMessage("You used " + itemStack.typeId + " on " + block.typeId);
+
+  // If the item is a diamond, set the block to be a diamond block
+  if (itemStack.typeId === MinecraftItemTypes.diamond.id) {
+    block.setType(MinecraftBlockTypes.diamondBlock);
+  }
+});
diff --git a/examples/README.md b/examples/README.md
@@ -9,3 +9,4 @@ This feature is experimental and it's subject to change, so please avoid taking
 - Examples of class static properties' usage are located in the `{ClassName}/*` directory.
 - Examples of class instance properties' usage are located in `{ClassName}/prototype/*` directory.
 - Examples usage of interface and enumeration are located in either the `{InterfaceName}/*` or `{EnumName}/*` directories.
+- Properties inherited from classes will not be documented. Please document the inherited properties in inherited class.
diff --git a/src/snippetsEditor.ts b/src/snippetsEditor.ts
@@ -92,7 +92,7 @@ const prettierOptions: prettier.Options = {
   tabWidth: 4
 };
 
-const formatDocExample = (filepath: string, code: string) => path.basename(filepath) + '\n' + "```" + path.extname(filepath).slice(1) + '\n' + prettier.format(code, prettierOptions) + '\n' + "```"
+const formatDocExample = (filepath: string, code: string) => path.basename(filepath) + '\n' + "```" + path.extname(filepath).slice(1) + '\n' + prettier.format(code, prettierOptions) + "```"
 
 function reader(tsPath: string, doc: JSDoc, module_name: string) {
   const dir = path.resolve('examples', module_name, tsPath.replace(/\./g, '/'));
@@ -150,7 +150,7 @@ function reader(tsPath: string, doc: JSDoc, module_name: string) {
     });
     doc.addTags(jsdoctags);
 
-    const formatted = prettier.format(doc.getText(), prettierOptions);
+    const formatted = prettier.format(doc.getText(), prettierOptions).replace(/\n\s*$/, "");
     doc.replaceWithText(formatted);
   };
 };
diff --git a/tsconfig.json b/tsconfig.json
@@ -9,5 +9,5 @@
     "skipLibCheck": true,
   },
   "include": ["src"],
-  "exclude": ["node_modules", "lib", "dist"]
+  "exclude": ["node_modules", "lib", "dist", "examples"]
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+const damageApplied = entity.applyDamage(10);`
	`2`	+console.log(`Damage applied: ${damageApplied}`);
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+const components = entity.getComponents();`
	`2`	+console.log(`Number of components: ${components.length}: ${components.map(component => component.typeId)}`);
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+const xpAdded = player.addExperience(100);`
	`2`	+console.log(`Player ${player.name} now has ${xpAdded} experience points.`);
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+const levels = player.addLevels(5);`
	`2`	+console.log(`Player ${player.name} now has ${levels} levels.`)
	`3`	`+`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+const cooldown = player.getItemCooldown("equipment");`
	`2`	+console.log(`Cooldown for the equipment category: ${cooldown} seconds.`);