rage-fw-client

rilaxik 2024-06-14 19:37:26 +00:00
parent 68ee76e12d
commit 59efd542a2

@ -142,32 +142,74 @@ fw = {
Further documentation will describe the functions included in ``fw`` Further documentation will describe the functions included in ``fw``
### Client ### Client
Handles event manipulations that do not require player to be present in context
#### register #### register
Registers client event
```ts
fw.event.register('clientEventName', ([arg1, arg2]) => {
// your logic here
})
```
#### unregister #### unregister
Unregisters client event
```ts
fw.event.unregister('clientEventName')
```
### Player ### Player
Handles event manipulations that require player to be present in context
#### trigger #### trigger
Triggers registered client event with passed arguments. Formerly known as ``call`` or ``emit``
```ts
fw.player.trigger('clientEventName', ['arg1', 2])
```
#### triggerServer #### triggerServer
Triggers registered client event with passed arguments. Formerly known as ``callServer`` or ``emitServer``
```ts
fw.player.triggerServer('serverEventName', ['arg1', 2])
```
#### triggerBrowser #### triggerBrowser
Triggers registered CEF event with passed arguments. Formerly known as ``callBrowser`` or ``emitBrowser``
```ts
fw.player.triggerBrowser('cefEventName', ['arg1', 2])
```
### Browser ### Browser
#### registerBrowser #### registerBrowser
Used to assign a browser instance. Returns the same browser instance
```ts
fw.browser.registerBrowser(browserInstance)
```
### System ### System
Handles functions used to interact with system environment
#### Log #### Logger
Used to log in a client in-game console
##### info ##### info
Informational logs. Colored in white
```ts
fw.system.log.info('some information to be logged')
```
##### warn ##### warn
Warning logs. Colored in yellow
```ts
fw.system.log.info('warning message')
```
##### error ##### error
Error logs. Colored in red
```ts
fw.system.log.info('error message')
```
## CEF ## CEF
Package used on a frontend-side of your Rage:MP Server Package used on a frontend-side of your Rage:MP Server