Netick.Network Class Reference
Inheritance diagram for Netick.Network:

Classes

struct  Sandboxs
 

Static Public Member Functions

static void Init (NetworkTransport transport=null, NetickConfig config=null)
 
static void Shutdown ()
 
static void Focus (NetworkSandbox sandbox)
 
static Sandboxs StartAsServerAndClient (int serverPort, GameObject prefab=null, int numOfClients=1, bool interpolateOnServer=true)
 
static NetworkSandbox StartAsClient (int port, GameObject prefab=null)
 
static NetworkSandbox StartAsServer (int port, GameObject prefab=null, bool interpolate=true)
 

Properties

StartMode StartMode [get, set]
 
static bool Running [get]
 
static string Version [get]
 
static bool IsHeadless [get]
 
static Network Instance [get]
 

Member Function Documentation

◆ Focus()

static void Netick.Network.Focus ( NetworkSandbox  sandbox)
static

Focus on a specific sandbox.

Parameters
sandboxThe sandbox to focus on.

◆ Init()

static void Netick.Network.Init ( NetworkTransport  transport = null,
NetickConfig  config = null 
)
static

Initialize Netick. This is automatically called when you start Netick.

If you don't provide a NetickConfig, Netick will use the default config, which can be modified/found in (Netick -> Settings).

If you don't provide a NetworkTransport, Netick will use the transport assigned in (Netick -> Settings -> Transport).

Parameters
transport

◆ Shutdown()

static void Netick.Network.Shutdown ( )
static

Shuts down Netick and destroys all sandboxes.

◆ StartAsClient()

static NetworkSandbox Netick.Network.StartAsClient ( int  port,
GameObject  prefab = null 
)
static

Starts Netick as a client.

Returns
The sandbox representing the client

◆ StartAsServer()

static NetworkSandbox Netick.Network.StartAsServer ( int  port,
GameObject  prefab = null,
bool  interpolate = true 
)
static

Starts Netick as a server.

Parameters
portNetwork port.
interpolateEnable interpolation.
Returns
The sandbox representing the server

◆ StartAsServerAndClient()

static Sandboxs Netick.Network.StartAsServerAndClient ( int  serverPort,
GameObject  prefab = null,
int  numOfClients = 1,
bool  interpolateOnServer = true 
)
static

Starts both a client (or clients) and a server.

Parameters
serverPortNetwork port.
numOfClientsNumber of client sandboxs to create.
interpolateOnServerEnable interpolation.
Returns

Property Documentation

◆ Instance

Network Netick.Network.Instance
staticget

◆ IsHeadless

bool Netick.Network.IsHeadless
staticget

◆ Running

bool Netick.Network.Running
staticget

◆ StartMode

StartMode Netick.Network.StartMode
getset

◆ Version

string Netick.Network.Version
staticget