Connection.xml 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814
  1. <Type Name="Connection" FullName="Urho.Network.Connection">
  2. <TypeSignature Language="C#" Value="public class Connection : Urho.UrhoObject" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Connection 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>Connection to a remote network host.
  14. </summary>
  15. <remarks>On the client, this object is retrieved after a successful connection from the <see cref="P:Urho.Network.Network.ServerConnection" /> property.   On the server, a new instance of this object is created for every connected client.</remarks>
  16. </Docs>
  17. <Members>
  18. <Member MemberName=".ctor">
  19. <MemberSignature Language="C#" Value="public Connection (IntPtr handle);" />
  20. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  21. <MemberType>Constructor</MemberType>
  22. <AssemblyInfo>
  23. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  24. </AssemblyInfo>
  25. <Parameters>
  26. <Parameter Name="handle" Type="System.IntPtr" />
  27. </Parameters>
  28. <Docs>
  29. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  30. <summary>Constructs a new instance of Urho.Network.Connection, given a raw pointer to an unmanaged object</summary>
  31. <remarks>
  32. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  33. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  34. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  35. </remarks>
  36. </Docs>
  37. </Member>
  38. <Member MemberName=".ctor">
  39. <MemberSignature Language="C#" Value="protected Connection (Urho.UrhoObjectFlag emptyFlag);" />
  40. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  41. <MemberType>Constructor</MemberType>
  42. <AssemblyInfo>
  43. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  44. </AssemblyInfo>
  45. <Parameters>
  46. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  47. </Parameters>
  48. <Docs>
  49. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  50. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  51. <remarks>
  52. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  53. <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>
  54. <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>
  55. </remarks>
  56. </Docs>
  57. </Member>
  58. <Member MemberName="Address">
  59. <MemberSignature Language="C#" Value="public string Address { get; }" />
  60. <MemberSignature Language="ILAsm" Value=".property instance string Address" />
  61. <MemberType>Property</MemberType>
  62. <AssemblyInfo>
  63. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  64. </AssemblyInfo>
  65. <ReturnValue>
  66. <ReturnType>System.String</ReturnType>
  67. </ReturnValue>
  68. <Docs>
  69. <summary>
  70. Return remote address.
  71. </summary>
  72. <value>To be added.</value>
  73. <remarks>To be added.</remarks>
  74. </Docs>
  75. </Member>
  76. <Member MemberName="BytesInPerSec">
  77. <MemberSignature Language="C#" Value="public float BytesInPerSec { get; }" />
  78. <MemberSignature Language="ILAsm" Value=".property instance float32 BytesInPerSec" />
  79. <MemberType>Property</MemberType>
  80. <AssemblyInfo>
  81. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  82. </AssemblyInfo>
  83. <ReturnValue>
  84. <ReturnType>System.Single</ReturnType>
  85. </ReturnValue>
  86. <Docs>
  87. <summary>
  88. Return bytes received per second.
  89. </summary>
  90. <value>To be added.</value>
  91. <remarks>To be added.</remarks>
  92. </Docs>
  93. </Member>
  94. <Member MemberName="BytesOutPerSec">
  95. <MemberSignature Language="C#" Value="public float BytesOutPerSec { get; }" />
  96. <MemberSignature Language="ILAsm" Value=".property instance float32 BytesOutPerSec" />
  97. <MemberType>Property</MemberType>
  98. <AssemblyInfo>
  99. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  100. </AssemblyInfo>
  101. <ReturnValue>
  102. <ReturnType>System.Single</ReturnType>
  103. </ReturnValue>
  104. <Docs>
  105. <summary>
  106. Return bytes sent per second.
  107. </summary>
  108. <value>To be added.</value>
  109. <remarks>To be added.</remarks>
  110. </Docs>
  111. </Member>
  112. <Member MemberName="Client">
  113. <MemberSignature Language="C#" Value="public bool Client { get; }" />
  114. <MemberSignature Language="ILAsm" Value=".property instance bool Client" />
  115. <MemberType>Property</MemberType>
  116. <AssemblyInfo>
  117. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  118. </AssemblyInfo>
  119. <ReturnValue>
  120. <ReturnType>System.Boolean</ReturnType>
  121. </ReturnValue>
  122. <Docs>
  123. <summary>Return whether is a client connection.</summary>
  124. <value>To be added.</value>
  125. <remarks>To be added.</remarks>
  126. </Docs>
  127. </Member>
  128. <Member MemberName="ClientIdentity">
  129. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.ClientIdentityEventArgs&gt; ClientIdentity;" />
  130. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.ClientIdentityEventArgs&gt; ClientIdentity" />
  131. <MemberType>Event</MemberType>
  132. <AssemblyInfo>
  133. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  134. </AssemblyInfo>
  135. <ReturnValue>
  136. <ReturnType>System.Action&lt;Urho.Network.ClientIdentityEventArgs&gt;</ReturnType>
  137. </ReturnValue>
  138. <Docs>
  139. <summary>Event raised on the server after the connection and contains the client identity information.   The default is to accept all connections.</summary>
  140. <remarks>
  141. <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.SubscribeToClientIdentity" /> method. That one will force that callback and will ignore any previously set events here.</para>
  142. </remarks>
  143. </Docs>
  144. </Member>
  145. <Member MemberName="ClientSceneLoaded">
  146. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Network.ClientSceneLoadedEventArgs&gt; ClientSceneLoaded;" />
  147. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Network.ClientSceneLoadedEventArgs&gt; ClientSceneLoaded" />
  148. <MemberType>Event</MemberType>
  149. <AssemblyInfo>
  150. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  151. </AssemblyInfo>
  152. <ReturnValue>
  153. <ReturnType>System.Action&lt;Urho.Network.ClientSceneLoadedEventArgs&gt;</ReturnType>
  154. </ReturnValue>
  155. <Docs>
  156. <summary>To be added.</summary>
  157. <remarks>
  158. <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.SubscribeToClientSceneLoaded" /> method. That one will force that callback and will ignore any previously set events here.</para>
  159. </remarks>
  160. </Docs>
  161. </Member>
  162. <Member MemberName="ConfigureNetworkSimulator">
  163. <MemberSignature Language="C#" Value="public void ConfigureNetworkSimulator (int latencyMs, float packetLoss);" />
  164. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ConfigureNetworkSimulator(int32 latencyMs, float32 packetLoss) cil managed" />
  165. <MemberType>Method</MemberType>
  166. <AssemblyInfo>
  167. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  168. </AssemblyInfo>
  169. <ReturnValue>
  170. <ReturnType>System.Void</ReturnType>
  171. </ReturnValue>
  172. <Parameters>
  173. <Parameter Name="latencyMs" Type="System.Int32" />
  174. <Parameter Name="packetLoss" Type="System.Single" />
  175. </Parameters>
  176. <Docs>
  177. <param name="latencyMs">To be added.</param>
  178. <param name="packetLoss">To be added.</param>
  179. <summary>
  180. Set network simulation parameters. Called by Network.
  181. </summary>
  182. <remarks>To be added.</remarks>
  183. </Docs>
  184. </Member>
  185. <Member MemberName="Connected">
  186. <MemberSignature Language="C#" Value="public bool Connected { get; }" />
  187. <MemberSignature Language="ILAsm" Value=".property instance bool Connected" />
  188. <MemberType>Property</MemberType>
  189. <AssemblyInfo>
  190. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  191. </AssemblyInfo>
  192. <ReturnValue>
  193. <ReturnType>System.Boolean</ReturnType>
  194. </ReturnValue>
  195. <Docs>
  196. <summary>Return whether is fully connected.</summary>
  197. <value>To be added.</value>
  198. <remarks>To be added.</remarks>
  199. </Docs>
  200. </Member>
  201. <Member MemberName="ConnectPending">
  202. <MemberSignature Language="C#" Value="public bool ConnectPending { get; set; }" />
  203. <MemberSignature Language="ILAsm" Value=".property instance bool ConnectPending" />
  204. <MemberType>Property</MemberType>
  205. <AssemblyInfo>
  206. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  207. </AssemblyInfo>
  208. <ReturnValue>
  209. <ReturnType>System.Boolean</ReturnType>
  210. </ReturnValue>
  211. <Docs>
  212. <summary>Return whether connection is pending.</summary>
  213. <value>To be added.</value>
  214. <remarks>To be added.</remarks>
  215. </Docs>
  216. </Member>
  217. <Member MemberName="Controls">
  218. <MemberSignature Language="C#" Value="public Urho.Controls Controls { get; set; }" />
  219. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Controls Controls" />
  220. <MemberType>Property</MemberType>
  221. <AssemblyInfo>
  222. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  223. </AssemblyInfo>
  224. <ReturnValue>
  225. <ReturnType>Urho.Controls</ReturnType>
  226. </ReturnValue>
  227. <Docs>
  228. <summary>To be added.</summary>
  229. <value>To be added.</value>
  230. <remarks>To be added.</remarks>
  231. </Docs>
  232. </Member>
  233. <Member MemberName="Disconnect">
  234. <MemberSignature Language="C#" Value="public void Disconnect (int waitMSec);" />
  235. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Disconnect(int32 waitMSec) cil managed" />
  236. <MemberType>Method</MemberType>
  237. <AssemblyInfo>
  238. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  239. </AssemblyInfo>
  240. <ReturnValue>
  241. <ReturnType>System.Void</ReturnType>
  242. </ReturnValue>
  243. <Parameters>
  244. <Parameter Name="waitMSec" Type="System.Int32" />
  245. </Parameters>
  246. <Docs>
  247. <param name="waitMSec">To be added.</param>
  248. <summary>
  249. Disconnect. If wait time is non-zero, will block while waiting for disconnect to finish.
  250. </summary>
  251. <remarks>To be added.</remarks>
  252. </Docs>
  253. </Member>
  254. <Member MemberName="DownloadName">
  255. <MemberSignature Language="C#" Value="public string DownloadName { get; }" />
  256. <MemberSignature Language="ILAsm" Value=".property instance string DownloadName" />
  257. <MemberType>Property</MemberType>
  258. <AssemblyInfo>
  259. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  260. </AssemblyInfo>
  261. <ReturnValue>
  262. <ReturnType>System.String</ReturnType>
  263. </ReturnValue>
  264. <Docs>
  265. <summary>
  266. Return name of current package download, or empty if no downloads.
  267. </summary>
  268. <value>To be added.</value>
  269. <remarks>To be added.</remarks>
  270. </Docs>
  271. </Member>
  272. <Member MemberName="DownloadProgress">
  273. <MemberSignature Language="C#" Value="public float DownloadProgress { get; }" />
  274. <MemberSignature Language="ILAsm" Value=".property instance float32 DownloadProgress" />
  275. <MemberType>Property</MemberType>
  276. <AssemblyInfo>
  277. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  278. </AssemblyInfo>
  279. <ReturnValue>
  280. <ReturnType>System.Single</ReturnType>
  281. </ReturnValue>
  282. <Docs>
  283. <summary>
  284. Return progress of current package download, or 1.0 if no downloads.
  285. </summary>
  286. <value>To be added.</value>
  287. <remarks>To be added.</remarks>
  288. </Docs>
  289. </Member>
  290. <Member MemberName="LastHeardTime">
  291. <MemberSignature Language="C#" Value="public float LastHeardTime { get; }" />
  292. <MemberSignature Language="ILAsm" Value=".property instance float32 LastHeardTime" />
  293. <MemberType>Property</MemberType>
  294. <AssemblyInfo>
  295. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  296. </AssemblyInfo>
  297. <ReturnValue>
  298. <ReturnType>System.Single</ReturnType>
  299. </ReturnValue>
  300. <Docs>
  301. <summary>
  302. Return the time since last received data from the remote host in milliseconds.
  303. </summary>
  304. <value>To be added.</value>
  305. <remarks>To be added.</remarks>
  306. </Docs>
  307. </Member>
  308. <Member MemberName="LogStatistics">
  309. <MemberSignature Language="C#" Value="public bool LogStatistics { get; set; }" />
  310. <MemberSignature Language="ILAsm" Value=".property instance bool LogStatistics" />
  311. <MemberType>Property</MemberType>
  312. <AssemblyInfo>
  313. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  314. </AssemblyInfo>
  315. <ReturnValue>
  316. <ReturnType>System.Boolean</ReturnType>
  317. </ReturnValue>
  318. <Docs>
  319. <summary>
  320. Return whether to log data in/out statistics.
  321. Or
  322. Set whether to log data in/out statistics.
  323. </summary>
  324. <value>To be added.</value>
  325. <remarks>To be added.</remarks>
  326. </Docs>
  327. </Member>
  328. <Member MemberName="NumDownloads">
  329. <MemberSignature Language="C#" Value="public uint NumDownloads { get; }" />
  330. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumDownloads" />
  331. <MemberType>Property</MemberType>
  332. <AssemblyInfo>
  333. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  334. </AssemblyInfo>
  335. <ReturnValue>
  336. <ReturnType>System.UInt32</ReturnType>
  337. </ReturnValue>
  338. <Docs>
  339. <summary>
  340. Return number of package downloads remaining.
  341. </summary>
  342. <value>To be added.</value>
  343. <remarks>To be added.</remarks>
  344. </Docs>
  345. </Member>
  346. <Member MemberName="PacketsInPerSec">
  347. <MemberSignature Language="C#" Value="public float PacketsInPerSec { get; }" />
  348. <MemberSignature Language="ILAsm" Value=".property instance float32 PacketsInPerSec" />
  349. <MemberType>Property</MemberType>
  350. <AssemblyInfo>
  351. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  352. </AssemblyInfo>
  353. <ReturnValue>
  354. <ReturnType>System.Single</ReturnType>
  355. </ReturnValue>
  356. <Docs>
  357. <summary>
  358. Return packets received per second.
  359. </summary>
  360. <value>To be added.</value>
  361. <remarks>To be added.</remarks>
  362. </Docs>
  363. </Member>
  364. <Member MemberName="PacketsOutPerSec">
  365. <MemberSignature Language="C#" Value="public float PacketsOutPerSec { get; }" />
  366. <MemberSignature Language="ILAsm" Value=".property instance float32 PacketsOutPerSec" />
  367. <MemberType>Property</MemberType>
  368. <AssemblyInfo>
  369. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  370. </AssemblyInfo>
  371. <ReturnValue>
  372. <ReturnType>System.Single</ReturnType>
  373. </ReturnValue>
  374. <Docs>
  375. <summary>
  376. Return packets sent per second.
  377. </summary>
  378. <value>To be added.</value>
  379. <remarks>To be added.</remarks>
  380. </Docs>
  381. </Member>
  382. <Member MemberName="Port">
  383. <MemberSignature Language="C#" Value="public ushort Port { get; }" />
  384. <MemberSignature Language="ILAsm" Value=".property instance unsigned int16 Port" />
  385. <MemberType>Property</MemberType>
  386. <AssemblyInfo>
  387. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  388. </AssemblyInfo>
  389. <ReturnValue>
  390. <ReturnType>System.UInt16</ReturnType>
  391. </ReturnValue>
  392. <Docs>
  393. <summary>
  394. Return remote port.
  395. </summary>
  396. <value>To be added.</value>
  397. <remarks>To be added.</remarks>
  398. </Docs>
  399. </Member>
  400. <Member MemberName="Position">
  401. <MemberSignature Language="C#" Value="public Urho.Vector3 Position { get; set; }" />
  402. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Vector3 Position" />
  403. <MemberType>Property</MemberType>
  404. <AssemblyInfo>
  405. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  406. </AssemblyInfo>
  407. <ReturnValue>
  408. <ReturnType>Urho.Vector3</ReturnType>
  409. </ReturnValue>
  410. <Docs>
  411. <summary>
  412. Return the observer position sent by the client for interest management.
  413. Or
  414. Set the observer position for interest management, to be sent to the server.
  415. </summary>
  416. <value>To be added.</value>
  417. <remarks>To be added.</remarks>
  418. </Docs>
  419. </Member>
  420. <Member MemberName="ProcessPendingLatestData">
  421. <MemberSignature Language="C#" Value="public void ProcessPendingLatestData ();" />
  422. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ProcessPendingLatestData() cil managed" />
  423. <MemberType>Method</MemberType>
  424. <AssemblyInfo>
  425. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  426. </AssemblyInfo>
  427. <ReturnValue>
  428. <ReturnType>System.Void</ReturnType>
  429. </ReturnValue>
  430. <Parameters />
  431. <Docs>
  432. <summary>
  433. Process pending latest data for nodes and components.
  434. </summary>
  435. <remarks>To be added.</remarks>
  436. </Docs>
  437. </Member>
  438. <Member MemberName="Rotation">
  439. <MemberSignature Language="C#" Value="public Urho.Quaternion Rotation { get; set; }" />
  440. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Quaternion Rotation" />
  441. <MemberType>Property</MemberType>
  442. <AssemblyInfo>
  443. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  444. </AssemblyInfo>
  445. <ReturnValue>
  446. <ReturnType>Urho.Quaternion</ReturnType>
  447. </ReturnValue>
  448. <Docs>
  449. <summary>
  450. Return the observer rotation sent by the client for interest management.
  451. Or
  452. Set the observer rotation for interest management, to be sent to the server. Note: not used by the NetworkPriority component.
  453. </summary>
  454. <value>To be added.</value>
  455. <remarks>To be added.</remarks>
  456. </Docs>
  457. </Member>
  458. <Member MemberName="RoundTripTime">
  459. <MemberSignature Language="C#" Value="public float RoundTripTime { get; }" />
  460. <MemberSignature Language="ILAsm" Value=".property instance float32 RoundTripTime" />
  461. <MemberType>Property</MemberType>
  462. <AssemblyInfo>
  463. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  464. </AssemblyInfo>
  465. <ReturnValue>
  466. <ReturnType>System.Single</ReturnType>
  467. </ReturnValue>
  468. <Docs>
  469. <summary>
  470. Return the connection's round trip time in milliseconds.
  471. </summary>
  472. <value>To be added.</value>
  473. <remarks>To be added.</remarks>
  474. </Docs>
  475. </Member>
  476. <Member MemberName="Scene">
  477. <MemberSignature Language="C#" Value="public Urho.Scene Scene { get; set; }" />
  478. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Scene Scene" />
  479. <MemberType>Property</MemberType>
  480. <AssemblyInfo>
  481. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  482. </AssemblyInfo>
  483. <ReturnValue>
  484. <ReturnType>Urho.Scene</ReturnType>
  485. </ReturnValue>
  486. <Docs>
  487. <summary>
  488. Return the scene used by this connection.
  489. Or
  490. Assign scene. On the server, this will cause the client to load it.
  491. </summary>
  492. <value>To be added.</value>
  493. <remarks>To be added.</remarks>
  494. </Docs>
  495. </Member>
  496. <Member MemberName="SceneLoaded">
  497. <MemberSignature Language="C#" Value="public bool SceneLoaded { get; }" />
  498. <MemberSignature Language="ILAsm" Value=".property instance bool SceneLoaded" />
  499. <MemberType>Property</MemberType>
  500. <AssemblyInfo>
  501. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  502. </AssemblyInfo>
  503. <ReturnValue>
  504. <ReturnType>System.Boolean</ReturnType>
  505. </ReturnValue>
  506. <Docs>
  507. <summary>Return whether the scene is loaded and ready to receive server updates.</summary>
  508. <value>To be added.</value>
  509. <remarks>To be added.</remarks>
  510. </Docs>
  511. </Member>
  512. <Member MemberName="SendClientUpdate">
  513. <MemberSignature Language="C#" Value="public void SendClientUpdate ();" />
  514. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendClientUpdate() cil managed" />
  515. <MemberType>Method</MemberType>
  516. <AssemblyInfo>
  517. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  518. </AssemblyInfo>
  519. <ReturnValue>
  520. <ReturnType>System.Void</ReturnType>
  521. </ReturnValue>
  522. <Parameters />
  523. <Docs>
  524. <summary>
  525. Send latest controls from the client. Called by Network.
  526. </summary>
  527. <remarks>To be added.</remarks>
  528. </Docs>
  529. </Member>
  530. <Member MemberName="SendMessage">
  531. <MemberSignature Language="C#" Value="public void SendMessage (int msgId, bool reliable, bool inOrder, byte[] buffer, uint contentId = 0);" />
  532. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendMessage(int32 msgId, bool reliable, bool inOrder, unsigned int8[] buffer, unsigned int32 contentId) cil managed" />
  533. <MemberType>Method</MemberType>
  534. <AssemblyInfo>
  535. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  536. </AssemblyInfo>
  537. <ReturnValue>
  538. <ReturnType>System.Void</ReturnType>
  539. </ReturnValue>
  540. <Parameters>
  541. <Parameter Name="msgId" Type="System.Int32" />
  542. <Parameter Name="reliable" Type="System.Boolean" />
  543. <Parameter Name="inOrder" Type="System.Boolean" />
  544. <Parameter Name="buffer" Type="System.Byte[]" />
  545. <Parameter Name="contentId" Type="System.UInt32" />
  546. </Parameters>
  547. <Docs>
  548. <param name="msgId">To be added.</param>
  549. <param name="reliable">To be added.</param>
  550. <param name="inOrder">To be added.</param>
  551. <param name="buffer">To be added.</param>
  552. <param name="contentId">To be added.</param>
  553. <summary>Sends a message over the connection.</summary>
  554. <remarks>To be added.</remarks>
  555. </Docs>
  556. </Member>
  557. <Member MemberName="SendMessage">
  558. <MemberSignature Language="C#" Value="public void SendMessage (int msgID, bool reliable, bool inOrder, byte* data, uint numBytes, uint contentID);" />
  559. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendMessage(int32 msgID, bool reliable, bool inOrder, unsigned int8* data, unsigned int32 numBytes, unsigned int32 contentID) cil managed" />
  560. <MemberType>Method</MemberType>
  561. <AssemblyInfo>
  562. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  563. </AssemblyInfo>
  564. <ReturnValue>
  565. <ReturnType>System.Void</ReturnType>
  566. </ReturnValue>
  567. <Parameters>
  568. <Parameter Name="msgID" Type="System.Int32" />
  569. <Parameter Name="reliable" Type="System.Boolean" />
  570. <Parameter Name="inOrder" Type="System.Boolean" />
  571. <Parameter Name="data" Type="System.Byte*" />
  572. <Parameter Name="numBytes" Type="System.UInt32" />
  573. <Parameter Name="contentID" Type="System.UInt32" />
  574. </Parameters>
  575. <Docs>
  576. <param name="msgID">To be added.</param>
  577. <param name="reliable">To be added.</param>
  578. <param name="inOrder">To be added.</param>
  579. <param name="data">To be added.</param>
  580. <param name="numBytes">To be added.</param>
  581. <param name="contentID">To be added.</param>
  582. <summary>Sends a message over the connection.</summary>
  583. <remarks>To be added.</remarks>
  584. </Docs>
  585. </Member>
  586. <Member MemberName="SendPackages">
  587. <MemberSignature Language="C#" Value="public void SendPackages ();" />
  588. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendPackages() cil managed" />
  589. <MemberType>Method</MemberType>
  590. <AssemblyInfo>
  591. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  592. </AssemblyInfo>
  593. <ReturnValue>
  594. <ReturnType>System.Void</ReturnType>
  595. </ReturnValue>
  596. <Parameters />
  597. <Docs>
  598. <summary>
  599. Send package files to client. Called by network.
  600. </summary>
  601. <remarks>To be added.</remarks>
  602. </Docs>
  603. </Member>
  604. <Member MemberName="SendPackageToClient">
  605. <MemberSignature Language="C#" Value="public void SendPackageToClient (Urho.IO.PackageFile package);" />
  606. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendPackageToClient(class Urho.IO.PackageFile package) cil managed" />
  607. <MemberType>Method</MemberType>
  608. <AssemblyInfo>
  609. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  610. </AssemblyInfo>
  611. <ReturnValue>
  612. <ReturnType>System.Void</ReturnType>
  613. </ReturnValue>
  614. <Parameters>
  615. <Parameter Name="package" Type="Urho.IO.PackageFile" />
  616. </Parameters>
  617. <Docs>
  618. <param name="package">To be added.</param>
  619. <summary>
  620. Trigger client connection to download a package file from the server. Can be used to download additional resource packages when client is already joined in a scene. The package must have been added as a requirement to the scene the client is joined in, or else the eventual download will fail.
  621. </summary>
  622. <remarks>To be added.</remarks>
  623. </Docs>
  624. </Member>
  625. <Member MemberName="SendRemoteEvents">
  626. <MemberSignature Language="C#" Value="public void SendRemoteEvents ();" />
  627. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendRemoteEvents() cil managed" />
  628. <MemberType>Method</MemberType>
  629. <AssemblyInfo>
  630. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  631. </AssemblyInfo>
  632. <ReturnValue>
  633. <ReturnType>System.Void</ReturnType>
  634. </ReturnValue>
  635. <Parameters />
  636. <Docs>
  637. <summary>
  638. Send queued remote events. Called by Network.
  639. </summary>
  640. <remarks>To be added.</remarks>
  641. </Docs>
  642. </Member>
  643. <Member MemberName="SendServerUpdate">
  644. <MemberSignature Language="C#" Value="public void SendServerUpdate ();" />
  645. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendServerUpdate() cil managed" />
  646. <MemberType>Method</MemberType>
  647. <AssemblyInfo>
  648. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  649. </AssemblyInfo>
  650. <ReturnValue>
  651. <ReturnType>System.Void</ReturnType>
  652. </ReturnValue>
  653. <Parameters />
  654. <Docs>
  655. <summary>
  656. Send scene update messages. Called by Network.
  657. </summary>
  658. <remarks>To be added.</remarks>
  659. </Docs>
  660. </Member>
  661. <Member MemberName="SubscribeToClientIdentity">
  662. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToClientIdentity (Action&lt;Urho.Network.ClientIdentityEventArgs&gt; handler);" />
  663. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToClientIdentity(class System.Action`1&lt;valuetype Urho.Network.ClientIdentityEventArgs&gt; handler) cil managed" />
  664. <MemberType>Method</MemberType>
  665. <AssemblyInfo>
  666. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  667. </AssemblyInfo>
  668. <ReturnValue>
  669. <ReturnType>Urho.Subscription</ReturnType>
  670. </ReturnValue>
  671. <Parameters>
  672. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.ClientIdentityEventArgs&gt;" />
  673. </Parameters>
  674. <Docs>
  675. <param name="handler">The handler to invoke when this event is raised.</param>
  676. <summary>Subscribes to the ClientIdentity event raised by the Connection.</summary>
  677. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  678. <remarks>
  679. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  680. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  681. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Connection.ClientIdentity" /> event.</para>
  682. </remarks>
  683. </Docs>
  684. </Member>
  685. <Member MemberName="SubscribeToClientSceneLoaded">
  686. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToClientSceneLoaded (Action&lt;Urho.Network.ClientSceneLoadedEventArgs&gt; handler);" />
  687. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToClientSceneLoaded(class System.Action`1&lt;valuetype Urho.Network.ClientSceneLoadedEventArgs&gt; handler) cil managed" />
  688. <MemberType>Method</MemberType>
  689. <AssemblyInfo>
  690. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  691. </AssemblyInfo>
  692. <ReturnValue>
  693. <ReturnType>Urho.Subscription</ReturnType>
  694. </ReturnValue>
  695. <Parameters>
  696. <Parameter Name="handler" Type="System.Action&lt;Urho.Network.ClientSceneLoadedEventArgs&gt;" />
  697. </Parameters>
  698. <Docs>
  699. <param name="handler">The handler to invoke when this event is raised.</param>
  700. <summary>Subscribes to the ClientSceneLoaded event raised by the Connection.</summary>
  701. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  702. <remarks>
  703. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  704. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  705. <para>For a more event-like approach, use the <see cref="E:Urho.Network.Connection.ClientSceneLoaded" /> event.</para>
  706. </remarks>
  707. </Docs>
  708. </Member>
  709. <Member MemberName="TimeStamp">
  710. <MemberSignature Language="C#" Value="public byte TimeStamp { get; }" />
  711. <MemberSignature Language="ILAsm" Value=".property instance unsigned int8 TimeStamp" />
  712. <MemberType>Property</MemberType>
  713. <AssemblyInfo>
  714. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  715. </AssemblyInfo>
  716. <ReturnValue>
  717. <ReturnType>System.Byte</ReturnType>
  718. </ReturnValue>
  719. <Docs>
  720. <summary>
  721. Return the controls timestamp, sent from client to server along each control update.
  722. </summary>
  723. <value>To be added.</value>
  724. <remarks>To be added.</remarks>
  725. </Docs>
  726. </Member>
  727. <Member MemberName="ToDebugString">
  728. <MemberSignature Language="C#" Value="public string ToDebugString ();" />
  729. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ToDebugString() cil managed" />
  730. <MemberType>Method</MemberType>
  731. <AssemblyInfo>
  732. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  733. </AssemblyInfo>
  734. <ReturnValue>
  735. <ReturnType>System.String</ReturnType>
  736. </ReturnValue>
  737. <Parameters />
  738. <Docs>
  739. <summary>
  740. Return an address:port string.
  741. </summary>
  742. <returns>To be added.</returns>
  743. <remarks>To be added.</remarks>
  744. </Docs>
  745. </Member>
  746. <Member MemberName="Type">
  747. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  748. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  749. <MemberType>Property</MemberType>
  750. <AssemblyInfo>
  751. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  752. </AssemblyInfo>
  753. <ReturnValue>
  754. <ReturnType>Urho.StringHash</ReturnType>
  755. </ReturnValue>
  756. <Docs>
  757. <summary>Urho's type system type.</summary>
  758. <value>StringHash representing the type for this C# type.</value>
  759. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  760. </Docs>
  761. </Member>
  762. <Member MemberName="TypeName">
  763. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  764. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  765. <MemberType>Property</MemberType>
  766. <AssemblyInfo>
  767. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  768. </AssemblyInfo>
  769. <ReturnValue>
  770. <ReturnType>System.String</ReturnType>
  771. </ReturnValue>
  772. <Docs>
  773. <summary>Urho's low-level type name.</summary>
  774. <value>Stringified low-level type name.</value>
  775. <remarks>
  776. </remarks>
  777. </Docs>
  778. </Member>
  779. <Member MemberName="TypeNameStatic">
  780. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  781. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  782. <MemberType>Property</MemberType>
  783. <AssemblyInfo>
  784. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  785. </AssemblyInfo>
  786. <ReturnValue>
  787. <ReturnType>System.String</ReturnType>
  788. </ReturnValue>
  789. <Docs>
  790. <summary>Urho's low-level type name, accessible as a static method.</summary>
  791. <value>Stringified low-level type name.</value>
  792. <remarks>
  793. </remarks>
  794. </Docs>
  795. </Member>
  796. <Member MemberName="TypeStatic">
  797. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  798. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  799. <MemberType>Property</MemberType>
  800. <AssemblyInfo>
  801. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  802. </AssemblyInfo>
  803. <ReturnValue>
  804. <ReturnType>Urho.StringHash</ReturnType>
  805. </ReturnValue>
  806. <Docs>
  807. <summary>Urho's low-level type, accessible as a static method.</summary>
  808. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  809. <remarks>
  810. </remarks>
  811. </Docs>
  812. </Member>
  813. </Members>
  814. </Type>