NetworkConfig Class |  |
[This is preliminary documentation and is subject to change.]
The configuration object used to start server, client and hosts
Inheritance HierarchyNamespace: MLAPI.Configuration
Assembly: MLAPI (in MLAPI.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe NetworkConfig type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | NetworkConfig | Initializes a new instance of the NetworkConfig class |
Methods| Name | Description | |
|---|---|---|
| CompareConfig |
Compares a SHA256 hash with the current NetworkingConfiguration instances hash
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| FromBase64 |
Sets the NetworkConfig data with that from a base64 encoded version
|
| GetConfig |
Gets a SHA256 hash of parts of the NetworkingConfiguration instance
|
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| ToBase64 |
Returns a base64 encoded version of the config
|
| ToString | (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | AttributeMessageMode |
Decides how many bytes to use for Attribute messaging. Leave this to 2 bytes unless you are facing hash collisions
|
| Channels |
Channels used by the NetworkedTransport
|
| ClientConnectionBufferTimeout |
The amount of seconds to wait for handshake to complete before timing out a client
|
| ConnectAddress |
The address to connect to
|
| ConnectionApproval |
Wheter or not to use connection approval
|
| ConnectionData |
The data to send during connection which can be used to decide on if a client should get accepted
|
| ConnectPort |
The port for the NetworkTransport to use when connecting
|
| EnableEncryption |
Wheter or not to enable encryption
|
| EnableSceneSwitching |
Wheter or not to enable scene switching
|
| EnableTimeResync |
If your logic uses the NetwokrTime, this should probably be turned off. If however it's needed to maximize accuracy, this is recommended to be turned on
|
| EventTickrate |
The amount of times per second internal frame events will occur, examples include SyncedVar send checking.
|
| HandleObjectSpawning |
Wheter or not to make the library handle object spawning
|
| MaxConnections |
The max amount of Clients that can connect.
|
| MaxReceiveEventsPerTickRate |
The max amount of messages to process per ReceiveTickrate. This is to prevent flooding.
|
| MessageBufferSize |
The size of the receive message buffer. This is the max message size.
|
| NetworkedPrefabs |
A list of spawnable prefabs
|
| NetworkTransport |
The transport hosts the sever uses
|
| ProtocolVersion |
The protocol version. Different versions doesn't talk to each other.
|
| ReceiveTickrate |
Amount of times per second the receive queue is emptied and all messages inside are processed.
|
| RegisteredScenes |
A list of SceneNames that can be used during networked games.
|
| RelayAddress |
Only used if the transport is MLPAI-Relay
|
| RelayEnabled |
Wheter or not to use the relay
|
| RelayPort |
Only used if the transport is MLPAI-Relay
|
| RSAPrivateKey |
Private RSA XML key to use for signing key exchange
|
| RSAPublicKey |
Public RSA XML key to use for signing key exchange
|
| SecondsHistory |
The amount of seconds to keep a lag compensation position history
|
| SendTickrate |
The amount of times per second every pending message will be sent away.
|
| SignKeyExchange |
Wheter or not to enable signed diffie hellman key exchange.
|
| Transport |
The transport to be used
|
See Also