Page:
ModuleServerAPIClient
Pages
Config
ContactDetails
GetiyoModuleTool
Home
ModuleAPIGameLibEndScreen
ModuleAPIGameLibRatio
ModuleApiGameLibFrameCycle
ModuleApiGameLibGameDetails
ModuleApiGameLibRuntimeStorage
ModuleApiGameLibTimeSpan
ModuleClientAPI
ModuleClientAPIFeedback
ModuleClientAPIGameLib
ModuleClientAPIGameLibController
ModuleClientAPIIntroduction
ModuleClientAPINeighbor
ModuleClientAPINeighborResults
ModuleClientAPIPrincipals
ModuleClientAPIProperty
ModuleClientAPIUser
ModuleConfigCondition
ModuleConfigProperty
ModuleConfigTrigger
ModuleDebugging
ModuleDevelopmentIntroduction
ModuleEnvironment
ModuleJSON
ModuleServerAPI
ModuleServerAPIClient
ModuleServerAPIData
ModuleServerAPIDatabase
ModuleServerAPIGameLib
ModuleServerAPIGameLibCollisionSpace
ModuleServerAPIGameLibGame
ModuleServerAPIGameLibGamePlayer
ModuleServerAPIGameLibIntroduction
ModuleServerAPIGameLibRoom
ModuleServerAPIGameLibScoreboard
ModuleServerAPIGameLibScoreboardDetails
ModuleServerAPIGameLibScoreboardState
ModuleServerAPIIntroduction
ModuleServerAPILibs
ModuleServerAPILibsWebSocketLib
ModuleServerAPILibsWebSocketLibClient
ModuleServerAPIPrincipals
ModuleServerAPIProperty
ModuleStore
ModuleTS
Prerequisites
Reporting
ServerSetup
V1ModuleStructure
V2ModuleStructure
WebSocketLibCommuncationStandard
Clone
2
ModuleServerAPIClient
Mees van der Wijk edited this page 2025-08-09 16:33:38 +02:00
Table of Contents
ModuleServerApi - Client
Class representing the ModuleServerApi Client.
Functions
send
Send a message to the client.
client.send(header, ...args);
| Argument | Type | Description |
|---|---|---|
| header | string | The header of the message. |
| args | any[] | Data of any type |
isAuthorized
Check if the client is authorized, meaning they are logged in and have access to the channel.
client.isAuthorized();
*Returns boolean Client is authorized
getSceneID
Get the scene id the client is in.
client.getSceneID();
*Returns string Scene ID
getDisplayID
Get the display id the client is in.
client.getDisplayID();
*Returns string Display ID
getClientID
Get the client id.
client.getClientID();
*Returns string Client ID
Getting Started
Module Development
- Introduction
- V2 Module Structure
- V1 Module Structure
- Development environment/Building
- Module Config
- Module Debugging
- GetiyoModuleTool
- Bug/Feature Reporting
- Contact Details
ModuleServerAPI
ModuleServerAPI GameLib
ModuleClientAPI
ModuleApi Shared
© Vix Entertainment 2023 - © Mooren Productief 2023 - All rights reserved