Network.xml 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981
  1. <Type Name="Network" FullName="Urho.Network.Network">
  2. <TypeSignature Language="C#" Value="public class Network : Urho.UrhoObject" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Network extends Urho.UrhoObject" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.UrhoObject</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>Network subsystem. Manages client-server communications using the UDP protocol.
  14. </summary>
  15. <remarks>
  16. <para>Use the <see cref="T:Urho.Network.Network" /> subsystem to start a server, or to connect to a server.</para>
  17. <para />
  18. <para>To start a server, call the <see cref="M:Urho.Network.Network.StartServer" /> method, to connect to a server, use the <see cref="T:Urho.Network.Network.Connect" /> method.</para>
  19. </remarks>
  20. </Docs>
  21. <Members>
  22. <Member MemberName=".ctor">
  23. <MemberSignature Language="C#" Value="public Network ();" />
  24. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  25. <MemberType>Constructor</MemberType>
  26. <AssemblyInfo>
  27. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  28. </AssemblyInfo>
  29. <Attributes>
  30. <Attribute>
  31. <AttributeName>Preserve</AttributeName>
  32. </Attribute>
  33. </Attributes>
  34. <Parameters />
  35. <Docs>
  36. <summary>
  37. <para>Constructs a new instance of Urho.Network.Network which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  38. </summary>
  39. <remarks>
  40. </remarks>
  41. </Docs>
  42. </Member>
  43. <Member MemberName=".ctor">
  44. <MemberSignature Language="C#" Value="public Network (IntPtr handle);" />
  45. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  46. <MemberType>Constructor</MemberType>
  47. <AssemblyInfo>
  48. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  49. </AssemblyInfo>
  50. <Attributes>
  51. <Attribute>
  52. <AttributeName>Preserve</AttributeName>
  53. </Attribute>
  54. </Attributes>
  55. <Parameters>
  56. <Parameter Name="handle" Type="System.IntPtr" />
  57. </Parameters>
  58. <Docs>
  59. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  60. <summary>Constructs a new instance of Urho.Network.Network, given a raw pointer to an unmanaged object</summary>
  61. <remarks>
  62. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  63. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  64. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  65. </remarks>
  66. </Docs>
  67. </Member>
  68. <Member MemberName=".ctor">
  69. <MemberSignature Language="C#" Value="public Network (Urho.Context context);" />
  70. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  71. <MemberType>Constructor</MemberType>
  72. <AssemblyInfo>
  73. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  74. </AssemblyInfo>
  75. <Attributes>
  76. <Attribute>
  77. <AttributeName>Preserve</AttributeName>
  78. </Attribute>
  79. </Attributes>
  80. <Parameters>
  81. <Parameter Name="context" Type="Urho.Context" />
  82. </Parameters>
  83. <Docs>
  84. <param name="context">The context that this object will be attached to.</param>
  85. <summary>
  86. <para>Constructs a new instance of Urho.Network.Network linked to a specific <see cref="T:Urho.Context" />.</para>
  87. </summary>
  88. <remarks>
  89. </remarks>
  90. </Docs>
  91. </Member>
  92. <Member MemberName=".ctor">
  93. <MemberSignature Language="C#" Value="protected Network (Urho.UrhoObjectFlag emptyFlag);" />
  94. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  95. <MemberType>Constructor</MemberType>
  96. <AssemblyInfo>
  97. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  98. </AssemblyInfo>
  99. <Attributes>
  100. <Attribute>
  101. <AttributeName>Preserve</AttributeName>
  102. </Attribute>
  103. </Attributes>
  104. <Parameters>
  105. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  106. </Parameters>
  107. <Docs>
  108. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  109. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  110. <remarks>
  111. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  112. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  113. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  114. </remarks>
  115. </Docs>
  116. </Member>
  117. <Member MemberName="BroadcastMessage">
  118. <MemberSignature Language="C#" Value="public void BroadcastMessage (int msgID, bool reliable, bool inOrder, byte* data, uint numBytes, uint contentID = 0);" />
  119. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void BroadcastMessage(int32 msgID, bool reliable, bool inOrder, unsigned int8* data, unsigned int32 numBytes, unsigned int32 contentID) cil managed" />
  120. <MemberType>Method</MemberType>
  121. <AssemblyInfo>
  122. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  123. </AssemblyInfo>
  124. <ReturnValue>
  125. <ReturnType>System.Void</ReturnType>
  126. </ReturnValue>
  127. <Parameters>
  128. <Parameter Name="msgID" Type="System.Int32" />
  129. <Parameter Name="reliable" Type="System.Boolean" />
  130. <Parameter Name="inOrder" Type="System.Boolean" />
  131. <Parameter Name="data" Type="System.Byte*" />
  132. <Parameter Name="numBytes" Type="System.UInt32" />
  133. <Parameter Name="contentID" Type="System.UInt32" />
  134. </Parameters>
  135. <Docs>
  136. <param name="msgID">To be added.</param>
  137. <param name="reliable">To be added.</param>
  138. <param name="inOrder">To be added.</param>
  139. <param name="data">To be added.</param>
  140. <param name="numBytes">To be added.</param>
  141. <param name="contentID">To be added.</param>
  142. <summary>
  143. Broadcast a message with content ID to all client connections.
  144. </summary>
  145. <remarks>To be added.</remarks>
  146. </Docs>
  147. </Member>
  148. <Member MemberName="CheckRemoteEvent">
  149. <MemberSignature Language="C#" Value="public bool CheckRemoteEvent (Urho.StringHash eventType);" />
  150. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool CheckRemoteEvent(valuetype Urho.StringHash eventType) cil managed" />
  151. <MemberType>Method</MemberType>
  152. <AssemblyInfo>
  153. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  154. </AssemblyInfo>
  155. <ReturnValue>
  156. <ReturnType>System.Boolean</ReturnType>
  157. </ReturnValue>
  158. <Parameters>
  159. <Parameter Name="eventType" Type="Urho.StringHash" />
  160. </Parameters>
  161. <Docs>
  162. <param name="eventType">To be added.</param>
  163. <summary>
  164. Return whether a remote event is allowed to be received.
  165. </summary>
  166. <returns>To be added.</returns>
  167. <remarks>To be added.</remarks>
  168. </Docs>
  169. </Member>
  170. <Member MemberName="ClientConnected">
  171. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.ClientConnectedEventArgs&gt; ClientConnected;" />
  172. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.ClientConnectedEventArgs&gt; ClientConnected" />
  173. <MemberType>Event</MemberType>
  174. <AssemblyInfo>
  175. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  176. </AssemblyInfo>
  177. <ReturnValue>
  178. <ReturnType>System.Action&lt;Urho.Network.ClientConnectedEventArgs&gt;</ReturnType>
  179. </ReturnValue>
  180. <Docs>
  181. <summary>To be added.</summary>
  182. <remarks>
  183. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToClientConnected" /> method. That one will force that callback and will ignore any previously set events here.</para>
  184. </remarks>
  185. </Docs>
  186. </Member>
  187. <Member MemberName="ClientDisconnected">
  188. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.ClientDisconnectedEventArgs&gt; ClientDisconnected;" />
  189. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.ClientDisconnectedEventArgs&gt; ClientDisconnected" />
  190. <MemberType>Event</MemberType>
  191. <AssemblyInfo>
  192. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  193. </AssemblyInfo>
  194. <ReturnValue>
  195. <ReturnType>System.Action&lt;Urho.Network.ClientDisconnectedEventArgs&gt;</ReturnType>
  196. </ReturnValue>
  197. <Docs>
  198. <summary>To be added.</summary>
  199. <remarks>
  200. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToClientDisconnected" /> method. That one will force that callback and will ignore any previously set events here.</para>
  201. </remarks>
  202. </Docs>
  203. </Member>
  204. <Member MemberName="Connect">
  205. <MemberSignature Language="C#" Value="public bool Connect (string address, short port, Urho.Scene scene);" />
  206. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Connect(string address, int16 port, class Urho.Scene scene) cil managed" />
  207. <MemberType>Method</MemberType>
  208. <AssemblyInfo>
  209. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  210. </AssemblyInfo>
  211. <ReturnValue>
  212. <ReturnType>System.Boolean</ReturnType>
  213. </ReturnValue>
  214. <Parameters>
  215. <Parameter Name="address" Type="System.String" />
  216. <Parameter Name="port" Type="System.Int16" />
  217. <Parameter Name="scene" Type="Urho.Scene" />
  218. </Parameters>
  219. <Docs>
  220. <param name="address">To be added.</param>
  221. <param name="port">To be added.</param>
  222. <param name="scene">To be added.</param>
  223. <summary>To be added.</summary>
  224. <returns>To be added.</returns>
  225. <remarks>To be added.</remarks>
  226. </Docs>
  227. </Member>
  228. <Member MemberName="ConnectFailed">
  229. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.ConnectFailedEventArgs&gt; ConnectFailed;" />
  230. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.ConnectFailedEventArgs&gt; ConnectFailed" />
  231. <MemberType>Event</MemberType>
  232. <AssemblyInfo>
  233. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  234. </AssemblyInfo>
  235. <ReturnValue>
  236. <ReturnType>System.Action&lt;Urho.Network.ConnectFailedEventArgs&gt;</ReturnType>
  237. </ReturnValue>
  238. <Docs>
  239. <summary>To be added.</summary>
  240. <remarks>
  241. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToConnectFailed" /> method. That one will force that callback and will ignore any previously set events here.</para>
  242. </remarks>
  243. </Docs>
  244. </Member>
  245. <Member MemberName="Disconnect">
  246. <MemberSignature Language="C#" Value="public void Disconnect (int waitMSec = 0);" />
  247. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Disconnect(int32 waitMSec) cil managed" />
  248. <MemberType>Method</MemberType>
  249. <AssemblyInfo>
  250. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  251. </AssemblyInfo>
  252. <ReturnValue>
  253. <ReturnType>System.Void</ReturnType>
  254. </ReturnValue>
  255. <Parameters>
  256. <Parameter Name="waitMSec" Type="System.Int32" />
  257. </Parameters>
  258. <Docs>
  259. <param name="waitMSec">To be added.</param>
  260. <summary>
  261. Disconnect the connection to the server. If wait time is non-zero, will block while waiting for disconnect to finish.
  262. </summary>
  263. <remarks>To be added.</remarks>
  264. </Docs>
  265. </Member>
  266. <Member MemberName="NetworkMessage">
  267. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.NetworkMessageEventArgs&gt; NetworkMessage;" />
  268. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.NetworkMessageEventArgs&gt; NetworkMessage" />
  269. <MemberType>Event</MemberType>
  270. <AssemblyInfo>
  271. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  272. </AssemblyInfo>
  273. <ReturnValue>
  274. <ReturnType>System.Action&lt;Urho.Network.NetworkMessageEventArgs&gt;</ReturnType>
  275. </ReturnValue>
  276. <Docs>
  277. <summary>To be added.</summary>
  278. <remarks>
  279. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToNetworkMessage" /> method. That one will force that callback and will ignore any previously set events here.</para>
  280. </remarks>
  281. </Docs>
  282. </Member>
  283. <Member MemberName="NetworkSceneLoadFailed">
  284. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.NetworkSceneLoadFailedEventArgs&gt; NetworkSceneLoadFailed;" />
  285. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.NetworkSceneLoadFailedEventArgs&gt; NetworkSceneLoadFailed" />
  286. <MemberType>Event</MemberType>
  287. <AssemblyInfo>
  288. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  289. </AssemblyInfo>
  290. <ReturnValue>
  291. <ReturnType>System.Action&lt;Urho.Network.NetworkSceneLoadFailedEventArgs&gt;</ReturnType>
  292. </ReturnValue>
  293. <Docs>
  294. <summary>To be added.</summary>
  295. <remarks>
  296. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToNetworkSceneLoadFailed" /> method. That one will force that callback and will ignore any previously set events here.</para>
  297. </remarks>
  298. </Docs>
  299. </Member>
  300. <Member MemberName="NetworkUpdate">
  301. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.NetworkUpdateEventArgs&gt; NetworkUpdate;" />
  302. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.NetworkUpdateEventArgs&gt; NetworkUpdate" />
  303. <MemberType>Event</MemberType>
  304. <AssemblyInfo>
  305. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  306. </AssemblyInfo>
  307. <ReturnValue>
  308. <ReturnType>System.Action&lt;Urho.Network.NetworkUpdateEventArgs&gt;</ReturnType>
  309. </ReturnValue>
  310. <Docs>
  311. <summary>To be added.</summary>
  312. <remarks>
  313. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToNetworkUpdate" /> method. That one will force that callback and will ignore any previously set events here.</para>
  314. </remarks>
  315. </Docs>
  316. </Member>
  317. <Member MemberName="NetworkUpdateSent">
  318. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.NetworkUpdateSentEventArgs&gt; NetworkUpdateSent;" />
  319. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.NetworkUpdateSentEventArgs&gt; NetworkUpdateSent" />
  320. <MemberType>Event</MemberType>
  321. <AssemblyInfo>
  322. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  323. </AssemblyInfo>
  324. <ReturnValue>
  325. <ReturnType>System.Action&lt;Urho.Network.NetworkUpdateSentEventArgs&gt;</ReturnType>
  326. </ReturnValue>
  327. <Docs>
  328. <summary>To be added.</summary>
  329. <remarks>
  330. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToNetworkUpdateSent" /> method. That one will force that callback and will ignore any previously set events here.</para>
  331. </remarks>
  332. </Docs>
  333. </Member>
  334. <Member MemberName="PackageCacheDir">
  335. <MemberSignature Language="C#" Value="public string PackageCacheDir { get; set; }" />
  336. <MemberSignature Language="ILAsm" Value=".property instance string PackageCacheDir" />
  337. <MemberType>Property</MemberType>
  338. <AssemblyInfo>
  339. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  340. </AssemblyInfo>
  341. <ReturnValue>
  342. <ReturnType>System.String</ReturnType>
  343. </ReturnValue>
  344. <Docs>
  345. <summary>
  346. Return the package download cache directory.
  347. Or
  348. Set the package download cache directory.
  349. </summary>
  350. <value>To be added.</value>
  351. <remarks>To be added.</remarks>
  352. </Docs>
  353. </Member>
  354. <Member MemberName="PostUpdate">
  355. <MemberSignature Language="C#" Value="public void PostUpdate (float timeStep);" />
  356. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void PostUpdate(float32 timeStep) cil managed" />
  357. <MemberType>Method</MemberType>
  358. <AssemblyInfo>
  359. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  360. </AssemblyInfo>
  361. <ReturnValue>
  362. <ReturnType>System.Void</ReturnType>
  363. </ReturnValue>
  364. <Parameters>
  365. <Parameter Name="timeStep" Type="System.Single" />
  366. </Parameters>
  367. <Docs>
  368. <param name="timeStep">To be added.</param>
  369. <summary>
  370. Send outgoing messages after frame logic. Called by HandleRenderUpdate.
  371. </summary>
  372. <remarks>To be added.</remarks>
  373. </Docs>
  374. </Member>
  375. <Member MemberName="RegisterRemoteEvent">
  376. <MemberSignature Language="C#" Value="public void RegisterRemoteEvent (Urho.StringHash eventType);" />
  377. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RegisterRemoteEvent(valuetype Urho.StringHash eventType) cil managed" />
  378. <MemberType>Method</MemberType>
  379. <AssemblyInfo>
  380. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  381. </AssemblyInfo>
  382. <ReturnValue>
  383. <ReturnType>System.Void</ReturnType>
  384. </ReturnValue>
  385. <Parameters>
  386. <Parameter Name="eventType" Type="Urho.StringHash" />
  387. </Parameters>
  388. <Docs>
  389. <param name="eventType">To be added.</param>
  390. <summary>
  391. Register a remote event as allowed to be received. There is also a fixed blacklist of events that can not be allowed in any case, such as ConsoleCommand.
  392. </summary>
  393. <remarks>To be added.</remarks>
  394. </Docs>
  395. </Member>
  396. <Member MemberName="SendPackageToClients">
  397. <MemberSignature Language="C#" Value="public void SendPackageToClients (Urho.Scene scene, Urho.IO.PackageFile package);" />
  398. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendPackageToClients(class Urho.Scene scene, class Urho.IO.PackageFile package) cil managed" />
  399. <MemberType>Method</MemberType>
  400. <AssemblyInfo>
  401. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  402. </AssemblyInfo>
  403. <ReturnValue>
  404. <ReturnType>System.Void</ReturnType>
  405. </ReturnValue>
  406. <Parameters>
  407. <Parameter Name="scene" Type="Urho.Scene" />
  408. <Parameter Name="package" Type="Urho.IO.PackageFile" />
  409. </Parameters>
  410. <Docs>
  411. <param name="scene">To be added.</param>
  412. <param name="package">To be added.</param>
  413. <summary>
  414. Trigger all client connections in the specified scene to download a package file from the server. Can be used to download additional resource packages when clients are already joined in the scene. The package must have been added as a requirement to the scene, or else the eventual download will fail.
  415. </summary>
  416. <remarks>To be added.</remarks>
  417. </Docs>
  418. </Member>
  419. <Member MemberName="ServerConnected">
  420. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.ServerConnectedEventArgs&gt; ServerConnected;" />
  421. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.ServerConnectedEventArgs&gt; ServerConnected" />
  422. <MemberType>Event</MemberType>
  423. <AssemblyInfo>
  424. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  425. </AssemblyInfo>
  426. <ReturnValue>
  427. <ReturnType>System.Action&lt;Urho.Network.ServerConnectedEventArgs&gt;</ReturnType>
  428. </ReturnValue>
  429. <Docs>
  430. <summary>To be added.</summary>
  431. <remarks>
  432. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToServerConnected" /> method. That one will force that callback and will ignore any previously set events here.</para>
  433. </remarks>
  434. </Docs>
  435. </Member>
  436. <Member MemberName="ServerConnection">
  437. <MemberSignature Language="C#" Value="public Urho.Network.Connection ServerConnection { get; }" />
  438. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Network.Connection ServerConnection" />
  439. <MemberType>Property</MemberType>
  440. <AssemblyInfo>
  441. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  442. </AssemblyInfo>
  443. <ReturnValue>
  444. <ReturnType>Urho.Network.Connection</ReturnType>
  445. </ReturnValue>
  446. <Docs>
  447. <summary>
  448. Return the connection to the server. Null if not connected.
  449. </summary>
  450. <value>To be added.</value>
  451. <remarks>To be added.</remarks>
  452. </Docs>
  453. </Member>
  454. <Member MemberName="ServerDisconnected">
  455. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.ServerDisconnectedEventArgs&gt; ServerDisconnected;" />
  456. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.ServerDisconnectedEventArgs&gt; ServerDisconnected" />
  457. <MemberType>Event</MemberType>
  458. <AssemblyInfo>
  459. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  460. </AssemblyInfo>
  461. <ReturnValue>
  462. <ReturnType>System.Action&lt;Urho.Network.ServerDisconnectedEventArgs&gt;</ReturnType>
  463. </ReturnValue>
  464. <Docs>
  465. <summary>To be added.</summary>
  466. <remarks>
  467. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToServerDisconnected" /> method. That one will force that callback and will ignore any previously set events here.</para>
  468. </remarks>
  469. </Docs>
  470. </Member>
  471. <Member MemberName="ServerRunning">
  472. <MemberSignature Language="C#" Value="public bool ServerRunning { get; }" />
  473. <MemberSignature Language="ILAsm" Value=".property instance bool ServerRunning" />
  474. <MemberType>Property</MemberType>
  475. <AssemblyInfo>
  476. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  477. </AssemblyInfo>
  478. <ReturnValue>
  479. <ReturnType>System.Boolean</ReturnType>
  480. </ReturnValue>
  481. <Docs>
  482. <summary>Return whether the server is running.</summary>
  483. <value>To be added.</value>
  484. <remarks>To be added.</remarks>
  485. </Docs>
  486. </Member>
  487. <Member MemberName="SimulatedLatency">
  488. <MemberSignature Language="C#" Value="public int SimulatedLatency { get; set; }" />
  489. <MemberSignature Language="ILAsm" Value=".property instance int32 SimulatedLatency" />
  490. <MemberType>Property</MemberType>
  491. <AssemblyInfo>
  492. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  493. </AssemblyInfo>
  494. <ReturnValue>
  495. <ReturnType>System.Int32</ReturnType>
  496. </ReturnValue>
  497. <Docs>
  498. <summary>
  499. Return simulated latency in milliseconds.
  500. Or
  501. Set simulated latency in milliseconds. This adds a fixed delay before sending each packet.
  502. </summary>
  503. <value>To be added.</value>
  504. <remarks>To be added.</remarks>
  505. </Docs>
  506. </Member>
  507. <Member MemberName="SimulatedPacketLoss">
  508. <MemberSignature Language="C#" Value="public float SimulatedPacketLoss { get; set; }" />
  509. <MemberSignature Language="ILAsm" Value=".property instance float32 SimulatedPacketLoss" />
  510. <MemberType>Property</MemberType>
  511. <AssemblyInfo>
  512. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  513. </AssemblyInfo>
  514. <ReturnValue>
  515. <ReturnType>System.Single</ReturnType>
  516. </ReturnValue>
  517. <Docs>
  518. <summary>
  519. Return simulated packet loss probability.
  520. Or
  521. Set simulated packet loss probability between 0.0 - 1.0.
  522. </summary>
  523. <value>To be added.</value>
  524. <remarks>To be added.</remarks>
  525. </Docs>
  526. </Member>
  527. <Member MemberName="StartServer">
  528. <MemberSignature Language="C#" Value="public bool StartServer (ushort port);" />
  529. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool StartServer(unsigned int16 port) cil managed" />
  530. <MemberType>Method</MemberType>
  531. <AssemblyInfo>
  532. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  533. </AssemblyInfo>
  534. <ReturnValue>
  535. <ReturnType>System.Boolean</ReturnType>
  536. </ReturnValue>
  537. <Parameters>
  538. <Parameter Name="port" Type="System.UInt16" />
  539. </Parameters>
  540. <Docs>
  541. <param name="port">To be added.</param>
  542. <summary>
  543. Start a server on a port using UDP protocol. Return true if successful.
  544. </summary>
  545. <returns>To be added.</returns>
  546. <remarks>To be added.</remarks>
  547. </Docs>
  548. </Member>
  549. <Member MemberName="StopServer">
  550. <MemberSignature Language="C#" Value="public void StopServer ();" />
  551. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void StopServer() cil managed" />
  552. <MemberType>Method</MemberType>
  553. <AssemblyInfo>
  554. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  555. </AssemblyInfo>
  556. <ReturnValue>
  557. <ReturnType>System.Void</ReturnType>
  558. </ReturnValue>
  559. <Parameters />
  560. <Docs>
  561. <summary>
  562. Stop the server.
  563. </summary>
  564. <remarks>To be added.</remarks>
  565. </Docs>
  566. </Member>
  567. <Member MemberName="SubscribeToClientConnected">
  568. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToClientConnected (Action&lt;Urho.Network.ClientConnectedEventArgs&gt; handler);" />
  569. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToClientConnected(class System.Action`1&lt;valuetype Urho.Network.ClientConnectedEventArgs&gt; handler) cil managed" />
  570. <MemberType>Method</MemberType>
  571. <AssemblyInfo>
  572. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  573. </AssemblyInfo>
  574. <Attributes>
  575. <Attribute>
  576. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ClientConnected += ...' instead.")</AttributeName>
  577. </Attribute>
  578. </Attributes>
  579. <ReturnValue>
  580. <ReturnType>Urho.Subscription</ReturnType>
  581. </ReturnValue>
  582. <Parameters>
  583. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.ClientConnectedEventArgs&gt;" />
  584. </Parameters>
  585. <Docs>
  586. <param name="handler">The handler to invoke when this event is raised.</param>
  587. <summary>Subscribes to the ClientConnected event raised by the Network.</summary>
  588. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  589. <remarks>
  590. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  591. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  592. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Network.ClientConnected" /> event.</para>
  593. </remarks>
  594. </Docs>
  595. </Member>
  596. <Member MemberName="SubscribeToClientDisconnected">
  597. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToClientDisconnected (Action&lt;Urho.Network.ClientDisconnectedEventArgs&gt; handler);" />
  598. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToClientDisconnected(class System.Action`1&lt;valuetype Urho.Network.ClientDisconnectedEventArgs&gt; handler) cil managed" />
  599. <MemberType>Method</MemberType>
  600. <AssemblyInfo>
  601. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  602. </AssemblyInfo>
  603. <Attributes>
  604. <Attribute>
  605. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ClientDisconnected += ...' instead.")</AttributeName>
  606. </Attribute>
  607. </Attributes>
  608. <ReturnValue>
  609. <ReturnType>Urho.Subscription</ReturnType>
  610. </ReturnValue>
  611. <Parameters>
  612. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.ClientDisconnectedEventArgs&gt;" />
  613. </Parameters>
  614. <Docs>
  615. <param name="handler">The handler to invoke when this event is raised.</param>
  616. <summary>Subscribes to the ClientDisconnected event raised by the Network.</summary>
  617. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  618. <remarks>
  619. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  620. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  621. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Network.ClientDisconnected" /> event.</para>
  622. </remarks>
  623. </Docs>
  624. </Member>
  625. <Member MemberName="SubscribeToConnectFailed">
  626. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToConnectFailed (Action&lt;Urho.Network.ConnectFailedEventArgs&gt; handler);" />
  627. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToConnectFailed(class System.Action`1&lt;valuetype Urho.Network.ConnectFailedEventArgs&gt; handler) cil managed" />
  628. <MemberType>Method</MemberType>
  629. <AssemblyInfo>
  630. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  631. </AssemblyInfo>
  632. <Attributes>
  633. <Attribute>
  634. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ConnectFailed += ...' instead.")</AttributeName>
  635. </Attribute>
  636. </Attributes>
  637. <ReturnValue>
  638. <ReturnType>Urho.Subscription</ReturnType>
  639. </ReturnValue>
  640. <Parameters>
  641. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.ConnectFailedEventArgs&gt;" />
  642. </Parameters>
  643. <Docs>
  644. <param name="handler">The handler to invoke when this event is raised.</param>
  645. <summary>Subscribes to the ConnectFailed event raised by the Network.</summary>
  646. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  647. <remarks>
  648. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  649. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  650. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Network.ConnectFailed" /> event.</para>
  651. </remarks>
  652. </Docs>
  653. </Member>
  654. <Member MemberName="SubscribeToNetworkMessage">
  655. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToNetworkMessage (Action&lt;Urho.Network.NetworkMessageEventArgs&gt; handler);" />
  656. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToNetworkMessage(class System.Action`1&lt;valuetype Urho.Network.NetworkMessageEventArgs&gt; handler) cil managed" />
  657. <MemberType>Method</MemberType>
  658. <AssemblyInfo>
  659. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  660. </AssemblyInfo>
  661. <Attributes>
  662. <Attribute>
  663. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.NetworkMessage += ...' instead.")</AttributeName>
  664. </Attribute>
  665. </Attributes>
  666. <ReturnValue>
  667. <ReturnType>Urho.Subscription</ReturnType>
  668. </ReturnValue>
  669. <Parameters>
  670. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.NetworkMessageEventArgs&gt;" />
  671. </Parameters>
  672. <Docs>
  673. <param name="handler">The handler to invoke when this event is raised.</param>
  674. <summary>Subscribes to the NetworkMessage event raised by the Network.</summary>
  675. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  676. <remarks>
  677. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  678. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  679. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Network.NetworkMessage" /> event.</para>
  680. </remarks>
  681. </Docs>
  682. </Member>
  683. <Member MemberName="SubscribeToNetworkSceneLoadFailed">
  684. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToNetworkSceneLoadFailed (Action&lt;Urho.Network.NetworkSceneLoadFailedEventArgs&gt; handler);" />
  685. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToNetworkSceneLoadFailed(class System.Action`1&lt;valuetype Urho.Network.NetworkSceneLoadFailedEventArgs&gt; handler) cil managed" />
  686. <MemberType>Method</MemberType>
  687. <AssemblyInfo>
  688. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  689. </AssemblyInfo>
  690. <Attributes>
  691. <Attribute>
  692. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.NetworkSceneLoadFailed += ...' instead.")</AttributeName>
  693. </Attribute>
  694. </Attributes>
  695. <ReturnValue>
  696. <ReturnType>Urho.Subscription</ReturnType>
  697. </ReturnValue>
  698. <Parameters>
  699. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.NetworkSceneLoadFailedEventArgs&gt;" />
  700. </Parameters>
  701. <Docs>
  702. <param name="handler">The handler to invoke when this event is raised.</param>
  703. <summary>Subscribes to the NetworkSceneLoadFailed event raised by the Network.</summary>
  704. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  705. <remarks>
  706. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  707. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  708. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Network.NetworkSceneLoadFailed" /> event.</para>
  709. </remarks>
  710. </Docs>
  711. </Member>
  712. <Member MemberName="SubscribeToNetworkUpdate">
  713. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToNetworkUpdate (Action&lt;Urho.Network.NetworkUpdateEventArgs&gt; handler);" />
  714. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToNetworkUpdate(class System.Action`1&lt;valuetype Urho.Network.NetworkUpdateEventArgs&gt; handler) cil managed" />
  715. <MemberType>Method</MemberType>
  716. <AssemblyInfo>
  717. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  718. </AssemblyInfo>
  719. <Attributes>
  720. <Attribute>
  721. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.NetworkUpdate += ...' instead.")</AttributeName>
  722. </Attribute>
  723. </Attributes>
  724. <ReturnValue>
  725. <ReturnType>Urho.Subscription</ReturnType>
  726. </ReturnValue>
  727. <Parameters>
  728. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.NetworkUpdateEventArgs&gt;" />
  729. </Parameters>
  730. <Docs>
  731. <param name="handler">The handler to invoke when this event is raised.</param>
  732. <summary>Subscribes to the NetworkUpdate event raised by the Network.</summary>
  733. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  734. <remarks>
  735. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  736. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  737. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Network.NetworkUpdate" /> event.</para>
  738. </remarks>
  739. </Docs>
  740. </Member>
  741. <Member MemberName="SubscribeToNetworkUpdateSent">
  742. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToNetworkUpdateSent (Action&lt;Urho.Network.NetworkUpdateSentEventArgs&gt; handler);" />
  743. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToNetworkUpdateSent(class System.Action`1&lt;valuetype Urho.Network.NetworkUpdateSentEventArgs&gt; handler) cil managed" />
  744. <MemberType>Method</MemberType>
  745. <AssemblyInfo>
  746. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  747. </AssemblyInfo>
  748. <Attributes>
  749. <Attribute>
  750. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.NetworkUpdateSent += ...' instead.")</AttributeName>
  751. </Attribute>
  752. </Attributes>
  753. <ReturnValue>
  754. <ReturnType>Urho.Subscription</ReturnType>
  755. </ReturnValue>
  756. <Parameters>
  757. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.NetworkUpdateSentEventArgs&gt;" />
  758. </Parameters>
  759. <Docs>
  760. <param name="handler">The handler to invoke when this event is raised.</param>
  761. <summary>Subscribes to the NetworkUpdateSent event raised by the Network.</summary>
  762. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  763. <remarks>
  764. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  765. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  766. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Network.NetworkUpdateSent" /> event.</para>
  767. </remarks>
  768. </Docs>
  769. </Member>
  770. <Member MemberName="SubscribeToServerConnected">
  771. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToServerConnected (Action&lt;Urho.Network.ServerConnectedEventArgs&gt; handler);" />
  772. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToServerConnected(class System.Action`1&lt;valuetype Urho.Network.ServerConnectedEventArgs&gt; handler) cil managed" />
  773. <MemberType>Method</MemberType>
  774. <AssemblyInfo>
  775. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  776. </AssemblyInfo>
  777. <Attributes>
  778. <Attribute>
  779. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ServerConnected += ...' instead.")</AttributeName>
  780. </Attribute>
  781. </Attributes>
  782. <ReturnValue>
  783. <ReturnType>Urho.Subscription</ReturnType>
  784. </ReturnValue>
  785. <Parameters>
  786. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.ServerConnectedEventArgs&gt;" />
  787. </Parameters>
  788. <Docs>
  789. <param name="handler">The handler to invoke when this event is raised.</param>
  790. <summary>Subscribes to the ServerConnected event raised by the Network.</summary>
  791. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  792. <remarks>
  793. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  794. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  795. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Network.ServerConnected" /> event.</para>
  796. </remarks>
  797. </Docs>
  798. </Member>
  799. <Member MemberName="SubscribeToServerDisconnected">
  800. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToServerDisconnected (Action&lt;Urho.Network.ServerDisconnectedEventArgs&gt; handler);" />
  801. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToServerDisconnected(class System.Action`1&lt;valuetype Urho.Network.ServerDisconnectedEventArgs&gt; handler) cil managed" />
  802. <MemberType>Method</MemberType>
  803. <AssemblyInfo>
  804. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  805. </AssemblyInfo>
  806. <Attributes>
  807. <Attribute>
  808. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ServerDisconnected += ...' instead.")</AttributeName>
  809. </Attribute>
  810. </Attributes>
  811. <ReturnValue>
  812. <ReturnType>Urho.Subscription</ReturnType>
  813. </ReturnValue>
  814. <Parameters>
  815. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.ServerDisconnectedEventArgs&gt;" />
  816. </Parameters>
  817. <Docs>
  818. <param name="handler">The handler to invoke when this event is raised.</param>
  819. <summary>Subscribes to the ServerDisconnected event raised by the Network.</summary>
  820. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  821. <remarks>
  822. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  823. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  824. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Network.ServerDisconnected" /> event.</para>
  825. </remarks>
  826. </Docs>
  827. </Member>
  828. <Member MemberName="Type">
  829. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  830. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  831. <MemberType>Property</MemberType>
  832. <AssemblyInfo>
  833. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  834. </AssemblyInfo>
  835. <ReturnValue>
  836. <ReturnType>Urho.StringHash</ReturnType>
  837. </ReturnValue>
  838. <Docs>
  839. <summary>Urho's type system type.</summary>
  840. <value>StringHash representing the type for this C# type.</value>
  841. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  842. </Docs>
  843. </Member>
  844. <Member MemberName="TypeName">
  845. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  846. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  847. <MemberType>Property</MemberType>
  848. <AssemblyInfo>
  849. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  850. </AssemblyInfo>
  851. <ReturnValue>
  852. <ReturnType>System.String</ReturnType>
  853. </ReturnValue>
  854. <Docs>
  855. <summary>Urho's low-level type name.</summary>
  856. <value>Stringified low-level type name.</value>
  857. <remarks>
  858. </remarks>
  859. </Docs>
  860. </Member>
  861. <Member MemberName="TypeNameStatic">
  862. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  863. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  864. <MemberType>Property</MemberType>
  865. <AssemblyInfo>
  866. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  867. </AssemblyInfo>
  868. <ReturnValue>
  869. <ReturnType>System.String</ReturnType>
  870. </ReturnValue>
  871. <Docs>
  872. <summary>Urho's low-level type name, accessible as a static method.</summary>
  873. <value>Stringified low-level type name.</value>
  874. <remarks>
  875. </remarks>
  876. </Docs>
  877. </Member>
  878. <Member MemberName="TypeStatic">
  879. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  880. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  881. <MemberType>Property</MemberType>
  882. <AssemblyInfo>
  883. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  884. </AssemblyInfo>
  885. <Attributes>
  886. <Attribute>
  887. <AttributeName>Preserve</AttributeName>
  888. </Attribute>
  889. </Attributes>
  890. <ReturnValue>
  891. <ReturnType>Urho.StringHash</ReturnType>
  892. </ReturnValue>
  893. <Docs>
  894. <summary>Urho's low-level type, accessible as a static method.</summary>
  895. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  896. <remarks>
  897. </remarks>
  898. </Docs>
  899. </Member>
  900. <Member MemberName="UnregisterAllRemoteEvents">
  901. <MemberSignature Language="C#" Value="public void UnregisterAllRemoteEvents ();" />
  902. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UnregisterAllRemoteEvents() cil managed" />
  903. <MemberType>Method</MemberType>
  904. <AssemblyInfo>
  905. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  906. </AssemblyInfo>
  907. <ReturnValue>
  908. <ReturnType>System.Void</ReturnType>
  909. </ReturnValue>
  910. <Parameters />
  911. <Docs>
  912. <summary>
  913. Unregister all remote events.
  914. </summary>
  915. <remarks>To be added.</remarks>
  916. </Docs>
  917. </Member>
  918. <Member MemberName="UnregisterRemoteEvent">
  919. <MemberSignature Language="C#" Value="public void UnregisterRemoteEvent (Urho.StringHash eventType);" />
  920. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UnregisterRemoteEvent(valuetype Urho.StringHash eventType) cil managed" />
  921. <MemberType>Method</MemberType>
  922. <AssemblyInfo>
  923. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  924. </AssemblyInfo>
  925. <ReturnValue>
  926. <ReturnType>System.Void</ReturnType>
  927. </ReturnValue>
  928. <Parameters>
  929. <Parameter Name="eventType" Type="Urho.StringHash" />
  930. </Parameters>
  931. <Docs>
  932. <param name="eventType">To be added.</param>
  933. <summary>
  934. Unregister a remote event as allowed to received.
  935. </summary>
  936. <remarks>To be added.</remarks>
  937. </Docs>
  938. </Member>
  939. <Member MemberName="Update">
  940. <MemberSignature Language="C#" Value="public void Update (float timeStep);" />
  941. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Update(float32 timeStep) cil managed" />
  942. <MemberType>Method</MemberType>
  943. <AssemblyInfo>
  944. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  945. </AssemblyInfo>
  946. <ReturnValue>
  947. <ReturnType>System.Void</ReturnType>
  948. </ReturnValue>
  949. <Parameters>
  950. <Parameter Name="timeStep" Type="System.Single" />
  951. </Parameters>
  952. <Docs>
  953. <param name="timeStep">To be added.</param>
  954. <summary>
  955. Process incoming messages from connections. Called by HandleBeginFrame.
  956. </summary>
  957. <remarks>To be added.</remarks>
  958. </Docs>
  959. </Member>
  960. <Member MemberName="UpdateFps">
  961. <MemberSignature Language="C#" Value="public int UpdateFps { get; set; }" />
  962. <MemberSignature Language="ILAsm" Value=".property instance int32 UpdateFps" />
  963. <MemberType>Property</MemberType>
  964. <AssemblyInfo>
  965. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  966. </AssemblyInfo>
  967. <ReturnValue>
  968. <ReturnType>System.Int32</ReturnType>
  969. </ReturnValue>
  970. <Docs>
  971. <summary>
  972. Return network update FPS.
  973. Or
  974. Set network update FPS.
  975. </summary>
  976. <value>To be added.</value>
  977. <remarks>To be added.</remarks>
  978. </Docs>
  979. </Member>
  980. </Members>
  981. </Type>