Adding GetEffects (JaylyDev#175)

fraysdev · web-flow · commit 94229cd7a18c · 2023-03-30T23:43:16.000+01:00
* Create chat-rank.js

* Add files via upload

* Update impact_of_removing_runCommand.md

* Delete impact_of_removing_runCommand.md

* Create index.js

* Create README.md

* Update index.js
diff --git a/scripts/get-effects/README.md b/scripts/get-effects/README.md
@@ -0,0 +1,31 @@
+# GetEffects
+
+Return list of object contain `EffectType` class and `Effecf` class. This will allow us to get the effect identifier when `Effect` class doesn't have `typeId` property.
+
+## How to use?
+
+```js
+import { system } from "@minecraft/server";
+import getEffects from "./getEffects";
+
+// Check if player has absorbtion effect
+system.runInterval(() => {
+  for (const player of world.getPlayers()) {
+    const absorbtion = getEffects(player)
+      .find((eff) => eff.effectType.getName() === "minecraft:absorbtion");
+    if (!absorbtion) continue;
+    
+    console.warn(`${player.name} has absorbtion`)
+  }
+}, 20)
+```
+
+## Properties
+
+- `effectType: EffectType`  
+  Get effect identifier  
+  `return`: [EffectType](https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/effecttype)
+
+- `effect: Effect`  
+  Get effect amplifier and duration  
+  `return`: [Effect](https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/effect)
diff --git a/scripts/get-effects/index.js b/scripts/get-effects/index.js
@@ -0,0 +1,35 @@
+// Script example for ScriptAPI
+// Author: FrankyRayMS <https://github.com/FrankyRay>
+// Project: https://github.com/JaylyDev/ScriptAPI
+
+import {
+  world,
+  MinecraftEffectTypes,
+  /* Typings only */
+  Entity,
+  Player,
+  Effect,
+  EffectType
+} from "@minecraft/server";
+
+/**
+ * Get every effect from the entity
+ *
+ * @param {Entity|Player} entity
+ * Entity or Player class
+ *
+ * @return {{ effectType: EffectType, effect: Effect }[]}
+ */
+export function getEffects(entity) {
+  const effectList = [];
+  for (const eff of Object.values(MinecraftEffectTypes)) {
+    const effect = entity.getEffect(eff);
+    if (!effect) continue;
+    effectList.push({
+      effectType: eff,
+      effect: effect
+    });
+  };
+  
+  return effectList;
+};
