Api Sandbox NetworkingSettings
class

NetworkingSettings

public class NetworkingSettings : ConfigData

A class that holds all configured networking settings for a game. This is serialized as a config and shared from the server to the client.

Constructors

NetworkingSettings()

Properties

Name Type Description
DestroyLobbyWhenHostLeaves Boolean Whether to disband the game lobby when the host leaves.
AutoSwitchToBestHost Boolean Whether to periodically switch to the best host candidate. Candidates are scored based on their average ping and connection quality to all other peers.
ClientsCanSpawnObjects Boolean By default, can clients create objects. This can be changed per connection after join.
ClientsCanRefreshObjects Boolean By default, can clients refresh objects. This can be changed per connection after join.
ClientsCanDestroyObjects Boolean By default, can clients destroy objects. This can be changed per connection after join.
UpdateRate Single The frequency at which the network system will send updates to clients. Higher is better but you probably want to stay in the 10-60 range.
Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.NetworkingSettings