newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference
Api
Classes
NetworkingSettings
chevron_left Classes
class
NetworkingSettings

Constructors

functionsNetworkingSettings

Properties

data_objectAutoSwitchToBestHostdata_objectClientsCanDestroyObjectsdata_objectClientsCanRefreshObjectsdata_objectClientsCanSpawnObjectsdata_objectDestroyLobbyWhenHostLeavesdata_objectUpdateRate
menu
NetworkingSettings
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.
class Sandbox .account_tree extends ConfigData
Sandbox.Engine

build Constructors 1

NetworkingSettings ()

data_object Properties 6

AutoSwitchToBestHost
bool
Whether to periodically switch to the best host candidate. Candidates are scored based on their average ping and connection quality to all other peers.
ClientsCanDestroyObjects
bool
By default, can clients destroy objects. This can be changed per connection after join.
ClientsCanRefreshObjects
bool
By default, can clients refresh objects. This can be changed per connection after join.
ClientsCanSpawnObjects
bool
By default, can clients create objects. This can be changed per connection after join.
DestroyLobbyWhenHostLeaves
bool
Whether to disband the game lobby when the host leaves.
UpdateRate
float
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.

Inheritance

ConfigData
NetworkingSettings
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.