Client

Here's a description of all registered client network events.

user_creation_response

Is triggered by the server when recieving a response from the user creation. It will include the list of user's processes that is rendered by calling CreateEmoteCreatorMenu(processes)

qr_code_response

Is triggered by the server when receiving a response after a requestQRCode event. It will include the PWA url that is rendered by calling CreateQRCodeAlert(url)

qr_code_error

Is triggered by the server when recieving a response after a requestQRCode event. It can be triggered either by a non 200 call on the server, or a custom paywall implementation. It will include the error message that is rendered by calling CreateErrorMenu(statusCode)

process_update

Is triggered by the server when receiving a response from the webhook url by the Kinetix infrastructure. I will include the webhook payload. It will call the functions NotifyProcessUpdate(data)

emote_ready

Is triggered by the server when an emote has been downloaded on the server. It will trigger the server event requestAvailableEmotes in order to refresh the user bag. It will then load anim dict in memory with the function RequestAnimDict . This event is generally broadcasted so that the new emote is visible to every connected player.

new_cached_emote

Is triggered by the server when a new emote have been downloaded on the server. The server does a RegisterResourceAsset, store the cache string and trigger this client event in order for the client to RegisterStreamingFileFromCache.

new_cached_emotes

Is triggered by the server when the client requests the app's configuration (during connection). It will send all the stored cache strings the the client and process it like in the new_cached_emote event.

emote_ready_notify

Is triggered by the server when an emote has been downloaded on the server. It will be rendered by the function NotifyEmoteReady. It is generally sent only to 'source' player to avoid spamming other players.

emotes_response

Is triggered by the server when receiving the list of available emotes for a user (user bag). It will include the API response and is rendered by calling the functions CreateEmoteWheel(data) and CreateEmoteBagMenu(data)

reopen_bag

Is triggered by the server when receiving a successful response from a renameEmote or deleteEmote trigger. It is used to refresh the user bag list with the function OpenEmoteBagMenu()

config

Is triggered by the server when receiving a response from a requestConfiguration event. It will parse the json response into a shared object through the exported getConfiguration function.

emote_preview

Is triggered by the server when receiving a response from a requestEmotePreview event. It will include the API response and be rendered with the function CreateProcessValidationMenu(data)

retake_process

Is triggered by the server when receiving a response from a requestRetake event. It will decode the json response and render the QR code with the function CreateQRCodeAlert(url) just like the qr_code_response event.

Last updated