Class ServerUtils

Hierarchy

ServerUtils

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ServerUtils(settings?: Partial<ServerUtilSettings>): ServerUtils

- Defined in server/sv_utils.d.ts:5
Parameters
- Optional settings: Partial<ServerUtilSettings>
Returns ServerUtils

Properties

Private Readonly _utilSettings

_utilSettings: any

Private debugLog

debugLog: any

Private uidCounter

uidCounter: any

Methods

callClientRPC

callClientRPC<T>(eventName: string, src: string | number, data?: unknown): Promise<T>

- Defined in server/sv_utils.d.ts:23
For calling RPC events registered on the client. RPC events will trigger on the client and return client data which is dependent on the logic of the RPC callback.

Type parameters
- T = any
  
  The return data type of the RPC callback
Parameters
- eventName: string
  
  The RPC name to call
- src: string | number
  
  The source of the player to call the RPC event on
- Optional data: unknown
  
  Optional data to pass to the client through the RPC callback
Returns Promise<T>

onNetPromise

onNetPromise<T, P>(eventName: string, callback: NetPromiseCallback<T, P>): void

- Defined in server/sv_utils.d.ts:14
The method used whenever handling a promisified event sent by the Client Utils instance

Type parameters
- T = any
  
  Request data type
- P = any
  
  Response data type
Parameters
- eventName: string
  
  The event name to listen for
- callback: NetPromiseCallback<T, P>
  
  A callback function which provides the request and response data to the caller
Returns void

Generated using TypeDoc