Photon Bolt Engine API 1.3

Public Member Functions | Public Attributes | Properties | List of all members
Photon.Bolt.BoltConfig Class Reference

Bolt configuration settings object More...

Public Member Functions

 BoltConfig ()
 

Public Attributes

int clientDejitterDelay
 Interpolation delay on client More...
 
int clientDejitterDelayMax
 Max interpolation delay on client More...
 
int clientDejitterDelayMin
 Min interpolation delay on client More...
 
int clientSendRate
 Client Update Send Rate. Default is every 3 frames More...
 
float commandPingMultiplier
 
int commandQueueSize
 The max number of input commands that can be queued at once. More...
 
int commandRedundancy
 The number of times to redundantly send input commands to the server. More...
 
int connectionLocalRequestAttempts = 5
 The max number of allowed connection attempts by a single client to LAN EndPoint of a Server. This value is used to limit the number of direct connection tries before the connection fails. More...
 
int connectionRequestAttempts = 20
 The max number of allowed connection attempts by a single client. This value is used to limit the number of direct connection tries before the connection fails. More...
 
int connectionRequestTimeout = 500
 The timeout until a new connect request will be performed. More...
 
int connectionTimeout = 10000
 Amount of time in milliseconds that the connection will be maintained before being closed by lack of response. More...
 
bool disableAutoSceneLoading
 Disables the automatic scene loading controlled by Bolt. By setting this value to True, you need to manage the scene synchronization between server and clients manually. More...
 
bool disableDejitterBuffer
 Whether dejitter delay buffering is disabled or not More...
 
bool EnableIPv6
 Enable IPv6 Support. Bolt will use IPv6 addresses on the client and server. More...
 
int framesPerSecond = 60
 The number of fixed updates to the simulation per second More...
 
BoltConfigLogTargets logTargets = BoltConfigLogTargets.Console | BoltConfigLogTargets.Unity
 The output targets to write log messages More...
 
int maxEntityPriority = 1 << 16
 The max priority value for updating an entity More...
 
int maxPropertyPriority = 1 << 11
 The max priority value for updating a property More...
 
int packetMaxEventSize = 512
 The max data payload size of a packet More...
 
int packetSize = 1200
 The UDP packet size in bytes More...
 
int packetStreamSize = 4096
 The Stream UDP Packet Size in Byte More...
 
ScopeMode scopeMode = ScopeMode.Automatic
 Whether to scope connections manually or automatically More...
 
BoltConnectionAcceptMode serverConnectionAcceptMode = BoltConnectionAcceptMode.Auto
 Whether to use automatic or manual mode for accepting incoming client connection requests More...
 
int serverConnectionLimit
 The max number of server connections More...
 
int serverDejitterDelay
 Interpolation delay on server More...
 
int serverDejitterDelayMax
 Max interpolation delay on server More...
 
int serverDejitterDelayMin
 Min interpolation delay on server More...
 
int serverSendRate
 Server Update Send Rate. More...
 
float simulatedLoss
 The packet loss rate to use in latency simulation. More...
 
int simulatedPingJitter
 The deviation to use in ping simulation. More...
 
int simulatedPingMean
 The mean ping in milliseconds to use in latency simulation. More...
 
BoltRandomFunction simulatedRandomFunction = BoltRandomFunction.PerlinNoise
 Whether to use Perlin Noise or System.Random function to create ping deviations. More...
 
bool useNetworkSimulation = true
 Whether to use network latency simulation. More...
 

Properties

int commandDejitterDelay [get, set]
 Minimum number of command left in the internal buffer in order to dejitter command base behavior More...
 

Detailed Description

Bolt configuration settings object

Example: Starting a bolt server simulation internally requires a config parameter (there is a bit more to it not shown here).

TODO

Constructor & Destructor Documentation

◆ BoltConfig()

Photon.Bolt.BoltConfig.BoltConfig ( )
inline

Member Data Documentation

◆ clientDejitterDelay

int Photon.Bolt.BoltConfig.clientDejitterDelay

Interpolation delay on client

◆ clientDejitterDelayMax

int Photon.Bolt.BoltConfig.clientDejitterDelayMax

Max interpolation delay on client

◆ clientDejitterDelayMin

int Photon.Bolt.BoltConfig.clientDejitterDelayMin

Min interpolation delay on client

◆ clientSendRate

int Photon.Bolt.BoltConfig.clientSendRate

Client Update Send Rate. Default is every 3 frames

◆ commandPingMultiplier

float Photon.Bolt.BoltConfig.commandPingMultiplier

◆ commandQueueSize

int Photon.Bolt.BoltConfig.commandQueueSize

The max number of input commands that can be queued at once.

◆ commandRedundancy

int Photon.Bolt.BoltConfig.commandRedundancy

The number of times to redundantly send input commands to the server.

◆ connectionLocalRequestAttempts

int Photon.Bolt.BoltConfig.connectionLocalRequestAttempts = 5

The max number of allowed connection attempts by a single client to LAN EndPoint of a Server. This value is used to limit the number of direct connection tries before the connection fails.

◆ connectionRequestAttempts

int Photon.Bolt.BoltConfig.connectionRequestAttempts = 20

The max number of allowed connection attempts by a single client. This value is used to limit the number of direct connection tries before the connection fails.

◆ connectionRequestTimeout

int Photon.Bolt.BoltConfig.connectionRequestTimeout = 500

The timeout until a new connect request will be performed.

◆ connectionTimeout

int Photon.Bolt.BoltConfig.connectionTimeout = 10000

Amount of time in milliseconds that the connection will be maintained before being closed by lack of response.

◆ disableAutoSceneLoading

bool Photon.Bolt.BoltConfig.disableAutoSceneLoading

Disables the automatic scene loading controlled by Bolt. By setting this value to True, you need to manage the scene synchronization between server and clients manually.

◆ disableDejitterBuffer

bool Photon.Bolt.BoltConfig.disableDejitterBuffer

Whether dejitter delay buffering is disabled or not

◆ EnableIPv6

bool Photon.Bolt.BoltConfig.EnableIPv6

Enable IPv6 Support. Bolt will use IPv6 addresses on the client and server.

◆ framesPerSecond

int Photon.Bolt.BoltConfig.framesPerSecond = 60

The number of fixed updates to the simulation per second

◆ logTargets

BoltConfigLogTargets Photon.Bolt.BoltConfig.logTargets = BoltConfigLogTargets.Console | BoltConfigLogTargets.Unity

The output targets to write log messages

◆ maxEntityPriority

int Photon.Bolt.BoltConfig.maxEntityPriority = 1 << 16

The max priority value for updating an entity

◆ maxPropertyPriority

int Photon.Bolt.BoltConfig.maxPropertyPriority = 1 << 11

The max priority value for updating a property

◆ packetMaxEventSize

int Photon.Bolt.BoltConfig.packetMaxEventSize = 512

The max data payload size of a packet

◆ packetSize

int Photon.Bolt.BoltConfig.packetSize = 1200

The UDP packet size in bytes

◆ packetStreamSize

int Photon.Bolt.BoltConfig.packetStreamSize = 4096

The Stream UDP Packet Size in Byte

◆ scopeMode

ScopeMode Photon.Bolt.BoltConfig.scopeMode = ScopeMode.Automatic

Whether to scope connections manually or automatically

◆ serverConnectionAcceptMode

BoltConnectionAcceptMode Photon.Bolt.BoltConfig.serverConnectionAcceptMode = BoltConnectionAcceptMode.Auto

Whether to use automatic or manual mode for accepting incoming client connection requests

◆ serverConnectionLimit

int Photon.Bolt.BoltConfig.serverConnectionLimit

The max number of server connections

◆ serverDejitterDelay

int Photon.Bolt.BoltConfig.serverDejitterDelay

Interpolation delay on server

◆ serverDejitterDelayMax

int Photon.Bolt.BoltConfig.serverDejitterDelayMax

Max interpolation delay on server

◆ serverDejitterDelayMin

int Photon.Bolt.BoltConfig.serverDejitterDelayMin

Min interpolation delay on server

◆ serverSendRate

int Photon.Bolt.BoltConfig.serverSendRate

Server Update Send Rate.

◆ simulatedLoss

float Photon.Bolt.BoltConfig.simulatedLoss

The packet loss rate to use in latency simulation.

◆ simulatedPingJitter

int Photon.Bolt.BoltConfig.simulatedPingJitter

The deviation to use in ping simulation.

◆ simulatedPingMean

int Photon.Bolt.BoltConfig.simulatedPingMean

The mean ping in milliseconds to use in latency simulation.

◆ simulatedRandomFunction

BoltRandomFunction Photon.Bolt.BoltConfig.simulatedRandomFunction = BoltRandomFunction.PerlinNoise

Whether to use Perlin Noise or System.Random function to create ping deviations.

◆ useNetworkSimulation

bool Photon.Bolt.BoltConfig.useNetworkSimulation = true

Whether to use network latency simulation.

Property Documentation

◆ commandDejitterDelay

int Photon.Bolt.BoltConfig.commandDejitterDelay
getset

Minimum number of command left in the internal buffer in order to dejitter command base behavior