Photon Bolt Engine API  1.2.7
Public Member Functions | Public Attributes | Properties | Private Member Functions | List of all members
BoltConfig Class Reference

Bolt configuration settings object More...

Public Member Functions

 BoltConfig ()
 

Public Attributes

int clientDejitterDelay
 
int clientDejitterDelayMax
 
int clientDejitterDelayMin
 
int clientSendRate
 
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 connectionRequestAttempts = 20
 The max number of allowed connection attempts by a single client More...
 
int connectionRequestTimeout = 500
 
int connectionTimeout = 10000
 
bool disableAutoSceneLoading
 
bool disableDejitterBuffer
 Whether dejitter delay buffering is disabled or not More...
 
bool EnableIPv6
 
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 = 1280
 The UDP packet size in bytes More...
 
Bolt.ScopeMode scopeMode = Bolt.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
 
int serverDejitterDelayMax
 
int serverDejitterDelayMin
 
int serverSendRate
 
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]
 
internal int commandDejitterDelayMax [get]
 
internal int commandDejitterDelayMin [get]
 

Private Member Functions

internal BoltConfig Clone ()
 

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 Function Documentation

◆ Clone()

internal BoltConfig BoltConfig.Clone ( )
inlineprivate

Member Data Documentation

◆ clientDejitterDelay

int BoltConfig.clientDejitterDelay

◆ clientDejitterDelayMax

int BoltConfig.clientDejitterDelayMax

◆ clientDejitterDelayMin

int BoltConfig.clientDejitterDelayMin

◆ clientSendRate

int BoltConfig.clientSendRate

◆ 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

◆ disableAutoSceneLoading

bool BoltConfig.disableAutoSceneLoading

◆ disableDejitterBuffer

bool BoltConfig.disableDejitterBuffer

Whether dejitter delay buffering is disabled or not

◆ EnableIPv6

bool BoltConfig.EnableIPv6

◆ 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

Property Documentation

◆ commandDejitterDelay

int BoltConfig.commandDejitterDelay
getset

◆ commandDejitterDelayMax

internal int BoltConfig.commandDejitterDelayMax
getprivate

◆ commandDejitterDelayMin

internal int BoltConfig.commandDejitterDelayMin
getprivate