Class NetworkSettings

Network settings container.

Inheritance

ISerializable

SettingsBase

NetworkSettings

Inherited Members

SettingsBase::Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

ISerializable::DeserializeIfExists(DeserializeStream& stream, const char* memberName, ISerializeModifier* modifier)

NetworkSettings

SettingsBase::Serialize(SerializeStream& stream, const void* otherObj)

NetworkSettings

NetworkSettings

ISerializable::~ISerializable()

Assembly: FlaxEngine.dll

File: Engine/Networking/NetworkSettings.h

Syntax

public class NetworkSettings : public SettingsBase

Fields

Address

Address of the server (server/host always runs on localhost). Only IPv4 is supported.

Declaration

public String Address = TEXT("127.0.0.1")

Field Value

String

MaxClients

Maximum amount of active network clients in a game session. Used by server or host to limit amount of players and spectators.

Declaration

public int32 MaxClients = 100

Field Value

int32

NetworkDriver

The type of the network driver (implements INetworkDriver) that will be used to create, manage, send and receive messages over the network.

Declaration

public StringAnsi NetworkDriver = "FlaxEngine.Networking.ENetDriver"

Field Value

StringAnsi

NetworkFPS

The target amount of the network system updates per second. Higher values provide better network synchronization (eg. 60 for shooters), lower values reduce network usage and performance impact (eg. 30 for strategy games). Can be used to tweak networking performance impact on game. Cannot be higher that UpdateFPS (from Time Settings). Use 0 to run every game update.

Declaration

public float NetworkFPS = 60.0f

Field Value

float

Port

The port for the network peer.

Declaration

public uint16 Port = 7777

Field Value

uint16

ProtocolVersion

Network protocol version of the game. Network clients and server can use only the same protocol version (verified upon client joining).

Declaration

public uint32 ProtocolVersion = 1

Field Value

uint32

Methods

Apply()

Applies the settings to the target system.

Declaration

public virtual void Apply() override

Overrides

SettingsBase::Apply()

Get()

Gets the instance of the settings asset (default value if missing). Object returned by this method is always loaded with valid data to use.

Declaration

public static NetworkSettings* Get()

Returns

NetworkSettings