Anders: Created page with "{{:ClientExampleCode}} ==Functions== {| class="wikitable" !|return !|function !|description |- |bool |isConnected() |returns true if connected to a server |- |bool |isLosingConnection() |returns true if no new messages has been received for the pas 2.5s. |- |bool |isAdmin() |returns true if admin of the server |- | |connect(string address) |Tries to connect t..."

2025-07-05T14:21:44Z

Created page with "{{:ClientExampleCode}} ==Functions== {| class="wikitable" !|return !|function !|description |- |bool |isConnected() |returns true if connected to a server |- |bool |isLosingConnection() |returns true if no new messages has been received for the pas 2.5s. |- |bool |isAdmin() |returns true if admin of the server |- | |connect(string address) |Tries to connect t..."

New page

{{:ClientExampleCode}}

==Functions==
{| class="wikitable"
!|return
!|function
!|description
|-
|bool
|[[Client:isConnected()|isConnected]]()
|returns true if connected to a server
|-
|bool
|[[Client:isLosingConnection()|isLosingConnection]]()
|returns true if no new messages has been received for the pas 2.5s.
|-
|bool
|[[Client:isAdmin()|isAdmin]]()
|returns true if admin of the server
|-
|
|[[Client:connect(string address)|connect]](string address)
|Tries to connect to to the address. address can be like "localhost","192.168.1.2". The connection attemps will be done in a seperate thread
|-
|
|[[Client:disconnect()|disconnect]]()
|Disconnects from the server
|-
|{ {ping=int(), clientId=int(),
playerId=int(), name=string()} }
|[[Client:getConnected()|getConnected]]()
|returns a table with all that is connected like {[1]="client1", [2]="client2"}
|-
|[[string]]
|[[Client:getWhyNotConnected()|getWhyNotConnected]]()
|returns a [[string]] with the reason why the client is not connected anymore.
|-
|[[string]]
|[[Client:getUserName()|getUserName]]()
|Returns the name for this client, is also what will be shown to other players
|-
|int
|[[Client:getPlayerId()|getPlayerId]]()
|Returns the player id for the client. Is used for who owns what in multiplayer, this id can be changed.
|-
|int
|[[Client:getClientId()|getClientId]]()
|Returns a constant id that the server is using to identify you.
|-
|bool
|[[Client:isPlayerIdInUse(int id)|isPlayerIdInUse]](int id)
|Returns true if the player id is in use
|-
|int
|[[Client:getConnectedPlayerCount()|getConnectedPlayerCount]]()
|Returns the numbers of players.
|-
|double
|[[Client:getPing()|getPing]]()
|Returns the RTT.
|-
|
|[[Client:setUserName(string userName)|setUserName]](string userName)
|Sets the username and inform the server.
|-
|
|[[Client:requestPlayerId(int playerId)|requestPlayerId]](int playerId)
|Sends a request to the server for a playerId.
|-
|bool
|[[Client:hasConnectedUsersChanged()|hasConnectedUsersChanged]]()
|returns true if somone has connected to the server or disconnected
|-
|bool
|[[Client:hasMessage()|hasMessage]]()
|returns true if there is a message in the queue to be popped
|-
|[[string]]
|[[Client:popMessage()|popMessage]]()
|Returns the message in queue. or "" if none is available
|-
|
|[[Client:write(string msg)|write]](string msg)
|Write a message to all other connected clients. Delivery is not guaranteed
|-
|
|[[Client:writeSafe(string msg)|writeSafe]](string msg)
|Write a message to all other connected clients. Message is guaranteed to be delivered but not in order
|-
|
|[[Client:sendFile(int toClientId, string file)|sendFile]](int toClientId, string file)
|sends a file to a client
|-
|{string()}
|[[Client:getDowloadedFiles()|getDowloadedFiles]]()
|return a list of all downloaded files to there local file path. the file list is cleared after each call.
|-
|number
|[[Client:getDownloadPercentage()|getDownloadPercentage]]()
|return the download percentage status, is the average of all downloads.
|-
|number
|[[Client:getSendingPercentage()|getSendingPercentage]]()
|return the upload percentage status, is the average of all uploads.
|-
|bool
|[[Client:isDownloadingFiles()|isDownloadingFiles]]()
|return true if we are downloading any file
|-
|bool
|[[Client:isSendingFiles()|isSendingFiles]]()
|return true if we are uploading any file
|-
|}

Client - Revision history