TileMapObject2D.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. <Type Name="TileMapObject2D" FullName="Urho.Urho2D.TileMapObject2D">
  2. <TypeSignature Language="C#" Value="public class TileMapObject2D : Urho.RefCounted" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TileMapObject2D extends Urho.RefCounted" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.RefCounted</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Tile map object.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public TileMapObject2D ();" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Parameters />
  27. <Docs>
  28. <summary>To be added.</summary>
  29. <remarks>To be added.</remarks>
  30. </Docs>
  31. </Member>
  32. <Member MemberName=".ctor">
  33. <MemberSignature Language="C#" Value="public TileMapObject2D (IntPtr handle);" />
  34. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  35. <MemberType>Constructor</MemberType>
  36. <AssemblyInfo>
  37. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  38. </AssemblyInfo>
  39. <Parameters>
  40. <Parameter Name="handle" Type="System.IntPtr" />
  41. </Parameters>
  42. <Docs>
  43. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  44. <summary>Constructs a new instance of Urho.Urho2D.TileMapObject2D, given a raw pointer to an unmanaged object</summary>
  45. <remarks>
  46. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  47. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  48. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  49. </remarks>
  50. </Docs>
  51. </Member>
  52. <Member MemberName=".ctor">
  53. <MemberSignature Language="C#" Value="protected TileMapObject2D (Urho.UrhoObjectFlag emptyFlag);" />
  54. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  55. <MemberType>Constructor</MemberType>
  56. <AssemblyInfo>
  57. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  58. </AssemblyInfo>
  59. <Parameters>
  60. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  61. </Parameters>
  62. <Docs>
  63. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  64. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  65. <remarks>
  66. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  67. <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>
  68. <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>
  69. </remarks>
  70. </Docs>
  71. </Member>
  72. <Member MemberName="GetPoint">
  73. <MemberSignature Language="C#" Value="public Urho.Vector2 GetPoint (uint index);" />
  74. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Vector2 GetPoint(unsigned int32 index) cil managed" />
  75. <MemberType>Method</MemberType>
  76. <AssemblyInfo>
  77. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  78. </AssemblyInfo>
  79. <ReturnValue>
  80. <ReturnType>Urho.Vector2</ReturnType>
  81. </ReturnValue>
  82. <Parameters>
  83. <Parameter Name="index" Type="System.UInt32" />
  84. </Parameters>
  85. <Docs>
  86. <param name="index">To be added.</param>
  87. <summary>
  88. Return point at index (use for script).
  89. </summary>
  90. <returns>To be added.</returns>
  91. <remarks>To be added.</remarks>
  92. </Docs>
  93. </Member>
  94. <Member MemberName="GetProperty">
  95. <MemberSignature Language="C#" Value="public string GetProperty (string name);" />
  96. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetProperty(string name) cil managed" />
  97. <MemberType>Method</MemberType>
  98. <AssemblyInfo>
  99. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  100. </AssemblyInfo>
  101. <ReturnValue>
  102. <ReturnType>System.String</ReturnType>
  103. </ReturnValue>
  104. <Parameters>
  105. <Parameter Name="name" Type="System.String" />
  106. </Parameters>
  107. <Docs>
  108. <param name="name">To be added.</param>
  109. <summary>
  110. Return property value.
  111. </summary>
  112. <returns>To be added.</returns>
  113. <remarks>To be added.</remarks>
  114. </Docs>
  115. </Member>
  116. <Member MemberName="HasProperty">
  117. <MemberSignature Language="C#" Value="public bool HasProperty (string name);" />
  118. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasProperty(string name) cil managed" />
  119. <MemberType>Method</MemberType>
  120. <AssemblyInfo>
  121. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  122. </AssemblyInfo>
  123. <ReturnValue>
  124. <ReturnType>System.Boolean</ReturnType>
  125. </ReturnValue>
  126. <Parameters>
  127. <Parameter Name="name" Type="System.String" />
  128. </Parameters>
  129. <Docs>
  130. <param name="name">To be added.</param>
  131. <summary>
  132. Return has property.
  133. </summary>
  134. <returns>To be added.</returns>
  135. <remarks>To be added.</remarks>
  136. </Docs>
  137. </Member>
  138. <Member MemberName="Name">
  139. <MemberSignature Language="C#" Value="public string Name { get; }" />
  140. <MemberSignature Language="ILAsm" Value=".property instance string Name" />
  141. <MemberType>Property</MemberType>
  142. <AssemblyInfo>
  143. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  144. </AssemblyInfo>
  145. <ReturnValue>
  146. <ReturnType>System.String</ReturnType>
  147. </ReturnValue>
  148. <Docs>
  149. <summary>
  150. Return name.
  151. </summary>
  152. <value>To be added.</value>
  153. <remarks>To be added.</remarks>
  154. </Docs>
  155. </Member>
  156. <Member MemberName="NumPoints">
  157. <MemberSignature Language="C#" Value="public uint NumPoints { get; }" />
  158. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumPoints" />
  159. <MemberType>Property</MemberType>
  160. <AssemblyInfo>
  161. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  162. </AssemblyInfo>
  163. <ReturnValue>
  164. <ReturnType>System.UInt32</ReturnType>
  165. </ReturnValue>
  166. <Docs>
  167. <summary>
  168. Return number of points (use for script).
  169. </summary>
  170. <value>To be added.</value>
  171. <remarks>To be added.</remarks>
  172. </Docs>
  173. </Member>
  174. <Member MemberName="ObjectType">
  175. <MemberSignature Language="C#" Value="public Urho.Urho2D.TileMapObjectType2D ObjectType { get; }" />
  176. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Urho2D.TileMapObjectType2D ObjectType" />
  177. <MemberType>Property</MemberType>
  178. <AssemblyInfo>
  179. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  180. </AssemblyInfo>
  181. <ReturnValue>
  182. <ReturnType>Urho.Urho2D.TileMapObjectType2D</ReturnType>
  183. </ReturnValue>
  184. <Docs>
  185. <summary>
  186. Return type.
  187. </summary>
  188. <value>To be added.</value>
  189. <remarks>To be added.</remarks>
  190. </Docs>
  191. </Member>
  192. <Member MemberName="Position">
  193. <MemberSignature Language="C#" Value="public Urho.Vector2 Position { get; }" />
  194. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Vector2 Position" />
  195. <MemberType>Property</MemberType>
  196. <AssemblyInfo>
  197. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  198. </AssemblyInfo>
  199. <ReturnValue>
  200. <ReturnType>Urho.Vector2</ReturnType>
  201. </ReturnValue>
  202. <Docs>
  203. <summary>
  204. Return position.
  205. </summary>
  206. <value>To be added.</value>
  207. <remarks>To be added.</remarks>
  208. </Docs>
  209. </Member>
  210. <Member MemberName="Size">
  211. <MemberSignature Language="C#" Value="public Urho.Vector2 Size { get; }" />
  212. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Vector2 Size" />
  213. <MemberType>Property</MemberType>
  214. <AssemblyInfo>
  215. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  216. </AssemblyInfo>
  217. <ReturnValue>
  218. <ReturnType>Urho.Vector2</ReturnType>
  219. </ReturnValue>
  220. <Docs>
  221. <summary>
  222. Return size (for rectangle and ellipse).
  223. </summary>
  224. <value>To be added.</value>
  225. <remarks>To be added.</remarks>
  226. </Docs>
  227. </Member>
  228. <Member MemberName="TileGid">
  229. <MemberSignature Language="C#" Value="public int TileGid { get; }" />
  230. <MemberSignature Language="ILAsm" Value=".property instance int32 TileGid" />
  231. <MemberType>Property</MemberType>
  232. <AssemblyInfo>
  233. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  234. </AssemblyInfo>
  235. <ReturnValue>
  236. <ReturnType>System.Int32</ReturnType>
  237. </ReturnValue>
  238. <Docs>
  239. <summary>
  240. Return tile Gid.
  241. </summary>
  242. <value>To be added.</value>
  243. <remarks>To be added.</remarks>
  244. </Docs>
  245. </Member>
  246. <Member MemberName="TileSprite">
  247. <MemberSignature Language="C#" Value="public Urho.Urho2D.Sprite2D TileSprite { get; }" />
  248. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Urho2D.Sprite2D TileSprite" />
  249. <MemberType>Property</MemberType>
  250. <AssemblyInfo>
  251. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  252. </AssemblyInfo>
  253. <ReturnValue>
  254. <ReturnType>Urho.Urho2D.Sprite2D</ReturnType>
  255. </ReturnValue>
  256. <Docs>
  257. <summary>
  258. Return tile sprite.
  259. </summary>
  260. <value>To be added.</value>
  261. <remarks>To be added.</remarks>
  262. </Docs>
  263. </Member>
  264. <Member MemberName="Type">
  265. <MemberSignature Language="C#" Value="public string Type { get; }" />
  266. <MemberSignature Language="ILAsm" Value=".property instance string Type" />
  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 type system type.</summary>
  276. <value>StringHash representing the type for this C# type.</value>
  277. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  278. </Docs>
  279. </Member>
  280. </Members>
  281. </Type>