Network.xml 48 KB

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