Barotrauma Client Doc
Barotrauma.Networking.ServerSettings Class Reference
Inheritance diagram for Barotrauma.Networking.ServerSettings:
Barotrauma.ISerializableEntity Barotrauma.ISerializableEntity

Classes

class  SavedClientPermission
 

Public Types

enum class  NetFlags : byte {
  None = 0x0 , Name = 0x1 , Message = 0x2 , Properties = 0x4 ,
  Misc = 0x8 , LevelSeed = 0x10 , HiddenSubs = 0x20
}
 

Public Member Functions

 ServerSettings (NetworkMember networkMember, string serverName, int port, int queryPort, int maxPlayers, bool isPublic, bool enableUPnP, IPAddress listenIp)
 
void SetPassword (string password)
 
bool IsPasswordCorrect (byte[] input, int salt)
 
void ReadMonsterEnabled (IReadMessage inc)
 
void WriteMonsterEnabled (IWriteMessage msg, Dictionary< Identifier, bool > monsterEnabled=null)
 
bool ReadExtraCargo (IReadMessage msg)
 
void WriteExtraCargo (IWriteMessage msg)
 
void ReadHiddenSubs (IReadMessage msg)
 
void WriteHiddenSubs (IWriteMessage msg)
 
void ClientAdminRead (IReadMessage incMsg)
 
void ClientRead (IReadMessage incMsg)
 
void ClientAdminWrite (NetFlags dataToSend, int? missionTypeOr=null, int? missionTypeAnd=null, float? levelDifficulty=null, bool? autoRestart=null, float? traitorProbability=null, int traitorDangerLevel=0, int botCount=0, int botSpawnMode=0, bool? useRespawnShuttle=null)
 
void AssignGUIComponent (string propertyName, GUIComponent component)
 
void AddToGUIUpdateList ()
 
bool ToggleSettingsFrame (GUIButton button, object obj)
 

Static Public Member Functions

static byte[] SaltPassword (byte[] password, int salt)
 

Public Attributes

bool ServerDetailsChanged
 Have some of the properties listed in the server list changed More...
 
int Port
 
int QueryPort
 
IPAddress ListenIPAddress
 
bool EnableUPnP
 
ServerLog ServerLog
 
float AutoRestartTimer
 

Static Public Attributes

const int PacketLimitMin = 1200
 
const string SettingsFile = "serversettings.xml"
 
static readonly string PermissionPresetFile = "Data" + Path.DirectorySeparatorChar + "permissionpresets.xml"
 
const int MaxExtraCargoItemsOfType = 10
 
const int MaxExtraCargoItemTypes = 20
 
const int DefaultTickRate = 20
 

Properties

string Name [get]
 
Dictionary< Identifier, SerializablePropertySerializableProperties [get]
 
string ServerName [get, set]
 
string ServerMessageText [get, set]
 
Dictionary< Identifier, bool > MonsterEnabled [get]
 
Dictionary< ItemPrefab, int > ExtraCargo [get]
 
HashSet< string > HiddenSubs [get, set]
 
List< SavedClientPermissionClientPermissions = new List<SavedClientPermission>() [get]
 
bool IsPublic [get, set]
 
int TickRate [get, set]
 
bool RandomizeSeed [get, set]
 
bool UseRespawnShuttle [get]
 
float RespawnInterval [get]
 
float MaxTransportTime [get]
 
float MinRespawnRatio [get]
 
float SkillLossPercentageOnDeath [get]
 How much skills drop towards the job's default skill levels when dying More...
 
float AutoRestartInterval [get, set]
 
bool StartWhenClientsReady [get, set]
 
float StartWhenClientsReadyRatio [get]
 
bool AllowSpectating [get]
 
bool SaveServerLogs [get]
 
bool AllowModDownloads = true [get]
 
bool AllowFileTransfers [get]
 
bool VoiceChatEnabled [get, set]
 
PlayStyle PlayStyle [get, set]
 
LosMode LosMode [get, set]
 
EnemyHealthBarMode ShowEnemyHealthBars [get, set]
 
int LinesPerLogFile [get, set]
 
bool? AutoRestart [get, set]
 
bool??? HasPassword [get, set]
 
bool AllowVoteKick [get, set]
 
bool AllowEndVoting [get, set]
 
bool AllowRespawn [get, set]
 
int BotCount [get, set]
 
int MaxBotCount [get, set]
 
BotSpawnMode BotSpawnMode [get, set]
 
bool DisableBotConversations [get, set]
 
float SelectedLevelDifficulty [get, set]
 
bool AllowDisguises [get, set]
 
bool AllowRewiring [get, set]
 
bool AllowImmediateItemDelivery [get, set]
 
bool LockAllDefaultWires [get, set]
 
bool AllowLinkingWifiToChat [get, set]
 
bool AllowFriendlyFire [get, set]
 
bool DestructibleOutposts [get, set]
 
bool KillableNPCs [get, set]
 
bool BanAfterWrongPassword [get, set]
 
int MaxPasswordRetriesBeforeBan [get]
 
bool EnableDoSProtection [get]
 
int MaxPacketAmount [get]
 
string SelectedSubmarine [get, set]
 
string SelectedShuttle [get, set]
 
float TraitorProbability [get, set]
 
int TraitorDangerLevel [get, set]
 
int TraitorsMinPlayerCount [get, set]
 
float MinPercentageOfPlayersForTraitorAccusation [get, set]
 
LanguageIdentifier Language [get, set]
 
SelectionMode SubSelectionMode [get, set]
 
SelectionMode ModeSelectionMode [get, set]
 
BanList BanList [get]
 
float EndVoteRequiredRatio [get]
 
float VoteRequiredRatio [get]
 
float VoteTimeout [get]
 
float KickVoteRequiredRatio [get]
 
float DisallowKickVoteTime [get]
 
float KillDisconnectedTime [get]
 
float KickAFKTime [get]
 
float MinimumMidRoundSyncTimeout [get]
 
bool KarmaEnabled [get, set]
 
string?? KarmaPreset [get, set]
 
Identifier GameModeIdentifier [get, set]
 
string MissionType [get, set]
 
int MaxPlayers [get, set]
 
List< MissionTypeAllowedRandomMissionTypes [get, set]
 
float AutoBanTime [get]
 
float MaxAutoBanTime [get]
 
LootedMoneyDestination LootedMoneyDestination [get, set]
 
int MaximumMoneyTransferRequest [get, set]
 
CampaignSettings CampaignSettings = CampaignSettings.Empty [get, set]
 
bool?? AllowSubVoting [get, set]
 
bool? AllowModeVoting [get, set]
 
List< Range< int > > AllowedClientNameChars = new List<Range<int>>() [get]
 A list of int pairs that represent the ranges of UTF-16 codes allowed in client names More...
 
- Properties inherited from Barotrauma.ISerializableEntity
string Name [get]
 
Dictionary< Identifier, SerializablePropertySerializableProperties [get]
 

Detailed Description

Member Enumeration Documentation

◆ NetFlags

Enumerator
None 
Name 
Message 
Properties 
Misc 
LevelSeed 
HiddenSubs 

Definition at line 49 of file BarotraumaShared/SharedSource/Networking/ServerSettings.cs.

Constructor & Destructor Documentation

◆ ServerSettings()

Barotrauma.Networking.ServerSettings.ServerSettings ( NetworkMember  networkMember,
string  serverName,
int  port,
int  queryPort,
int  maxPlayers,
bool  isPublic,
bool  enableUPnP,
IPAddress  listenIp 
)

Member Function Documentation

◆ AddToGUIUpdateList()

void Barotrauma.Networking.ServerSettings.AddToGUIUpdateList ( )

◆ AssignGUIComponent()

void Barotrauma.Networking.ServerSettings.AssignGUIComponent ( string  propertyName,
GUIComponent  component 
)

◆ ClientAdminRead()

void Barotrauma.Networking.ServerSettings.ClientAdminRead ( IReadMessage  incMsg)

◆ ClientAdminWrite()

void Barotrauma.Networking.ServerSettings.ClientAdminWrite ( NetFlags  dataToSend,
int?  missionTypeOr = null,
int?  missionTypeAnd = null,
float?  levelDifficulty = null,
bool?  autoRestart = null,
float?  traitorProbability = null,
int  traitorDangerLevel = 0,
int  botCount = 0,
int  botSpawnMode = 0,
bool?  useRespawnShuttle = null 
)

◆ ClientRead()

void Barotrauma.Networking.ServerSettings.ClientRead ( IReadMessage  incMsg)

◆ IsPasswordCorrect()

bool Barotrauma.Networking.ServerSettings.IsPasswordCorrect ( byte[]  input,
int  salt 
)

◆ ReadExtraCargo()

bool Barotrauma.Networking.ServerSettings.ReadExtraCargo ( IReadMessage  msg)

◆ ReadHiddenSubs()

void Barotrauma.Networking.ServerSettings.ReadHiddenSubs ( IReadMessage  msg)

◆ ReadMonsterEnabled()

void Barotrauma.Networking.ServerSettings.ReadMonsterEnabled ( IReadMessage  inc)

◆ SaltPassword()

static byte [] Barotrauma.Networking.ServerSettings.SaltPassword ( byte[]  password,
int  salt 
)
static

◆ SetPassword()

void Barotrauma.Networking.ServerSettings.SetPassword ( string  password)

◆ ToggleSettingsFrame()

bool Barotrauma.Networking.ServerSettings.ToggleSettingsFrame ( GUIButton  button,
object  obj 
)

◆ WriteExtraCargo()

void Barotrauma.Networking.ServerSettings.WriteExtraCargo ( IWriteMessage  msg)

◆ WriteHiddenSubs()

void Barotrauma.Networking.ServerSettings.WriteHiddenSubs ( IWriteMessage  msg)

◆ WriteMonsterEnabled()

void Barotrauma.Networking.ServerSettings.WriteMonsterEnabled ( IWriteMessage  msg,
Dictionary< Identifier, bool >  monsterEnabled = null 
)

Member Data Documentation

◆ AutoRestartTimer

float Barotrauma.Networking.ServerSettings.AutoRestartTimer

◆ DefaultTickRate

const int Barotrauma.Networking.ServerSettings.DefaultTickRate = 20
static

◆ EnableUPnP

bool Barotrauma.Networking.ServerSettings.EnableUPnP

◆ ListenIPAddress

IPAddress Barotrauma.Networking.ServerSettings.ListenIPAddress

◆ MaxExtraCargoItemsOfType

const int Barotrauma.Networking.ServerSettings.MaxExtraCargoItemsOfType = 10
static

◆ MaxExtraCargoItemTypes

const int Barotrauma.Networking.ServerSettings.MaxExtraCargoItemTypes = 20
static

◆ PacketLimitMin

const int Barotrauma.Networking.ServerSettings.PacketLimitMin = 1200
static

◆ PermissionPresetFile

readonly string Barotrauma.Networking.ServerSettings.PermissionPresetFile = "Data" + Path.DirectorySeparatorChar + "permissionpresets.xml"
static

◆ Port

int Barotrauma.Networking.ServerSettings.Port

◆ QueryPort

int Barotrauma.Networking.ServerSettings.QueryPort

◆ ServerDetailsChanged

bool Barotrauma.Networking.ServerSettings.ServerDetailsChanged

Have some of the properties listed in the server list changed

Definition at line 70 of file BarotraumaShared/SharedSource/Networking/ServerSettings.cs.

◆ ServerLog

ServerLog Barotrauma.Networking.ServerSettings.ServerLog

◆ SettingsFile

const string Barotrauma.Networking.ServerSettings.SettingsFile = "serversettings.xml"
static

Property Documentation

◆ AllowDisguises

bool Barotrauma.Networking.ServerSettings.AllowDisguises
getset

◆ AllowedClientNameChars

List<Range<int> > Barotrauma.Networking.ServerSettings.AllowedClientNameChars = new List<Range<int>>()
get

A list of int pairs that represent the ranges of UTF-16 codes allowed in client names

Definition at line 1021 of file BarotraumaShared/SharedSource/Networking/ServerSettings.cs.

◆ AllowedRandomMissionTypes

List<MissionType> Barotrauma.Networking.ServerSettings.AllowedRandomMissionTypes
getset

◆ AllowEndVoting

bool Barotrauma.Networking.ServerSettings.AllowEndVoting
getset

◆ AllowFileTransfers

bool Barotrauma.Networking.ServerSettings.AllowFileTransfers
get

◆ AllowFriendlyFire

bool Barotrauma.Networking.ServerSettings.AllowFriendlyFire
getset

◆ AllowImmediateItemDelivery

bool Barotrauma.Networking.ServerSettings.AllowImmediateItemDelivery
getset

◆ AllowLinkingWifiToChat

bool Barotrauma.Networking.ServerSettings.AllowLinkingWifiToChat
getset

◆ AllowModDownloads

bool Barotrauma.Networking.ServerSettings.AllowModDownloads = true
get

◆ AllowModeVoting

bool? Barotrauma.Networking.ServerSettings.AllowModeVoting
getset

◆ AllowRespawn

bool Barotrauma.Networking.ServerSettings.AllowRespawn
getset

◆ AllowRewiring

bool Barotrauma.Networking.ServerSettings.AllowRewiring
getset

◆ AllowSpectating

bool Barotrauma.Networking.ServerSettings.AllowSpectating
get

◆ AllowSubVoting

bool?? Barotrauma.Networking.ServerSettings.AllowSubVoting
getset

◆ AllowVoteKick

bool Barotrauma.Networking.ServerSettings.AllowVoteKick
getset

◆ AutoBanTime

float Barotrauma.Networking.ServerSettings.AutoBanTime
get

◆ AutoRestart

bool? Barotrauma.Networking.ServerSettings.AutoRestart
getset

◆ AutoRestartInterval

float Barotrauma.Networking.ServerSettings.AutoRestartInterval
getset

◆ BanAfterWrongPassword

bool Barotrauma.Networking.ServerSettings.BanAfterWrongPassword
getset

◆ BanList

BanList Barotrauma.Networking.ServerSettings.BanList
get

◆ BotCount

int Barotrauma.Networking.ServerSettings.BotCount
getset

◆ BotSpawnMode

BotSpawnMode Barotrauma.Networking.ServerSettings.BotSpawnMode
getset

◆ CampaignSettings

CampaignSettings Barotrauma.Networking.ServerSettings.CampaignSettings = CampaignSettings.Empty
getset

◆ ClientPermissions

List<SavedClientPermission> Barotrauma.Networking.ServerSettings.ClientPermissions = new List<SavedClientPermission>()
get

◆ DestructibleOutposts

bool Barotrauma.Networking.ServerSettings.DestructibleOutposts
getset

◆ DisableBotConversations

bool Barotrauma.Networking.ServerSettings.DisableBotConversations
getset

◆ DisallowKickVoteTime

float Barotrauma.Networking.ServerSettings.DisallowKickVoteTime
get

◆ EnableDoSProtection

bool Barotrauma.Networking.ServerSettings.EnableDoSProtection
get

◆ EndVoteRequiredRatio

float Barotrauma.Networking.ServerSettings.EndVoteRequiredRatio
get

◆ ExtraCargo

Dictionary<ItemPrefab, int> Barotrauma.Networking.ServerSettings.ExtraCargo
get

◆ GameModeIdentifier

Identifier Barotrauma.Networking.ServerSettings.GameModeIdentifier
getset

◆ HasPassword

bool??? Barotrauma.Networking.ServerSettings.HasPassword
getset

◆ HiddenSubs

HashSet<string> Barotrauma.Networking.ServerSettings.HiddenSubs
getset

◆ IsPublic

bool Barotrauma.Networking.ServerSettings.IsPublic
getset

◆ KarmaEnabled

bool Barotrauma.Networking.ServerSettings.KarmaEnabled
getset

◆ KarmaPreset

string?? Barotrauma.Networking.ServerSettings.KarmaPreset
getset

◆ KickAFKTime

float Barotrauma.Networking.ServerSettings.KickAFKTime
get

◆ KickVoteRequiredRatio

float Barotrauma.Networking.ServerSettings.KickVoteRequiredRatio
get

◆ KillableNPCs

bool Barotrauma.Networking.ServerSettings.KillableNPCs
getset

◆ KillDisconnectedTime

float Barotrauma.Networking.ServerSettings.KillDisconnectedTime
get

◆ Language

LanguageIdentifier Barotrauma.Networking.ServerSettings.Language
getset

◆ LinesPerLogFile

int Barotrauma.Networking.ServerSettings.LinesPerLogFile
getset

◆ LockAllDefaultWires

bool Barotrauma.Networking.ServerSettings.LockAllDefaultWires
getset

◆ LootedMoneyDestination

LootedMoneyDestination Barotrauma.Networking.ServerSettings.LootedMoneyDestination
getset

◆ LosMode

LosMode Barotrauma.Networking.ServerSettings.LosMode
getset

◆ MaxAutoBanTime

float Barotrauma.Networking.ServerSettings.MaxAutoBanTime
get

◆ MaxBotCount

int Barotrauma.Networking.ServerSettings.MaxBotCount
getset

◆ MaximumMoneyTransferRequest

int Barotrauma.Networking.ServerSettings.MaximumMoneyTransferRequest
getset

◆ MaxPacketAmount

int Barotrauma.Networking.ServerSettings.MaxPacketAmount
get

◆ MaxPasswordRetriesBeforeBan

int Barotrauma.Networking.ServerSettings.MaxPasswordRetriesBeforeBan
get

◆ MaxPlayers

int Barotrauma.Networking.ServerSettings.MaxPlayers
getset

◆ MaxTransportTime

float Barotrauma.Networking.ServerSettings.MaxTransportTime
get

◆ MinimumMidRoundSyncTimeout

float Barotrauma.Networking.ServerSettings.MinimumMidRoundSyncTimeout
get

◆ MinPercentageOfPlayersForTraitorAccusation

float Barotrauma.Networking.ServerSettings.MinPercentageOfPlayersForTraitorAccusation
getset

◆ MinRespawnRatio

float Barotrauma.Networking.ServerSettings.MinRespawnRatio
get

◆ MissionType

string Barotrauma.Networking.ServerSettings.MissionType
getset

◆ ModeSelectionMode

SelectionMode Barotrauma.Networking.ServerSettings.ModeSelectionMode
getset

◆ MonsterEnabled

Dictionary<Identifier, bool> Barotrauma.Networking.ServerSettings.MonsterEnabled
get

◆ Name

string Barotrauma.Networking.ServerSettings.Name
get

◆ PlayStyle

PlayStyle Barotrauma.Networking.ServerSettings.PlayStyle
getset

◆ RandomizeSeed

bool Barotrauma.Networking.ServerSettings.RandomizeSeed
getset

◆ RespawnInterval

float Barotrauma.Networking.ServerSettings.RespawnInterval
get

◆ SaveServerLogs

bool Barotrauma.Networking.ServerSettings.SaveServerLogs
get

◆ SelectedLevelDifficulty

float Barotrauma.Networking.ServerSettings.SelectedLevelDifficulty
getset

◆ SelectedShuttle

string Barotrauma.Networking.ServerSettings.SelectedShuttle
getset

◆ SelectedSubmarine

string Barotrauma.Networking.ServerSettings.SelectedSubmarine
getset

◆ SerializableProperties

Dictionary<Identifier, SerializableProperty> Barotrauma.Networking.ServerSettings.SerializableProperties
get

◆ ServerMessageText

string Barotrauma.Networking.ServerSettings.ServerMessageText
getset

◆ ServerName

string Barotrauma.Networking.ServerSettings.ServerName
getset

◆ ShowEnemyHealthBars

EnemyHealthBarMode Barotrauma.Networking.ServerSettings.ShowEnemyHealthBars
getset

◆ SkillLossPercentageOnDeath

float Barotrauma.Networking.ServerSettings.SkillLossPercentageOnDeath
get

How much skills drop towards the job's default skill levels when dying

Definition at line 443 of file BarotraumaShared/SharedSource/Networking/ServerSettings.cs.

◆ StartWhenClientsReady

bool Barotrauma.Networking.ServerSettings.StartWhenClientsReady
getset

◆ StartWhenClientsReadyRatio

float Barotrauma.Networking.ServerSettings.StartWhenClientsReadyRatio
get

◆ SubSelectionMode

SelectionMode Barotrauma.Networking.ServerSettings.SubSelectionMode
getset

◆ TickRate

int Barotrauma.Networking.ServerSettings.TickRate
getset

◆ TraitorDangerLevel

int Barotrauma.Networking.ServerSettings.TraitorDangerLevel
getset

◆ TraitorProbability

float Barotrauma.Networking.ServerSettings.TraitorProbability
getset

◆ TraitorsMinPlayerCount

int Barotrauma.Networking.ServerSettings.TraitorsMinPlayerCount
getset

◆ UseRespawnShuttle

bool Barotrauma.Networking.ServerSettings.UseRespawnShuttle
get

◆ VoiceChatEnabled

bool Barotrauma.Networking.ServerSettings.VoiceChatEnabled
getset

◆ VoteRequiredRatio

float Barotrauma.Networking.ServerSettings.VoteRequiredRatio
get

◆ VoteTimeout

float Barotrauma.Networking.ServerSettings.VoteTimeout
get