2022-07-01 17:00:42 +08:00
<!DOCTYPE html>
<!-- [if IE]><![endif] -->
< html >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge,chrome=1" >
< title > Class ServerSettings
| RageCoop resource documentation < / title >
< meta name = "viewport" content = "width=device-width" >
< meta name = "title" content = "Class ServerSettings
| RageCoop resource documentation ">
< meta name = "generator" content = "docfx 2.59.2.0" >
< link rel = "shortcut icon" href = "../favicon.ico" >
< link rel = "stylesheet" href = "../styles/docfx.vendor.css" >
< link rel = "stylesheet" href = "../styles/docfx.css" >
< link rel = "stylesheet" href = "../styles/main.css" >
< meta property = "docfx:navrel" content = "../toc.html" >
< meta property = "docfx:tocrel" content = "toc.html" >
< meta property = "docfx:rel" content = "../" >
< / head >
< body data-spy = "scroll" data-target = "#affix" data-offset = "120" >
< div id = "wrapper" >
< header >
< nav id = "autocollapse" class = "navbar navbar-inverse ng-scope" role = "navigation" >
< div class = "container" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = "#navbar" >
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = "../index.html" >
< img id = "logo" class = "svg" src = "../logo.svg" alt = "" >
< / a >
< / div >
< div class = "collapse navbar-collapse" id = "navbar" >
< form class = "navbar-form navbar-right" role = "search" id = "search" >
< div class = "form-group" >
< input type = "text" class = "form-control" id = "search-query" placeholder = "Search" autocomplete = "off" >
< / div >
< / form >
< / div >
< / div >
< / nav >
< div class = "subnav navbar navbar-default" >
< div class = "container hide-when-search" id = "breadcrumb" >
< ul class = "breadcrumb" >
< li > < / li >
< / ul >
< / div >
< / div >
< / header >
< div class = "container body-content" >
< div id = "search-results" >
< div class = "search-list" > Search Results for < span > < / span > < / div >
< div class = "sr-items" >
< p > < i class = "glyphicon glyphicon-refresh index-loading" > < / i > < / p >
< / div >
< ul id = "pagination" data-first = "First" data-prev = "Previous" data-next = "Next" data-last = "Last" > < / ul >
< / div >
< / div >
< div role = "main" class = "container body-content hide-when-search" >
< div class = "sidenav hide-when-search" >
< a class = "btn toc-toggle collapse" data-toggle = "collapse" href = "#sidetoggle" aria-expanded = "false" aria-controls = "sidetoggle" > Show / Hide Table of Contents< / a >
< div class = "sidetoggle collapse" id = "sidetoggle" >
< div id = "sidetoc" > < / div >
< / div >
< / div >
< div class = "article row grid-right" >
< div class = "col-md-10" >
< article class = "content wrap" id = "_content" data-uid = "RageCoop.Server.ServerSettings" >
< h1 id = "RageCoop_Server_ServerSettings" data-uid = "RageCoop.Server.ServerSettings" class = "text-break" > Class ServerSettings
< / h1 >
< div class = "markdown level0 summary" > < p > Settings for RageCoop Server< / p >
< / div >
< div class = "markdown level0 conceptual" > < / div >
< div class = "inheritance" >
< h5 > Inheritance< / h5 >
< div class = "level0" > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.object" > Object< / a > < / div >
< div class = "level1" > < span class = "xref" > ServerSettings< / span > < / div >
< / div >
< div class = "inheritedMembers" >
< h5 > Inherited Members< / h5 >
< div >
< a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)" > Object.Equals(Object)< / a >
< / div >
< div >
< a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)" > Object.Equals(Object, Object)< / a >
< / div >
< div >
< a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode" > Object.GetHashCode()< / a >
< / div >
< div >
< a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype" > Object.GetType()< / a >
< / div >
< div >
< a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone" > Object.MemberwiseClone()< / a >
< / div >
< div >
< a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)" > Object.ReferenceEquals(Object, Object)< / a >
< / div >
< div >
< a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring" > Object.ToString()< / a >
< / div >
< / div >
< h6 > < strong > Namespace< / strong > : < a class = "xref" href = "RageCoop.Server.html" > RageCoop.Server< / a > < / h6 >
< h6 > < strong > Assembly< / strong > : RageCoop.Server.dll< / h6 >
< h5 id = "RageCoop_Server_ServerSettings_syntax" > Syntax< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public class ServerSettings< / code > < / pre >
< / div >
2022-07-02 11:23:12 +08:00
< h3 id = "properties" > Properties
2022-07-01 17:00:42 +08:00
< / h3 >
2022-07-02 11:23:12 +08:00
< a id = "RageCoop_Server_ServerSettings_AnnounceSelf_" data-uid = "RageCoop.Server.ServerSettings.AnnounceSelf*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_AnnounceSelf" data-uid = "RageCoop.Server.ServerSettings.AnnounceSelf" > AnnounceSelf< / h4 >
< div class = "markdown level1 summary" > < p > Whether or not to announce this server so it'll appear on server list.< / p >
2022-07-01 17:00:42 +08:00
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
2022-07-02 11:23:12 +08:00
< pre > < code class = "lang-csharp hljs" > public bool AnnounceSelf { get; set; }< / code > < / pre >
2022-07-01 17:00:42 +08:00
< / div >
2022-07-02 11:23:12 +08:00
< h5 class = "propertyValue" > Property Value< / h5 >
2022-07-01 17:00:42 +08:00
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2022-07-02 11:23:12 +08:00
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.boolean" > Boolean< / a > < / td >
2022-07-01 17:00:42 +08:00
< td > < / td >
< / tr >
< / tbody >
< / table >
2022-07-02 11:23:12 +08:00
< a id = "RageCoop_Server_ServerSettings_LogLevel_" data-uid = "RageCoop.Server.ServerSettings.LogLevel*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_LogLevel" data-uid = "RageCoop.Server.ServerSettings.LogLevel" > LogLevel< / h4 >
< div class = "markdown level1 summary" > < p > See < a class = "xref" href = "RageCoop.Core.Logger.html#RageCoop_Core_Logger_LogLevel" > LogLevel< / a > .< / p >
2022-07-01 17:00:42 +08:00
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
2022-07-02 11:23:12 +08:00
< pre > < code class = "lang-csharp hljs" > public int LogLevel { get; set; }< / code > < / pre >
2022-07-01 17:00:42 +08:00
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2022-07-02 11:23:12 +08:00
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.int32" > Int32< / a > < / td >
2022-07-01 17:00:42 +08:00
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "RageCoop_Server_ServerSettings_MasterServer_" data-uid = "RageCoop.Server.ServerSettings.MasterServer*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_MasterServer" data-uid = "RageCoop.Server.ServerSettings.MasterServer" > MasterServer< / h4 >
2022-07-02 11:23:12 +08:00
< div class = "markdown level1 summary" > < p > Master server address, mostly doesn't need to be changed.< / p >
2022-07-01 17:00:42 +08:00
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public string MasterServer { get; set; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.string" > String< / a > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "RageCoop_Server_ServerSettings_MaxLatency_" data-uid = "RageCoop.Server.ServerSettings.MaxLatency*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_MaxLatency" data-uid = "RageCoop.Server.ServerSettings.MaxLatency" > MaxLatency< / h4 >
< div class = "markdown level1 summary" > < p > Maximum latency allowed for a client, a client will be kicked if it's latency it's higher than this value< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public int MaxLatency { get; set; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.int32" > Int32< / a > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "RageCoop_Server_ServerSettings_MaxPlayers_" data-uid = "RageCoop.Server.ServerSettings.MaxPlayers*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_MaxPlayers" data-uid = "RageCoop.Server.ServerSettings.MaxPlayers" > MaxPlayers< / h4 >
< div class = "markdown level1 summary" > < p > Maximum number of players on this server< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public int MaxPlayers { get; set; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.int32" > Int32< / a > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "RageCoop_Server_ServerSettings_Name_" data-uid = "RageCoop.Server.ServerSettings.Name*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_Name" data-uid = "RageCoop.Server.ServerSettings.Name" > Name< / h4 >
< div class = "markdown level1 summary" > < p > The server name to be shown on master server< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public string Name { get; set; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.string" > String< / a > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "RageCoop_Server_ServerSettings_NpcStreamingDistance_" data-uid = "RageCoop.Server.ServerSettings.NpcStreamingDistance*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_NpcStreamingDistance" data-uid = "RageCoop.Server.ServerSettings.NpcStreamingDistance" > NpcStreamingDistance< / h4 >
< div class = "markdown level1 summary" > < p > NPC data won't be sent to a player if their distance is greater than this value. -1 for unlimited.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public float NpcStreamingDistance { get; set; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.single" > Single< / a > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "RageCoop_Server_ServerSettings_PlayerStreamingDistance_" data-uid = "RageCoop.Server.ServerSettings.PlayerStreamingDistance*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_PlayerStreamingDistance" data-uid = "RageCoop.Server.ServerSettings.PlayerStreamingDistance" > PlayerStreamingDistance< / h4 >
< div class = "markdown level1 summary" > < p > Player's data won't be sent to another player if their distance is greater than this value. -1 for unlimited.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public float PlayerStreamingDistance { get; set; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.single" > Single< / a > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "RageCoop_Server_ServerSettings_Port_" data-uid = "RageCoop.Server.ServerSettings.Port*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_Port" data-uid = "RageCoop.Server.ServerSettings.Port" > Port< / h4 >
< div class = "markdown level1 summary" > < p > Port to listen for incoming connections< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public int Port { get; set; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.int32" > Int32< / a > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "RageCoop_Server_ServerSettings_WelcomeMessage_" data-uid = "RageCoop.Server.ServerSettings.WelcomeMessage*" > < / a >
< h4 id = "RageCoop_Server_ServerSettings_WelcomeMessage" data-uid = "RageCoop.Server.ServerSettings.WelcomeMessage" > WelcomeMessage< / h4 >
< div class = "markdown level1 summary" > < p > The message to send when a client connected (not visible to others)< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public string WelcomeMessage { get; set; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "https://docs.microsoft.com/dotnet/api/system.string" > String< / a > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< / article >
< / div >
< div class = "hidden-sm col-md-2" role = "complementary" >
< div class = "sideaffix" >
< div class = "contribution" >
< ul class = "nav" >
< / ul >
< / div >
< nav class = "bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id = "affix" >
< h5 > In This Article< / h5 >
< div > < / div >
< / nav >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "grad-bottom" > < / div >
< div class = "footer" >
< div class = "container" >
< span class = "pull-right" >
< a href = "#top" > Back to top< / a >
< / span >
< span > Generated by < strong > DocFX< / strong > < / span >
< / div >
< / div >
< / footer >
< / div >
< script type = "text/javascript" src = "../styles/docfx.vendor.js" > < / script >
< script type = "text/javascript" src = "../styles/docfx.js" > < / script >
< script type = "text/javascript" src = "../styles/main.js" > < / script >
< / body >
< / html >
