Connection.xml 35 KB

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