Photon Bolt Engine API
Networking Middleware
Public Member Functions | Public Attributes | List of all members
BoltConfig Class Reference

Bolt configuration settings object More...

Public Member Functions

 BoltConfig ()
 

Public Attributes

int framesPerSecond = 60
 The number of fixed updates to the simulation per second More...
 
int packetSize = 1280
 The UDP packet size in bytes More...
 
int packetMaxEventSize = 512
 The max data payload size of a packet 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...
 
Bolt.ScopeMode scopeMode = Bolt.ScopeMode.Automatic
 Whether to scope connections manually or automatically More...
 
BoltConfigLogTargets logTargets = BoltConfigLogTargets.Console | BoltConfigLogTargets.Unity
 The output targets to write log messages More...
 
bool disableDejitterBuffer
 Whether dejitter delay buffering is disabled or not More...
 
int clientSendRate
 
int clientDejitterDelay
 
int clientDejitterDelayMin
 
int clientDejitterDelayMax
 
int serverSendRate
 
int serverDejitterDelay
 
int serverDejitterDelayMin
 
int serverDejitterDelayMax
 
int serverConnectionLimit
 The max number of server connections More...
 
BoltConnectionAcceptMode serverConnectionAcceptMode = BoltConnectionAcceptMode.Auto
 Whether to use automatic or manual mode for accepting incoming client connection requests More...
 
int commandDejitterDelay
 
int commandQueueSize
 The max number of input commands that can be queued at once More...
 
int commandDelayAllowed
 
int commandRedundancy
 The number of times to redundantly send input commands to the server More...
 
float commandPingMultiplier
 
bool useNetworkSimulation = true
 Whether to use network latency simulation More...
 
float simulatedLoss
 The packet loss rate to use in latency simulation More...
 
int simulatedPingMean
 The mean ping in milliseconds to use in latency simulation More...
 
int simulatedPingJitter
 The deviation to use in ping simulation More...
 
BoltRandomFunction simulatedRandomFunction = BoltRandomFunction.PerlinNoise
 Whether to use Perlin Noise or System.Random function to create ping deviations More...
 
int connectionTimeout = 10000
 
int connectionRequestTimeout = 500
 
int connectionRequestAttempts = 20
 The max number of allowed connection attempts by a single client 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).

static void Initialize(BoltNetworkModes modes, UdpEndPoint endpoint, BoltConfig config) {
BoltNetworkInternal.__Initialize(modes, endpoint, config, CreateUdpPlatform());

Constructor & Destructor Documentation

◆ BoltConfig()

BoltConfig.BoltConfig ( )
inline

Member Data Documentation

◆ clientDejitterDelay

int BoltConfig.clientDejitterDelay

◆ clientDejitterDelayMax

int BoltConfig.clientDejitterDelayMax

◆ clientDejitterDelayMin

int BoltConfig.clientDejitterDelayMin

◆ clientSendRate

int BoltConfig.clientSendRate

◆ commandDejitterDelay

int BoltConfig.commandDejitterDelay

◆ commandDelayAllowed

int BoltConfig.commandDelayAllowed

◆ commandPingMultiplier

float BoltConfig.commandPingMultiplier

◆ commandQueueSize

int BoltConfig.commandQueueSize

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

◆ commandRedundancy

int BoltConfig.commandRedundancy

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

◆ connectionRequestAttempts

int BoltConfig.connectionRequestAttempts = 20

The max number of allowed connection attempts by a single client

◆ connectionRequestTimeout

int BoltConfig.connectionRequestTimeout = 500

◆ connectionTimeout

int BoltConfig.connectionTimeout = 10000

◆ disableDejitterBuffer

bool BoltConfig.disableDejitterBuffer

Whether dejitter delay buffering is disabled or not

◆ framesPerSecond

int BoltConfig.framesPerSecond = 60

The number of fixed updates to the simulation per second

◆ logTargets

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

The output targets to write log messages

◆ maxEntityPriority

int BoltConfig.maxEntityPriority = 1 << 16

The max priority value for updating an entity

◆ maxPropertyPriority

int BoltConfig.maxPropertyPriority = 1 << 11

The max priority value for updating a property

◆ packetMaxEventSize

int BoltConfig.packetMaxEventSize = 512

The max data payload size of a packet

◆ packetSize

int BoltConfig.packetSize = 1280

The UDP packet size in bytes

◆ scopeMode

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

Whether to scope connections manually or automatically

◆ serverConnectionAcceptMode

BoltConnectionAcceptMode BoltConfig.serverConnectionAcceptMode = BoltConnectionAcceptMode.Auto

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

◆ serverConnectionLimit

int BoltConfig.serverConnectionLimit

The max number of server connections

◆ serverDejitterDelay

int BoltConfig.serverDejitterDelay

◆ serverDejitterDelayMax

int BoltConfig.serverDejitterDelayMax

◆ serverDejitterDelayMin

int BoltConfig.serverDejitterDelayMin

◆ serverSendRate

int BoltConfig.serverSendRate

◆ simulatedLoss

float BoltConfig.simulatedLoss

The packet loss rate to use in latency simulation

◆ simulatedPingJitter

int BoltConfig.simulatedPingJitter

The deviation to use in ping simulation

◆ simulatedPingMean

int BoltConfig.simulatedPingMean

The mean ping in milliseconds to use in latency simulation

◆ simulatedRandomFunction

BoltRandomFunction BoltConfig.simulatedRandomFunction = BoltRandomFunction.PerlinNoise

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

◆ useNetworkSimulation

bool BoltConfig.useNetworkSimulation = true

Whether to use network latency simulation