chore(docs): fs rewrite

dockfries · Nov 27, 2024 · 3b1faf1 · 3b1faf1
1 parent 96b6420
commit 3b1faf1
Show file tree

Hide file tree

Showing 3 changed files with 132 additions and 126 deletions.
diff --git a/docs/es-ES/essentials/use.md b/docs/es-ES/essentials/use.md
@@ -1,125 +1,127 @@
-# Uso
-
-**`GameMode.use` es un método para simular `filterscript`, que se utiliza para la reutilización lógica en GameMode.**
-
-::: tip
-Debido a que se trata de una simulación y no de un `filterscript` real, no puede operar estos scripts a través de comandos como `rcon loadfs/unloadfs`.
-:::
-
-## Tipo
-
-```ts
-interface IFilterScript {
-  name: string;
-  load: (...args: Array<any>) => any;
-  unload: () => any;
-  [propName: string | number | symbol]: any;
-}
-
-type Use = (plugin: IFilterScript, ...options: Array<any>) => GameMode;
-```
-
-## Definir script
-
-Puedes escribir tú mismo algunos scripts de reutilización lógica y compartirlos con otros a través de `node package` u otras formas.
-
-```ts
-import { GameMode } from "@infernus/core";
-import type { IFilterScript } from "@infernus/core";
-
-interface IMyScriptOptions {
-  debug?: boolean;
-}
-
-interface IMyScript extends IFilterScript {
-  load(options: IMyScriptOptions): ReturnType<IFilterScript["load"]>;
-}
-
-const MyScript: IMyScript = {
-  name: "my_script",
-  load(...args) {
-    console.log('Mi script cargó.', args);
-  },
-  unload() {
-    console.log('Mi script se descargó.');
-  }
-};
-
-// Ningún parámetro es pasado al método load
-GameMode.use(MyScript);
-// Pasa parámetros al método load
-GameMode.use(MyScript, 'arg1', 'arg2', 'arg...');
-```
-
-::: tip
-Los scripts registrados se cargan automáticamente después del inicio del GameMode.
-El script cargado se descarga automáticamente al salir del GameMode.
-:::
-
-## Cargar un comando
-
-- `GameMode.loadUseScript(name: string)`: Cargar un script registrado
-- `GameMode.unloadUseScript(nombre: cadena)`: Descargar un script registrado
-- `GameMode.reloadUseScript(nombre: cadena)`: Recargar un script registrado
-
-### Ejemplo
-
-```ts
-import { GameMode, PlayerEvent } from "@infernus/core";
-
-PlayerEvent.onCommandText("reloadMyScript", ({ next }) => {
-  GameMode.reloadUseScript("my_script");
-  return next();
-});
-```
-
-## Noticia
-
-::: warning
-No deberías de registrar el evento `GameMode.onInit` en la función `load`, ya que se ejecuta en su evento cuando es cargada a través de `GameMode.use`.
-
-Si usas funciones de middleware en la función `load`, deberías retornar un arreglo de funciones de middleware canceladas la final, ¡de otra forma habría un fenómeno de fuga de memoria! Para otras variables globales, como los timers, ¡deberías reiniciarlas en la función `unload`!
-
-La razón es simple, si no haces eso, el middleware no va a ser descargado cuando la GameMode es reiniciada o se ejecuta de forma manual el script del comando para reiniciar, y cada vez que el script es cargado, una nueva función intermedia es agregada, ¡lo que provocará una fuga de memoria!  
-:::
-
-Además, no debe llamar a `script.load()` o `script.unload()`. Debe usar el [cargar comando](#load-command) para llamar.
-
-```ts
-const MyScript = {
-  name: 'my_script',
-  load(...args) {
-    const off1 = PlayerEvent.onCommandText("foo", ({ player, next }) => {
-      return next();
-    });
-
-    const off2 = PlayerEvent.onConnect(({ player, next }) => {
-      return next();
-    });
-
-    return [off1, off2];
-  },
-  unload() {
-
-  }
-}
-
-GameMode.use(MyScript);
-```
-
-## Reescribe el oficial filterscript
-
-`Infernus` ha intentado reescribir el filterscript oficial, pero hasta ahora solo se ha implementado una pequeña parte. Puedes probarlo instalando `@infernus/fs`. Si está interesado, puede continuar mejorando el filterscript oficial que no se ha reescrito y enviarlo al repositorio.
-
-```sh
-pnpm install @infernus/fs
-```
-
-```ts
-import { GameMode } from "@infernus/core";
-import { A51Base } from "@infernus/fs";
-
-GameMode.use(A51Base, { debug: true });
-```
-
+# Uso
+
+**`GameMode.use` es un método para simular `filterscript`, que se utiliza para la reutilización lógica en GameMode.**
+
+::: tip
+Debido a que se trata de una simulación y no de un `filterscript` real, no puede operar estos scripts a través de comandos como `rcon loadfs/unloadfs`.
+:::
+
+## Tipo
+
+```ts
+interface IFilterScript {
+  name: string;
+  load: (...args: Array<any>) => any;
+  unload: () => any;
+  [propName: string | number | symbol]: any;
+}
+
+type Use = (plugin: IFilterScript, ...options: Array<any>) => GameMode;
+```
+
+## Definir script
+
+Puedes escribir tú mismo algunos scripts de reutilización lógica y compartirlos con otros a través de `node package` u otras formas.
+
+```ts
+import { GameMode } from "@infernus/core";
+import type { IFilterScript } from "@infernus/core";
+
+interface IMyScriptOptions {
+  debug?: boolean;
+}
+
+interface IMyScript extends IFilterScript {
+  load(options: IMyScriptOptions): ReturnType<IFilterScript["load"]>;
+}
+
+const MyScript: IMyScript = {
+  name: "my_script",
+  load(...args) {
+    console.log('Mi script cargó.', args);
+  },
+  unload() {
+    console.log('Mi script se descargó.');
+  }
+};
+
+// Ningún parámetro es pasado al método load
+GameMode.use(MyScript);
+// Pasa parámetros al método load
+GameMode.use(MyScript, 'arg1', 'arg2', 'arg...');
+```
+
+::: tip
+Los scripts registrados se cargan automáticamente después del inicio del GameMode.
+El script cargado se descarga automáticamente al salir del GameMode.
+:::
+
+## Cargar un comando
+
+- `GameMode.loadUseScript(name: string)`: Cargar un script registrado
+- `GameMode.unloadUseScript(nombre: cadena)`: Descargar un script registrado
+- `GameMode.reloadUseScript(nombre: cadena)`: Recargar un script registrado
+
+### Ejemplo
+
+```ts
+import { GameMode, PlayerEvent } from "@infernus/core";
+
+PlayerEvent.onCommandText("reloadMyScript", ({ next }) => {
+  GameMode.reloadUseScript("my_script");
+  return next();
+});
+```
+
+## Noticia
+
+::: warning
+No deberías de registrar el evento `GameMode.onInit` en la función `load`, ya que se ejecuta en su evento cuando es cargada a través de `GameMode.use`.
+
+Si usas funciones de middleware en la función `load`, deberías retornar un arreglo de funciones de middleware canceladas la final, ¡de otra forma habría un fenómeno de fuga de memoria! Para otras variables globales, como los timers, ¡deberías reiniciarlas en la función `unload`!
+
+La razón es simple, si no haces eso, el middleware no va a ser descargado cuando la GameMode es reiniciada o se ejecuta de forma manual el script del comando para reiniciar, y cada vez que el script es cargado, una nueva función intermedia es agregada, ¡lo que provocará una fuga de memoria!  
+:::
+
+Además, no debe llamar a `script.load()` o `script.unload()`. Debe usar el [cargar comando](#load-command) para llamar.
+
+```ts
+const MyScript = {
+  name: 'my_script',
+  load(...args) {
+    const off1 = PlayerEvent.onCommandText("foo", ({ player, next }) => {
+      return next();
+    });
+
+    const off2 = PlayerEvent.onConnect(({ player, next }) => {
+      return next();
+    });
+
+    return [off1, off2];
+  },
+  unload() {
+
+  }
+}
+
+GameMode.use(MyScript);
+```
+
+## Reescribe el oficial filterscript
+
+`Infernus` ha intentado reescribir el filtro oficial. Puedes probarlo instalando [@infernus/fs](https://github.com/dockfries/infernus/tree/main/packages/filterscript).
+
+Si está interesado, puede referirse a estos casos para familiarizarse con la sintaxis más rápido. También puedes descargar el código fuente y modificarlo para aplicarlo mejor en tu GameMode.
+
+```sh
+pnpm install @infernus/fs
+```
+
+```ts
+import { GameMode } from "@infernus/core";
+import { A51Base } from "@infernus/fs";
+
+GameMode.use(A51Base, { debug: true });
+```
+
 Luego ingresas `/a51` en el juego para teletransportarte a la base.
diff --git a/docs/essentials/use.md b/docs/essentials/use.md
@@ -111,7 +111,9 @@ GameMode.use(MyScript);
 
 ## Rewrite the official filterscript
 
-`Infernus` has tried to rewrite the official filterscript, but only a little has been implemented so far. You can try it by installing [@infernus/fs](https://github.com/dockfries/infernus/tree/main/packages/filterscript). If you are interested, you can continue to improve the official filterscript that has not been rewritten and commit to the repository.
+`Infernus` has tried to rewrite the official filterscript. You can try it by installing [@infernus/fs](https://github.com/dockfries/infernus/tree/main/packages/filterscript).
+
+If you are interested, you can refer to these cases to familiarize you with the syntax faster. You can also download the source code and modify it to better apply it in your GameMode.
 
 ```sh
 pnpm install @infernus/fs

diff --git a/docs/zh-CN/essentials/use.md b/docs/zh-CN/essentials/use.md
@@ -111,7 +111,9 @@ GameMode.use(MyScript);
 
 ## 重写官方过滤脚本
 
-`Infernus` 尝试了重写官方的过滤脚本，不过目前只实现了一点点，您可以通过安装 [@infernus/fs](https://github.com/dockfries/infernus/tree/main/packages/filterscript) 来体验，如果您感兴趣也可以继续完善未重写的官方过滤脚本，将这些例子提交到仓库中。
+`Infernus` 尝试了重写官方的过滤脚本，您可以通过安装 [@infernus/fs](https://github.com/dockfries/infernus/tree/main/packages/filterscript) 来体验。
+
+如果您感兴趣，可以参考这些案例，让您更快熟悉语法，您也可以下载源码并修改，让它更好地应用到您的游戏模式中。
 
 ```sh
 pnpm install @infernus/fs