Compare commits
4
Commits
a820e9896b
...
dev
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
12d2197e18 | ||
|
|
897fd5a9f5 | ||
|
|
d5dc6924aa | ||
|
|
78d1831bbc |
+99
-13
@@ -75,12 +75,42 @@ export class FW_Browser extends FW_Helper {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Triggers a browser event from the browser with arguments from shared types
|
* Triggers a browser event from the browser with arguments from 'rage-fw-shared-types'
|
||||||
*
|
*
|
||||||
* Formerly known as ``call`` or ``emit``
|
* Formerly known as ``call`` or ``emit``
|
||||||
*
|
*
|
||||||
* @param eventName - The name of the browser event to trigger
|
* @param eventName - The name of the browser event to trigger
|
||||||
* @param [args] - Arguments for the browser event, if present
|
* @param [args] - Arguments for the browser event, if present
|
||||||
|
* @returns {void}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Triggering a browser event without arguments
|
||||||
|
* fw.event.trigger("browserEventName")
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Triggering a browser event with arguments
|
||||||
|
* fw.event.trigger("browserEventName", ["message to me"])
|
||||||
|
*
|
||||||
|
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
||||||
|
*/
|
||||||
|
public trigger<EventName extends T.FW_BrowserEvent>(
|
||||||
|
eventName: EventName,
|
||||||
|
...args: T._BrowserEventHasArgs<EventName> extends true
|
||||||
|
? [T.FW_BrowserArgs<EventName>]
|
||||||
|
: []
|
||||||
|
): void {
|
||||||
|
this.log_('[RPC](trigger):', eventName, ...args)
|
||||||
|
|
||||||
|
rpc.call<typeof args, EventName>(eventName, args)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggers an asynchronous browser event from the browser 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 browser event to trigger
|
||||||
|
* @param [args] - Arguments for the browser event, if present
|
||||||
* @returns {Promise} resolving to the browser's response for the event
|
* @returns {Promise} resolving to the browser's response for the event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
@@ -93,7 +123,7 @@ export class FW_Browser extends FW_Helper {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
||||||
*/
|
*/
|
||||||
public async trigger<EventName extends T.FW_BrowserEvent>(
|
public async triggerAsync<EventName extends T.FW_BrowserEvent>(
|
||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
...args: T._BrowserEventHasArgs<EventName> extends true
|
...args: T._BrowserEventHasArgs<EventName> extends true
|
||||||
? [T.FW_BrowserArgs<EventName>]
|
? [T.FW_BrowserArgs<EventName>]
|
||||||
@@ -101,7 +131,7 @@ export class FW_Browser extends FW_Helper {
|
|||||||
): Promise<T.FW_BrowserReturn<EventName>> {
|
): Promise<T.FW_BrowserReturn<EventName>> {
|
||||||
this.log_('[RPC](trigger):', eventName, ...args)
|
this.log_('[RPC](trigger):', eventName, ...args)
|
||||||
|
|
||||||
return await rpc.call<
|
return await rpc.callAsync<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.FW_BrowserReturn<EventName>
|
T.FW_BrowserReturn<EventName>
|
||||||
@@ -109,12 +139,42 @@ export class FW_Browser extends FW_Helper {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Triggers a server event from the browser with arguments from shared types
|
* Triggers a server event from the browser with arguments from 'rage-fw-shared-types'
|
||||||
*
|
*
|
||||||
* Formerly known as ``callServer`` or ``emitServer``
|
* Formerly known as ``callServer`` or ``emitServer``
|
||||||
*
|
*
|
||||||
* @param eventName - The name of the server event to trigger
|
* @param eventName - The name of the server event to trigger
|
||||||
* @param [args] - Arguments for the server event, if present
|
* @param [args] - Arguments for the server event, if present
|
||||||
|
* @returns {void}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Triggering a server event without arguments
|
||||||
|
* fw.event.triggerServer("serverEventName")
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Triggering a server event with arguments
|
||||||
|
* fw.event.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 {
|
||||||
|
this.log_('[RPC](triggerServer):', eventName, ...args)
|
||||||
|
|
||||||
|
rpc.callServer<typeof args, EventName>(eventName, args)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggers an asynchronous server event from the browser 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
|
* @returns {Promise} resolving to the server's response for the event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
@@ -127,7 +187,7 @@ export class FW_Browser extends FW_Helper {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._ServerEventHasArgs<EventName> extends true
|
...args: T._ServerEventHasArgs<EventName> extends true
|
||||||
? [T.FW_ServerArgs<EventName>]
|
? [T.FW_ServerArgs<EventName>]
|
||||||
@@ -135,7 +195,7 @@ export class FW_Browser extends FW_Helper {
|
|||||||
): Promise<T.FW_ServerReturn<EventName>> {
|
): Promise<T.FW_ServerReturn<EventName>> {
|
||||||
this.log_('[RPC](triggerServer):', eventName, ...args)
|
this.log_('[RPC](triggerServer):', eventName, ...args)
|
||||||
|
|
||||||
return await rpc.callServer<
|
return await rpc.callServerAsync<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.FW_ServerReturn<EventName>
|
T.FW_ServerReturn<EventName>
|
||||||
@@ -143,12 +203,42 @@ export class FW_Browser extends FW_Helper {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Triggers a client event from the browser with arguments from shared types
|
* Triggers a browser event from the browser with arguments from 'rage-fw-shared-types'
|
||||||
*
|
*
|
||||||
* Formerly known as ``callClient`` or ``emitClient``
|
* Formerly known as ``callClient`` or ``emitClient``
|
||||||
*
|
*
|
||||||
* @param eventName - The name of the client event to trigger
|
* @param eventName - The name of the client event to trigger
|
||||||
* @param [args] - Arguments for the client event, if present
|
* @param [args] - Arguments for the client event, if present
|
||||||
|
* @returns {void}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Triggering a client event without arguments
|
||||||
|
* fw.event.triggerClient("clientEventName")
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Triggering a client event with arguments
|
||||||
|
* fw.event.triggerClient("clientEventName", ["message to client"])
|
||||||
|
*
|
||||||
|
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
||||||
|
*/
|
||||||
|
public triggerClient<EventName extends T.FW_ClientEvent>(
|
||||||
|
eventName: EventName,
|
||||||
|
...args: T._ClientEventHasArgs<EventName> extends true
|
||||||
|
? [T.FW_ClientArgs<EventName>]
|
||||||
|
: []
|
||||||
|
): void {
|
||||||
|
this.log_('[RPC](triggerClient):', eventName, ...args)
|
||||||
|
|
||||||
|
rpc.callClient<typeof args, EventName>(eventName, args)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggers an asynchronous client event from the browser with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
|
||||||
|
*
|
||||||
|
* Formerly known as ``callClientAsync`` or ``emitClientAsync``
|
||||||
|
*
|
||||||
|
* @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
|
* @returns {Promise} resolving to the client's response for the event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
@@ -161,7 +251,7 @@ export class FW_Browser extends FW_Helper {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
||||||
*/
|
*/
|
||||||
public async triggerClient<EventName extends T.FW_ClientEvent>(
|
public async triggerClientAsync<EventName extends T.FW_ClientEvent>(
|
||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
...args: T._ClientEventHasArgs<EventName> extends true
|
...args: T._ClientEventHasArgs<EventName> extends true
|
||||||
? [T.FW_ClientArgs<EventName>]
|
? [T.FW_ClientArgs<EventName>]
|
||||||
@@ -169,14 +259,10 @@ export class FW_Browser extends FW_Helper {
|
|||||||
): Promise<T.FW_ClientReturn<EventName>> {
|
): Promise<T.FW_ClientReturn<EventName>> {
|
||||||
this.log_('[RPC](triggerClient):', eventName, ...args)
|
this.log_('[RPC](triggerClient):', eventName, ...args)
|
||||||
|
|
||||||
return await rpc.callClient<
|
return await rpc.callClientAsync<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.FW_ClientReturn<EventName>
|
T.FW_ClientReturn<EventName>
|
||||||
>(eventName, args)
|
>(eventName, args)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// new Browser()
|
|
||||||
// .register('customCefEvent', async (a, b) => true)
|
|
||||||
// .triggerServer('customServerEvent', ['', 1])
|
|
||||||
|
|||||||
@@ -11,8 +11,3 @@ export const fw = {
|
|||||||
/** ``rage-fw-rpc`` instance used under the hood. It is highly recommended to use this one if you need it instead of creating a new instance */
|
/** ``rage-fw-rpc`` instance used under the hood. It is highly recommended to use this one if you need it instead of creating a new instance */
|
||||||
rpc,
|
rpc,
|
||||||
}
|
}
|
||||||
;(async () => {
|
|
||||||
await fw.event.triggerClient(
|
|
||||||
'cefReady' as Parameters<typeof fw.event.triggerClient>[0],
|
|
||||||
)
|
|
||||||
})()
|
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
export * from './browser'
|
export type * from './browser'
|
||||||
export * from './client'
|
export type * from './client'
|
||||||
export * from './server'
|
export type * from './server'
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ export class FW_Logger {
|
|||||||
*/
|
*/
|
||||||
public info(...message: unknown[]) {
|
public info(...message: unknown[]) {
|
||||||
mp.console.logInfo(
|
mp.console.logInfo(
|
||||||
`[${new Date().toLocaleTimeString()}] [INFO] ${message.join(' ')}`,
|
`[${new Date().toLocaleTimeString(undefined, { hour: 'numeric', minute: 'numeric', second: 'numeric', fractionalSecondDigits: 2 })}] [INFO] ${message.join(' ')}`,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ export class FW_Logger {
|
|||||||
*/
|
*/
|
||||||
public warn(...message: unknown[]) {
|
public warn(...message: unknown[]) {
|
||||||
mp.console.logWarning(
|
mp.console.logWarning(
|
||||||
`[${new Date().toLocaleTimeString()}] [WARN] ${message.join(' ')}`,
|
`[${new Date().toLocaleTimeString(undefined, { hour: 'numeric', minute: 'numeric', second: 'numeric', fractionalSecondDigits: 2 })}] [WARN] ${message.join(' ')}`,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ export class FW_Logger {
|
|||||||
*/
|
*/
|
||||||
public error(...message: unknown[]) {
|
public error(...message: unknown[]) {
|
||||||
mp.console.logError(
|
mp.console.logError(
|
||||||
`[${new Date().toLocaleTimeString()}] [ERROR] ${message.join(' ')}`,
|
`[${new Date().toLocaleTimeString(undefined, { hour: 'numeric', minute: 'numeric', second: 'numeric', fractionalSecondDigits: 2 })}] [ERROR] ${message.join(' ')}`,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+96
-13
@@ -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``
|
* Formerly known as ``call`` or ``emit``
|
||||||
*
|
*
|
||||||
* @param eventName - The name of the client event to trigger
|
* @param eventName - The name of the client event to trigger
|
||||||
* @param [args] - Arguments for the client event, if present
|
* @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
|
* @returns {Promise} resolving to the client's response for the event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
@@ -32,13 +60,13 @@ export class FW_Player {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._ClientEventHasArgs<EventName> extends true
|
...args: T._ClientEventHasArgs<EventName> extends true
|
||||||
? [T.FW_ClientArgs<EventName>]
|
? [T.FW_ClientArgs<EventName>]
|
||||||
: []
|
: []
|
||||||
): Promise<T.FW_ClientReturn<EventName>> {
|
): Promise<T.FW_ClientReturn<EventName>> {
|
||||||
return await rpc.call<
|
return await rpc.callAsync<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.FW_ClientReturn<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``
|
* Formerly known as ``callServer`` or ``emitServer``
|
||||||
*
|
*
|
||||||
* @param eventName - The name of the server event to trigger
|
* @param eventName - The name of the server event to trigger
|
||||||
* @param [args] - Arguments for the server event, if present
|
* @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
|
* @returns {Promise} resolving to the server's response for the event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
@@ -64,13 +120,13 @@ export class FW_Player {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._ServerEventHasArgs<EventName> extends true
|
...args: T._ServerEventHasArgs<EventName> extends true
|
||||||
? [T.FW_ServerArgs<EventName>]
|
? [T.FW_ServerArgs<EventName>]
|
||||||
: []
|
: []
|
||||||
): Promise<T.FW_ClientServerReturn<EventName>> {
|
): Promise<T.FW_ClientServerReturn<EventName>> {
|
||||||
return await rpc.callServer<
|
return await rpc.callServerAsync<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.FW_ClientServerReturn<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``
|
* Formerly known as ``callBrowser`` or ``emitBrowser``
|
||||||
*
|
*
|
||||||
* @param eventName - The name of the browser event to trigger
|
* @param eventName - The name of the browser event to trigger
|
||||||
* @param [args] - Arguments for the browser event, if present
|
* @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
|
* @returns {Promise} resolving to the browser's response for the event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
@@ -96,7 +183,7 @@ export class FW_Player {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._BrowserEventHasArgs<EventName> extends true
|
...args: T._BrowserEventHasArgs<EventName> extends true
|
||||||
? [T.FW_BrowserArgs<EventName>]
|
? [T.FW_BrowserArgs<EventName>]
|
||||||
@@ -105,14 +192,10 @@ export class FW_Player {
|
|||||||
if (!this._browser)
|
if (!this._browser)
|
||||||
throw new Error('You need to initialize browser first')
|
throw new Error('You need to initialize browser first')
|
||||||
|
|
||||||
return await rpc.callBrowser<
|
return await rpc.callBrowserAsync<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.FW_BrowserReturn<EventName>
|
T.FW_BrowserReturn<EventName>
|
||||||
>(eventName, args)
|
>(eventName, args)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// new Player().trigger('customClientEvent', ['', 1])
|
|
||||||
// new Player().triggerServer('customServerEvent', ['', 1])
|
|
||||||
// new Player().triggerBrowser('customCefEvent', ['', 1])
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
export * from './browser'
|
export type * from './browser'
|
||||||
export * from './client'
|
export type * from './client'
|
||||||
export * from './middleware'
|
export type * from './middleware'
|
||||||
export * from './server'
|
export type * from './server'
|
||||||
|
|||||||
+394
-53
@@ -77,7 +77,7 @@ class Rpc extends Wrapper {
|
|||||||
*
|
*
|
||||||
* @template CallbackArguments - An array of argument types that the callback function accepts
|
* @template CallbackArguments - An array of argument types that the callback function accepts
|
||||||
* @template CallbackReturn - The type of the value returned by the callback function
|
* @template CallbackReturn - The type of the value returned by the callback function
|
||||||
* @template EventName - A string representing the event name or union of names
|
* @template EventName - A string or union representing the event name
|
||||||
*
|
*
|
||||||
* @param {EventName} eventName - The name of the event to register the callback for
|
* @param {EventName} eventName - The name of the event to register the callback for
|
||||||
* @param {(...args: CallbackArguments) => CallbackReturn} cb - The callback function that is called when the event is triggered
|
* @param {(...args: CallbackArguments) => CallbackReturn} cb - The callback function that is called when the event is triggered
|
||||||
@@ -116,7 +116,7 @@ class Rpc extends Wrapper {
|
|||||||
/**
|
/**
|
||||||
* Unregisters callback function for a specified event
|
* Unregisters callback function for a specified event
|
||||||
*
|
*
|
||||||
* @template EventName - A string representing the event name or union of names
|
* @template EventName - A string or union representing the event name
|
||||||
*
|
*
|
||||||
* @param {EventName} eventName - The name of the event to register the callback for
|
* @param {EventName} eventName - The name of the event to register the callback for
|
||||||
*
|
*
|
||||||
@@ -133,54 +133,47 @@ class Rpc extends Wrapper {
|
|||||||
Utils.errorUnknownEnvironment(this.environment_)
|
Utils.errorUnknownEnvironment(this.environment_)
|
||||||
|
|
||||||
delete this.state_[eventName]
|
delete this.state_[eventName]
|
||||||
|
mp.events.remove(eventName)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Calls a client-side event from server or browser
|
* Calls a client-side event from browser or server. Use 'call' to call client from client
|
||||||
*
|
*
|
||||||
* @template Arguments - An array of argument types to be passed to the client event
|
* @template Arguments - An array of argument types to be passed to the client event
|
||||||
* @template EventName - A string representing the client event name or union of names
|
* @template EventName - A string or union representing the client event name
|
||||||
* @template Return - The type of the value returned by the client event
|
|
||||||
*
|
*
|
||||||
* @param {EventName} eventName - The name of the client event to be called
|
* @param {EventName} eventName - The name of the client event to be called
|
||||||
* @param {Arguments} [args] - Optional arguments to pass to the client event
|
* @param {Arguments} [args] - Optional arguments to pass to the client event
|
||||||
* @returns {Promise<Return>} A promise resolving to the return value of the client event
|
* @returns {void}
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* // Calls an event on client without specifying a player
|
* // Calls an event on a client without specifying a player
|
||||||
* callClient<[], string, object>('onDataRequest').then(response => {
|
* callClient<[], string, object>('onDataRequest')
|
||||||
* console.log(`Received: ${response}`) // ^ object
|
|
||||||
* })
|
|
||||||
*/
|
*/
|
||||||
public async callClient<
|
public callClient<
|
||||||
Arguments extends unknown[] = unknown[],
|
Arguments extends unknown[] = unknown[],
|
||||||
EventName extends string = string,
|
EventName extends string = string,
|
||||||
Return = unknown,
|
>(eventName: EventName, args?: Arguments): void
|
||||||
>(eventName: EventName, args?: Arguments): Promise<Return>
|
|
||||||
/**
|
/**
|
||||||
* Calls a client-side event from server or browser
|
* Calls a client-side event from server or server. Use 'call' to call client from client
|
||||||
*
|
*
|
||||||
* @template Arguments - An array of argument types to be passed to the client event
|
* @template Arguments - An array of argument types to be passed to the client event
|
||||||
* @template EventName - A string representing the client event name or union of names
|
* @template EventName - A string or union representing the client event name
|
||||||
* @template Return - The type of the value returned by the client event
|
|
||||||
*
|
*
|
||||||
* @param {PlayerMp} player - The player for whom the client event is called
|
* @param {PlayerMp} player - The player for whom the client event is called
|
||||||
* @param {EventName} eventName - The name of the client event to be called
|
* @param {EventName} eventName - The name of the client event to be called
|
||||||
* @param {Arguments} [args] - Optional arguments to pass to the client event
|
* @param {Arguments} [args] - Optional arguments to pass to the client event
|
||||||
* @returns {Promise<Return>} A promise resolving to the return value of the client event
|
* @returns {void} A promise resolving to the return value of the client event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* // Calls an event on client for a specific player
|
* // Calls an event on a client for a specific player
|
||||||
* callClient<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]).then(result => {
|
* callClient<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2])
|
||||||
* console.log(`Action success: ${result}`) // ^ boolean
|
|
||||||
* })
|
|
||||||
*/
|
*/
|
||||||
public async callClient<
|
public callClient<
|
||||||
Arguments extends unknown[] = unknown[],
|
Arguments extends unknown[] = unknown[],
|
||||||
EventName extends string = string,
|
EventName extends string = string,
|
||||||
Return = unknown,
|
>(player: PlayerMp, eventName: EventName, args?: Arguments): void
|
||||||
>(player: PlayerMp, eventName: EventName, args?: Arguments): Promise<Return>
|
public callClient(
|
||||||
public async callClient(
|
|
||||||
playerOrEventName: PlayerMp | string,
|
playerOrEventName: PlayerMp | string,
|
||||||
eventNameOrArgs?: string | unknown[],
|
eventNameOrArgs?: string | unknown[],
|
||||||
args?: unknown[],
|
args?: unknown[],
|
||||||
@@ -202,10 +195,7 @@ class Rpc extends Wrapper {
|
|||||||
|
|
||||||
if (this.environment_ === Environment.CLIENT) {
|
if (this.environment_ === Environment.CLIENT) {
|
||||||
// client
|
// client
|
||||||
return await this.call(
|
this.call(playerOrEventName as string, args as unknown[])
|
||||||
playerOrEventName as string,
|
|
||||||
args as unknown[],
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// server
|
// server
|
||||||
@@ -227,7 +217,6 @@ class Rpc extends Wrapper {
|
|||||||
const dataRaw = Utils.prepareTransfer(state)
|
const dataRaw = Utils.prepareTransfer(state)
|
||||||
|
|
||||||
playerOrEventName.call(Events.LOCAL_EVENT_LISTENER, [dataRaw])
|
playerOrEventName.call(Events.LOCAL_EVENT_LISTENER, [dataRaw])
|
||||||
return (await this.responseHandler(state.uuid)).data
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// browser
|
// browser
|
||||||
@@ -249,7 +238,6 @@ class Rpc extends Wrapper {
|
|||||||
const dataRaw = Utils.prepareTransfer(state)
|
const dataRaw = Utils.prepareTransfer(state)
|
||||||
|
|
||||||
mp.trigger(Events.LOCAL_EVENT_LISTENER, dataRaw)
|
mp.trigger(Events.LOCAL_EVENT_LISTENER, dataRaw)
|
||||||
return (await this.responseHandler(state.uuid)).data
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function _is1StParamPlayer(x: unknown): x is PlayerMp {
|
function _is1StParamPlayer(x: unknown): x is PlayerMp {
|
||||||
@@ -262,10 +250,201 @@ class Rpc extends Wrapper {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Calls a server-side event from browser or client
|
* Calls an asynchronous client-side event from server or browser, expecting a response. Use 'callAsync' to call client from client
|
||||||
|
*
|
||||||
|
* @template Arguments - An array of argument types to be passed to the client event
|
||||||
|
* @template EventName - A string or union representing the client event name
|
||||||
|
* @template Return - The type of the value returned by the client event
|
||||||
|
*
|
||||||
|
* @param {EventName} eventName - The name of the client event to be called
|
||||||
|
* @param {Arguments} [args] - Optional arguments to pass to the client event
|
||||||
|
* @returns {Promise<Return>} A promise resolving to the return value of the client event
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Calls an event on a client without specifying a player
|
||||||
|
* callClient<[], string, object>('onDataRequest').then(response => {
|
||||||
|
* console.log(`Received: ${response}`) // ^ object
|
||||||
|
* })
|
||||||
|
*/
|
||||||
|
public async callClientAsync<
|
||||||
|
Arguments extends unknown[] = unknown[],
|
||||||
|
EventName extends string = string,
|
||||||
|
Return = unknown,
|
||||||
|
>(eventName: EventName, args?: Arguments): Promise<Return>
|
||||||
|
/**
|
||||||
|
* Calls an asynchronous client-side event from server or browser, expecting a response. Use 'callAsync' to call client from client
|
||||||
|
*
|
||||||
|
* @template Arguments - An array of argument types to be passed to the client event
|
||||||
|
* @template EventName - A string or union representing the client event name
|
||||||
|
* @template Return - The type of the value returned by the client event
|
||||||
|
*
|
||||||
|
* @param {PlayerMp} player - The player for whom the client event is called
|
||||||
|
* @param {EventName} eventName - The name of the client event to be called
|
||||||
|
* @param {Arguments} [args] - Optional arguments to pass to the client event
|
||||||
|
* @returns {Promise<Return>} A promise resolving to the return value of the client event
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Calls an event on a client for a specific player
|
||||||
|
* callClient<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]).then(result => {
|
||||||
|
* console.log(`Action success: ${result}`) // ^ boolean
|
||||||
|
* })
|
||||||
|
*/
|
||||||
|
public async callClientAsync<
|
||||||
|
Arguments extends unknown[] = unknown[],
|
||||||
|
EventName extends string = string,
|
||||||
|
Return = unknown,
|
||||||
|
>(player: PlayerMp, eventName: EventName, args?: Arguments): Promise<Return>
|
||||||
|
public async callClientAsync(
|
||||||
|
playerOrEventName: PlayerMp | string,
|
||||||
|
eventNameOrArgs?: string | unknown[],
|
||||||
|
args?: unknown[],
|
||||||
|
) {
|
||||||
|
if (_is1StParamPlayer(playerOrEventName)) {
|
||||||
|
this.log(
|
||||||
|
'callClientAsync',
|
||||||
|
eventNameOrArgs as string,
|
||||||
|
playerOrEventName,
|
||||||
|
eventNameOrArgs,
|
||||||
|
args,
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
this.log(
|
||||||
|
'callClientAsync',
|
||||||
|
playerOrEventName as string,
|
||||||
|
eventNameOrArgs,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.forceBrowserDevMode_) return
|
||||||
|
Utils.errorUnknownEnvironment(this.environment_)
|
||||||
|
|
||||||
|
if (this.environment_ === Environment.CLIENT) {
|
||||||
|
// client
|
||||||
|
return await this.callAsync(
|
||||||
|
playerOrEventName as string,
|
||||||
|
args as unknown[],
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// server
|
||||||
|
if (
|
||||||
|
this.environment_ === Environment.SERVER &&
|
||||||
|
_is1StParamPlayer(playerOrEventName) &&
|
||||||
|
_is2NdParamEventName(eventNameOrArgs)
|
||||||
|
) {
|
||||||
|
let state: RPCState = {
|
||||||
|
uuid: Utils.generateUUID(),
|
||||||
|
eventName: eventNameOrArgs,
|
||||||
|
calledTo: Environment.CLIENT,
|
||||||
|
calledFrom: this.environment_,
|
||||||
|
knownError: undefined,
|
||||||
|
data: args as unknown[],
|
||||||
|
type: RPCEventType.EVENT,
|
||||||
|
}
|
||||||
|
|
||||||
|
const dataRaw = Utils.prepareTransfer(state)
|
||||||
|
|
||||||
|
playerOrEventName.call(Events.LOCAL_EVENT_LISTENER, [dataRaw])
|
||||||
|
|
||||||
|
return await this.responseHandler(state.uuid)
|
||||||
|
.then(r => r.data)
|
||||||
|
.catch((e: string) => {
|
||||||
|
state.knownError = e
|
||||||
|
return this.triggerError_(state)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// browser
|
||||||
|
if (
|
||||||
|
this.environment_ === Environment.BROWSER &&
|
||||||
|
!_is1StParamPlayer(playerOrEventName) &&
|
||||||
|
!_is2NdParamEventName(eventNameOrArgs)
|
||||||
|
) {
|
||||||
|
const state: RPCState = {
|
||||||
|
uuid: Utils.generateUUID(),
|
||||||
|
eventName: playerOrEventName,
|
||||||
|
calledTo: Environment.CLIENT,
|
||||||
|
calledFrom: this.environment_,
|
||||||
|
knownError: undefined,
|
||||||
|
data: eventNameOrArgs,
|
||||||
|
type: RPCEventType.EVENT,
|
||||||
|
}
|
||||||
|
|
||||||
|
const dataRaw = Utils.prepareTransfer(state)
|
||||||
|
|
||||||
|
mp.trigger(Events.LOCAL_EVENT_LISTENER, dataRaw)
|
||||||
|
|
||||||
|
return await this.responseHandler(state.uuid)
|
||||||
|
.then(r => r.data)
|
||||||
|
.catch((e: string) => {
|
||||||
|
state.knownError = e
|
||||||
|
return this.triggerError_(state)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
function _is1StParamPlayer(x: unknown): x is PlayerMp {
|
||||||
|
return typeof x === 'object'
|
||||||
|
}
|
||||||
|
|
||||||
|
function _is2NdParamEventName(x: unknown): x is string {
|
||||||
|
return typeof x === 'string'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calls a server-side event from browser or client. Use 'call' to call server from server
|
||||||
*
|
*
|
||||||
* @template Arguments - An array of argument types to be passed to the server event
|
* @template Arguments - An array of argument types to be passed to the server event
|
||||||
* @template EventName - A string representing the server event name or union of names
|
* @template EventName - A string or union representing the server event name
|
||||||
|
*
|
||||||
|
* @param {EventName} eventName - The name of the server event to be called
|
||||||
|
* @param {Arguments} [args] - Optional arguments to pass to the server event
|
||||||
|
* @returns {void}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Calls an event on a server
|
||||||
|
* callServer<[], string, object>('onDataRequest')
|
||||||
|
*/
|
||||||
|
public callServer<
|
||||||
|
Arguments extends unknown[] = unknown[],
|
||||||
|
EventName extends string = string,
|
||||||
|
>(eventName: EventName, args?: Arguments): void {
|
||||||
|
this.log('callServer', eventName, args)
|
||||||
|
if (this.forceBrowserDevMode_) return
|
||||||
|
Utils.errorUnknownEnvironment(this.environment_)
|
||||||
|
|
||||||
|
const state: RPCState = {
|
||||||
|
uuid: Utils.generateUUID(),
|
||||||
|
eventName,
|
||||||
|
calledTo: Environment.SERVER,
|
||||||
|
calledFrom: this.environment_,
|
||||||
|
knownError: undefined,
|
||||||
|
data: args,
|
||||||
|
type: RPCEventType.EVENT,
|
||||||
|
}
|
||||||
|
|
||||||
|
const dataRaw = Utils.prepareTransfer(state)
|
||||||
|
|
||||||
|
switch (this.environment_) {
|
||||||
|
case Environment.SERVER:
|
||||||
|
this.callSelf(state)
|
||||||
|
break
|
||||||
|
|
||||||
|
case Environment.CLIENT:
|
||||||
|
mp.events.callRemote(Events.LOCAL_EVENT_LISTENER, dataRaw)
|
||||||
|
break
|
||||||
|
|
||||||
|
case Environment.BROWSER:
|
||||||
|
mp.trigger(Events.LOCAL_EVENT_LISTENER, dataRaw)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calls an asynchronous server-side event from browser or client, expecting a response. Use 'callAsync' to call server from server
|
||||||
|
*
|
||||||
|
* @template Arguments - An array of argument types to be passed to the server event
|
||||||
|
* @template EventName - A string or union representing the server event name
|
||||||
* @template Return - The type of the value returned by the server event
|
* @template Return - The type of the value returned by the server event
|
||||||
*
|
*
|
||||||
* @param {EventName} eventName - The name of the server event to be called
|
* @param {EventName} eventName - The name of the server event to be called
|
||||||
@@ -273,17 +452,17 @@ class Rpc extends Wrapper {
|
|||||||
* @returns {Promise<Return>} A promise resolving to the return value of the server event
|
* @returns {Promise<Return>} A promise resolving to the return value of the server event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* // Calls an event on server
|
* // Calls an event on a server
|
||||||
* callServer<[], string, object>('onDataRequest').then(response => {
|
* callServer<[], string, object>('onDataRequest').then(response => {
|
||||||
* console.log(`Received: ${response}`) // ^ object
|
* console.log(`Received: ${response}`) // ^ object
|
||||||
* })
|
* })
|
||||||
*/
|
*/
|
||||||
public async callServer<
|
public async callServerAsync<
|
||||||
Arguments extends unknown[] = unknown[],
|
Arguments extends unknown[] = unknown[],
|
||||||
EventName extends string = string,
|
EventName extends string = string,
|
||||||
Return = unknown,
|
Return = unknown,
|
||||||
>(eventName: EventName, args?: Arguments): Promise<Return> {
|
>(eventName: EventName, args?: Arguments): Promise<Return> {
|
||||||
this.log('callServer', eventName, args)
|
this.log('callServerAsync', eventName, args)
|
||||||
if (this.forceBrowserDevMode_)
|
if (this.forceBrowserDevMode_)
|
||||||
return undefined as unknown as Promise<Return>
|
return undefined as unknown as Promise<Return>
|
||||||
Utils.errorUnknownEnvironment(this.environment_)
|
Utils.errorUnknownEnvironment(this.environment_)
|
||||||
@@ -302,7 +481,7 @@ class Rpc extends Wrapper {
|
|||||||
|
|
||||||
switch (this.environment_) {
|
switch (this.environment_) {
|
||||||
case Environment.SERVER:
|
case Environment.SERVER:
|
||||||
return this.callSelf(state)
|
return this.callSelfAsync(state)
|
||||||
|
|
||||||
case Environment.CLIENT:
|
case Environment.CLIENT:
|
||||||
mp.events.callRemote(Events.LOCAL_EVENT_LISTENER, dataRaw)
|
mp.events.callRemote(Events.LOCAL_EVENT_LISTENER, dataRaw)
|
||||||
@@ -313,14 +492,122 @@ class Rpc extends Wrapper {
|
|||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
|
||||||
return (await this.responseHandler(state.uuid)).data
|
return await this.responseHandler(state.uuid)
|
||||||
|
.then(r => r.data)
|
||||||
|
.catch((e: string) => {
|
||||||
|
state.knownError = e
|
||||||
|
return this.triggerError_(state)
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Calls a browser-side event from server or client
|
* Calls a browser-side event from client or server. Use 'call' to call browser from browser
|
||||||
|
*
|
||||||
|
* @template Arguments - An array of argument types to be passed to the browser event
|
||||||
|
* @template EventName - A string or union representing the browser event name
|
||||||
|
*
|
||||||
|
* @param {EventName} eventName - The name of the browser event to be called
|
||||||
|
* @param {Arguments} [args] - Optional arguments to pass to the browser event
|
||||||
|
* @returns {void}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Calls an event on a browser without specifying a player
|
||||||
|
* callBrowser<[], string, object>('onDataRequest')
|
||||||
|
*/
|
||||||
|
public callBrowser<
|
||||||
|
Arguments extends unknown[] = unknown[],
|
||||||
|
EventName extends string = string,
|
||||||
|
>(eventName: EventName, args?: Arguments): void
|
||||||
|
/**
|
||||||
|
* Calls a browser-side event from client or server. Use 'call' to call browser from browser
|
||||||
*
|
*
|
||||||
* @template Arguments - An array of argument types to be passed to the browser event
|
* @template Arguments - An array of argument types to be passed to the browser event
|
||||||
* @template EventName - A string representing the browser event name or union of names
|
* @template EventName - A string representing the browser event name or union of names
|
||||||
|
*
|
||||||
|
* @param {PlayerMp} player - The player for whom the browser event is called
|
||||||
|
* @param {EventName} eventName - The name of the browser event to be called
|
||||||
|
* @param {Arguments} [args] - Optional arguments to pass to the browser event
|
||||||
|
* @returns {void}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Calls an event on a browser for a specific player
|
||||||
|
* callBrowser<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2])
|
||||||
|
*/
|
||||||
|
public callBrowser<
|
||||||
|
Arguments extends unknown[] = unknown[],
|
||||||
|
EventName extends string = string,
|
||||||
|
>(player: PlayerMp, eventName: EventName, args?: Arguments): void
|
||||||
|
public callBrowser(
|
||||||
|
playerOrEventName: PlayerMp | string,
|
||||||
|
eventNameOrArgs?: string | unknown[],
|
||||||
|
args?: unknown[],
|
||||||
|
) {
|
||||||
|
if (_is1StParamPlayer(playerOrEventName)) {
|
||||||
|
this.log(
|
||||||
|
'callBrowser',
|
||||||
|
eventNameOrArgs as string,
|
||||||
|
playerOrEventName,
|
||||||
|
eventNameOrArgs,
|
||||||
|
args,
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
this.log(
|
||||||
|
'callBrowser',
|
||||||
|
playerOrEventName as string,
|
||||||
|
eventNameOrArgs,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.forceBrowserDevMode_) return
|
||||||
|
Utils.errorUnknownEnvironment(this.environment_)
|
||||||
|
|
||||||
|
const state: RPCState = {
|
||||||
|
uuid: Utils.generateUUID(),
|
||||||
|
eventName: !_is1StParamPlayer(playerOrEventName)
|
||||||
|
? playerOrEventName
|
||||||
|
: _is2NdParamEventName(eventNameOrArgs)
|
||||||
|
? eventNameOrArgs
|
||||||
|
: '',
|
||||||
|
calledTo: Environment.BROWSER,
|
||||||
|
calledFrom: this.environment_,
|
||||||
|
knownError: undefined,
|
||||||
|
data: _is1StParamPlayer(playerOrEventName) ? args : eventNameOrArgs,
|
||||||
|
type: RPCEventType.EVENT,
|
||||||
|
}
|
||||||
|
|
||||||
|
const dataRaw = Utils.prepareTransfer(state)
|
||||||
|
|
||||||
|
switch (this.environment_) {
|
||||||
|
case Environment.BROWSER:
|
||||||
|
this.callSelf(state)
|
||||||
|
break
|
||||||
|
|
||||||
|
case Environment.CLIENT:
|
||||||
|
mp.events.callRemote(Events.LOCAL_EVENT_LISTENER, dataRaw)
|
||||||
|
break
|
||||||
|
|
||||||
|
case Environment.SERVER:
|
||||||
|
;(playerOrEventName as PlayerMp).call(
|
||||||
|
Events.LOCAL_EVENT_LISTENER,
|
||||||
|
[dataRaw],
|
||||||
|
)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
function _is1StParamPlayer(x: unknown): x is PlayerMp {
|
||||||
|
return typeof x === 'object'
|
||||||
|
}
|
||||||
|
|
||||||
|
function _is2NdParamEventName(x: unknown): x is string {
|
||||||
|
return typeof x === 'string'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calls an asynchronous browser-side event from client or server, expecting response. Use 'callAsync' to call browser from browser
|
||||||
|
*
|
||||||
|
* @template Arguments - An array of argument types to be passed to the browser event
|
||||||
|
* @template EventName - A string or union representing the browser event name
|
||||||
* @template Return - The type of the value returned by the browser event
|
* @template Return - The type of the value returned by the browser event
|
||||||
*
|
*
|
||||||
* @param {EventName} eventName - The name of the browser event to be called
|
* @param {EventName} eventName - The name of the browser event to be called
|
||||||
@@ -328,18 +615,18 @@ class Rpc extends Wrapper {
|
|||||||
* @returns {Promise<Return>} A promise resolving to the return value of the browser event
|
* @returns {Promise<Return>} A promise resolving to the return value of the browser event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* // Calls an event on browser without specifying a player
|
* // Calls an event on a browser without specifying a player
|
||||||
* callBrowser<[], string, object>('onDataRequest').then(response => {
|
* callBrowser<[], string, object>('onDataRequest').then(response => {
|
||||||
* console.log(`Received: ${response}`) // ^ object
|
* console.log(`Received: ${response}`) // ^ object
|
||||||
* })
|
* })
|
||||||
*/
|
*/
|
||||||
public async callBrowser<
|
public async callBrowserAsync<
|
||||||
Arguments extends unknown[] = unknown[],
|
Arguments extends unknown[] = unknown[],
|
||||||
EventName extends string = string,
|
EventName extends string = string,
|
||||||
Return = unknown,
|
Return = unknown,
|
||||||
>(eventName: EventName, args?: Arguments): Promise<Return>
|
>(eventName: EventName, args?: Arguments): Promise<Return>
|
||||||
/**
|
/**
|
||||||
* Calls a browser-side event from server or client
|
* Calls an asynchronous browser-side event from client or server, expecting response. Use 'callAsync' to call browser from browser
|
||||||
*
|
*
|
||||||
* @template Arguments - An array of argument types to be passed to the browser event
|
* @template Arguments - An array of argument types to be passed to the browser event
|
||||||
* @template EventName - A string representing the browser event name or union of names
|
* @template EventName - A string representing the browser event name or union of names
|
||||||
@@ -351,24 +638,24 @@ class Rpc extends Wrapper {
|
|||||||
* @returns {Promise<Return>} A promise resolving to the return value of the browser event
|
* @returns {Promise<Return>} A promise resolving to the return value of the browser event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* // Calls an event on a browser for a specific player
|
* // Calls an asynchronous event on a browser for a specific player
|
||||||
* callBrowser<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]).then(result => {
|
* callBrowser<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]).then(result => {
|
||||||
* console.log(`Action success: ${result}`) // ^ boolean
|
* console.log(`Action success: ${result}`) // ^ boolean
|
||||||
* })
|
* })
|
||||||
*/
|
*/
|
||||||
public async callBrowser<
|
public async callBrowserAsync<
|
||||||
Arguments extends unknown[] = unknown[],
|
Arguments extends unknown[] = unknown[],
|
||||||
EventName extends string = string,
|
EventName extends string = string,
|
||||||
Return = unknown,
|
Return = unknown,
|
||||||
>(player: PlayerMp, eventName: EventName, args?: Arguments): Promise<Return>
|
>(player: PlayerMp, eventName: EventName, args?: Arguments): Promise<Return>
|
||||||
public async callBrowser(
|
public async callBrowserAsync(
|
||||||
playerOrEventName: PlayerMp | string,
|
playerOrEventName: PlayerMp | string,
|
||||||
eventNameOrArgs?: string | unknown[],
|
eventNameOrArgs?: string | unknown[],
|
||||||
args?: unknown[],
|
args?: unknown[],
|
||||||
) {
|
) {
|
||||||
if (_is1StParamPlayer(playerOrEventName)) {
|
if (_is1StParamPlayer(playerOrEventName)) {
|
||||||
this.log(
|
this.log(
|
||||||
'DEV callClient',
|
'callBrowserAsync',
|
||||||
eventNameOrArgs as string,
|
eventNameOrArgs as string,
|
||||||
playerOrEventName,
|
playerOrEventName,
|
||||||
eventNameOrArgs,
|
eventNameOrArgs,
|
||||||
@@ -376,7 +663,7 @@ class Rpc extends Wrapper {
|
|||||||
)
|
)
|
||||||
} else {
|
} else {
|
||||||
this.log(
|
this.log(
|
||||||
'DEV callClient',
|
'callBrowserAsync',
|
||||||
playerOrEventName as string,
|
playerOrEventName as string,
|
||||||
eventNameOrArgs,
|
eventNameOrArgs,
|
||||||
)
|
)
|
||||||
@@ -417,7 +704,12 @@ class Rpc extends Wrapper {
|
|||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
|
||||||
return (await this.responseHandler(state.uuid)).data
|
return await this.responseHandler(state.uuid)
|
||||||
|
.then(r => r.data)
|
||||||
|
.catch((e: string) => {
|
||||||
|
state.knownError = e
|
||||||
|
return this.triggerError_(state)
|
||||||
|
})
|
||||||
|
|
||||||
function _is1StParamPlayer(x: unknown): x is PlayerMp {
|
function _is1StParamPlayer(x: unknown): x is PlayerMp {
|
||||||
return typeof x === 'object'
|
return typeof x === 'object'
|
||||||
@@ -432,7 +724,42 @@ class Rpc extends Wrapper {
|
|||||||
* Calls an event in current environment
|
* Calls an event in current environment
|
||||||
*
|
*
|
||||||
* @template Arguments - An array of argument types to be passed to the event
|
* @template Arguments - An array of argument types to be passed to the event
|
||||||
* @template EventName - A string representing the event name or union of names
|
* @template EventName - A string or union representing the event name
|
||||||
|
*
|
||||||
|
* @param {EventName} eventName - The name of the event to be called
|
||||||
|
* @param {Arguments} [args] - Optional arguments to pass to the event
|
||||||
|
* @returns {void}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Calls an event in current environment
|
||||||
|
* call<[], string>('getSomething')
|
||||||
|
*/
|
||||||
|
public call<
|
||||||
|
Arguments extends unknown[] = unknown[],
|
||||||
|
EventName extends string = string,
|
||||||
|
>(eventName: EventName, args?: Arguments): void {
|
||||||
|
this.log('call', eventName, args)
|
||||||
|
if (this.forceBrowserDevMode_) return
|
||||||
|
Utils.errorUnknownEnvironment(this.environment_)
|
||||||
|
|
||||||
|
const state: RPCState = {
|
||||||
|
uuid: Utils.generateUUID(),
|
||||||
|
eventName,
|
||||||
|
calledTo: this.environment_,
|
||||||
|
calledFrom: this.environment_,
|
||||||
|
knownError: undefined,
|
||||||
|
data: args,
|
||||||
|
type: RPCEventType.EVENT,
|
||||||
|
}
|
||||||
|
|
||||||
|
this.callSelf(state)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calls an asynchronous event in current environment, expecting a response
|
||||||
|
*
|
||||||
|
* @template Arguments - An array of argument types to be passed to the event
|
||||||
|
* @template EventName - A string or union representing the event name
|
||||||
* @template Return - The type of the value returned by the event
|
* @template Return - The type of the value returned by the event
|
||||||
*
|
*
|
||||||
* @param {EventName} eventName - The name of the event to be called
|
* @param {EventName} eventName - The name of the event to be called
|
||||||
@@ -445,12 +772,12 @@ class Rpc extends Wrapper {
|
|||||||
* console.log(`Received: ${response}`) // ^ number
|
* console.log(`Received: ${response}`) // ^ number
|
||||||
* })
|
* })
|
||||||
*/
|
*/
|
||||||
public async call<
|
public async callAsync<
|
||||||
Arguments extends unknown[] = unknown[],
|
Arguments extends unknown[] = unknown[],
|
||||||
EventName extends string = string,
|
EventName extends string = string,
|
||||||
Return = unknown,
|
Return = unknown,
|
||||||
>(eventName: EventName, args?: Arguments): Promise<Return> {
|
>(eventName: EventName, args?: Arguments): Promise<Return> {
|
||||||
this.log('call', eventName, args)
|
this.log('callAsync', eventName, args)
|
||||||
if (this.forceBrowserDevMode_)
|
if (this.forceBrowserDevMode_)
|
||||||
return undefined as unknown as Promise<Return>
|
return undefined as unknown as Promise<Return>
|
||||||
Utils.errorUnknownEnvironment(this.environment_)
|
Utils.errorUnknownEnvironment(this.environment_)
|
||||||
@@ -465,13 +792,27 @@ class Rpc extends Wrapper {
|
|||||||
type: RPCEventType.EVENT,
|
type: RPCEventType.EVENT,
|
||||||
}
|
}
|
||||||
|
|
||||||
return await this.callSelf<Return>(state)
|
return await this.callSelfAsync<Return>(state)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* redirects an event in cases of it calling its own environment
|
* redirects an event in cases of it calling its own environment
|
||||||
*/
|
*/
|
||||||
private async callSelf<Return = unknown>(state: RPCState): Promise<Return> {
|
private callSelf(state: RPCState): void {
|
||||||
|
state = this.verifyEvent_(state)
|
||||||
|
if (state.knownError) {
|
||||||
|
this.triggerError_(state, state.knownError)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.state_[state.eventName](...state.data)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* redirects an asynchronous event in cases of it calling its own environment
|
||||||
|
*/
|
||||||
|
private async callSelfAsync<Return = unknown>(
|
||||||
|
state: RPCState,
|
||||||
|
): Promise<Return> {
|
||||||
state = this.verifyEvent_(state)
|
state = this.verifyEvent_(state)
|
||||||
if (state.knownError) {
|
if (state.knownError) {
|
||||||
this.triggerError_(state, state.knownError)
|
this.triggerError_(state, state.knownError)
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ const { timestamp, printf, colorize } = format
|
|||||||
/** Used to log in a server console */
|
/** Used to log in a server console */
|
||||||
export class FW_Logger {
|
export class FW_Logger {
|
||||||
private format = printf(({ message, level }) => {
|
private format = printf(({ message, level }) => {
|
||||||
return `[${new Date().toLocaleTimeString()}] [${level}]: ${message}`
|
return `[${new Date().toLocaleTimeString(undefined, { hour: 'numeric', minute: 'numeric', second: 'numeric', fractionalSecondDigits: 2 })}] [${level}]: ${message}`
|
||||||
})
|
})
|
||||||
|
|
||||||
private systemLogger = winston.createLogger({
|
private systemLogger = winston.createLogger({
|
||||||
|
|||||||
@@ -4,13 +4,43 @@ import type * as T from '../types'
|
|||||||
/** Handles event manipulations that require player to be present in context */
|
/** Handles event manipulations that require player to be present in context */
|
||||||
export class FW_Player {
|
export class FW_Player {
|
||||||
/**
|
/**
|
||||||
* Triggers a client event from the server with arguments from shared types
|
* Triggers a client event from the server with arguments from 'rage-fw-shared-types'
|
||||||
*
|
*
|
||||||
* Formerly known as ``callClient`` or ``emitClient``
|
* Formerly known as ``callClient`` or ``emitClient``
|
||||||
*
|
*
|
||||||
* @param {PlayerMp} player - Player object as an event target
|
* @param {PlayerMp} player - Player object as an event target
|
||||||
* @param eventName - The name of the client event to trigger
|
* @param eventName - The name of the client event to trigger
|
||||||
* @param [args] - Arguments for the client event, if present
|
* @param [args] - Arguments for the client event, if present
|
||||||
|
* @returns {void}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Triggering a client event without arguments
|
||||||
|
* fw.player.triggerClient("clientEventName")
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Triggering a client event with arguments
|
||||||
|
* fw.player.triggerClient("clientEventName", ["message to client"])
|
||||||
|
*
|
||||||
|
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
||||||
|
*/
|
||||||
|
public triggerClient<EventName extends T.FW_ClientEvent>(
|
||||||
|
player: PlayerMp,
|
||||||
|
eventName: EventName,
|
||||||
|
...args: T._ClientEventHasArgs<EventName> extends true
|
||||||
|
? [T.FW_ClientArgs<EventName>]
|
||||||
|
: []
|
||||||
|
): void {
|
||||||
|
rpc.callClient<typeof args, EventName>(player, eventName, args)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggers an asynchronous client event from the server with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
|
||||||
|
*
|
||||||
|
* Formerly known as ``callClientAsync`` or ``emitClientAsync``
|
||||||
|
*
|
||||||
|
* @param {PlayerMp} player - Player object as an event target
|
||||||
|
* @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
|
* @returns {Promise} resolving to the client's response for the event
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
@@ -23,25 +53,29 @@ export class FW_Player {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
||||||
*/
|
*/
|
||||||
public async triggerClient<EventName extends T.FW_ClientEvent>(
|
public async triggerClientAsync<EventName extends T.FW_ClientEvent>(
|
||||||
player: PlayerMp,
|
player: PlayerMp,
|
||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
...args: T._ClientEventHasArgs<EventName> extends true
|
...args: T._ClientEventHasArgs<EventName> extends true
|
||||||
? [T.FW_ClientArgs<EventName>]
|
? [T.FW_ClientArgs<EventName>]
|
||||||
: []
|
: []
|
||||||
): Promise<T.FW_ClientReturn<EventName>> {
|
): Promise<T.FW_ClientReturn<EventName>> {
|
||||||
return await rpc.callClient(player, eventName, args)
|
return await rpc.callClientAsync<
|
||||||
|
typeof args,
|
||||||
|
EventName,
|
||||||
|
T.FW_ClientReturn<EventName>
|
||||||
|
>(player, eventName, args)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Triggers a browser event from the server with arguments from shared types
|
* Triggers a browser event from the server with arguments from 'rage-fw-shared-types'
|
||||||
*
|
*
|
||||||
* Formerly known as ``callBrowser`` or ``emitBrowser``
|
* Formerly known as ``callBrowser`` or ``emitBrowser``
|
||||||
*
|
*
|
||||||
* @param {PlayerMp} player - Player object as an event target
|
* @param {PlayerMp} player - Player object as an event target
|
||||||
* @param eventName - The name of the browser event to trigger
|
* @param eventName - The name of the browser event to trigger
|
||||||
* @param [args] - Arguments for the browser event, if present
|
* @param [args] - Arguments for the browser event, if present
|
||||||
* @returns {Promise} resolving to the browser's response for the event
|
* @returns {void}
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* // Triggering a browser event without arguments
|
* // Triggering a browser event without arguments
|
||||||
@@ -53,13 +87,47 @@ export class FW_Player {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
||||||
*/
|
*/
|
||||||
public async triggerBrowser<EventName extends T.FW_BrowserEvent>(
|
public triggerBrowser<EventName extends T.FW_BrowserEvent>(
|
||||||
|
player: PlayerMp,
|
||||||
|
eventName: EventName,
|
||||||
|
...args: T._BrowserEventHasArgs<EventName> extends true
|
||||||
|
? [T.FW_BrowserArgs<EventName>]
|
||||||
|
: []
|
||||||
|
): void {
|
||||||
|
rpc.callBrowser<typeof args, EventName>(player, eventName, args)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggers an asynchronous browser event from the server with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
|
||||||
|
*
|
||||||
|
* Formerly known as ``callBrowserAsync`` or ``emitBrowserAsync``
|
||||||
|
*
|
||||||
|
* @param {PlayerMp} player - Player object as an event target
|
||||||
|
* @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
|
||||||
|
* // Triggering a browser event without arguments
|
||||||
|
* fw.player.triggerBrowserAsync("browserEventName")
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Triggering a browser event with arguments
|
||||||
|
* fw.player.triggerBrowserAsync("browserEventName", ["message to browser"])
|
||||||
|
*
|
||||||
|
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
||||||
|
*/
|
||||||
|
public async triggerBrowserAsync<EventName extends T.FW_BrowserEvent>(
|
||||||
player: PlayerMp,
|
player: PlayerMp,
|
||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
...args: T._BrowserEventHasArgs<EventName> extends true
|
...args: T._BrowserEventHasArgs<EventName> extends true
|
||||||
? [T.FW_BrowserArgs<EventName>]
|
? [T.FW_BrowserArgs<EventName>]
|
||||||
: []
|
: []
|
||||||
): Promise<T.FW_BrowserReturn<EventName>> {
|
): Promise<T.FW_BrowserReturn<EventName>> {
|
||||||
return await rpc.callBrowser(player, eventName, args)
|
return await rpc.callBrowserAsync<
|
||||||
|
typeof args,
|
||||||
|
EventName,
|
||||||
|
T.FW_BrowserReturn<EventName>
|
||||||
|
>(player, eventName, args)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
export * from './browser'
|
export type * from './browser'
|
||||||
export * from './client'
|
export type * from './client'
|
||||||
export * from './middleware'
|
export type * from './middleware'
|
||||||
export * from './server'
|
export type * from './server'
|
||||||
|
|||||||
Reference in New Issue
Block a user