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