@plugify-plugins/s2sdk-types 1.1.13 → 1.1.14

package/index.d.ts

@@ -213,6 +213,22 @@ declare module ":s2sdk" {
         Stop = 3
     }
 
+    /**
+    * @description Enum representing the type of callback.
+    */
+    export enum HookMode {
+
+        /**
+         * @description Callback will be executed before the original function 
+         * */
+        Pre = 0,
+
+        /**
+         * @description Callback will be executed after the original function 
+         * */
+        Post = 1
+    }
+
     /**
     * @description undefined
     */
@@ -1551,8 +1567,9 @@ declare module ":s2sdk" {
      * @param description A brief description of what the command does.
      * @param flags Command flags that define the behavior of the command.
      * @param callback A callback function that is invoked when the command is executed.
+     * @param type Whether the hook was in post mode (after processing) or pre mode (before processing).
      */
-    export function AddAdminCommand(name: string, adminFlags: number, description: string, flags: ConVarFlag, callback: typeof Callbacks.CommandCallback): boolean;
+    export function AddAdminCommand(name: string, adminFlags: number, description: string, flags: ConVarFlag, callback: typeof Callbacks.CommandCallback, type: HookMode): boolean;
 
     /**
      * @description Creates a console command or hooks an already existing one.
@@ -1563,8 +1580,9 @@ declare module ":s2sdk" {
      * @param description A brief description of what the command does.
      * @param flags Command flags that define the behavior of the command.
      * @param callback A callback function that is invoked when the command is executed.
+     * @param type Whether the hook was in post mode (after processing) or pre mode (before processing).
      */
-    export function AddConsoleCommand(name: string, description: string, flags: ConVarFlag, callback: typeof Callbacks.CommandCallback): boolean;
+    export function AddConsoleCommand(name: string, description: string, flags: ConVarFlag, callback: typeof Callbacks.CommandCallback, type: HookMode): boolean;
 
     /**
      * @description Removes a console command from the system.
@@ -1583,9 +1601,9 @@ declare module ":s2sdk" {
      * 
      * @param name The name of the command.
      * @param callback The callback function that will be invoked when the command is executed.
-     * @param post A boolean indicating whether the callback should fire after the command is executed.
+     * @param type Whether the hook was in post mode (after processing) or pre mode (before processing).
      */
-    export function AddCommandListener(name: string, callback: typeof Callbacks.CommandCallback, post: boolean): boolean;
+    export function AddCommandListener(name: string, callback: typeof Callbacks.CommandCallback, type: HookMode): boolean;
 
     /**
      * @description Removes a callback that fires when a command is sent to the server.
@@ -1594,9 +1612,9 @@ declare module ":s2sdk" {
      * 
      * @param name The name of the command.
      * @param callback The callback function to be removed.
-     * @param post A boolean indicating whether the callback should be removed for post-execution.
+     * @param type Whether the hook was in post mode (after processing) or pre mode (before processing).
      */
-    export function RemoveCommandListener(name: string, callback: typeof Callbacks.CommandCallback, post: boolean): boolean;
+    export function RemoveCommandListener(name: string, callback: typeof Callbacks.CommandCallback, type: HookMode): boolean;
 
     /**
      * @description Executes a server command as if it were run on the server console or through RCON.
@@ -2813,9 +2831,9 @@ declare module ":s2sdk" {
      * @param szClassname The class name of the entity to hook the output for.
      * @param szOutput The output event name to hook.
      * @param callback The callback function to invoke when the output is fired.
-     * @param post Indicates whether the hook should be a post-hook (true) or pre-hook (false).
+     * @param type Whether the hook was in post mode (after processing) or pre mode (before processing).
      */
-    export function HookEntityOutput(szClassname: string, szOutput: string, callback: typeof Callbacks.HookEntityOutputCallback, post: boolean): void;
+    export function HookEntityOutput(szClassname: string, szOutput: string, callback: typeof Callbacks.HookEntityOutputCallback, type: HookMode): boolean;
 
     /**
      * @description Removes an entity output hook.
@@ -2825,9 +2843,9 @@ declare module ":s2sdk" {
      * @param szClassname The class name of the entity from which to unhook the output.
      * @param szOutput The output event name to unhook.
      * @param callback The callback function that was previously hooked.
-     * @param post Indicates whether the hook was a post-hook (true) or pre-hook (false).
+     * @param type Whether the hook was in post mode (after processing) or pre mode (before processing).
      */
-    export function UnhookEntityOutput(szClassname: string, szOutput: string, callback: typeof Callbacks.HookEntityOutputCallback, post: boolean): void;
+    export function UnhookEntityOutput(szClassname: string, szOutput: string, callback: typeof Callbacks.HookEntityOutputCallback, type: HookMode): boolean;
 
     /**
      * @description Searches for an entity by classname.
@@ -3223,9 +3241,9 @@ declare module ":s2sdk" {
      * 
      * @param name The name of the event to hook.
      * @param pCallback The callback function to call when the event is fired.
-     * @param post A boolean indicating whether the hook should be for a post event.
+     * @param type Whether the hook was in post mode (after processing) or pre mode (before processing).
      */
-    export function HookEvent(name: string, pCallback: typeof Callbacks.EventCallback, post: boolean): number;
+    export function HookEvent(name: string, pCallback: typeof Callbacks.EventCallback, type: HookMode): number;
 
     /**
      * @description Removes a hook for when a game event is fired.
@@ -3234,9 +3252,9 @@ declare module ":s2sdk" {
      * 
      * @param name The name of the event to unhook.
      * @param pCallback The callback function to remove.
-     * @param post A boolean indicating whether the hook is for a post event.
+     * @param type Whether the hook was in post mode (after processing) or pre mode (before processing).
      */
-    export function UnhookEvent(name: string, pCallback: typeof Callbacks.EventCallback, post: boolean): number;
+    export function UnhookEvent(name: string, pCallback: typeof Callbacks.EventCallback, type: HookMode): number;
 
     /**
      * @description Creates a game event to be fired later.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@plugify-plugins/s2sdk-types",
-    "version": "1.1.13",
+    "version": "1.1.14",
     "description": "generated typescript types to write plugins on plugify",
     "types": "index.d.ts",
     "scripts": {},