NetworkServer: Difference between revisions
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
|parent=[[Instance:NetworkPeer]] | |parent=[[Instance:NetworkPeer]] | ||
|name=NetworkServer | |name=NetworkServer | ||
|removed=''Most features removed in 2017, yet still exists'' | |||
|creatable=No | |creatable=No | ||
|replicates=No | |replicates=No | ||
}} | }} | ||
NetworkServer is a Instance which stores every [[Instance:NetworkReplicator]] in the game and handles connecting to the server. | |||
== Methods == | |||
=== int GetClientCount() === | |||
Gets the number of clients connected to this NetworkServer. Removed in 2020-02-07 16:52 (v0.419.0.381237). | |||
=== void SetGameId(string newGameId) === | |||
Sets the Game ID? This function only existed for a week, and was likely a debug function. Added in 2014-02-19 23:47 (v0.138.0.43576), removed in 2014-02-26 23:37 (v0.139.0.43815). | |||
=== void Start(int port = 0, int threadSleepTime = 20) === | |||
Starts the NetworkServer. Removed in 2017-10-10 23:48 (v0.311.0.156626). | |||
=== void Stop(int blockDuration = 1000) === | |||
Stops the NetworkServer. Removed in 2017-10-03 23:40 (v0.310.0.154547). | |||
=== void SetIsPlayerAuthenticationRequired(bool value) === | |||
Sets if the NetworkServer requires new players to be authenticated with a client ticket. See [[Client authentication]]. | |||
== Properties == | |||
=== int Port === | |||
The current port that the NetworkServer is hosting on. Removed in 2020-06-19 18:13 (v0.438.0.407270). | |||
== Events == | |||
=== IncommingConnection(string peer, Instance replicator) === | |||
It is spelt 'Incomming'. This event is raised when a new client is connecting to the NetworkServer. | |||
Revision as of 20:45, 1 July 2023
 Instance NetworkServer | |
|---|---|
| Parent Instance | Instance:NetworkPeer |
| Introduced | Unknown Introduction |
| Removed | Most features removed in 2017, yet still exists |
| Replicates | No |
| Creatable | No |
NetworkServer is a Instance which stores every Instance:NetworkReplicator in the game and handles connecting to the server.
Methods
int GetClientCount()
Gets the number of clients connected to this NetworkServer. Removed in 2020-02-07 16:52 (v0.419.0.381237).
void SetGameId(string newGameId)
Sets the Game ID? This function only existed for a week, and was likely a debug function. Added in 2014-02-19 23:47 (v0.138.0.43576), removed in 2014-02-26 23:37 (v0.139.0.43815).
void Start(int port = 0, int threadSleepTime = 20)
Starts the NetworkServer. Removed in 2017-10-10 23:48 (v0.311.0.156626).
void Stop(int blockDuration = 1000)
Stops the NetworkServer. Removed in 2017-10-03 23:40 (v0.310.0.154547).
void SetIsPlayerAuthenticationRequired(bool value)
Sets if the NetworkServer requires new players to be authenticated with a client ticket. See Client authentication.
Properties
int Port
The current port that the NetworkServer is hosting on. Removed in 2020-06-19 18:13 (v0.438.0.407270).
Events
IncommingConnection(string peer, Instance replicator)
It is spelt 'Incomming'. This event is raised when a new client is connecting to the NetworkServer.