NetworkSettings Struct Reference

All settings related to the network. More...

#include <settings_type.h>

Public Member Functions
bool	AdminAuthenticationConfigured () const

Data Fields
uint16_t	sync_freq
	how often do we check whether we are still in-sync
uint8_t	frame_freq
	how often do we send commands to the clients
uint16_t	commands_per_frame
	how many commands may be sent each frame_freq frames?
uint16_t	commands_per_frame_server
	how many commands may be sent each frame_freq frames? (server-originating commands)
uint16_t	max_commands_in_queue
	how many commands may there be in the incoming queue before dropping the connection?
uint16_t	bytes_per_frame
	how many bytes may, over a long period, be received per frame?
uint16_t	bytes_per_frame_burst
	how many bytes may, over a short period, be received?
uint16_t	max_init_time
	maximum amount of time, in game ticks, a client may take to initiate joining
uint16_t	max_join_time
	maximum amount of time, in game ticks, a client may take to sync up during joining
uint16_t	max_download_time
	maximum amount of time, in game ticks, a client may take to download the map
uint16_t	max_password_time
	maximum amount of time, in game ticks, a client may take to enter the password
uint16_t	max_lag_time
	maximum amount of time, in game ticks, a client may be lagging behind the server
bool	pause_on_join
	pause the game when people join
uint16_t	server_port
	port the server listens on
uint16_t	server_admin_port
	port the server listens on for the admin network
bool	server_admin_chat
	allow private chat for the server to be distributed to the admin network
ServerGameType	server_game_type
	Server type: local / public / invite-only.
std::string	server_invite_code
	Invite code to use when registering as server.
std::string	server_invite_code_secret
	Secret to proof we got this invite code from the Game Coordinator.
std::string	server_name
	name of the server
std::string	server_password
	password for joining this server
NetworkAuthorizedKeys	server_authorized_keys
	Public keys of clients that are authorized to connect to the game.
std::string	rcon_password
	password for rconsole (server side)
NetworkAuthorizedKeys	rcon_authorized_keys
	Public keys of clients that are authorized to use the rconsole (server side).
bool	allow_insecure_admin_login
	Whether to allow logging in as admin using the insecure old JOIN packet.
std::string	admin_password
	password for the admin network
NetworkAuthorizedKeys	admin_authorized_keys
	Public keys of clients that are authorized to use the admin network.
std::string	client_name
	name of the player (as client)
std::string	client_secret_key
	The secret key of the client for authorized key logins.
std::string	client_public_key
	The public key of the client for authorized key logins.
std::string	connect_to_ip
	default for the "Add server" query
bool	autoclean_companies
	automatically remove companies that are not in use
uint8_t	autoclean_protected
	Remove companies after this many months.
uint8_t	autoclean_novehicles
	remove companies with no vehicles after this many months
uint8_t	max_companies
	maximum amount of companies
uint8_t	max_clients
	maximum amount of clients
TimerGameCalendar::Year	restart_game_year
	year the server restarts
uint16_t	restart_hours
	number of hours to run the server before automatic restart
uint8_t	min_active_clients
	minimum amount of active clients to unpause the game
bool	reload_cfg
	reload the config file before restarting
std::string	last_joined
	Last joined server.
UseRelayService	use_relay_service
	Use relay service?
ParticipateSurvey	participate_survey
	Participate in the automated survey.

Detailed Description

All settings related to the network.

Definition at line 302 of file settings_type.h.

---

The documentation for this struct was generated from the following file:

• src/settings_type.h