Skip to content

NetworkClient

Supported Class Services NotCreatable NotReplicated Service

A service that manages a network connection's properties server.

Description

This service is responsible for connecting a client to a server.

Inheritance

Object → Instance → NetworkPeer → NetworkClient

Nova inheritance: Instance → NetworkPeer → NetworkClient

Properties

Ticket Supported Property
Ticket: string

No description available.

Roblox documentation

Methods

Disconnect Supported Function
NetworkClient:Disconnect(int blockDuration = 3000)

No description available.

Security: LocalUserSecurity

Roblox documentation

PlayerConnect Supported Function
NetworkClient:PlayerConnect(int userId, string server, int serverPort, int clientPort = 0, int threadSleepTime = 30): Instance

No description available.

Security: PluginSecurity

Roblox documentation

SetGameSessionID Supported Function
NetworkClient:SetGameSessionID(string gameSessionID)

No description available.

Security: RobloxSecurity

Roblox documentation

Events

ConnectionAccepted Supported Event Fired when the client successfully connects to a server. Returns a string showing the server's IP and port, and the client's ClientReplicator.
ConnectionAccepted(string peer, Instance replicator)

Fired when the client successfully connects to a server. Returns a string showing the server's IP and Port, and the client's ClientReplicator.

Roblox reference signature
ConnectionAccepted(peer: string, replicator: Instance)

Roblox documentation

ConnectionFailed Supported Event Fired if the client fails to connect to the server.
ConnectionFailed(string peer, int code, string reason)

Fired if the client fails to connect to the server.

Roblox reference signature
ConnectionFailed(peer: string, code: int)

Roblox documentation

ConnectionRejected Supported Event
ConnectionRejected(string peer)

No description available.

Roblox documentation

Inherited members

Inherited from NetworkPeer: 8 properties, 37 methods, 7 events. They are documented on the base class page.

Roblox reference: NetworkClient

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.