Component.xml 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661
  1. <Type Name="Component" FullName="Urho.Component">
  2. <TypeSignature Language="C#" Value="public class Component : Urho.Animatable" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Component extends Urho.Animatable" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Animatable</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>Base class for components. Components can be attached to scene nodes. </summary>
  14. <remarks>
  15. <para>Use the <see cref="T:Urho.Component" /> is the base class for custom components, it is a low-level interface.   A simpler version to use is <see cref="T:Urho.LogicComponent" /> which provides various convenience features.   </para>
  16. <para>The next section for details on how to connect to various events in the life cycle of a component.</para>
  17. <format type="text/html">
  18. <h2>Events</h2>
  19. </format>
  20. <para>You can catch the time where the component is attached to a <see cref="T:Urho.Node" /> by overwriting the <see cref="M:Urho.Component.OnAttachedToNode" /> method.   To receive <see cref="T:Urho.Scene" /> update messages, you should first set the <see cref="P:Urho.Component.ReceiveSceneUpdates" /> property to <see langword="true" /> on your constructor, and then override the <see cref="M:Urho.Component.OnUpdate" /> method.</para>
  21. <para>If you are interest in updates from the physics engine, you should connect directly to the <see cref="E:Urho.Physics.PhysicsWorld.PhysicsPreStep" /> event for your world. </para>
  22. <para>If you are interested in receiving the scene post-update, subscribe to the <see cref="E:Urho.Scene.ScenePostUpdate" /> event.</para>
  23. <format type="text/html">
  24. <h2>Serialization</h2>
  25. </format>
  26. <para>To implement serialization you would override the OnSerialize and OnDeserialize methods and store your component state on the provided serializer and deserializer objects.</para>
  27. <para></para>
  28. <code lang="C#"><![CDATA[class MyComponent : Component { // Constructor needed for deserialization public MyComponent(IntPtr handle) : base(handle) { } public MyComponent() { } // user defined properties (managed state): public Quaternion MyRotation { get; set; } public string MyName { get; set; } public override void OnSerialize(IComponentSerializer ser) { // register our properties with their names as keys using nameof() ser.Serialize(nameof(MyRotation), MyRotation); ser.Serialize(nameof(MyName), MyName); } public override void OnDeserialize(IComponentDeserializer des) { MyRotation = des.Deserialize<Quaternion>(nameof(MyRotation)); MyName = des.Deserialize<string>(nameof(MyName)); } // called when the component is attached to some node public override void OnAttachedToNode() { var node = this.Node; } }]]></code>
  29. </remarks>
  30. </Docs>
  31. <Members>
  32. <Member MemberName=".ctor">
  33. <MemberSignature Language="C#" Value="public Component ();" />
  34. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  35. <MemberType>Constructor</MemberType>
  36. <AssemblyInfo>
  37. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  38. </AssemblyInfo>
  39. <Parameters />
  40. <Docs>
  41. <summary>
  42. <para>Constructs a new instance of Urho.Component which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  43. </summary>
  44. <remarks></remarks>
  45. </Docs>
  46. </Member>
  47. <Member MemberName=".ctor">
  48. <MemberSignature Language="C#" Value="public Component (IntPtr handle);" />
  49. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  50. <MemberType>Constructor</MemberType>
  51. <AssemblyInfo>
  52. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  53. </AssemblyInfo>
  54. <Parameters>
  55. <Parameter Name="handle" Type="System.IntPtr" />
  56. </Parameters>
  57. <Docs>
  58. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  59. <summary>Constructs a new instance of Urho.Component, given a raw pointer to an unmanaged object</summary>
  60. <remarks>
  61. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  62. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  63. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  64. </remarks>
  65. </Docs>
  66. </Member>
  67. <Member MemberName=".ctor">
  68. <MemberSignature Language="C#" Value="public Component (Urho.Context context);" />
  69. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  70. <MemberType>Constructor</MemberType>
  71. <AssemblyInfo>
  72. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  73. </AssemblyInfo>
  74. <Parameters>
  75. <Parameter Name="context" Type="Urho.Context" />
  76. </Parameters>
  77. <Docs>
  78. <param name="context">The context that this object will be attached to.</param>
  79. <summary>
  80. <para>Constructs a new instance of Urho.Component linked to a specific <see cref="T:Urho.Context" />.</para>
  81. </summary>
  82. <remarks></remarks>
  83. </Docs>
  84. </Member>
  85. <Member MemberName=".ctor">
  86. <MemberSignature Language="C#" Value="protected Component (Urho.UrhoObjectFlag emptyFlag);" />
  87. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  88. <MemberType>Constructor</MemberType>
  89. <AssemblyInfo>
  90. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  91. </AssemblyInfo>
  92. <Parameters>
  93. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  94. </Parameters>
  95. <Docs>
  96. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  97. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  98. <remarks>
  99. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  100. <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>
  101. <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>
  102. </remarks>
  103. </Docs>
  104. </Member>
  105. <Member MemberName="AddReplicationState">
  106. <MemberSignature Language="C#" Value="public void AddReplicationState (Urho.ComponentReplicationState* state);" />
  107. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddReplicationState(valuetype Urho.ComponentReplicationState* state) cil managed" />
  108. <MemberType>Method</MemberType>
  109. <AssemblyInfo>
  110. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  111. </AssemblyInfo>
  112. <ReturnValue>
  113. <ReturnType>System.Void</ReturnType>
  114. </ReturnValue>
  115. <Parameters>
  116. <Parameter Name="state" Type="Urho.ComponentReplicationState*" />
  117. </Parameters>
  118. <Docs>
  119. <param name="state">To be added.</param>
  120. <summary>
  121. Add a replication state that is tracking this component.
  122. </summary>
  123. <remarks>To be added.</remarks>
  124. </Docs>
  125. </Member>
  126. <Member MemberName="Application">
  127. <MemberSignature Language="C#" Value="public Urho.Application Application { get; }" />
  128. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Application Application" />
  129. <MemberType>Property</MemberType>
  130. <AssemblyInfo>
  131. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  132. </AssemblyInfo>
  133. <ReturnValue>
  134. <ReturnType>Urho.Application</ReturnType>
  135. </ReturnValue>
  136. <Docs>
  137. <summary>To be added.</summary>
  138. <value>To be added.</value>
  139. <remarks>To be added.</remarks>
  140. </Docs>
  141. </Member>
  142. <Member MemberName="CleanupConnection">
  143. <MemberSignature Language="C#" Value="public void CleanupConnection (Urho.Network.Connection connection);" />
  144. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CleanupConnection(class Urho.Network.Connection connection) cil managed" />
  145. <MemberType>Method</MemberType>
  146. <AssemblyInfo>
  147. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  148. </AssemblyInfo>
  149. <ReturnValue>
  150. <ReturnType>System.Void</ReturnType>
  151. </ReturnValue>
  152. <Parameters>
  153. <Parameter Name="connection" Type="Urho.Network.Connection" />
  154. </Parameters>
  155. <Docs>
  156. <param name="connection">To be added.</param>
  157. <summary>
  158. Clean up all references to a network connection that is about to be removed.
  159. </summary>
  160. <remarks>To be added.</remarks>
  161. </Docs>
  162. </Member>
  163. <Member MemberName="DrawDebugGeometry">
  164. <MemberSignature Language="C#" Value="public virtual void DrawDebugGeometry (Urho.DebugRenderer debug, bool depthTest);" />
  165. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void DrawDebugGeometry(class Urho.DebugRenderer debug, bool depthTest) cil managed" />
  166. <MemberType>Method</MemberType>
  167. <AssemblyInfo>
  168. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  169. </AssemblyInfo>
  170. <ReturnValue>
  171. <ReturnType>System.Void</ReturnType>
  172. </ReturnValue>
  173. <Parameters>
  174. <Parameter Name="debug" Type="Urho.DebugRenderer" />
  175. <Parameter Name="depthTest" Type="System.Boolean" />
  176. </Parameters>
  177. <Docs>
  178. <param name="debug">To be added.</param>
  179. <param name="depthTest">To be added.</param>
  180. <summary>
  181. Visualize the component as debug geometry.
  182. </summary>
  183. <remarks>To be added.</remarks>
  184. </Docs>
  185. </Member>
  186. <Member MemberName="Enabled">
  187. <MemberSignature Language="C#" Value="public bool Enabled { get; set; }" />
  188. <MemberSignature Language="ILAsm" Value=".property instance bool Enabled" />
  189. <MemberType>Property</MemberType>
  190. <AssemblyInfo>
  191. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  192. </AssemblyInfo>
  193. <ReturnValue>
  194. <ReturnType>System.Boolean</ReturnType>
  195. </ReturnValue>
  196. <Docs>
  197. <summary>Controls whether the component is enabled or not, additionally, the node might not be enabled, see EnabledEffective for a computation that takes both into account.</summary>
  198. <value>To be added.</value>
  199. <remarks>To be added.</remarks>
  200. </Docs>
  201. </Member>
  202. <Member MemberName="EnabledEffective">
  203. <MemberSignature Language="C#" Value="public bool EnabledEffective { get; }" />
  204. <MemberSignature Language="ILAsm" Value=".property instance bool EnabledEffective" />
  205. <MemberType>Property</MemberType>
  206. <AssemblyInfo>
  207. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  208. </AssemblyInfo>
  209. <ReturnValue>
  210. <ReturnType>System.Boolean</ReturnType>
  211. </ReturnValue>
  212. <Docs>
  213. <summary>Return whether is effectively enabled, that is, both the component and its containing Node are enabled.</summary>
  214. <value>To be added.</value>
  215. <remarks>To be added.</remarks>
  216. </Docs>
  217. </Member>
  218. <Member MemberName="GetComponent">
  219. <MemberSignature Language="C#" Value="public Urho.Component GetComponent (Urho.StringHash type);" />
  220. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Component GetComponent(valuetype Urho.StringHash type) cil managed" />
  221. <MemberType>Method</MemberType>
  222. <AssemblyInfo>
  223. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  224. </AssemblyInfo>
  225. <ReturnValue>
  226. <ReturnType>Urho.Component</ReturnType>
  227. </ReturnValue>
  228. <Parameters>
  229. <Parameter Name="type" Type="Urho.StringHash" />
  230. </Parameters>
  231. <Docs>
  232. <param name="type">To be added.</param>
  233. <summary>
  234. Return component in the same scene node by type. If there are several, returns the first.
  235. </summary>
  236. <returns>To be added.</returns>
  237. <remarks>To be added.</remarks>
  238. </Docs>
  239. </Member>
  240. <Member MemberName="GetComponent&lt;T&gt;">
  241. <MemberSignature Language="C#" Value="public T GetComponent&lt;T&gt; () where T : Urho.Component;" />
  242. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T GetComponent&lt;(class Urho.Component) T&gt;() cil managed" />
  243. <MemberType>Method</MemberType>
  244. <AssemblyInfo>
  245. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  246. </AssemblyInfo>
  247. <ReturnValue>
  248. <ReturnType>T</ReturnType>
  249. </ReturnValue>
  250. <TypeParameters>
  251. <TypeParameter Name="T">
  252. <Constraints>
  253. <BaseTypeName>Urho.Component</BaseTypeName>
  254. </Constraints>
  255. </TypeParameter>
  256. </TypeParameters>
  257. <Parameters />
  258. <Docs>
  259. <typeparam name="T">To be added.</typeparam>
  260. <summary>To be added.</summary>
  261. <returns>To be added.</returns>
  262. <remarks>To be added.</remarks>
  263. </Docs>
  264. </Member>
  265. <Member MemberName="ID">
  266. <MemberSignature Language="C#" Value="public uint ID { get; }" />
  267. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 ID" />
  268. <MemberType>Property</MemberType>
  269. <AssemblyInfo>
  270. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  271. </AssemblyInfo>
  272. <ReturnValue>
  273. <ReturnType>System.UInt32</ReturnType>
  274. </ReturnValue>
  275. <Docs>
  276. <summary>
  277. Return ID.
  278. </summary>
  279. <value>To be added.</value>
  280. <remarks>To be added.</remarks>
  281. </Docs>
  282. </Member>
  283. <Member MemberName="MarkNetworkUpdate">
  284. <MemberSignature Language="C#" Value="public override void MarkNetworkUpdate ();" />
  285. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void MarkNetworkUpdate() cil managed" />
  286. <MemberType>Method</MemberType>
  287. <AssemblyInfo>
  288. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  289. </AssemblyInfo>
  290. <ReturnValue>
  291. <ReturnType>System.Void</ReturnType>
  292. </ReturnValue>
  293. <Parameters />
  294. <Docs>
  295. <summary>
  296. Mark for attribute check on the next network update.
  297. </summary>
  298. <remarks>To be added.</remarks>
  299. </Docs>
  300. </Member>
  301. <Member MemberName="Node">
  302. <MemberSignature Language="C#" Value="public Urho.Node Node { get; }" />
  303. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Node Node" />
  304. <MemberType>Property</MemberType>
  305. <AssemblyInfo>
  306. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  307. </AssemblyInfo>
  308. <ReturnValue>
  309. <ReturnType>Urho.Node</ReturnType>
  310. </ReturnValue>
  311. <Docs>
  312. <summary>
  313. Return scene node.
  314. </summary>
  315. <value>To be added.</value>
  316. <remarks>To be added.</remarks>
  317. </Docs>
  318. </Member>
  319. <Member MemberName="OnAttachedToNode">
  320. <MemberSignature Language="C#" Value="public virtual void OnAttachedToNode (Urho.Node node);" />
  321. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnAttachedToNode(class Urho.Node node) cil managed" />
  322. <MemberType>Method</MemberType>
  323. <AssemblyInfo>
  324. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  325. </AssemblyInfo>
  326. <ReturnValue>
  327. <ReturnType>System.Void</ReturnType>
  328. </ReturnValue>
  329. <Parameters>
  330. <Parameter Name="node" Type="Urho.Node" />
  331. </Parameters>
  332. <Docs>
  333. <param name="node">To be added.</param>
  334. <summary>To be added.</summary>
  335. <remarks>To be added.</remarks>
  336. </Docs>
  337. </Member>
  338. <Member MemberName="OnDeleted">
  339. <MemberSignature Language="C#" Value="protected override void OnDeleted ();" />
  340. <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnDeleted() cil managed" />
  341. <MemberType>Method</MemberType>
  342. <AssemblyInfo>
  343. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  344. </AssemblyInfo>
  345. <ReturnValue>
  346. <ReturnType>System.Void</ReturnType>
  347. </ReturnValue>
  348. <Parameters />
  349. <Docs>
  350. <summary>To be added.</summary>
  351. <remarks>To be added.</remarks>
  352. </Docs>
  353. </Member>
  354. <Member MemberName="OnDeserialize">
  355. <MemberSignature Language="C#" Value="public virtual void OnDeserialize (Urho.Resources.IComponentDeserializer deserializer);" />
  356. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnDeserialize(class Urho.Resources.IComponentDeserializer deserializer) cil managed" />
  357. <MemberType>Method</MemberType>
  358. <AssemblyInfo>
  359. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  360. </AssemblyInfo>
  361. <ReturnValue>
  362. <ReturnType>System.Void</ReturnType>
  363. </ReturnValue>
  364. <Parameters>
  365. <Parameter Name="deserializer" Type="Urho.Resources.IComponentDeserializer" />
  366. </Parameters>
  367. <Docs>
  368. <param name="deserializer">Object used to retrieve the stored information</param>
  369. <summary>Overridable method to deserialize the component state</summary>
  370. <remarks>Implement this method to have the Urho runtime initialize your object state from a previously saved state.</remarks>
  371. </Docs>
  372. </Member>
  373. <Member MemberName="OnNodeSetEnabled">
  374. <MemberSignature Language="C#" Value="public virtual void OnNodeSetEnabled ();" />
  375. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnNodeSetEnabled() cil managed" />
  376. <MemberType>Method</MemberType>
  377. <AssemblyInfo>
  378. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  379. </AssemblyInfo>
  380. <ReturnValue>
  381. <ReturnType>System.Void</ReturnType>
  382. </ReturnValue>
  383. <Parameters />
  384. <Docs>
  385. <summary>To be added.</summary>
  386. <remarks>To be added.</remarks>
  387. </Docs>
  388. </Member>
  389. <Member MemberName="OnSceneSet">
  390. <MemberSignature Language="C#" Value="public virtual void OnSceneSet (Urho.Scene scene);" />
  391. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnSceneSet(class Urho.Scene scene) cil managed" />
  392. <MemberType>Method</MemberType>
  393. <AssemblyInfo>
  394. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  395. </AssemblyInfo>
  396. <ReturnValue>
  397. <ReturnType>System.Void</ReturnType>
  398. </ReturnValue>
  399. <Parameters>
  400. <Parameter Name="scene" Type="Urho.Scene" />
  401. </Parameters>
  402. <Docs>
  403. <param name="scene">To be added.</param>
  404. <summary>To be added.</summary>
  405. <remarks>To be added.</remarks>
  406. </Docs>
  407. </Member>
  408. <Member MemberName="OnSerialize">
  409. <MemberSignature Language="C#" Value="public virtual void OnSerialize (Urho.Resources.IComponentSerializer serializer);" />
  410. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnSerialize(class Urho.Resources.IComponentSerializer serializer) cil managed" />
  411. <MemberType>Method</MemberType>
  412. <AssemblyInfo>
  413. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  414. </AssemblyInfo>
  415. <ReturnValue>
  416. <ReturnType>System.Void</ReturnType>
  417. </ReturnValue>
  418. <Parameters>
  419. <Parameter Name="serializer" Type="Urho.Resources.IComponentSerializer" />
  420. </Parameters>
  421. <Docs>
  422. <param name="serializer">You serialize the state into this object.</param>
  423. <summary>Overridable method to serialize the component state</summary>
  424. <remarks>You typically override this method in your application to save the state of your component.   Saving takes place by saving the state on the API surfaced by the serializer parameter.</remarks>
  425. </Docs>
  426. </Member>
  427. <Member MemberName="OnSetEnabled">
  428. <MemberSignature Language="C#" Value="public virtual void OnSetEnabled ();" />
  429. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnSetEnabled() cil managed" />
  430. <MemberType>Method</MemberType>
  431. <AssemblyInfo>
  432. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  433. </AssemblyInfo>
  434. <ReturnValue>
  435. <ReturnType>System.Void</ReturnType>
  436. </ReturnValue>
  437. <Parameters />
  438. <Docs>
  439. <summary>
  440. Handle enabled/disabled state change.
  441. </summary>
  442. <remarks>To be added.</remarks>
  443. </Docs>
  444. </Member>
  445. <Member MemberName="OnUpdate">
  446. <MemberSignature Language="C#" Value="protected virtual void OnUpdate (float timeStep);" />
  447. <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnUpdate(float32 timeStep) cil managed" />
  448. <MemberType>Method</MemberType>
  449. <AssemblyInfo>
  450. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  451. </AssemblyInfo>
  452. <ReturnValue>
  453. <ReturnType>System.Void</ReturnType>
  454. </ReturnValue>
  455. <Parameters>
  456. <Parameter Name="timeStep" Type="System.Single" />
  457. </Parameters>
  458. <Docs>
  459. <param name="timeStep">To be added.</param>
  460. <summary>
  461. Make sure to set the <see cref="P:Urho.Component.ReceiveSceneUpdates" /> property to true in order to receive update events
  462. </summary>
  463. <remarks>To be added.</remarks>
  464. </Docs>
  465. </Member>
  466. <Member MemberName="PrepareNetworkUpdate">
  467. <MemberSignature Language="C#" Value="public void PrepareNetworkUpdate ();" />
  468. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void PrepareNetworkUpdate() cil managed" />
  469. <MemberType>Method</MemberType>
  470. <AssemblyInfo>
  471. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  472. </AssemblyInfo>
  473. <ReturnValue>
  474. <ReturnType>System.Void</ReturnType>
  475. </ReturnValue>
  476. <Parameters />
  477. <Docs>
  478. <summary>
  479. Prepare network update by comparing attributes and marking replication states dirty as necessary.
  480. </summary>
  481. <remarks>To be added.</remarks>
  482. </Docs>
  483. </Member>
  484. <Member MemberName="ReceiveSceneUpdates">
  485. <MemberSignature Language="C#" Value="protected bool ReceiveSceneUpdates { get; set; }" />
  486. <MemberSignature Language="ILAsm" Value=".property instance bool ReceiveSceneUpdates" />
  487. <MemberType>Property</MemberType>
  488. <AssemblyInfo>
  489. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  490. </AssemblyInfo>
  491. <ReturnValue>
  492. <ReturnType>System.Boolean</ReturnType>
  493. </ReturnValue>
  494. <Docs>
  495. <summary>To be added.</summary>
  496. <value>To be added.</value>
  497. <remarks>To be added.</remarks>
  498. </Docs>
  499. </Member>
  500. <Member MemberName="Remove">
  501. <MemberSignature Language="C#" Value="public void Remove ();" />
  502. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Remove() cil managed" />
  503. <MemberType>Method</MemberType>
  504. <AssemblyInfo>
  505. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  506. </AssemblyInfo>
  507. <ReturnValue>
  508. <ReturnType>System.Void</ReturnType>
  509. </ReturnValue>
  510. <Parameters />
  511. <Docs>
  512. <summary>
  513. Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
  514. </summary>
  515. <remarks>To be added.</remarks>
  516. </Docs>
  517. </Member>
  518. <Member MemberName="Save">
  519. <MemberSignature Language="C#" Value="public override bool Save (Urho.IO.File dest);" />
  520. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Save(class Urho.IO.File dest) cil managed" />
  521. <MemberType>Method</MemberType>
  522. <AssemblyInfo>
  523. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  524. </AssemblyInfo>
  525. <ReturnValue>
  526. <ReturnType>System.Boolean</ReturnType>
  527. </ReturnValue>
  528. <Parameters>
  529. <Parameter Name="dest" Type="Urho.IO.File" />
  530. </Parameters>
  531. <Docs>
  532. <param name="dest">To be added.</param>
  533. <summary>To be added.</summary>
  534. <returns>To be added.</returns>
  535. <remarks>To be added.</remarks>
  536. </Docs>
  537. </Member>
  538. <Member MemberName="Save">
  539. <MemberSignature Language="C#" Value="public override bool Save (Urho.MemoryBuffer dest);" />
  540. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Save(class Urho.MemoryBuffer dest) cil managed" />
  541. <MemberType>Method</MemberType>
  542. <AssemblyInfo>
  543. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  544. </AssemblyInfo>
  545. <ReturnValue>
  546. <ReturnType>System.Boolean</ReturnType>
  547. </ReturnValue>
  548. <Parameters>
  549. <Parameter Name="dest" Type="Urho.MemoryBuffer" />
  550. </Parameters>
  551. <Docs>
  552. <param name="dest">To be added.</param>
  553. <summary>To be added.</summary>
  554. <returns>To be added.</returns>
  555. <remarks>To be added.</remarks>
  556. </Docs>
  557. </Member>
  558. <Member MemberName="SaveXml">
  559. <MemberSignature Language="C#" Value="public override bool SaveXml (Urho.Resources.XmlElement dest);" />
  560. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool SaveXml(class Urho.Resources.XmlElement dest) cil managed" />
  561. <MemberType>Method</MemberType>
  562. <AssemblyInfo>
  563. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  564. </AssemblyInfo>
  565. <ReturnValue>
  566. <ReturnType>System.Boolean</ReturnType>
  567. </ReturnValue>
  568. <Parameters>
  569. <Parameter Name="dest" Type="Urho.Resources.XmlElement" />
  570. </Parameters>
  571. <Docs>
  572. <param name="dest">To be added.</param>
  573. <summary>To be added.</summary>
  574. <returns>To be added.</returns>
  575. <remarks>To be added.</remarks>
  576. </Docs>
  577. </Member>
  578. <Member MemberName="Scene">
  579. <MemberSignature Language="C#" Value="public Urho.Scene Scene { get; }" />
  580. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Scene Scene" />
  581. <MemberType>Property</MemberType>
  582. <AssemblyInfo>
  583. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  584. </AssemblyInfo>
  585. <ReturnValue>
  586. <ReturnType>Urho.Scene</ReturnType>
  587. </ReturnValue>
  588. <Docs>
  589. <summary>
  590. Return the scene the node belongs to.
  591. </summary>
  592. <value>To be added.</value>
  593. <remarks>To be added.</remarks>
  594. </Docs>
  595. </Member>
  596. <Member MemberName="Type">
  597. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  598. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  599. <MemberType>Property</MemberType>
  600. <AssemblyInfo>
  601. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  602. </AssemblyInfo>
  603. <ReturnValue>
  604. <ReturnType>Urho.StringHash</ReturnType>
  605. </ReturnValue>
  606. <Docs>
  607. <summary>Urho's type system type.</summary>
  608. <value>StringHash representing the type for this C# type.</value>
  609. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  610. </Docs>
  611. </Member>
  612. <Member MemberName="TypeName">
  613. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  614. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  615. <MemberType>Property</MemberType>
  616. <AssemblyInfo>
  617. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  618. </AssemblyInfo>
  619. <ReturnValue>
  620. <ReturnType>System.String</ReturnType>
  621. </ReturnValue>
  622. <Docs>
  623. <summary>Urho's low-level type name.</summary>
  624. <value>Stringified low-level type name.</value>
  625. <remarks></remarks>
  626. </Docs>
  627. </Member>
  628. <Member MemberName="TypeNameStatic">
  629. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  630. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  631. <MemberType>Property</MemberType>
  632. <AssemblyInfo>
  633. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  634. </AssemblyInfo>
  635. <ReturnValue>
  636. <ReturnType>System.String</ReturnType>
  637. </ReturnValue>
  638. <Docs>
  639. <summary>Urho's low-level type name, accessible as a static method.</summary>
  640. <value>Stringified low-level type name.</value>
  641. <remarks></remarks>
  642. </Docs>
  643. </Member>
  644. <Member MemberName="TypeStatic">
  645. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  646. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  647. <MemberType>Property</MemberType>
  648. <AssemblyInfo>
  649. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  650. </AssemblyInfo>
  651. <ReturnValue>
  652. <ReturnType>Urho.StringHash</ReturnType>
  653. </ReturnValue>
  654. <Docs>
  655. <summary>Urho's low-level type, accessible as a static method.</summary>
  656. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  657. <remarks></remarks>
  658. </Docs>
  659. </Member>
  660. </Members>
  661. </Type>