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

55 lines
20 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 Fields</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="NetworkConfig class, fields" /><meta name="Microsoft.Help.Id" content="Fields.T:MLAPI.Data.NetworkConfig" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="MLAPI.Data" /><meta name="file" content="Fields_T_MLAPI_Data_NetworkConfig" /><meta name="guid" content="Fields_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="toclevel0" data-toclevel="0"><a class="tocCollapsed" 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="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" 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 class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_AllowPassthroughMessages.htm" title="AllowPassthroughMessages Field" tocid="F_MLAPI_Data_NetworkConfig_AllowPassthroughMessages">AllowPassthroughMessages Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_Channels.htm" title="Channels Field" tocid="F_MLAPI_Data_NetworkConfig_Channels">Channels Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_ClientConnectionBufferTimeout.htm" title="ClientConnectionBufferTimeout Field" tocid="F_MLAPI_Data_NetworkConfig_ClientConnectionBufferTimeout">ClientConnectionBufferTimeout Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_ConnectAddress.htm" title="ConnectAddress Field" tocid="F_MLAPI_Data_NetworkConfig_ConnectAddress">ConnectAddress Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_ConnectionApproval.htm" title="ConnectionApproval Field" tocid="F_MLAPI_Data_NetworkConfig_ConnectionApproval">ConnectionApproval Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_ConnectionData.htm" title="ConnectionData Field" tocid="F_MLAPI_Data_NetworkConfig_ConnectionData">ConnectionData Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_ConnectPort.htm" title="ConnectPort Field" tocid="F_MLAPI_Data_NetworkConfig_ConnectPort">ConnectPort Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_EnableEncryption.htm" title="EnableEncryption Field" tocid="F_MLAPI_Data_NetworkConfig_EnableEncryption">EnableEncryption Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_EnableSceneSwitching.htm" title="EnableSceneSwitching Field" tocid="F_MLAPI_Data_NetworkConfig_EnableSceneSwitching">EnableSceneSwitching Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_EnableTimeResync.htm" title="EnableTimeResync Field" tocid="F_MLAPI_Data_NetworkConfig_EnableTimeResync">EnableTimeResync Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_EventTickrate.htm" title="EventTickrate Field" tocid="F_MLAPI_Data_NetworkConfig_EventTickrate">EventTickrate Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_HandleObjectSpawning.htm" title="HandleObjectSpawning Field" tocid="F_MLAPI_Data_NetworkConfig_HandleObjectSpawning">HandleObjectSpawning Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_MaxConnections.htm" title="MaxConnections Field" tocid="F_MLAPI_Data_NetworkConfig_MaxConnections">MaxConnections Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_MaxReceiveEventsPerTickRate.htm" title="MaxReceiveEventsPerTickRate Field" tocid="F_MLAPI_Data_NetworkConfig_MaxReceiveEventsPerTickRate">MaxReceiveEventsPerTickRate Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_MessageBufferSize.htm" title="MessageBufferSize Field" tocid="F_MLAPI_Data_NetworkConfig_MessageBufferSize">MessageBufferSize Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_MessageTypes.htm" title="MessageTypes Field" tocid="F_MLAPI_Data_NetworkConfig_MessageTypes">MessageTypes Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_NetworkedPrefabs.htm" title="NetworkedPrefabs Field" tocid="F_MLAPI_Data_NetworkConfig_NetworkedPrefabs">NetworkedPrefabs Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_ProtocolVersion.htm" title="ProtocolVersion Field" tocid="F_MLAPI_Data_NetworkConfig_ProtocolVersion">ProtocolVersion Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_ReceiveTickrate.htm" title="ReceiveTickrate Field" tocid="F_MLAPI_Data_NetworkConfig_ReceiveTickrate">ReceiveTickrate Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_RegisteredScenes.htm" title="RegisteredScenes Field" tocid="F_MLAPI_Data_NetworkConfig_RegisteredScenes">RegisteredScenes Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_RSAPrivateKey.htm" title="RSAPrivateKey Field" tocid="F_MLAPI_Data_NetworkConfig_RSAPrivateKey">RSAPrivateKey Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_RSAPublicKey.htm" title="RSAPublicKey Field" tocid="F_MLAPI_Data_NetworkConfig_RSAPublicKey">RSAPublicKey Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_SecondsHistory.htm" title="SecondsHistory Field" tocid="F_MLAPI_Data_NetworkConfig_SecondsHistory">SecondsHistory Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_SendTickrate.htm" title="SendTickrate Field" tocid="F_MLAPI_Data_NetworkConfig_SendTickrate">SendTickrate Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_ServerTransports.htm" title="ServerTransports Field" tocid="F_MLAPI_Data_NetworkConfig_ServerTransports">ServerTransports Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/F_MLAPI_Data_NetworkConfig_SignKeyExchange.htm" title="SignKeyExchange Field" tocid="F_MLAPI_Data_NetworkConfig_SignKeyExchange">SignKeyExchange Field</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 Fields</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><p>The <a href="T_MLAPI_Data_NetworkConfig.htm">NetworkConfig</a> type exposes the following members.</p><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" />Fields</span></div><div id="ID0RBSection" 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('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID1RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="T_MLAPI_Data_NetworkConfig.htm">NetworkConfig Class</a></div><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