ParticleEmitter2D.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. <Type Name="ParticleEmitter2D" FullName="Urho.ParticleEmitter2D">
  2. <TypeSignature Language="C#" Value="public class ParticleEmitter2D : Urho.Drawable2D" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ParticleEmitter2D extends Urho.Drawable2D" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Drawable2D</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. 2D particle emitter component.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public ParticleEmitter2D (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 ParticleEmitter2D, 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 ParticleEmitter2D (Urho.Context context);" />
  41. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  42. <MemberType>Constructor</MemberType>
  43. <AssemblyInfo>
  44. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  45. </AssemblyInfo>
  46. <Parameters>
  47. <Parameter Name="context" Type="Urho.Context" />
  48. </Parameters>
  49. <Docs>
  50. <param name="context">The context that this object will be attached to.</param>
  51. <summary>Creates an instance of ParticleEmitter2D that is attached to an execution context.</summary>
  52. <remarks>
  53. <para>This creates an instance of ParticleEmitter2D attached to the specified execution context.</para>
  54. </remarks>
  55. </Docs>
  56. </Member>
  57. <Member MemberName=".ctor">
  58. <MemberSignature Language="C#" Value="public ParticleEmitter2D (Urho.UrhoObjectFlag emptyFlag);" />
  59. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  60. <MemberType>Constructor</MemberType>
  61. <AssemblyInfo>
  62. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  63. </AssemblyInfo>
  64. <Parameters>
  65. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  66. </Parameters>
  67. <Docs>
  68. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  69. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  70. <remarks>
  71. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  72. <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>
  73. <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>
  74. </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="BlendMode">
  94. <MemberSignature Language="C#" Value="public Urho.BlendMode BlendMode { get; set; }" />
  95. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.BlendMode BlendMode" />
  96. <MemberType>Property</MemberType>
  97. <AssemblyInfo>
  98. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  99. </AssemblyInfo>
  100. <ReturnValue>
  101. <ReturnType>Urho.BlendMode</ReturnType>
  102. </ReturnValue>
  103. <Docs>
  104. <summary>
  105. Return blend mode.
  106. Or
  107. Set blend mode.
  108. </summary>
  109. <value>To be added.</value>
  110. <remarks>To be added.</remarks>
  111. </Docs>
  112. </Member>
  113. <Member MemberName="Effect">
  114. <MemberSignature Language="C#" Value="public Urho.ParticleEffect2D Effect { get; set; }" />
  115. <MemberSignature Language="ILAsm" Value=".property instance class Urho.ParticleEffect2D Effect" />
  116. <MemberType>Property</MemberType>
  117. <AssemblyInfo>
  118. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  119. </AssemblyInfo>
  120. <ReturnValue>
  121. <ReturnType>Urho.ParticleEffect2D</ReturnType>
  122. </ReturnValue>
  123. <Docs>
  124. <summary>
  125. Return particle effect.
  126. Or
  127. Set particle effect.
  128. </summary>
  129. <value>To be added.</value>
  130. <remarks>To be added.</remarks>
  131. </Docs>
  132. </Member>
  133. <Member MemberName="MaxParticles">
  134. <MemberSignature Language="C#" Value="public uint MaxParticles { get; set; }" />
  135. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 MaxParticles" />
  136. <MemberType>Property</MemberType>
  137. <AssemblyInfo>
  138. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  139. </AssemblyInfo>
  140. <ReturnValue>
  141. <ReturnType>System.UInt32</ReturnType>
  142. </ReturnValue>
  143. <Docs>
  144. <summary>
  145. Return max particles.
  146. Or
  147. Set max particles.
  148. </summary>
  149. <value>To be added.</value>
  150. <remarks>To be added.</remarks>
  151. </Docs>
  152. </Member>
  153. <Member MemberName="OnSetEnabled">
  154. <MemberSignature Language="C#" Value="public override void OnSetEnabled ();" />
  155. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnSetEnabled() cil managed" />
  156. <MemberType>Method</MemberType>
  157. <AssemblyInfo>
  158. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  159. </AssemblyInfo>
  160. <ReturnValue>
  161. <ReturnType>System.Void</ReturnType>
  162. </ReturnValue>
  163. <Parameters />
  164. <Docs>
  165. <summary>
  166. Handle enabled/disabled state change.
  167. </summary>
  168. <remarks>To be added.</remarks>
  169. </Docs>
  170. </Member>
  171. <Member MemberName="ParticleEffectAttr">
  172. <MemberSignature Language="C#" Value="public Urho.ResourceRef ParticleEffectAttr { get; }" />
  173. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.ResourceRef ParticleEffectAttr" />
  174. <MemberType>Property</MemberType>
  175. <AssemblyInfo>
  176. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  177. </AssemblyInfo>
  178. <ReturnValue>
  179. <ReturnType>Urho.ResourceRef</ReturnType>
  180. </ReturnValue>
  181. <Docs>
  182. <summary>
  183. Return particle model attr.
  184. </summary>
  185. <value>To be added.</value>
  186. <remarks>To be added.</remarks>
  187. </Docs>
  188. </Member>
  189. <Member MemberName="RegisterObject">
  190. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  191. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  192. <MemberType>Method</MemberType>
  193. <AssemblyInfo>
  194. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  195. </AssemblyInfo>
  196. <ReturnValue>
  197. <ReturnType>System.Void</ReturnType>
  198. </ReturnValue>
  199. <Parameters>
  200. <Parameter Name="context" Type="Urho.Context" />
  201. </Parameters>
  202. <Docs>
  203. <param name="context">To be added.</param>
  204. <summary>
  205. Register object factory. drawable2d must be registered first.
  206. </summary>
  207. <remarks>To be added.</remarks>
  208. </Docs>
  209. </Member>
  210. <Member MemberName="Sprite">
  211. <MemberSignature Language="C#" Value="public Urho.Sprite2D Sprite { get; set; }" />
  212. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Sprite2D Sprite" />
  213. <MemberType>Property</MemberType>
  214. <AssemblyInfo>
  215. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  216. </AssemblyInfo>
  217. <ReturnValue>
  218. <ReturnType>Urho.Sprite2D</ReturnType>
  219. </ReturnValue>
  220. <Docs>
  221. <summary>
  222. Return sprite.
  223. Or
  224. Set sprite.
  225. </summary>
  226. <value>To be added.</value>
  227. <remarks>To be added.</remarks>
  228. </Docs>
  229. </Member>
  230. <Member MemberName="SpriteAttr">
  231. <MemberSignature Language="C#" Value="public Urho.ResourceRef SpriteAttr { get; }" />
  232. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.ResourceRef SpriteAttr" />
  233. <MemberType>Property</MemberType>
  234. <AssemblyInfo>
  235. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  236. </AssemblyInfo>
  237. <ReturnValue>
  238. <ReturnType>Urho.ResourceRef</ReturnType>
  239. </ReturnValue>
  240. <Docs>
  241. <summary>
  242. Return sprite attribute.
  243. </summary>
  244. <value>To be added.</value>
  245. <remarks>To be added.</remarks>
  246. </Docs>
  247. </Member>
  248. <Member MemberName="Type">
  249. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  250. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  251. <MemberType>Property</MemberType>
  252. <AssemblyInfo>
  253. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  254. </AssemblyInfo>
  255. <ReturnValue>
  256. <ReturnType>Urho.StringHash</ReturnType>
  257. </ReturnValue>
  258. <Docs>
  259. <summary>Urho's type system type.</summary>
  260. <value>StringHash representing the type for this C# type.</value>
  261. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  262. </Docs>
  263. </Member>
  264. <Member MemberName="TypeName">
  265. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  266. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  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>Urho's low-level type name.</summary>
  276. <value>Stringified low-level type name.</value>
  277. <remarks></remarks>
  278. </Docs>
  279. </Member>
  280. <Member MemberName="TypeNameStatic">
  281. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  282. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  283. <MemberType>Property</MemberType>
  284. <AssemblyInfo>
  285. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  286. </AssemblyInfo>
  287. <ReturnValue>
  288. <ReturnType>System.String</ReturnType>
  289. </ReturnValue>
  290. <Docs>
  291. <summary>Urho's low-level type name, accessible as a static method.</summary>
  292. <value>Stringified low-level type name.</value>
  293. <remarks></remarks>
  294. </Docs>
  295. </Member>
  296. <Member MemberName="TypeStatic">
  297. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  298. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  299. <MemberType>Property</MemberType>
  300. <AssemblyInfo>
  301. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  302. </AssemblyInfo>
  303. <ReturnValue>
  304. <ReturnType>Urho.StringHash</ReturnType>
  305. </ReturnValue>
  306. <Docs>
  307. <summary>To be added.</summary>
  308. <value>To be added.</value>
  309. <remarks>To be added.</remarks>
  310. </Docs>
  311. </Member>
  312. </Members>
  313. </Type>