upd (fw/rpc):

- (rpc) removed unnecessary return type generics
- (fw) implemented synchronous versions of rpc events to omit waiting for response
- (fw) more descriptive docs

client/src/core/player.ts

@@ -14,12 +14,40 @@ export class FW_Player {
     }
 
     /**
-     * Triggers a client event from the client with arguments from shared types
+     * Triggers a client event from the client with arguments from 'rage-fw-shared-types'
      *
      * Formerly known as ``call`` or ``emit``
      *
      * @param eventName - The name of the client event to trigger
      * @param [args] - Arguments for the client event, if present
+     * @returns {void}
+     *
+     * @example
+     * // Triggering a client event without arguments
+     * fw.player.trigger("clientEventName")
+     *
+     * @example
+     * // Triggering a client event with arguments
+     * fw.player.trigger("clientEventName", ["message to me"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public trigger<EventName extends keyof T.FW_ICustomClientEvent>(
+        eventName: EventName,
+        ...args: T._ClientEventHasArgs<EventName> extends true
+            ? [T.FW_ClientArgs<EventName>]
+            : []
+    ): void {
+        rpc.call<typeof args, EventName>(eventName, args)
+    }
+
+    /**
+     * Triggers an asynchronous client event from the client with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
+     *
+     * Formerly known as ``callAsync`` or ``emitAsync``
+     *
+     * @param eventName - The name of the client event to trigger
+     * @param [args] - Arguments for the client event, if present
      * @returns {Promise} resolving to the client's response for the event
      *
      * @example
@@ -32,13 +60,13 @@ export class FW_Player {
      *
      * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
      */
-    public async trigger<EventName extends keyof T.FW_ICustomClientEvent>(
+    public async triggerAsync<EventName extends keyof T.FW_ICustomClientEvent>(
         eventName: EventName,
         ...args: T._ClientEventHasArgs<EventName> extends true
             ? [T.FW_ClientArgs<EventName>]
             : []
     ): Promise<T.FW_ClientReturn<EventName>> {
-        return await rpc.call<
+        return await rpc.callAsync<
             typeof args,
             EventName,
             T.FW_ClientReturn<EventName>
@@ -46,12 +74,40 @@ export class FW_Player {
     }
 
     /**
-     * Triggers a server event from the client with arguments from shared types
+     * Triggers a server event from the client with arguments from 'rage-fw-shared-types'
      *
      * Formerly known as ``callServer`` or ``emitServer``
      *
      * @param eventName - The name of the server event to trigger
      * @param [args] - Arguments for the server event, if present
+     * @returns {void}
+     *
+     * @example
+     * // Triggering a server event without arguments
+     * fw.player.triggerServer("serverEventName")
+     *
+     * @example
+     * // Triggering a server event with arguments
+     * fw.player.triggerServer("serverEventName", ["message to server"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public triggerServer<EventName extends T.FW_ServerEvent>(
+        eventName: EventName,
+        ...args: T._ServerEventHasArgs<EventName> extends true
+            ? [T.FW_ServerArgs<EventName>]
+            : []
+    ): void {
+        rpc.callServer<typeof args, EventName>(eventName, args)
+    }
+
+    /**
+     * Triggers an asynchronous server event from the client with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
+     *
+     * Formerly known as ``callServerAsync`` or ``emitServerAsync``
+     *
+     * @param eventName - The name of the server event to trigger
+     * @param [args] - Arguments for the server event, if present
      * @returns {Promise} resolving to the server's response for the event
      *
      * @example
@@ -64,13 +120,13 @@ export class FW_Player {
      *
      * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
      */
-    public async triggerServer<EventName extends T.FW_ServerEvent>(
+    public async triggerServerAsync<EventName extends T.FW_ServerEvent>(
         eventName: EventName,
         ...args: T._ServerEventHasArgs<EventName> extends true
             ? [T.FW_ServerArgs<EventName>]
             : []
     ): Promise<T.FW_ClientServerReturn<EventName>> {
-        return await rpc.callServer<
+        return await rpc.callServerAsync<
             typeof args,
             EventName,
             T.FW_ClientServerReturn<EventName>
@@ -78,12 +134,43 @@ export class FW_Player {
     }
 
     /**
-     * Triggers a browser event from the client with arguments from shared types
+     * Triggers a browser event from the client with arguments from 'rage-fw-shared-types'
      *
      * Formerly known as ``callBrowser`` or ``emitBrowser``
      *
      * @param eventName - The name of the browser event to trigger
      * @param [args] - Arguments for the browser event, if present
+     * @returns {void}
+     *
+     * @example
+     * // Triggering a browser event without arguments
+     * fw.player.triggerBrowser("browserEventName")
+     *
+     * @example
+     * // Triggering a browser event with arguments
+     * fw.player.triggerBrowser("browserEventName", ["message to browser"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public triggerBrowser<EventName extends T.FW_BrowserEvent>(
+        eventName: EventName,
+        ...args: T._BrowserEventHasArgs<EventName> extends true
+            ? [T.FW_BrowserArgs<EventName>]
+            : []
+    ): void {
+        if (!this._browser)
+            throw new Error('You need to initialize browser first')
+
+        rpc.callBrowser<typeof args, EventName>(eventName, args)
+    }
+
+    /**
+     * Triggers an asynchronous browser event from the client with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
+     *
+     * Formerly known as ``callBrowserAsync`` or ``emitBrowserAsync``
+     *
+     * @param eventName - The name of the browser event to trigger
+     * @param [args] - Arguments for the browser event, if present
      * @returns {Promise} resolving to the browser's response for the event
      *
      * @example
@@ -96,7 +183,7 @@ export class FW_Player {
      *
      * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
      */
-    public async triggerBrowser<EventName extends T.FW_BrowserEvent>(
+    public async triggerBrowserAsync<EventName extends T.FW_BrowserEvent>(
         eventName: EventName,
         ...args: T._BrowserEventHasArgs<EventName> extends true
             ? [T.FW_BrowserArgs<EventName>]
@@ -105,14 +192,10 @@ export class FW_Player {
         if (!this._browser)
             throw new Error('You need to initialize browser first')
 
-        return await rpc.callBrowser<
+        return await rpc.callBrowserAsync<
             typeof args,
             EventName,
             T.FW_BrowserReturn<EventName>
         >(eventName, args)
     }
 }
-
-// new Player().trigger('customClientEvent', ['', 1])
-// new Player().triggerServer('customServerEvent', ['', 1])
-// new Player().triggerBrowser('customCefEvent', ['', 1])