MLAPI/docs/html/M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_CreatePool.htm

25 lines
10 KiB
HTML
Raw 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>NetworkPoolManager.CreatePool Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="CreatePool method" /><meta name="System.Keywords" content="NetworkPoolManager.CreatePool method" /><meta name="Microsoft.Help.F1" content="MLAPI.NetworkingManagerComponents.NetworkPoolManager.CreatePool" /><meta name="Microsoft.Help.Id" content="M:MLAPI.NetworkingManagerComponents.NetworkPoolManager.CreatePool(System.String,System.Int32,System.UInt32)" /><meta name="Description" content="Creates a networked object pool. Can only be called from the server" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="MLAPI.NetworkingManagerComponents" /><meta name="file" content="M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_CreatePool" /><meta name="guid" content="M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_CreatePool" /><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.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_NetworkingManagerComponents.htm" title="MLAPI.NetworkingManagerComponents" tocid="N_MLAPI_NetworkingManagerComponents">MLAPI.NetworkingManagerComponents</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/T_MLAPI_NetworkingManagerComponents_NetworkPoolManager.htm" title="NetworkPoolManager Class" tocid="T_MLAPI_NetworkingManagerComponents_NetworkPoolManager">NetworkPoolManager Class</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/Methods_T_MLAPI_NetworkingManagerComponents_NetworkPoolManager.htm" title="NetworkPoolManager Methods" tocid="Methods_T_MLAPI_NetworkingManagerComponents_NetworkPoolManager">NetworkPoolManager Methods</a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="../html/M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_CreatePool.htm" title="CreatePool Method " tocid="M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_CreatePool">CreatePool Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_DestroyPool.htm" title="DestroyPool Method " tocid="M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_DestroyPool">DestroyPool Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_DestroyPoolObject.htm" title="DestroyPoolObject Method " tocid="M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_DestroyPoolObject">DestroyPoolObject Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_SpawnPoolObject.htm" title="SpawnPoolObject Method " tocid="M_MLAPI_NetworkingManagerComponents_NetworkPoolManager_SpawnPoolObject">SpawnPoolObject Method </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>NetworkPoolManager<span id="LST7B02889A_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7B02889A_0?cpp=::|nu=.");</script>CreatePool Method </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">
Creates a networked object pool. Can only be called from the server
</div><p> </p>
<strong>Namespace:</strong>
 <a href="N_MLAPI_NetworkingManagerComponents.htm">MLAPI.NetworkingManagerComponents</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('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EACA');return false;" title="Copy">Copy</a></div></div><div id="ID0EACA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">CreatePool</span>(
<span class="identifier">string</span> <span class="parameter">poolName</span>,
<span class="identifier">int</span> <span class="parameter">spawnablePrefabIndex</span>,
<span class="identifier">uint</span> <span class="parameter">size</span> = 16
)</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EACA");</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/NetworkingManagerComponents/NetworkPoolManager.cs#L25" title="View the source code">View Source</a><h4 class="subHeading">Parameters</h4><dl><dt><span class="parameter">poolName</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">System<span id="LST7B02889A_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7B02889A_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>String</a><br />Name of the pool</dd><dt><span class="parameter">spawnablePrefabIndex</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/td2s409d" target="_blank">System<span id="LST7B02889A_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7B02889A_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Int32</a><br />The index of the prefab to use in the spawnablePrefabs array</dd><dt><span class="parameter">size</span> (Optional)</dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/ctys3981" target="_blank">System<span id="LST7B02889A_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7B02889A_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>UInt32</a><br />The amount of objects in the pool</dd></dl></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID2RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="T_MLAPI_NetworkingManagerComponents_NetworkPoolManager.htm">NetworkPoolManager Class</a></div><div class="seeAlsoStyle"><a href="N_MLAPI_NetworkingManagerComponents.htm">MLAPI.NetworkingManagerComponents Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>