Connection.xml 31 KB

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