GabrielTofvesson/MLAPI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
MLAPI/docs/html/T_MLAPI_Data_NetworkConfig.htm

84 lines
21 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>NetworkConfig Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="NetworkConfig class" /><meta name="System.Keywords" content="MLAPI.Data.NetworkConfig class" /><meta name="Microsoft.Help.F1" content="MLAPI.Data.NetworkConfig" /><meta name="Microsoft.Help.Id" content="T:MLAPI.Data.NetworkConfig" /><meta name="Description" content="The configuration object used to start server, client and hosts" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="MLAPI.Data" /><meta name="file" content="T_MLAPI_Data_NetworkConfig" /><meta name="guid" content="T_MLAPI_Data_NetworkConfig" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">MLAPI API Reference<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html\N_MLAPI_Attributes.htm" title="MLAPI API Reference" tocid="roottoc">MLAPI API Reference</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/N_MLAPI_Data.htm" title="MLAPI.Data" tocid="N_MLAPI_Data">MLAPI.Data</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/T_MLAPI_Data_NetworkConfig.htm" title="NetworkConfig Class" tocid="T_MLAPI_Data_NetworkConfig">NetworkConfig Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/M_MLAPI_Data_NetworkConfig__ctor.htm" title="NetworkConfig Constructor " tocid="M_MLAPI_Data_NetworkConfig__ctor">NetworkConfig Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/Methods_T_MLAPI_Data_NetworkConfig.htm" title="NetworkConfig Methods" tocid="Methods_T_MLAPI_Data_NetworkConfig">NetworkConfig Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/Fields_T_MLAPI_Data_NetworkConfig.htm" title="NetworkConfig Fields" tocid="Fields_T_MLAPI_Data_NetworkConfig">NetworkConfig Fields</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn"><h1>NetworkConfig Class</h1></td><td class="logoColumn"><img width="600" src="../icons/MLAPI_Logo.png" /></td></tr></table><span class="introStyle"></span> <p style="color: #dc143c; font-size: 8.5pt; font-weight: bold;">[This is preliminary documentation and is subject to change.]</p><div class="summary">
The configuration object used to start server, client and hosts
</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LST4C0EAFBF_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4C0EAFBF_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <span class="selflink">MLAPI.Data<span id="LST4C0EAFBF_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4C0EAFBF_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>NetworkConfig</span><br /></div><p> </p>
<strong>Namespace:</strong>
 <a href="N_MLAPI_Data.htm">MLAPI.Data</a><br />
<strong>Assembly:</strong>
 MLAPI (in MLAPI.dll) Version: 1.0.0.0 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID1EACA');return false;" title="Copy">Copy</a></div></div><div id="ID1EACA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve">[<span class="identifier">SerializableAttribute</span>]
<span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">NetworkConfig</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EACA");</script><a id="HT_RequestExampleLink" href="https://github.com/TwoTenPvP/MLAPI/issues/new" target="_blank" class="button" title="Request an example for this topic">Request Example</a>
<script type="text/javascript">
var HT_requestExampleLink = document.getElementById("HT_RequestExampleLink");
var HT_requestExampleLinkText = HT_requestExampleLink.innerHTML;
if(HT_requestExampleLink.href.substring(0, 4).toLowerCase() == "http")
HT_requestExampleLink.href += "?title=";
else
HT_requestExampleLink.href += "?subject=MLAPI API Reference: ";
HT_requestExampleLink.href += "Add an Example for " + encodeURIComponent(document.title) + "&amp;body=" +
encodeURIComponent("Please add an example for " + document.title + ".%0D%0DTODO (optional): Describe a specific " +
"scenario you would like to see addressed.%0D%0DHelp Topic: " + window.location.href).replace(/%250D/g, "%0D");
HT_requestExampleLink.innerHTML = HT_requestExampleLinkText;
</script><a target="_blank" class="button" href="https://github.com/TwoTenPvP/MLAPI/blob/master/MLAPI/Data/NetworkConfig.cs" title="View the source code">View Source</a></div><p>The <span class="selflink">NetworkConfig</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table class="members" id="constructorList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_MLAPI_Data_NetworkConfig__ctor.htm">NetworkConfig</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">NetworkConfig</span> class</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID4RBSection" class="collapsibleSection"><table class="members" id="methodList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_MLAPI_Data_NetworkConfig_CompareConfig.htm">CompareConfig</a></td><td><div class="summary">
Compares a SHA256 hash with the current NetworkingConfiguration instances hash
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_MLAPI_Data_NetworkConfig_GetConfig.htm">GetConfig</a></td><td><div class="summary">
Gets a SHA256 hash of parts of the NetworkingConfiguration instance
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">ToString</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID5RBSection" class="collapsibleSection"><table class="members" id="fieldList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_AllowPassthroughMessages.htm">AllowPassthroughMessages</a></td><td><div class="summary">
Wheter or not to allow any type of passthrough messages
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_Channels.htm">Channels</a></td><td><div class="summary">
Channels used by the NetworkedTransport
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_ClientConnectionBufferTimeout.htm">ClientConnectionBufferTimeout</a></td><td><div class="summary">
The amount of seconds to wait for handshake to complete before timing out a client
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_ConnectAddress.htm">ConnectAddress</a></td><td><div class="summary">
The address to connect to
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_ConnectionApproval.htm">ConnectionApproval</a></td><td><div class="summary">
Wheter or not to use connection approval
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_ConnectionData.htm">ConnectionData</a></td><td><div class="summary">
The data to send during connection which can be used to decide on if a client should get accepted
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_ConnectPort.htm">ConnectPort</a></td><td><div class="summary">
The port for the NetworkTransport to use when connecting
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_EnableEncryption.htm">EnableEncryption</a></td><td><div class="summary">
Wheter or not to enable encryption
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_EnableSceneSwitching.htm">EnableSceneSwitching</a></td><td><div class="summary">
Wheter or not to enable scene switching
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_EnableTimeResync.htm">EnableTimeResync</a></td><td><div class="summary">
If your logic uses the NetwokrTime, this should probably be turned off. If however it's needed to maximize accuracy, this is recommended to be turned on
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_EventTickrate.htm">EventTickrate</a></td><td><div class="summary">
The amount of times per second internal frame events will occur, examples include SyncedVar send checking.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_HandleObjectSpawning.htm">HandleObjectSpawning</a></td><td><div class="summary">
Wheter or not to make the library handle object spawning
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_MaxConnections.htm">MaxConnections</a></td><td><div class="summary">
The max amount of Clients that can connect.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_MaxReceiveEventsPerTickRate.htm">MaxReceiveEventsPerTickRate</a></td><td><div class="summary">
The max amount of messages to process per ReceiveTickrate. This is to prevent flooding.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_MessageBufferSize.htm">MessageBufferSize</a></td><td><div class="summary">
The size of the receive message buffer. This is the max message size.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_MessageTypes.htm">MessageTypes</a></td><td><div class="summary">
Registered MessageTypes
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_NetworkedPrefabs.htm">NetworkedPrefabs</a></td><td><div class="summary">
A list of spawnable prefabs
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_ProtocolVersion.htm">ProtocolVersion</a></td><td><div class="summary">
The protocol version. Different versions doesn't talk to each other.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_ReceiveTickrate.htm">ReceiveTickrate</a></td><td><div class="summary">
Amount of times per second the receive queue is emptied and all messages inside are processed.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_RegisteredScenes.htm">RegisteredScenes</a></td><td><div class="summary">
A list of SceneNames that can be used during networked games.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_RSAPrivateKey.htm">RSAPrivateKey</a></td><td><div class="summary">
Private RSA XML key to use for signing key exchange
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_RSAPublicKey.htm">RSAPublicKey</a></td><td><div class="summary">
Public RSA XML key to use for signing key exchange
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_SecondsHistory.htm">SecondsHistory</a></td><td><div class="summary">
The amount of seconds to keep a lag compensation position history
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_SendTickrate.htm">SendTickrate</a></td><td><div class="summary">
The amount of times per second every pending message will be sent away.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_ServerTransports.htm">ServerTransports</a></td><td><div class="summary">
The transport hosts the sever uses
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_Data_NetworkConfig_SignKeyExchange.htm">SignKeyExchange</a></td><td><div class="summary">
Wheter or not to enable signed diffie hellman key exchange.
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID6RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="N_MLAPI_Data.htm">MLAPI.Data Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>
Reference in New Issue View Git Blame Copy Permalink