UnityEngine.Physics2DModule.xml 151 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.Physics2DModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.AnchoredJoint2D">
  8. <summary>
  9. <para>Parent class for all joints that have anchor points.</para>
  10. </summary>
  11. </member>
  12. <member name="P:UnityEngine.AnchoredJoint2D.anchor">
  13. <summary>
  14. <para>The joint's anchor point on the object that has the joint component.</para>
  15. </summary>
  16. </member>
  17. <member name="P:UnityEngine.AnchoredJoint2D.autoConfigureConnectedAnchor">
  18. <summary>
  19. <para>Should the connectedAnchor be calculated automatically?</para>
  20. </summary>
  21. </member>
  22. <member name="P:UnityEngine.AnchoredJoint2D.connectedAnchor">
  23. <summary>
  24. <para>The joint's anchor point on the second object (ie, the one which doesn't have the joint component).</para>
  25. </summary>
  26. </member>
  27. <member name="T:UnityEngine.AreaEffector2D">
  28. <summary>
  29. <para>Applies forces within an area.</para>
  30. </summary>
  31. </member>
  32. <member name="P:UnityEngine.AreaEffector2D.angularDrag">
  33. <summary>
  34. <para>The angular drag to apply to rigid-bodies.</para>
  35. </summary>
  36. </member>
  37. <member name="P:UnityEngine.AreaEffector2D.drag">
  38. <summary>
  39. <para>The linear drag to apply to rigid-bodies.</para>
  40. </summary>
  41. </member>
  42. <member name="P:UnityEngine.AreaEffector2D.forceAngle">
  43. <summary>
  44. <para>The angle of the force to be applied.</para>
  45. </summary>
  46. </member>
  47. <member name="P:UnityEngine.AreaEffector2D.forceMagnitude">
  48. <summary>
  49. <para>The magnitude of the force to be applied.</para>
  50. </summary>
  51. </member>
  52. <member name="P:UnityEngine.AreaEffector2D.forceTarget">
  53. <summary>
  54. <para>The target for where the effector applies any force.</para>
  55. </summary>
  56. </member>
  57. <member name="P:UnityEngine.AreaEffector2D.forceVariation">
  58. <summary>
  59. <para>The variation of the magnitude of the force to be applied.</para>
  60. </summary>
  61. </member>
  62. <member name="P:UnityEngine.AreaEffector2D.useGlobalAngle">
  63. <summary>
  64. <para>Should the forceAngle use global space?</para>
  65. </summary>
  66. </member>
  67. <member name="T:UnityEngine.BoxCollider2D">
  68. <summary>
  69. <para>Collider for 2D physics representing an axis-aligned rectangle.</para>
  70. </summary>
  71. </member>
  72. <member name="P:UnityEngine.BoxCollider2D.autoTiling">
  73. <summary>
  74. <para>Determines whether the BoxCollider2D's shape is automatically updated based on a SpriteRenderer's tiling properties.</para>
  75. </summary>
  76. </member>
  77. <member name="P:UnityEngine.BoxCollider2D.edgeRadius">
  78. <summary>
  79. <para>Controls the radius of all edges created by the collider.</para>
  80. </summary>
  81. </member>
  82. <member name="P:UnityEngine.BoxCollider2D.size">
  83. <summary>
  84. <para>The width and height of the rectangle.</para>
  85. </summary>
  86. </member>
  87. <member name="T:UnityEngine.BuoyancyEffector2D">
  88. <summary>
  89. <para>Applies forces to simulate buoyancy, fluid-flow and fluid drag.</para>
  90. </summary>
  91. </member>
  92. <member name="P:UnityEngine.BuoyancyEffector2D.angularDrag">
  93. <summary>
  94. <para>A force applied to slow angular movement of any Collider2D in contact with the effector.</para>
  95. </summary>
  96. </member>
  97. <member name="P:UnityEngine.BuoyancyEffector2D.density">
  98. <summary>
  99. <para>The density of the fluid used to calculate the buoyancy forces.</para>
  100. </summary>
  101. </member>
  102. <member name="P:UnityEngine.BuoyancyEffector2D.flowAngle">
  103. <summary>
  104. <para>The angle of the force used to similate fluid flow.</para>
  105. </summary>
  106. </member>
  107. <member name="P:UnityEngine.BuoyancyEffector2D.flowMagnitude">
  108. <summary>
  109. <para>The magnitude of the force used to similate fluid flow.</para>
  110. </summary>
  111. </member>
  112. <member name="P:UnityEngine.BuoyancyEffector2D.flowVariation">
  113. <summary>
  114. <para>The random variation of the force used to similate fluid flow.</para>
  115. </summary>
  116. </member>
  117. <member name="P:UnityEngine.BuoyancyEffector2D.linearDrag">
  118. <summary>
  119. <para>A force applied to slow linear movement of any Collider2D in contact with the effector.</para>
  120. </summary>
  121. </member>
  122. <member name="P:UnityEngine.BuoyancyEffector2D.surfaceLevel">
  123. <summary>
  124. <para>Defines an arbitrary horizontal line that represents the fluid surface level.</para>
  125. </summary>
  126. </member>
  127. <member name="T:UnityEngine.CapsuleCollider2D">
  128. <summary>
  129. <para>A capsule-shaped primitive collider.</para>
  130. </summary>
  131. </member>
  132. <member name="P:UnityEngine.CapsuleCollider2D.direction">
  133. <summary>
  134. <para>The direction that the capsule sides can extend.</para>
  135. </summary>
  136. </member>
  137. <member name="P:UnityEngine.CapsuleCollider2D.size">
  138. <summary>
  139. <para>The width and height of the capsule area.</para>
  140. </summary>
  141. </member>
  142. <member name="T:UnityEngine.CapsuleDirection2D">
  143. <summary>
  144. <para>The direction that the capsule sides can extend.</para>
  145. </summary>
  146. </member>
  147. <member name="F:UnityEngine.CapsuleDirection2D.Horizontal">
  148. <summary>
  149. <para>The capsule sides extend horizontally.</para>
  150. </summary>
  151. </member>
  152. <member name="F:UnityEngine.CapsuleDirection2D.Vertical">
  153. <summary>
  154. <para>The capsule sides extend vertically.</para>
  155. </summary>
  156. </member>
  157. <member name="T:UnityEngine.CircleCollider2D">
  158. <summary>
  159. <para>Collider for 2D physics representing an circle.</para>
  160. </summary>
  161. </member>
  162. <member name="P:UnityEngine.CircleCollider2D.radius">
  163. <summary>
  164. <para>Radius of the circle.</para>
  165. </summary>
  166. </member>
  167. <member name="T:UnityEngine.Collider2D">
  168. <summary>
  169. <para>Parent class for collider types used with 2D gameplay.</para>
  170. </summary>
  171. </member>
  172. <member name="P:UnityEngine.Collider2D.attachedRigidbody">
  173. <summary>
  174. <para>The Rigidbody2D attached to the Collider2D.</para>
  175. </summary>
  176. </member>
  177. <member name="P:UnityEngine.Collider2D.bounciness">
  178. <summary>
  179. <para>Get the bounciness used by the collider.</para>
  180. </summary>
  181. </member>
  182. <member name="P:UnityEngine.Collider2D.bounds">
  183. <summary>
  184. <para>The world space bounding area of the collider.</para>
  185. </summary>
  186. </member>
  187. <member name="P:UnityEngine.Collider2D.composite">
  188. <summary>
  189. <para>Get the CompositeCollider2D that is available to be attached to the collider.</para>
  190. </summary>
  191. </member>
  192. <member name="P:UnityEngine.Collider2D.density">
  193. <summary>
  194. <para>The density of the collider used to calculate its mass (when auto mass is enabled).</para>
  195. </summary>
  196. </member>
  197. <member name="P:UnityEngine.Collider2D.friction">
  198. <summary>
  199. <para>Get the friction used by the collider.</para>
  200. </summary>
  201. </member>
  202. <member name="P:UnityEngine.Collider2D.isTrigger">
  203. <summary>
  204. <para>Is this collider configured as a trigger?</para>
  205. </summary>
  206. </member>
  207. <member name="P:UnityEngine.Collider2D.offset">
  208. <summary>
  209. <para>The local offset of the collider geometry.</para>
  210. </summary>
  211. </member>
  212. <member name="P:UnityEngine.Collider2D.shapeCount">
  213. <summary>
  214. <para>The number of separate shaped regions in the collider.</para>
  215. </summary>
  216. </member>
  217. <member name="P:UnityEngine.Collider2D.sharedMaterial">
  218. <summary>
  219. <para>The PhysicsMaterial2D that is applied to this collider.</para>
  220. </summary>
  221. </member>
  222. <member name="P:UnityEngine.Collider2D.usedByComposite">
  223. <summary>
  224. <para>Sets whether the Collider will be used or not used by a CompositeCollider2D.</para>
  225. </summary>
  226. </member>
  227. <member name="P:UnityEngine.Collider2D.usedByEffector">
  228. <summary>
  229. <para>Whether the collider is used by an attached effector or not.</para>
  230. </summary>
  231. </member>
  232. <member name="M:UnityEngine.Collider2D.Cast(UnityEngine.Vector2,UnityEngine.RaycastHit2D[],System.Single,System.Boolean)">
  233. <summary>
  234. <para>Casts the collider shape into the scene starting at the collider position ignoring the collider itself.</para>
  235. </summary>
  236. <param name="direction">Vector representing the direction to cast the shape.</param>
  237. <param name="results">Array to receive results.</param>
  238. <param name="distance">Maximum distance over which to cast the shape.</param>
  239. <param name="ignoreSiblingColliders">Should colliders attached to the same Rigidbody2D (known as sibling colliders) be ignored?</param>
  240. <returns>
  241. <para>The number of results returned.</para>
  242. </returns>
  243. </member>
  244. <member name="M:UnityEngine.Collider2D.Cast(UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.RaycastHit2D[],System.Single,System.Boolean)">
  245. <summary>
  246. <para>Casts the collider shape into the scene starting at the collider position ignoring the collider itself.</para>
  247. </summary>
  248. <param name="direction">Vector representing the direction to cast the shape.</param>
  249. <param name="contactFilter">Filter results defined by the contact filter.</param>
  250. <param name="results">Array to receive results.</param>
  251. <param name="distance">Maximum distance over which to cast the shape.</param>
  252. <param name="ignoreSiblingColliders">Should colliders attached to the same Rigidbody2D (known as sibling colliders) be ignored?</param>
  253. <returns>
  254. <para>The number of results returned.</para>
  255. </returns>
  256. </member>
  257. <member name="M:UnityEngine.Collider2D.Distance(UnityEngine.Collider2D)">
  258. <summary>
  259. <para>Calculates the minimum separation of this collider against another collider.</para>
  260. </summary>
  261. <param name="collider">A collider used to calculate the minimum separation against this collider.</param>
  262. <returns>
  263. <para>The minimum separation of collider and this collider.</para>
  264. </returns>
  265. </member>
  266. <member name="M:UnityEngine.Collider2D.GetContacts(UnityEngine.ContactPoint2D[])">
  267. <summary>
  268. <para>Retrieves all contact points for this collider.</para>
  269. </summary>
  270. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  271. <returns>
  272. <para>Returns the number of contacts placed in the contacts array.</para>
  273. </returns>
  274. </member>
  275. <member name="M:UnityEngine.Collider2D.GetContacts(UnityEngine.Collider2D[])">
  276. <summary>
  277. <para>Retrieves all colliders in contact with this collider.</para>
  278. </summary>
  279. <param name="colliders">An array of Collider2D used to receive the results.</param>
  280. <returns>
  281. <para>Returns the number of contacts placed in the colliders array.</para>
  282. </returns>
  283. </member>
  284. <member name="M:UnityEngine.Collider2D.GetContacts(UnityEngine.ContactFilter2D,UnityEngine.ContactPoint2D[])">
  285. <summary>
  286. <para>Retrieves all contact points for this collider, with the results filtered by the ContactFilter2D.</para>
  287. </summary>
  288. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  289. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  290. <returns>
  291. <para>Returns the number of contacts placed in the contacts array.</para>
  292. </returns>
  293. </member>
  294. <member name="M:UnityEngine.Collider2D.GetContacts(UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  295. <summary>
  296. <para>Retrieves all colliders in contact with this collider, with the results filtered by the ContactFilter2D.</para>
  297. </summary>
  298. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  299. <param name="colliders">An array of Collider2D used to receive the results.</param>
  300. <returns>
  301. <para>Returns the number of collidersplaced in the colliders array.</para>
  302. </returns>
  303. </member>
  304. <member name="M:UnityEngine.Collider2D.IsTouching(UnityEngine.Collider2D)">
  305. <summary>
  306. <para>Check whether this collider is touching the collider or not.</para>
  307. </summary>
  308. <param name="collider">The collider to check if it is touching this collider.</param>
  309. <returns>
  310. <para>Whether this collider is touching the collider or not.</para>
  311. </returns>
  312. </member>
  313. <member name="M:UnityEngine.Collider2D.IsTouching(UnityEngine.Collider2D,UnityEngine.ContactFilter2D)">
  314. <summary>
  315. <para>Check whether this collider is touching the collider or not with the results filtered by the ContactFilter2D.</para>
  316. </summary>
  317. <param name="collider">The collider to check if it is touching this collider.</param>
  318. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  319. <returns>
  320. <para>Whether this collider is touching the collider or not.</para>
  321. </returns>
  322. </member>
  323. <member name="M:UnityEngine.Collider2D.IsTouching(UnityEngine.ContactFilter2D)">
  324. <summary>
  325. <para>Check whether this collider is touching other colliders or not with the results filtered by the ContactFilter2D.</para>
  326. </summary>
  327. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  328. <returns>
  329. <para>Whether this collider is touching the collider or not.</para>
  330. </returns>
  331. </member>
  332. <member name="M:UnityEngine.Collider2D.IsTouchingLayers(System.Int32)">
  333. <summary>
  334. <para>Checks whether this collider is touching any colliders on the specified layerMask or not.</para>
  335. </summary>
  336. <param name="layerMask">Any colliders on any of these layers count as touching.</param>
  337. <returns>
  338. <para>Whether this collider is touching any collider on the specified layerMask or not.</para>
  339. </returns>
  340. </member>
  341. <member name="M:UnityEngine.Collider2D.OverlapCollider(UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  342. <summary>
  343. <para>Get a list of all colliders that overlap this collider.</para>
  344. </summary>
  345. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.</param>
  346. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  347. <returns>
  348. <para>Returns the number of results placed in the results array.</para>
  349. </returns>
  350. </member>
  351. <member name="M:UnityEngine.Collider2D.OverlapPoint(UnityEngine.Vector2)">
  352. <summary>
  353. <para>Check if a collider overlaps a point in space.</para>
  354. </summary>
  355. <param name="point">A point in world space.</param>
  356. <returns>
  357. <para>Does point overlap the collider?</para>
  358. </returns>
  359. </member>
  360. <member name="M:UnityEngine.Collider2D.Raycast(UnityEngine.Vector2,UnityEngine.RaycastHit2D[],System.Single,System.Int32,System.Single,System.Single)">
  361. <summary>
  362. <para>Casts a ray into the scene starting at the collider position ignoring the collider itself.</para>
  363. </summary>
  364. <param name="direction">Vector representing the direction of the ray.</param>
  365. <param name="results">Array to receive results.</param>
  366. <param name="distance">Maximum distance over which to cast the ray.</param>
  367. <param name="layerMask">Filter to check objects only on specific layers.</param>
  368. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  369. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  370. <param name="contactFilter">Filter results defined by the contact filter.</param>
  371. <returns>
  372. <para>The number of results returned.</para>
  373. </returns>
  374. </member>
  375. <member name="M:UnityEngine.Collider2D.Raycast(UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.RaycastHit2D[],System.Single)">
  376. <summary>
  377. <para>Casts a ray into the scene starting at the collider position ignoring the collider itself.</para>
  378. </summary>
  379. <param name="direction">Vector representing the direction of the ray.</param>
  380. <param name="results">Array to receive results.</param>
  381. <param name="distance">Maximum distance over which to cast the ray.</param>
  382. <param name="layerMask">Filter to check objects only on specific layers.</param>
  383. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  384. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  385. <param name="contactFilter">Filter results defined by the contact filter.</param>
  386. <returns>
  387. <para>The number of results returned.</para>
  388. </returns>
  389. </member>
  390. <member name="T:UnityEngine.ColliderDistance2D">
  391. <summary>
  392. <para>Represents the separation or overlap of two Collider2D.</para>
  393. </summary>
  394. </member>
  395. <member name="P:UnityEngine.ColliderDistance2D.distance">
  396. <summary>
  397. <para>Gets the distance between two colliders.</para>
  398. </summary>
  399. </member>
  400. <member name="P:UnityEngine.ColliderDistance2D.isOverlapped">
  401. <summary>
  402. <para>Gets whether the distance represents an overlap or not.</para>
  403. </summary>
  404. </member>
  405. <member name="P:UnityEngine.ColliderDistance2D.isValid">
  406. <summary>
  407. <para>Gets whether the distance is valid or not.</para>
  408. </summary>
  409. </member>
  410. <member name="P:UnityEngine.ColliderDistance2D.normal">
  411. <summary>
  412. <para>A normalized vector that points from pointB to pointA.</para>
  413. </summary>
  414. </member>
  415. <member name="P:UnityEngine.ColliderDistance2D.pointA">
  416. <summary>
  417. <para>A point on a Collider2D that is a specific distance away from pointB.</para>
  418. </summary>
  419. </member>
  420. <member name="P:UnityEngine.ColliderDistance2D.pointB">
  421. <summary>
  422. <para>A point on a Collider2D that is a specific distance away from pointA.</para>
  423. </summary>
  424. </member>
  425. <member name="T:UnityEngine.Collision2D">
  426. <summary>
  427. <para>Collision details returned by 2D physics callback functions.</para>
  428. </summary>
  429. </member>
  430. <member name="P:UnityEngine.Collision2D.collider">
  431. <summary>
  432. <para>The incoming Collider2D involved in the collision with the otherCollider.</para>
  433. </summary>
  434. </member>
  435. <member name="P:UnityEngine.Collision2D.contactCount">
  436. <summary>
  437. <para>Gets the number of contacts for this collision.</para>
  438. </summary>
  439. </member>
  440. <member name="P:UnityEngine.Collision2D.contacts">
  441. <summary>
  442. <para>The specific points of contact with the incoming Collider2D. You should avoid using this as it produces memory garbage. Use GetContact or GetContacts instead.</para>
  443. </summary>
  444. </member>
  445. <member name="P:UnityEngine.Collision2D.enabled">
  446. <summary>
  447. <para>Indicates whether the collision response or reaction is enabled or disabled.</para>
  448. </summary>
  449. </member>
  450. <member name="P:UnityEngine.Collision2D.gameObject">
  451. <summary>
  452. <para>The incoming GameObject involved in the collision.</para>
  453. </summary>
  454. </member>
  455. <member name="P:UnityEngine.Collision2D.otherCollider">
  456. <summary>
  457. <para>The other Collider2D involved in the collision with the collider.</para>
  458. </summary>
  459. </member>
  460. <member name="P:UnityEngine.Collision2D.otherRigidbody">
  461. <summary>
  462. <para>The other Rigidbody2D involved in the collision with the rigidbody.</para>
  463. </summary>
  464. </member>
  465. <member name="P:UnityEngine.Collision2D.relativeVelocity">
  466. <summary>
  467. <para>The relative linear velocity of the two colliding objects (Read Only).</para>
  468. </summary>
  469. </member>
  470. <member name="P:UnityEngine.Collision2D.rigidbody">
  471. <summary>
  472. <para>The incoming Rigidbody2D involved in the collision with the otherRigidbody.</para>
  473. </summary>
  474. </member>
  475. <member name="P:UnityEngine.Collision2D.transform">
  476. <summary>
  477. <para>The Transform of the incoming object involved in the collision.</para>
  478. </summary>
  479. </member>
  480. <member name="M:UnityEngine.Collision2D.GetContact(System.Int32)">
  481. <summary>
  482. <para>Gets the contact point at the specified index.</para>
  483. </summary>
  484. <param name="index">The index of the contact to retrieve.</param>
  485. <returns>
  486. <para>The contact at the specified index.</para>
  487. </returns>
  488. </member>
  489. <member name="M:UnityEngine.Collision2D.GetContacts(UnityEngine.ContactPoint2D[])">
  490. <summary>
  491. <para>Retrieves all contact points in for contacts between collider and otherCollider.</para>
  492. </summary>
  493. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  494. <returns>
  495. <para>Returns the number of contacts placed in the contacts array.</para>
  496. </returns>
  497. </member>
  498. <member name="T:UnityEngine.CollisionDetectionMode2D">
  499. <summary>
  500. <para>Controls how collisions are detected when a Rigidbody2D moves.</para>
  501. </summary>
  502. </member>
  503. <member name="F:UnityEngine.CollisionDetectionMode2D.Continuous">
  504. <summary>
  505. <para>Ensures that all collisions are detected when a Rigidbody2D moves.</para>
  506. </summary>
  507. </member>
  508. <member name="F:UnityEngine.CollisionDetectionMode2D.Discrete">
  509. <summary>
  510. <para>When a Rigidbody2D moves, only collisions at the new position are detected.</para>
  511. </summary>
  512. </member>
  513. <member name="F:UnityEngine.CollisionDetectionMode2D.None">
  514. <summary>
  515. <para>This mode is obsolete. You should use Discrete mode.</para>
  516. </summary>
  517. </member>
  518. <member name="T:UnityEngine.CompositeCollider2D">
  519. <summary>
  520. <para>A Collider that can merge other Colliders together.</para>
  521. </summary>
  522. </member>
  523. <member name="P:UnityEngine.CompositeCollider2D.edgeRadius">
  524. <summary>
  525. <para>Controls the radius of all edges created by the Collider.</para>
  526. </summary>
  527. </member>
  528. <member name="P:UnityEngine.CompositeCollider2D.generationType">
  529. <summary>
  530. <para>Specifies when to generate the Composite Collider geometry.</para>
  531. </summary>
  532. </member>
  533. <member name="P:UnityEngine.CompositeCollider2D.geometryType">
  534. <summary>
  535. <para>Specifies the type of geometry the Composite Collider should generate.</para>
  536. </summary>
  537. </member>
  538. <member name="P:UnityEngine.CompositeCollider2D.pathCount">
  539. <summary>
  540. <para>The number of paths in the Collider.</para>
  541. </summary>
  542. </member>
  543. <member name="P:UnityEngine.CompositeCollider2D.pointCount">
  544. <summary>
  545. <para>Gets the total number of points in all the paths within the Collider.</para>
  546. </summary>
  547. </member>
  548. <member name="P:UnityEngine.CompositeCollider2D.vertexDistance">
  549. <summary>
  550. <para>Controls the minimum distance allowed between generated vertices.</para>
  551. </summary>
  552. </member>
  553. <member name="M:UnityEngine.CompositeCollider2D.GenerateGeometry">
  554. <summary>
  555. <para>Regenerates the Composite Collider geometry.</para>
  556. </summary>
  557. </member>
  558. <member name="T:UnityEngine.CompositeCollider2D.GenerationType">
  559. <summary>
  560. <para>Specifies when to generate the Composite Collider geometry.</para>
  561. </summary>
  562. </member>
  563. <member name="F:UnityEngine.CompositeCollider2D.GenerationType.Manual">
  564. <summary>
  565. <para>Sets the Composite Collider geometry to not automatically update when a Collider used by the Composite Collider changes.</para>
  566. </summary>
  567. </member>
  568. <member name="F:UnityEngine.CompositeCollider2D.GenerationType.Synchronous">
  569. <summary>
  570. <para>Sets the Composite Collider geometry to update synchronously immediately when a Collider used by the Composite Collider changes.</para>
  571. </summary>
  572. </member>
  573. <member name="T:UnityEngine.CompositeCollider2D.GeometryType">
  574. <summary>
  575. <para>Specifies the type of geometry the Composite Collider generates.</para>
  576. </summary>
  577. </member>
  578. <member name="F:UnityEngine.CompositeCollider2D.GeometryType.Outlines">
  579. <summary>
  580. <para>Sets the Composite Collider to generate closed outlines for the merged Collider geometry consisting of only edges.</para>
  581. </summary>
  582. </member>
  583. <member name="F:UnityEngine.CompositeCollider2D.GeometryType.Polygons">
  584. <summary>
  585. <para>Sets the Composite Collider to generate closed outlines for the merged Collider geometry consisting of convex polygon shapes.</para>
  586. </summary>
  587. </member>
  588. <member name="M:UnityEngine.CompositeCollider2D.GetPath(System.Int32,UnityEngine.Vector2[])">
  589. <summary>
  590. <para>Gets a path from the Collider by its index.</para>
  591. </summary>
  592. <param name="index">The index of the path from 0 to pathCount.</param>
  593. <param name="points">An ordered array of the vertices or points in the selected path.</param>
  594. <returns>
  595. <para>Returns the number of points placed in the points array.</para>
  596. </returns>
  597. </member>
  598. <member name="M:UnityEngine.CompositeCollider2D.GetPathPointCount(System.Int32)">
  599. <summary>
  600. <para>Gets the number of points in the specified path from the Collider by its index.</para>
  601. </summary>
  602. <param name="index">The index of the path from 0 to pathCount.</param>
  603. <returns>
  604. <para>Returns the number of points in the path specified by index.</para>
  605. </returns>
  606. </member>
  607. <member name="T:UnityEngine.ConstantForce2D">
  608. <summary>
  609. <para>Applies both linear and angular (torque) forces continuously to the rigidbody each physics update.</para>
  610. </summary>
  611. </member>
  612. <member name="P:UnityEngine.ConstantForce2D.force">
  613. <summary>
  614. <para>The linear force applied to the rigidbody each physics update.</para>
  615. </summary>
  616. </member>
  617. <member name="P:UnityEngine.ConstantForce2D.relativeForce">
  618. <summary>
  619. <para>The linear force, relative to the rigid-body coordinate system, applied each physics update.</para>
  620. </summary>
  621. </member>
  622. <member name="P:UnityEngine.ConstantForce2D.torque">
  623. <summary>
  624. <para>The torque applied to the rigidbody each physics update.</para>
  625. </summary>
  626. </member>
  627. <member name="T:UnityEngine.ContactFilter2D">
  628. <summary>
  629. <para>A set of parameters for filtering contact results.</para>
  630. </summary>
  631. </member>
  632. <member name="P:UnityEngine.ContactFilter2D.isFiltering">
  633. <summary>
  634. <para>Given the current state of the contact filter, determine whether it would filter anything.</para>
  635. </summary>
  636. </member>
  637. <member name="F:UnityEngine.ContactFilter2D.layerMask">
  638. <summary>
  639. <para>Sets the contact filter to filter the results that only include Collider2D on the layers defined by the layer mask.</para>
  640. </summary>
  641. </member>
  642. <member name="F:UnityEngine.ContactFilter2D.maxDepth">
  643. <summary>
  644. <para>Sets the contact filter to filter the results to only include Collider2D with a Z coordinate (depth) less than this value.</para>
  645. </summary>
  646. </member>
  647. <member name="F:UnityEngine.ContactFilter2D.maxNormalAngle">
  648. <summary>
  649. <para>Sets the contact filter to filter the results to only include contacts with collision normal angles that are less than this angle.</para>
  650. </summary>
  651. </member>
  652. <member name="F:UnityEngine.ContactFilter2D.minDepth">
  653. <summary>
  654. <para>Sets the contact filter to filter the results to only include Collider2D with a Z coordinate (depth) greater than this value.</para>
  655. </summary>
  656. </member>
  657. <member name="F:UnityEngine.ContactFilter2D.minNormalAngle">
  658. <summary>
  659. <para>Sets the contact filter to filter the results to only include contacts with collision normal angles that are greater than this angle.</para>
  660. </summary>
  661. </member>
  662. <member name="F:UnityEngine.ContactFilter2D.useDepth">
  663. <summary>
  664. <para>Sets the contact filter to filter the results by depth using minDepth and maxDepth.</para>
  665. </summary>
  666. </member>
  667. <member name="F:UnityEngine.ContactFilter2D.useLayerMask">
  668. <summary>
  669. <para>Sets the contact filter to filter results by layer mask.</para>
  670. </summary>
  671. </member>
  672. <member name="F:UnityEngine.ContactFilter2D.useNormalAngle">
  673. <summary>
  674. <para>Sets the contact filter to filter the results by the collision's normal angle using minNormalAngle and maxNormalAngle.</para>
  675. </summary>
  676. </member>
  677. <member name="F:UnityEngine.ContactFilter2D.useOutsideDepth">
  678. <summary>
  679. <para>Sets the contact filter to filter within the minDepth and maxDepth range, or outside that range.</para>
  680. </summary>
  681. </member>
  682. <member name="F:UnityEngine.ContactFilter2D.useOutsideNormalAngle">
  683. <summary>
  684. <para>Sets the contact filter to filter within the minNormalAngle and maxNormalAngle range, or outside that range.</para>
  685. </summary>
  686. </member>
  687. <member name="F:UnityEngine.ContactFilter2D.useTriggers">
  688. <summary>
  689. <para>Sets to filter contact results based on trigger collider involvement.</para>
  690. </summary>
  691. </member>
  692. <member name="M:UnityEngine.ContactFilter2D.ClearDepth">
  693. <summary>
  694. <para>Turns off depth filtering by setting useDepth to false. The associated values of minDepth and maxDepth are not changed.</para>
  695. </summary>
  696. </member>
  697. <member name="M:UnityEngine.ContactFilter2D.ClearLayerMask">
  698. <summary>
  699. <para>Turns off layer mask filtering by setting useLayerMask to false. The associated value of layerMask is not changed.</para>
  700. </summary>
  701. </member>
  702. <member name="M:UnityEngine.ContactFilter2D.ClearNormalAngle">
  703. <summary>
  704. <para>Turns off normal angle filtering by setting useNormalAngle to false. The associated values of minNormalAngle and maxNormalAngle are not changed.</para>
  705. </summary>
  706. </member>
  707. <member name="M:UnityEngine.ContactFilter2D.IsFilteringDepth(UnityEngine.GameObject)">
  708. <summary>
  709. <para>Checks if the Transform for obj is within the depth range to be filtered.</para>
  710. </summary>
  711. <param name="obj">The GameObject used to check the z-position (depth) of Transform.position.</param>
  712. <returns>
  713. <para>Returns true when obj is excluded by the filter and false if otherwise.</para>
  714. </returns>
  715. </member>
  716. <member name="M:UnityEngine.ContactFilter2D.IsFilteringLayerMask(UnityEngine.GameObject)">
  717. <summary>
  718. <para>Checks if the GameObject.layer for obj is included in the layerMask to be filtered.</para>
  719. </summary>
  720. <param name="obj">The GameObject used to check the GameObject.layer.</param>
  721. <returns>
  722. <para>Returns true when obj is excluded by the filter and false if otherwise.</para>
  723. </returns>
  724. </member>
  725. <member name="M:UnityEngine.ContactFilter2D.IsFilteringNormalAngle(UnityEngine.Vector2)">
  726. <summary>
  727. <para>Checks if the angle of normal is within the normal angle range to be filtered.</para>
  728. </summary>
  729. <param name="normal">The normal used to calculate an angle.</param>
  730. <returns>
  731. <para>Returns true when normal is excluded by the filter and false if otherwise.</para>
  732. </returns>
  733. </member>
  734. <member name="M:UnityEngine.ContactFilter2D.IsFilteringNormalAngle(System.Single)">
  735. <summary>
  736. <para>Checks if the angle is within the normal angle range to be filtered.</para>
  737. </summary>
  738. <param name="angle">The angle used for comparison in the filter.</param>
  739. <returns>
  740. <para>Returns true when angle is excluded by the filter and false if otherwise.</para>
  741. </returns>
  742. </member>
  743. <member name="M:UnityEngine.ContactFilter2D.IsFilteringTrigger(UnityEngine.Collider2D)">
  744. <summary>
  745. <para>Checks if the collider is a trigger and should be filtered by the useTriggers to be filtered.</para>
  746. </summary>
  747. <param name="collider">The Collider2D used to check for a trigger.</param>
  748. <returns>
  749. <para>Returns true when collider is excluded by the filter and false if otherwise.</para>
  750. </returns>
  751. </member>
  752. <member name="M:UnityEngine.ContactFilter2D.NoFilter">
  753. <summary>
  754. <para>Sets the contact filter to not filter any ContactPoint2D.</para>
  755. </summary>
  756. <returns>
  757. <para>A copy of the contact filter set to not filter any ContactPoint2D.</para>
  758. </returns>
  759. </member>
  760. <member name="M:UnityEngine.ContactFilter2D.SetDepth(System.Single,System.Single)">
  761. <summary>
  762. <para>Sets the minDepth and maxDepth filter properties and turns on depth filtering by setting useDepth to true.</para>
  763. </summary>
  764. <param name="minDepth">The value used to set minDepth.</param>
  765. <param name="maxDepth">The value used to set maxDepth.</param>
  766. </member>
  767. <member name="M:UnityEngine.ContactFilter2D.SetLayerMask(UnityEngine.LayerMask)">
  768. <summary>
  769. <para>Sets the layerMask filter property using the layerMask parameter provided and also enables layer mask filtering by setting useLayerMask to true.</para>
  770. </summary>
  771. <param name="layerMask">The value used to set the layerMask.</param>
  772. </member>
  773. <member name="M:UnityEngine.ContactFilter2D.SetNormalAngle(System.Single,System.Single)">
  774. <summary>
  775. <para>Sets the minNormalAngle and maxNormalAngle filter properties and turns on normal angle filtering by setting useNormalAngle to true.</para>
  776. </summary>
  777. <param name="minNormalAngle">The value used to set the minNormalAngle.</param>
  778. <param name="maxNormalAngle">The value used to set the maxNormalAngle.</param>
  779. </member>
  780. <member name="T:UnityEngine.ContactPoint2D">
  781. <summary>
  782. <para>Details about a specific point of contact involved in a 2D physics collision.</para>
  783. </summary>
  784. </member>
  785. <member name="P:UnityEngine.ContactPoint2D.collider">
  786. <summary>
  787. <para>The incoming Collider2D involved in the collision with the otherCollider.</para>
  788. </summary>
  789. </member>
  790. <member name="P:UnityEngine.ContactPoint2D.enabled">
  791. <summary>
  792. <para>Indicates whether the collision response or reaction is enabled or disabled.</para>
  793. </summary>
  794. </member>
  795. <member name="P:UnityEngine.ContactPoint2D.normal">
  796. <summary>
  797. <para>Surface normal at the contact point.</para>
  798. </summary>
  799. </member>
  800. <member name="P:UnityEngine.ContactPoint2D.normalImpulse">
  801. <summary>
  802. <para>Gets the impulse force applied at the contact point along the ContactPoint2D.normal.</para>
  803. </summary>
  804. </member>
  805. <member name="P:UnityEngine.ContactPoint2D.otherCollider">
  806. <summary>
  807. <para>The other Collider2D involved in the collision with the collider.</para>
  808. </summary>
  809. </member>
  810. <member name="P:UnityEngine.ContactPoint2D.otherRigidbody">
  811. <summary>
  812. <para>The other Rigidbody2D involved in the collision with the rigidbody.</para>
  813. </summary>
  814. </member>
  815. <member name="P:UnityEngine.ContactPoint2D.point">
  816. <summary>
  817. <para>The point of contact between the two colliders in world space.</para>
  818. </summary>
  819. </member>
  820. <member name="P:UnityEngine.ContactPoint2D.relativeVelocity">
  821. <summary>
  822. <para>Gets the relative velocity of the two colliders at the contact point (Read Only).</para>
  823. </summary>
  824. </member>
  825. <member name="P:UnityEngine.ContactPoint2D.rigidbody">
  826. <summary>
  827. <para>The incoming Rigidbody2D involved in the collision with the otherRigidbody.</para>
  828. </summary>
  829. </member>
  830. <member name="P:UnityEngine.ContactPoint2D.separation">
  831. <summary>
  832. <para>Gets the distance between the colliders at the contact point.</para>
  833. </summary>
  834. </member>
  835. <member name="P:UnityEngine.ContactPoint2D.tangentImpulse">
  836. <summary>
  837. <para>Gets the impulse force applied at the contact point which is perpendicular to the ContactPoint2D.normal.</para>
  838. </summary>
  839. </member>
  840. <member name="T:UnityEngine.DistanceJoint2D">
  841. <summary>
  842. <para>Joint that keeps two Rigidbody2D objects a fixed distance apart.</para>
  843. </summary>
  844. </member>
  845. <member name="P:UnityEngine.DistanceJoint2D.autoConfigureDistance">
  846. <summary>
  847. <para>Should the distance be calculated automatically?</para>
  848. </summary>
  849. </member>
  850. <member name="P:UnityEngine.DistanceJoint2D.distance">
  851. <summary>
  852. <para>The distance separating the two ends of the joint.</para>
  853. </summary>
  854. </member>
  855. <member name="P:UnityEngine.DistanceJoint2D.maxDistanceOnly">
  856. <summary>
  857. <para>Whether to maintain a maximum distance only or not. If not then the absolute distance will be maintained instead.</para>
  858. </summary>
  859. </member>
  860. <member name="T:UnityEngine.EdgeCollider2D">
  861. <summary>
  862. <para>Collider for 2D physics representing an arbitrary set of connected edges (lines) defined by its vertices.</para>
  863. </summary>
  864. </member>
  865. <member name="P:UnityEngine.EdgeCollider2D.edgeCount">
  866. <summary>
  867. <para>Gets the number of edges.</para>
  868. </summary>
  869. </member>
  870. <member name="P:UnityEngine.EdgeCollider2D.edgeRadius">
  871. <summary>
  872. <para>Controls the radius of all edges created by the collider.</para>
  873. </summary>
  874. </member>
  875. <member name="P:UnityEngine.EdgeCollider2D.pointCount">
  876. <summary>
  877. <para>Gets the number of points.</para>
  878. </summary>
  879. </member>
  880. <member name="P:UnityEngine.EdgeCollider2D.points">
  881. <summary>
  882. <para>Get or set the points defining multiple continuous edges.</para>
  883. </summary>
  884. </member>
  885. <member name="M:UnityEngine.EdgeCollider2D.Reset">
  886. <summary>
  887. <para>Reset to a single edge consisting of two points.</para>
  888. </summary>
  889. </member>
  890. <member name="T:UnityEngine.Effector2D">
  891. <summary>
  892. <para>A base class for all 2D effectors.</para>
  893. </summary>
  894. </member>
  895. <member name="P:UnityEngine.Effector2D.colliderMask">
  896. <summary>
  897. <para>The mask used to select specific layers allowed to interact with the effector.</para>
  898. </summary>
  899. </member>
  900. <member name="P:UnityEngine.Effector2D.useColliderMask">
  901. <summary>
  902. <para>Should the collider-mask be used or the global collision matrix?</para>
  903. </summary>
  904. </member>
  905. <member name="T:UnityEngine.EffectorForceMode2D">
  906. <summary>
  907. <para>The mode used to apply Effector2D forces.</para>
  908. </summary>
  909. </member>
  910. <member name="F:UnityEngine.EffectorForceMode2D.Constant">
  911. <summary>
  912. <para>The force is applied at a constant rate.</para>
  913. </summary>
  914. </member>
  915. <member name="F:UnityEngine.EffectorForceMode2D.InverseLinear">
  916. <summary>
  917. <para>The force is applied inverse-linear relative to a point.</para>
  918. </summary>
  919. </member>
  920. <member name="F:UnityEngine.EffectorForceMode2D.InverseSquared">
  921. <summary>
  922. <para>The force is applied inverse-squared relative to a point.</para>
  923. </summary>
  924. </member>
  925. <member name="T:UnityEngine.EffectorSelection2D">
  926. <summary>
  927. <para>Selects the source and/or target to be used by an Effector2D.</para>
  928. </summary>
  929. </member>
  930. <member name="F:UnityEngine.EffectorSelection2D.Collider">
  931. <summary>
  932. <para>The source/target is defined by the Collider2D.</para>
  933. </summary>
  934. </member>
  935. <member name="F:UnityEngine.EffectorSelection2D.Rigidbody">
  936. <summary>
  937. <para>The source/target is defined by the Rigidbody2D.</para>
  938. </summary>
  939. </member>
  940. <member name="T:UnityEngine.FixedJoint2D">
  941. <summary>
  942. <para>Connects two Rigidbody2D together at their anchor points using a configurable spring.</para>
  943. </summary>
  944. </member>
  945. <member name="P:UnityEngine.FixedJoint2D.dampingRatio">
  946. <summary>
  947. <para>The amount by which the spring force is reduced in proportion to the movement speed.</para>
  948. </summary>
  949. </member>
  950. <member name="P:UnityEngine.FixedJoint2D.frequency">
  951. <summary>
  952. <para>The frequency at which the spring oscillates around the distance between the objects.</para>
  953. </summary>
  954. </member>
  955. <member name="P:UnityEngine.FixedJoint2D.referenceAngle">
  956. <summary>
  957. <para>The angle referenced between the two bodies used as the constraint for the joint.</para>
  958. </summary>
  959. </member>
  960. <member name="T:UnityEngine.ForceMode2D">
  961. <summary>
  962. <para>Option for how to apply a force using Rigidbody2D.AddForce.</para>
  963. </summary>
  964. </member>
  965. <member name="F:UnityEngine.ForceMode2D.Force">
  966. <summary>
  967. <para>Add a force to the Rigidbody2D, using its mass.</para>
  968. </summary>
  969. </member>
  970. <member name="F:UnityEngine.ForceMode2D.Impulse">
  971. <summary>
  972. <para>Add an instant force impulse to the rigidbody2D, using its mass.</para>
  973. </summary>
  974. </member>
  975. <member name="T:UnityEngine.FrictionJoint2D">
  976. <summary>
  977. <para>Applies both force and torque to reduce both the linear and angular velocities to zero.</para>
  978. </summary>
  979. </member>
  980. <member name="P:UnityEngine.FrictionJoint2D.maxForce">
  981. <summary>
  982. <para>The maximum force that can be generated when trying to maintain the friction joint constraint.</para>
  983. </summary>
  984. </member>
  985. <member name="P:UnityEngine.FrictionJoint2D.maxTorque">
  986. <summary>
  987. <para>The maximum torque that can be generated when trying to maintain the friction joint constraint.</para>
  988. </summary>
  989. </member>
  990. <member name="T:UnityEngine.HingeJoint2D">
  991. <summary>
  992. <para>Joint that allows a Rigidbody2D object to rotate around a point in space or a point on another object.</para>
  993. </summary>
  994. </member>
  995. <member name="P:UnityEngine.HingeJoint2D.jointAngle">
  996. <summary>
  997. <para>The current joint angle (in degrees) with respect to the reference angle.</para>
  998. </summary>
  999. </member>
  1000. <member name="P:UnityEngine.HingeJoint2D.jointSpeed">
  1001. <summary>
  1002. <para>The current joint speed.</para>
  1003. </summary>
  1004. </member>
  1005. <member name="P:UnityEngine.HingeJoint2D.limits">
  1006. <summary>
  1007. <para>Limit of angular rotation (in degrees) on the joint.</para>
  1008. </summary>
  1009. </member>
  1010. <member name="P:UnityEngine.HingeJoint2D.limitState">
  1011. <summary>
  1012. <para>Gets the state of the joint limit.</para>
  1013. </summary>
  1014. </member>
  1015. <member name="P:UnityEngine.HingeJoint2D.motor">
  1016. <summary>
  1017. <para>Parameters for the motor force applied to the joint.</para>
  1018. </summary>
  1019. </member>
  1020. <member name="P:UnityEngine.HingeJoint2D.referenceAngle">
  1021. <summary>
  1022. <para>The angle (in degrees) referenced between the two bodies used as the constraint for the joint.</para>
  1023. </summary>
  1024. </member>
  1025. <member name="P:UnityEngine.HingeJoint2D.useLimits">
  1026. <summary>
  1027. <para>Should limits be placed on the range of rotation?</para>
  1028. </summary>
  1029. </member>
  1030. <member name="P:UnityEngine.HingeJoint2D.useMotor">
  1031. <summary>
  1032. <para>Should the joint be rotated automatically by a motor torque?</para>
  1033. </summary>
  1034. </member>
  1035. <member name="M:UnityEngine.HingeJoint2D.GetMotorTorque(System.Single)">
  1036. <summary>
  1037. <para>Gets the motor torque of the joint given the specified timestep.</para>
  1038. </summary>
  1039. <param name="timeStep">The time to calculate the motor torque for.</param>
  1040. </member>
  1041. <member name="T:UnityEngine.Joint2D">
  1042. <summary>
  1043. <para>Parent class for joints to connect Rigidbody2D objects.</para>
  1044. </summary>
  1045. </member>
  1046. <member name="P:UnityEngine.Joint2D.attachedRigidbody">
  1047. <summary>
  1048. <para>The Rigidbody2D attached to the Joint2D.</para>
  1049. </summary>
  1050. </member>
  1051. <member name="P:UnityEngine.Joint2D.breakForce">
  1052. <summary>
  1053. <para>The force that needs to be applied for this joint to break.</para>
  1054. </summary>
  1055. </member>
  1056. <member name="P:UnityEngine.Joint2D.breakTorque">
  1057. <summary>
  1058. <para>The torque that needs to be applied for this joint to break.</para>
  1059. </summary>
  1060. </member>
  1061. <member name="P:UnityEngine.Joint2D.connectedBody">
  1062. <summary>
  1063. <para>The Rigidbody2D object to which the other end of the joint is attached (ie, the object without the joint component).</para>
  1064. </summary>
  1065. </member>
  1066. <member name="P:UnityEngine.Joint2D.enableCollision">
  1067. <summary>
  1068. <para>Should the two rigid bodies connected with this joint collide with each other?</para>
  1069. </summary>
  1070. </member>
  1071. <member name="P:UnityEngine.Joint2D.reactionForce">
  1072. <summary>
  1073. <para>Gets the reaction force of the joint.</para>
  1074. </summary>
  1075. </member>
  1076. <member name="P:UnityEngine.Joint2D.reactionTorque">
  1077. <summary>
  1078. <para>Gets the reaction torque of the joint.</para>
  1079. </summary>
  1080. </member>
  1081. <member name="M:UnityEngine.Joint2D.GetReactionForce(System.Single)">
  1082. <summary>
  1083. <para>Gets the reaction force of the joint given the specified timeStep.</para>
  1084. </summary>
  1085. <param name="timeStep">The time to calculate the reaction force for.</param>
  1086. <returns>
  1087. <para>The reaction force of the joint in the specified timeStep.</para>
  1088. </returns>
  1089. </member>
  1090. <member name="M:UnityEngine.Joint2D.GetReactionTorque(System.Single)">
  1091. <summary>
  1092. <para>Gets the reaction torque of the joint given the specified timeStep.</para>
  1093. </summary>
  1094. <param name="timeStep">The time to calculate the reaction torque for.</param>
  1095. <returns>
  1096. <para>The reaction torque of the joint in the specified timeStep.</para>
  1097. </returns>
  1098. </member>
  1099. <member name="T:UnityEngine.JointAngleLimits2D">
  1100. <summary>
  1101. <para>Angular limits on the rotation of a Rigidbody2D object around a HingeJoint2D.</para>
  1102. </summary>
  1103. </member>
  1104. <member name="P:UnityEngine.JointAngleLimits2D.max">
  1105. <summary>
  1106. <para>Upper angular limit of rotation.</para>
  1107. </summary>
  1108. </member>
  1109. <member name="P:UnityEngine.JointAngleLimits2D.min">
  1110. <summary>
  1111. <para>Lower angular limit of rotation.</para>
  1112. </summary>
  1113. </member>
  1114. <member name="T:UnityEngine.JointLimitState2D">
  1115. <summary>
  1116. <para>Represents the state of a joint limit.</para>
  1117. </summary>
  1118. </member>
  1119. <member name="F:UnityEngine.JointLimitState2D.EqualLimits">
  1120. <summary>
  1121. <para>Represents a state where the joint limit is at the specified lower and upper limits (they are identical).</para>
  1122. </summary>
  1123. </member>
  1124. <member name="F:UnityEngine.JointLimitState2D.Inactive">
  1125. <summary>
  1126. <para>Represents a state where the joint limit is inactive.</para>
  1127. </summary>
  1128. </member>
  1129. <member name="F:UnityEngine.JointLimitState2D.LowerLimit">
  1130. <summary>
  1131. <para>Represents a state where the joint limit is at the specified lower limit.</para>
  1132. </summary>
  1133. </member>
  1134. <member name="F:UnityEngine.JointLimitState2D.UpperLimit">
  1135. <summary>
  1136. <para>Represents a state where the joint limit is at the specified upper limit.</para>
  1137. </summary>
  1138. </member>
  1139. <member name="T:UnityEngine.JointMotor2D">
  1140. <summary>
  1141. <para>Parameters for the optional motor force applied to a Joint2D.</para>
  1142. </summary>
  1143. </member>
  1144. <member name="P:UnityEngine.JointMotor2D.maxMotorTorque">
  1145. <summary>
  1146. <para>The maximum force that can be applied to the Rigidbody2D at the joint to attain the target speed.</para>
  1147. </summary>
  1148. </member>
  1149. <member name="P:UnityEngine.JointMotor2D.motorSpeed">
  1150. <summary>
  1151. <para>The desired speed for the Rigidbody2D to reach as it moves with the joint.</para>
  1152. </summary>
  1153. </member>
  1154. <member name="T:UnityEngine.JointSuspension2D">
  1155. <summary>
  1156. <para>Joint suspension is used to define how suspension works on a WheelJoint2D.</para>
  1157. </summary>
  1158. </member>
  1159. <member name="P:UnityEngine.JointSuspension2D.angle">
  1160. <summary>
  1161. <para>The world angle (in degrees) along which the suspension will move.</para>
  1162. </summary>
  1163. </member>
  1164. <member name="P:UnityEngine.JointSuspension2D.dampingRatio">
  1165. <summary>
  1166. <para>The amount by which the suspension spring force is reduced in proportion to the movement speed.</para>
  1167. </summary>
  1168. </member>
  1169. <member name="P:UnityEngine.JointSuspension2D.frequency">
  1170. <summary>
  1171. <para>The frequency at which the suspension spring oscillates.</para>
  1172. </summary>
  1173. </member>
  1174. <member name="T:UnityEngine.JointTranslationLimits2D">
  1175. <summary>
  1176. <para>Motion limits of a Rigidbody2D object along a SliderJoint2D.</para>
  1177. </summary>
  1178. </member>
  1179. <member name="P:UnityEngine.JointTranslationLimits2D.max">
  1180. <summary>
  1181. <para>Maximum distance the Rigidbody2D object can move from the Slider Joint's anchor.</para>
  1182. </summary>
  1183. </member>
  1184. <member name="P:UnityEngine.JointTranslationLimits2D.min">
  1185. <summary>
  1186. <para>Minimum distance the Rigidbody2D object can move from the Slider Joint's anchor.</para>
  1187. </summary>
  1188. </member>
  1189. <member name="T:UnityEngine.Physics2D">
  1190. <summary>
  1191. <para>Global settings and helpers for 2D physics.</para>
  1192. </summary>
  1193. </member>
  1194. <member name="P:UnityEngine.Physics2D.alwaysShowColliders">
  1195. <summary>
  1196. <para>Should the collider gizmos always be shown even when they are not selected?</para>
  1197. </summary>
  1198. </member>
  1199. <member name="P:UnityEngine.Physics2D.angularSleepTolerance">
  1200. <summary>
  1201. <para>A rigid-body cannot sleep if its angular velocity is above this tolerance.</para>
  1202. </summary>
  1203. </member>
  1204. <member name="P:UnityEngine.Physics2D.autoSimulation">
  1205. <summary>
  1206. <para>Sets whether the physics should be simulated automatically or not.</para>
  1207. </summary>
  1208. </member>
  1209. <member name="P:UnityEngine.Physics2D.autoSyncTransforms">
  1210. <summary>
  1211. <para>Whether or not to automatically sync transform changes with the physics system whenever a Transform component changes.</para>
  1212. </summary>
  1213. </member>
  1214. <member name="P:UnityEngine.Physics2D.baumgarteScale">
  1215. <summary>
  1216. <para>The scale factor that controls how fast overlaps are resolved.</para>
  1217. </summary>
  1218. </member>
  1219. <member name="P:UnityEngine.Physics2D.baumgarteTOIScale">
  1220. <summary>
  1221. <para>The scale factor that controls how fast TOI overlaps are resolved.</para>
  1222. </summary>
  1223. </member>
  1224. <member name="P:UnityEngine.Physics2D.callbacksOnDisable">
  1225. <summary>
  1226. <para>Use this to control whether or not the appropriate OnCollisionExit2D or OnTriggerExit2D callbacks should be called when a Collider2D is disabled.</para>
  1227. </summary>
  1228. </member>
  1229. <member name="P:UnityEngine.Physics2D.colliderAABBColor">
  1230. <summary>
  1231. <para>Sets the color used by the gizmos to show all Collider axis-aligned bounding boxes (AABBs).</para>
  1232. </summary>
  1233. </member>
  1234. <member name="P:UnityEngine.Physics2D.colliderAsleepColor">
  1235. <summary>
  1236. <para>The color used by the gizmos to show all asleep colliders (collider is asleep when the body is asleep).</para>
  1237. </summary>
  1238. </member>
  1239. <member name="P:UnityEngine.Physics2D.colliderAwakeColor">
  1240. <summary>
  1241. <para>The color used by the gizmos to show all awake colliders (collider is awake when the body is awake).</para>
  1242. </summary>
  1243. </member>
  1244. <member name="P:UnityEngine.Physics2D.colliderContactColor">
  1245. <summary>
  1246. <para>The color used by the gizmos to show all collider contacts.</para>
  1247. </summary>
  1248. </member>
  1249. <member name="P:UnityEngine.Physics2D.contactArrowScale">
  1250. <summary>
  1251. <para>The scale of the contact arrow used by the collider gizmos.</para>
  1252. </summary>
  1253. </member>
  1254. <member name="P:UnityEngine.Physics2D.defaultContactOffset">
  1255. <summary>
  1256. <para>The default contact offset of the newly created colliders.</para>
  1257. </summary>
  1258. </member>
  1259. <member name="P:UnityEngine.Physics2D.gravity">
  1260. <summary>
  1261. <para>Acceleration due to gravity.</para>
  1262. </summary>
  1263. </member>
  1264. <member name="P:UnityEngine.Physics2D.jobOptions">
  1265. <summary>
  1266. <para>A set of options that control how physics operates when using the job system to multithread the physics simulation.</para>
  1267. </summary>
  1268. </member>
  1269. <member name="P:UnityEngine.Physics2D.linearSleepTolerance">
  1270. <summary>
  1271. <para>A rigid-body cannot sleep if its linear velocity is above this tolerance.</para>
  1272. </summary>
  1273. </member>
  1274. <member name="P:UnityEngine.Physics2D.maxAngularCorrection">
  1275. <summary>
  1276. <para>The maximum angular position correction used when solving constraints. This helps to prevent overshoot.</para>
  1277. </summary>
  1278. </member>
  1279. <member name="P:UnityEngine.Physics2D.maxLinearCorrection">
  1280. <summary>
  1281. <para>The maximum linear position correction used when solving constraints. This helps to prevent overshoot.</para>
  1282. </summary>
  1283. </member>
  1284. <member name="P:UnityEngine.Physics2D.maxRotationSpeed">
  1285. <summary>
  1286. <para>The maximum angular speed of a rigid-body per physics update. Increasing this can cause numerical problems.</para>
  1287. </summary>
  1288. </member>
  1289. <member name="P:UnityEngine.Physics2D.maxTranslationSpeed">
  1290. <summary>
  1291. <para>The maximum linear speed of a rigid-body per physics update. Increasing this can cause numerical problems.</para>
  1292. </summary>
  1293. </member>
  1294. <member name="P:UnityEngine.Physics2D.positionIterations">
  1295. <summary>
  1296. <para>The number of iterations of the physics solver when considering objects' positions.</para>
  1297. </summary>
  1298. </member>
  1299. <member name="P:UnityEngine.Physics2D.queriesHitTriggers">
  1300. <summary>
  1301. <para>Do raycasts detect Colliders configured as triggers?</para>
  1302. </summary>
  1303. </member>
  1304. <member name="P:UnityEngine.Physics2D.queriesStartInColliders">
  1305. <summary>
  1306. <para>Sets the raycasts or linecasts that start inside Colliders to detect or not detect those Colliders.</para>
  1307. </summary>
  1308. </member>
  1309. <member name="P:UnityEngine.Physics2D.showColliderAABB">
  1310. <summary>
  1311. <para>Should the collider gizmos show the AABBs for each collider?</para>
  1312. </summary>
  1313. </member>
  1314. <member name="P:UnityEngine.Physics2D.showColliderContacts">
  1315. <summary>
  1316. <para>Should the collider gizmos show current contacts for each collider?</para>
  1317. </summary>
  1318. </member>
  1319. <member name="P:UnityEngine.Physics2D.showColliderSleep">
  1320. <summary>
  1321. <para>Should the collider gizmos show the sleep-state for each collider?</para>
  1322. </summary>
  1323. </member>
  1324. <member name="P:UnityEngine.Physics2D.timeToSleep">
  1325. <summary>
  1326. <para>The time in seconds that a rigid-body must be still before it will go to sleep.</para>
  1327. </summary>
  1328. </member>
  1329. <member name="P:UnityEngine.Physics2D.velocityIterations">
  1330. <summary>
  1331. <para>The number of iterations of the physics solver when considering objects' velocities.</para>
  1332. </summary>
  1333. </member>
  1334. <member name="P:UnityEngine.Physics2D.velocityThreshold">
  1335. <summary>
  1336. <para>Any collisions with a relative linear velocity below this threshold will be treated as inelastic.</para>
  1337. </summary>
  1338. </member>
  1339. <member name="F:UnityEngine.Physics2D.AllLayers">
  1340. <summary>
  1341. <para>Layer mask constant that includes all layers.</para>
  1342. </summary>
  1343. </member>
  1344. <member name="M:UnityEngine.Physics2D.BoxCast(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  1345. <summary>
  1346. <para>Casts a box against colliders in the scene, returning the first collider to contact with it.</para>
  1347. </summary>
  1348. <param name="origin">The point in 2D space where the box originates.</param>
  1349. <param name="size">The size of the box.</param>
  1350. <param name="angle">The angle of the box (in degrees).</param>
  1351. <param name="direction">Vector representing the direction of the box.</param>
  1352. <param name="distance">Maximum distance over which to cast the box.</param>
  1353. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1354. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1355. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1356. <returns>
  1357. <para>The cast results returned.</para>
  1358. </returns>
  1359. </member>
  1360. <member name="M:UnityEngine.Physics2D.BoxCast(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.RaycastHit2D[],System.Single)">
  1361. <summary>
  1362. <para>Casts a box against the colliders in the Scene and returns all colliders that are in contact with it.</para>
  1363. </summary>
  1364. <param name="origin">The point in 2D space where the box originates.</param>
  1365. <param name="size">The size of the box.</param>
  1366. <param name="angle">The angle of the box (in degrees).</param>
  1367. <param name="direction">Vector representing the direction of the box.</param>
  1368. <param name="distance">Maximum distance over which to cast the box.</param>
  1369. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  1370. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1371. <returns>
  1372. <para>Returns the number of results placed in the results array.</para>
  1373. </returns>
  1374. </member>
  1375. <member name="M:UnityEngine.Physics2D.BoxCastAll(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  1376. <summary>
  1377. <para>Casts a box against colliders in the scene, returning all colliders that contact with it.</para>
  1378. </summary>
  1379. <param name="origin">The point in 2D space where the box originates.</param>
  1380. <param name="size">The size of the box.</param>
  1381. <param name="angle">The angle of the box (in degrees).</param>
  1382. <param name="direction">Vector representing the direction of the box.</param>
  1383. <param name="distance">Maximum distance over which to cast the box.</param>
  1384. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1385. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1386. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1387. <returns>
  1388. <para>The cast results returned.</para>
  1389. </returns>
  1390. </member>
  1391. <member name="M:UnityEngine.Physics2D.BoxCastNonAlloc(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,UnityEngine.Vector2,UnityEngine.RaycastHit2D[],System.Single,System.Int32,System.Single,System.Single)">
  1392. <summary>
  1393. <para>Casts a box into the scene, returning colliders that contact with it into the provided results array.</para>
  1394. </summary>
  1395. <param name="origin">The point in 2D space where the box originates.</param>
  1396. <param name="size">The size of the box.</param>
  1397. <param name="angle">The angle of the box (in degrees).</param>
  1398. <param name="direction">Vector representing the direction of the box.</param>
  1399. <param name="results">Array to receive results.</param>
  1400. <param name="distance">Maximum distance over which to cast the box.</param>
  1401. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1402. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1403. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1404. <returns>
  1405. <para>Returns the number of results placed in the results array.</para>
  1406. </returns>
  1407. </member>
  1408. <member name="M:UnityEngine.Physics2D.CapsuleCast(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.CapsuleDirection2D,System.Single,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  1409. <summary>
  1410. <para>Casts a capsule against colliders in the scene, returning the first collider to contact with it.</para>
  1411. </summary>
  1412. <param name="origin">The point in 2D space where the capsule originates.</param>
  1413. <param name="size">The size of the capsule.</param>
  1414. <param name="capsuleDirection">The direction of the capsule.</param>
  1415. <param name="angle">The angle of the capsule (in degrees).</param>
  1416. <param name="direction">Vector representing the direction to cast the capsule.</param>
  1417. <param name="distance">Maximum distance over which to cast the capsule.</param>
  1418. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1419. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  1420. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  1421. <returns>
  1422. <para>The cast results returned.</para>
  1423. </returns>
  1424. </member>
  1425. <member name="M:UnityEngine.Physics2D.CapsuleCast(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.CapsuleDirection2D,System.Single,UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.RaycastHit2D[],System.Single)">
  1426. <summary>
  1427. <para>Casts a capsule against the colliders in the Scene and returns all colliders that are in contact with it.</para>
  1428. </summary>
  1429. <param name="origin">The point in 2D space where the capsule originates.</param>
  1430. <param name="size">The size of the capsule.</param>
  1431. <param name="capsuleDirection">The direction of the capsule.</param>
  1432. <param name="angle">The angle of the capsule (in degrees).</param>
  1433. <param name="direction">Vector representing the direction to cast the capsule.</param>
  1434. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1435. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  1436. <param name="distance">Maximum distance over which to cast the capsule.</param>
  1437. <returns>
  1438. <para>Returns the number of results placed in the results array.</para>
  1439. </returns>
  1440. </member>
  1441. <member name="M:UnityEngine.Physics2D.CapsuleCastAll(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.CapsuleDirection2D,System.Single,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  1442. <summary>
  1443. <para>Casts a capsule against colliders in the scene, returning all colliders that contact with it.</para>
  1444. </summary>
  1445. <param name="origin">The point in 2D space where the capsule originates.</param>
  1446. <param name="size">The size of the capsule.</param>
  1447. <param name="capsuleDirection">The direction of the capsule.</param>
  1448. <param name="angle">The angle of the capsule (in degrees).</param>
  1449. <param name="direction">Vector representing the direction to cast the capsule.</param>
  1450. <param name="distance">Maximum distance over which to cast the capsule.</param>
  1451. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1452. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  1453. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  1454. <returns>
  1455. <para>The cast results returned.</para>
  1456. </returns>
  1457. </member>
  1458. <member name="M:UnityEngine.Physics2D.CapsuleCastNonAlloc(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.CapsuleDirection2D,System.Single,UnityEngine.Vector2,UnityEngine.RaycastHit2D[],System.Single,System.Int32,System.Single,System.Single)">
  1459. <summary>
  1460. <para>Casts a capsule into the scene, returning colliders that contact with it into the provided results array.</para>
  1461. </summary>
  1462. <param name="origin">The point in 2D space where the capsule originates.</param>
  1463. <param name="size">The size of the capsule.</param>
  1464. <param name="capsuleDirection">The direction of the capsule.</param>
  1465. <param name="angle">The angle of the capsule (in degrees).</param>
  1466. <param name="direction">Vector representing the direction to cast the capsule.</param>
  1467. <param name="results">Array to receive results.</param>
  1468. <param name="distance">Maximum distance over which to cast the capsule.</param>
  1469. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1470. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  1471. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  1472. <returns>
  1473. <para>Returns the number of results placed in the results array.</para>
  1474. </returns>
  1475. </member>
  1476. <member name="M:UnityEngine.Physics2D.CircleCast(UnityEngine.Vector2,System.Single,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  1477. <summary>
  1478. <para>Casts a circle against colliders in the scene, returning the first collider to contact with it.</para>
  1479. </summary>
  1480. <param name="origin">The point in 2D space where the circle originates.</param>
  1481. <param name="radius">The radius of the circle.</param>
  1482. <param name="direction">Vector representing the direction of the circle.</param>
  1483. <param name="distance">Maximum distance over which to cast the circle.</param>
  1484. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1485. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1486. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1487. <returns>
  1488. <para>The cast results returned.</para>
  1489. </returns>
  1490. </member>
  1491. <member name="M:UnityEngine.Physics2D.CircleCast(UnityEngine.Vector2,System.Single,UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.RaycastHit2D[],System.Single)">
  1492. <summary>
  1493. <para>Casts a circle against colliders in the Scene, returning all colliders that contact with it.</para>
  1494. </summary>
  1495. <param name="origin">The point in 2D space where the circle originates.</param>
  1496. <param name="radius">The radius of the circle.</param>
  1497. <param name="direction">Vector representing the direction of the circle.</param>
  1498. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1499. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  1500. <param name="distance">Maximum distance over which to cast the circle.</param>
  1501. <returns>
  1502. <para>Returns the number of results placed in the results array.</para>
  1503. </returns>
  1504. </member>
  1505. <member name="M:UnityEngine.Physics2D.CircleCastAll(UnityEngine.Vector2,System.Single,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  1506. <summary>
  1507. <para>Casts a circle against colliders in the scene, returning all colliders that contact with it.</para>
  1508. </summary>
  1509. <param name="origin">The point in 2D space where the circle originates.</param>
  1510. <param name="radius">The radius of the circle.</param>
  1511. <param name="direction">Vector representing the direction of the circle.</param>
  1512. <param name="distance">Maximum distance over which to cast the circle.</param>
  1513. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1514. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1515. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1516. <returns>
  1517. <para>The cast results returned.</para>
  1518. </returns>
  1519. </member>
  1520. <member name="M:UnityEngine.Physics2D.CircleCastNonAlloc(UnityEngine.Vector2,System.Single,UnityEngine.Vector2,UnityEngine.RaycastHit2D[],System.Single,System.Int32,System.Single,System.Single)">
  1521. <summary>
  1522. <para>Casts a circle into the scene, returning colliders that contact with it into the provided results array.</para>
  1523. </summary>
  1524. <param name="origin">The point in 2D space where the circle originates.</param>
  1525. <param name="radius">The radius of the circle.</param>
  1526. <param name="direction">Vector representing the direction of the circle.</param>
  1527. <param name="results">Array to receive results.</param>
  1528. <param name="distance">Maximum distance over which to cast the circle.</param>
  1529. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1530. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1531. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1532. <returns>
  1533. <para>Returns the number of results placed in the results array.</para>
  1534. </returns>
  1535. </member>
  1536. <member name="F:UnityEngine.Physics2D.DefaultRaycastLayers">
  1537. <summary>
  1538. <para>Layer mask constant that includes all layers participating in raycasts by default.</para>
  1539. </summary>
  1540. </member>
  1541. <member name="M:UnityEngine.Physics2D.Distance(UnityEngine.Collider2D,UnityEngine.Collider2D)">
  1542. <summary>
  1543. <para>Calculates the minimum distance between two colliders.</para>
  1544. </summary>
  1545. <param name="colliderA">A collider used to calculate the minimum distance against colliderB.</param>
  1546. <param name="colliderB">A collider used to calculate the minimum distance against colliderA.</param>
  1547. <returns>
  1548. <para>The minimum distance between colliderA and colliderB.</para>
  1549. </returns>
  1550. </member>
  1551. <member name="M:UnityEngine.Physics2D.GetContacts(UnityEngine.Collider2D,UnityEngine.Collider2D[])">
  1552. <summary>
  1553. <para>Retrieves all colliders in contact with the collider.</para>
  1554. </summary>
  1555. <param name="collider">The collider to retrieve contacts for.</param>
  1556. <param name="colliders">An array of Collider2D used to receive the results.</param>
  1557. <returns>
  1558. <para>Returns the number of colliders placed in the colliders array.</para>
  1559. </returns>
  1560. </member>
  1561. <member name="M:UnityEngine.Physics2D.GetContacts(UnityEngine.Collider2D,UnityEngine.ContactPoint2D[])">
  1562. <summary>
  1563. <para>Retrieves all contact points in contact with the collider.</para>
  1564. </summary>
  1565. <param name="collider">The collider to retrieve contacts for.</param>
  1566. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  1567. <returns>
  1568. <para>Returns the number of contacts placed in the contacts array.</para>
  1569. </returns>
  1570. </member>
  1571. <member name="M:UnityEngine.Physics2D.GetContacts(UnityEngine.Collider2D,UnityEngine.ContactFilter2D,UnityEngine.ContactPoint2D[])">
  1572. <summary>
  1573. <para>Retrieves all contact points in contact with the collider, with the results filtered by the ContactFilter2D.</para>
  1574. </summary>
  1575. <param name="collider">The collider to retrieve contacts for.</param>
  1576. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1577. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  1578. <returns>
  1579. <para>Returns the number of contacts placed in the contacts array.</para>
  1580. </returns>
  1581. </member>
  1582. <member name="M:UnityEngine.Physics2D.GetContacts(UnityEngine.Collider2D,UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  1583. <summary>
  1584. <para>Retrieves all colliders in contact with the collider, with the results filtered by the ContactFilter2D.</para>
  1585. </summary>
  1586. <param name="collider">The collider to retrieve contacts for.</param>
  1587. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1588. <param name="colliders">An array of Collider2D used to receive the results.</param>
  1589. <returns>
  1590. <para>Returns the number of colliders placed in the colliders array.</para>
  1591. </returns>
  1592. </member>
  1593. <member name="M:UnityEngine.Physics2D.GetContacts(UnityEngine.Collider2D,UnityEngine.Collider2D,UnityEngine.ContactFilter2D,UnityEngine.ContactPoint2D[])">
  1594. <summary>
  1595. <para>Retrieves all contact points in for contacts between with the collider1 and collider2, with the results filtered by the ContactFilter2D.</para>
  1596. </summary>
  1597. <param name="collider1">The collider to check if it has contacts against collider2.</param>
  1598. <param name="collider2">The collider to check if it has contacts against collider1.</param>
  1599. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1600. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  1601. <returns>
  1602. <para>Returns the number of contacts placed in the contacts array.</para>
  1603. </returns>
  1604. </member>
  1605. <member name="M:UnityEngine.Physics2D.GetContacts(UnityEngine.Rigidbody2D,UnityEngine.ContactPoint2D[])">
  1606. <summary>
  1607. <para>Retrieves all contact points in contact with any of the collider(s) attached to this rigidbody.</para>
  1608. </summary>
  1609. <param name="rigidbody">The rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked.</param>
  1610. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  1611. <returns>
  1612. <para>Returns the number of contacts placed in the contacts array.</para>
  1613. </returns>
  1614. </member>
  1615. <member name="M:UnityEngine.Physics2D.GetContacts(UnityEngine.Rigidbody2D,UnityEngine.Collider2D[])">
  1616. <summary>
  1617. <para>Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody.</para>
  1618. </summary>
  1619. <param name="rigidbody">The rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked.</param>
  1620. <param name="colliders">An array of Collider2D used to receive the results.</param>
  1621. <returns>
  1622. <para>Returns the number of colliders placed in the colliders array.</para>
  1623. </returns>
  1624. </member>
  1625. <member name="M:UnityEngine.Physics2D.GetContacts(UnityEngine.Rigidbody2D,UnityEngine.ContactFilter2D,UnityEngine.ContactPoint2D[])">
  1626. <summary>
  1627. <para>Retrieves all contact points in contact with any of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D.</para>
  1628. </summary>
  1629. <param name="rigidbody">The rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked.</param>
  1630. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1631. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  1632. <returns>
  1633. <para>Returns the number of contacts placed in the contacts array.</para>
  1634. </returns>
  1635. </member>
  1636. <member name="M:UnityEngine.Physics2D.GetContacts(UnityEngine.Rigidbody2D,UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  1637. <summary>
  1638. <para>Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D.</para>
  1639. </summary>
  1640. <param name="rigidbody">The rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked.</param>
  1641. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1642. <param name="colliders">An array of Collider2D used to receive the results.</param>
  1643. <returns>
  1644. <para>Returns the number of colliders placed in the colliders array.</para>
  1645. </returns>
  1646. </member>
  1647. <member name="M:UnityEngine.Physics2D.GetIgnoreCollision(UnityEngine.Collider2D,UnityEngine.Collider2D)">
  1648. <summary>
  1649. <para>Checks whether the collision detection system will ignore all collisionstriggers between collider1 and collider2/ or not.</para>
  1650. </summary>
  1651. <param name="collider1">The first collider to compare to collider2.</param>
  1652. <param name="collider2">The second collider to compare to collider1.</param>
  1653. <returns>
  1654. <para>Whether the collision detection system will ignore all collisionstriggers between collider1 and collider2/ or not.</para>
  1655. </returns>
  1656. </member>
  1657. <member name="M:UnityEngine.Physics2D.GetIgnoreLayerCollision(System.Int32,System.Int32)">
  1658. <summary>
  1659. <para>Checks whether collisions between the specified layers be ignored or not.</para>
  1660. </summary>
  1661. <param name="layer1">ID of first layer.</param>
  1662. <param name="layer2">ID of second layer.</param>
  1663. <returns>
  1664. <para>Whether collisions between the specified layers be ignored or not.</para>
  1665. </returns>
  1666. </member>
  1667. <member name="M:UnityEngine.Physics2D.GetLayerCollisionMask(System.Int32)">
  1668. <summary>
  1669. <para>Get the collision layer mask that indicates which layer(s) the specified layer can collide with.</para>
  1670. </summary>
  1671. <param name="layer">The layer to retrieve the collision layer mask for.</param>
  1672. <returns>
  1673. <para>A mask where each bit indicates a layer and whether it can collide with layer or not.</para>
  1674. </returns>
  1675. </member>
  1676. <member name="M:UnityEngine.Physics2D.GetRayIntersection(UnityEngine.Ray,System.Single,System.Int32)">
  1677. <summary>
  1678. <para>Cast a 3D ray against the colliders in the scene returning the first collider along the ray.</para>
  1679. </summary>
  1680. <param name="ray">The 3D ray defining origin and direction to test.</param>
  1681. <param name="distance">Maximum distance over which to cast the ray.</param>
  1682. <param name="layerMask">Filter to detect colliders only on certain layers.</param>
  1683. <returns>
  1684. <para>The cast results returned.</para>
  1685. </returns>
  1686. </member>
  1687. <member name="M:UnityEngine.Physics2D.GetRayIntersectionAll(UnityEngine.Ray,System.Single,System.Int32)">
  1688. <summary>
  1689. <para>Cast a 3D ray against the colliders in the scene returning all the colliders along the ray.</para>
  1690. </summary>
  1691. <param name="ray">The 3D ray defining origin and direction to test.</param>
  1692. <param name="distance">Maximum distance over which to cast the ray.</param>
  1693. <param name="layerMask">Filter to detect colliders only on certain layers.</param>
  1694. <returns>
  1695. <para>The cast results returned.</para>
  1696. </returns>
  1697. </member>
  1698. <member name="M:UnityEngine.Physics2D.GetRayIntersectionNonAlloc(UnityEngine.Ray,UnityEngine.RaycastHit2D[],System.Single,System.Int32)">
  1699. <summary>
  1700. <para>Cast a 3D ray against the colliders in the scene returning the colliders along the ray.</para>
  1701. </summary>
  1702. <param name="ray">The 3D ray defining origin and direction to test.</param>
  1703. <param name="distance">Maximum distance over which to cast the ray.</param>
  1704. <param name="layerMask">Filter to detect colliders only on certain layers.</param>
  1705. <param name="results">Array to receive results.</param>
  1706. <returns>
  1707. <para>The number of results returned.</para>
  1708. </returns>
  1709. </member>
  1710. <member name="M:UnityEngine.Physics2D.IgnoreCollision(UnityEngine.Collider2D,UnityEngine.Collider2D,System.Boolean)">
  1711. <summary>
  1712. <para>Makes the collision detection system ignore all collisionstriggers between collider1 and collider2/.</para>
  1713. </summary>
  1714. <param name="collider1">The first collider to compare to collider2.</param>
  1715. <param name="collider2">The second collider to compare to collider1.</param>
  1716. <param name="ignore">Whether collisionstriggers between collider1 and collider2/ should be ignored or not.</param>
  1717. </member>
  1718. <member name="M:UnityEngine.Physics2D.IgnoreLayerCollision(System.Int32,System.Int32,System.Boolean)">
  1719. <summary>
  1720. <para>Choose whether to detect or ignore collisions between a specified pair of layers.</para>
  1721. </summary>
  1722. <param name="layer1">ID of the first layer.</param>
  1723. <param name="layer2">ID of the second layer.</param>
  1724. <param name="ignore">Should collisions between these layers be ignored?</param>
  1725. </member>
  1726. <member name="F:UnityEngine.Physics2D.IgnoreRaycastLayer">
  1727. <summary>
  1728. <para>Layer mask constant for the default layer that ignores raycasts.</para>
  1729. </summary>
  1730. </member>
  1731. <member name="M:UnityEngine.Physics2D.IsTouching(UnityEngine.Collider2D,UnityEngine.Collider2D)">
  1732. <summary>
  1733. <para>Checks whether the passed colliders are in contact or not.</para>
  1734. </summary>
  1735. <param name="collider1">The collider to check if it is touching collider2.</param>
  1736. <param name="collider2">The collider to check if it is touching collider1.</param>
  1737. <returns>
  1738. <para>Whether collider1 is touching collider2 or not.</para>
  1739. </returns>
  1740. </member>
  1741. <member name="M:UnityEngine.Physics2D.IsTouching(UnityEngine.Collider2D,UnityEngine.ContactFilter2D)">
  1742. <summary>
  1743. <para>Checks whether the passed colliders are in contact or not.</para>
  1744. </summary>
  1745. <param name="collider">The collider to check if it is touching any other collider filtered by the contactFilter.</param>
  1746. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1747. <returns>
  1748. <para>Whether the collider is touching any other collider filtered by the contactFilter or not.</para>
  1749. </returns>
  1750. </member>
  1751. <member name="M:UnityEngine.Physics2D.IsTouching(UnityEngine.Collider2D,UnityEngine.Collider2D,UnityEngine.ContactFilter2D)">
  1752. <summary>
  1753. <para>Checks whether the passed colliders are in contact or not.</para>
  1754. </summary>
  1755. <param name="collider1">The collider to check if it is touching collider2.</param>
  1756. <param name="collider2">The collider to check if it is touching collider1.</param>
  1757. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1758. <returns>
  1759. <para>Whether collider1 is touching collider2 or not.</para>
  1760. </returns>
  1761. </member>
  1762. <member name="M:UnityEngine.Physics2D.IsTouchingLayers(UnityEngine.Collider2D,System.Int32)">
  1763. <summary>
  1764. <para>Checks whether the collider is touching any colliders on the specified layerMask or not.</para>
  1765. </summary>
  1766. <param name="collider">The collider to check if it is touching colliders on the layerMask.</param>
  1767. <param name="layerMask">Any colliders on any of these layers count as touching.</param>
  1768. <returns>
  1769. <para>Whether the collider is touching any colliders on the specified layerMask or not.</para>
  1770. </returns>
  1771. </member>
  1772. <member name="M:UnityEngine.Physics2D.Linecast(UnityEngine.Vector2,UnityEngine.Vector2,System.Int32,System.Single,System.Single)">
  1773. <summary>
  1774. <para>Casts a line segment against colliders in the Scene.</para>
  1775. </summary>
  1776. <param name="start">The start point of the line in world space.</param>
  1777. <param name="end">The end point of the line in world space.</param>
  1778. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1779. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1780. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1781. <returns>
  1782. <para>The cast results returned.</para>
  1783. </returns>
  1784. </member>
  1785. <member name="M:UnityEngine.Physics2D.Linecast(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.RaycastHit2D[])">
  1786. <summary>
  1787. <para>Casts a line segment against colliders in the Scene with results filtered by ContactFilter2D.</para>
  1788. </summary>
  1789. <param name="start">The start point of the line in world space.</param>
  1790. <param name="end">The end point of the line in world space.</param>
  1791. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  1792. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  1793. <returns>
  1794. <para>Returns the number of results placed in the results array.</para>
  1795. </returns>
  1796. </member>
  1797. <member name="M:UnityEngine.Physics2D.LinecastAll(UnityEngine.Vector2,UnityEngine.Vector2,System.Int32,System.Single,System.Single)">
  1798. <summary>
  1799. <para>Casts a line against colliders in the scene.</para>
  1800. </summary>
  1801. <param name="start">The start point of the line in world space.</param>
  1802. <param name="end">The end point of the line in world space.</param>
  1803. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1804. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1805. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1806. <returns>
  1807. <para>The cast results returned.</para>
  1808. </returns>
  1809. </member>
  1810. <member name="M:UnityEngine.Physics2D.LinecastNonAlloc(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.RaycastHit2D[],System.Int32,System.Single,System.Single)">
  1811. <summary>
  1812. <para>Casts a line against colliders in the scene.</para>
  1813. </summary>
  1814. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1815. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1816. <param name="start">The start point of the line in world space.</param>
  1817. <param name="end">The end point of the line in world space.</param>
  1818. <param name="results">Returned array of objects that intersect the line.</param>
  1819. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  1820. <returns>
  1821. <para>Returns the number of results placed in the results array.</para>
  1822. </returns>
  1823. </member>
  1824. <member name="M:UnityEngine.Physics2D.OverlapArea(UnityEngine.Vector2,UnityEngine.Vector2,System.Int32,System.Single,System.Single)">
  1825. <summary>
  1826. <para>Checks if a collider falls within a rectangular area.</para>
  1827. </summary>
  1828. <param name="pointA">One corner of the rectangle.</param>
  1829. <param name="pointB">Diagonally opposite the point A corner of the rectangle.</param>
  1830. <param name="layerMask">Filter to check objects only on specific layers.</param>
  1831. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1832. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1833. <returns>
  1834. <para>The collider overlapping the area.</para>
  1835. </returns>
  1836. </member>
  1837. <member name="M:UnityEngine.Physics2D.OverlapArea(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  1838. <summary>
  1839. <para>Checks if a collider falls within a rectangular area.</para>
  1840. </summary>
  1841. <param name="pointA">One corner of the rectangle.</param>
  1842. <param name="pointB">Diagonally opposite the point A corner of the rectangle.</param>
  1843. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  1844. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.</param>
  1845. <returns>
  1846. <para>Returns the number of results placed in the results array.</para>
  1847. </returns>
  1848. </member>
  1849. <member name="M:UnityEngine.Physics2D.OverlapAreaAll(UnityEngine.Vector2,UnityEngine.Vector2,System.Int32,System.Single,System.Single)">
  1850. <summary>
  1851. <para>Get a list of all colliders that fall within a rectangular area.</para>
  1852. </summary>
  1853. <param name="pointA">One corner of the rectangle.</param>
  1854. <param name="pointB">Diagonally opposite the point A corner of the rectangle.</param>
  1855. <param name="layerMask">Filter to check objects only on specific layers.</param>
  1856. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1857. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1858. <returns>
  1859. <para>The cast results returned.</para>
  1860. </returns>
  1861. </member>
  1862. <member name="M:UnityEngine.Physics2D.OverlapAreaNonAlloc(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.Collider2D[],System.Int32,System.Single,System.Single)">
  1863. <summary>
  1864. <para>Get a list of all colliders that fall within a specified area.</para>
  1865. </summary>
  1866. <param name="pointA">One corner of the rectangle.</param>
  1867. <param name="pointB">Diagonally opposite the point A corner of the rectangle.</param>
  1868. <param name="results">Array to receive results.</param>
  1869. <param name="layerMask">Filter to check objects only on specified layers.</param>
  1870. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  1871. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  1872. <returns>
  1873. <para>Returns the number of results placed in the results array.</para>
  1874. </returns>
  1875. </member>
  1876. <member name="M:UnityEngine.Physics2D.OverlapBox(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  1877. <summary>
  1878. <para>Checks if a collider falls within a box area.</para>
  1879. </summary>
  1880. <param name="point">Center of the box.</param>
  1881. <param name="size">Size of the box.</param>
  1882. <param name="angle">Angle of the box.</param>
  1883. <param name="layerMask">Filter to check objects only on specific layers.</param>
  1884. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  1885. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  1886. <returns>
  1887. <para>The collider overlapping the box.</para>
  1888. </returns>
  1889. </member>
  1890. <member name="M:UnityEngine.Physics2D.OverlapBox(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  1891. <summary>
  1892. <para>Checks if a collider falls within a box area.</para>
  1893. </summary>
  1894. <param name="point">Center of the box.</param>
  1895. <param name="size">Size of the box.</param>
  1896. <param name="angle">Angle of the box.</param>
  1897. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.</param>
  1898. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  1899. <returns>
  1900. <para>Returns the number of results placed in the results array.</para>
  1901. </returns>
  1902. </member>
  1903. <member name="M:UnityEngine.Physics2D.OverlapBoxAll(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  1904. <summary>
  1905. <para>Get a list of all colliders that fall within a box area.</para>
  1906. </summary>
  1907. <param name="point">Center of the box.</param>
  1908. <param name="size">Size of the box.</param>
  1909. <param name="angle">Angle of the box.</param>
  1910. <param name="layerMask">Filter to check objects only on specific layers.</param>
  1911. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  1912. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  1913. <returns>
  1914. <para>The cast results returned.</para>
  1915. </returns>
  1916. </member>
  1917. <member name="M:UnityEngine.Physics2D.OverlapBoxNonAlloc(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,UnityEngine.Collider2D[],System.Int32,System.Single,System.Single)">
  1918. <summary>
  1919. <para>Get a list of all colliders that fall within a box area.</para>
  1920. </summary>
  1921. <param name="point">Center of the box.</param>
  1922. <param name="size">Size of the box.</param>
  1923. <param name="angle">Angle of the box.</param>
  1924. <param name="results">Array to receive results.</param>
  1925. <param name="layerMask">Filter to check objects only on specific layers.</param>
  1926. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  1927. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  1928. <returns>
  1929. <para>Returns the number of results placed in the results array.</para>
  1930. </returns>
  1931. </member>
  1932. <member name="M:UnityEngine.Physics2D.OverlapCapsule(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.CapsuleDirection2D,System.Single,System.Int32,System.Single,System.Single)">
  1933. <summary>
  1934. <para>Checks if a collider falls within a capsule area.</para>
  1935. </summary>
  1936. <param name="point">Center of the capsule.</param>
  1937. <param name="size">Size of the capsule.</param>
  1938. <param name="direction">The direction of the capsule.</param>
  1939. <param name="angle">Angle of the capsule.</param>
  1940. <param name="layerMask">Filter to check objects only on specific layers.</param>
  1941. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  1942. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  1943. <returns>
  1944. <para>The collider overlapping the capsule.</para>
  1945. </returns>
  1946. </member>
  1947. <member name="M:UnityEngine.Physics2D.OverlapCapsule(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.CapsuleDirection2D,System.Single,UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  1948. <summary>
  1949. <para>Checks if a collider falls within a capsule area.</para>
  1950. </summary>
  1951. <param name="point">Center of the capsule.</param>
  1952. <param name="size">Size of the capsule.</param>
  1953. <param name="direction">The direction of the capsule.</param>
  1954. <param name="angle">Angle of the capsule.</param>
  1955. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.</param>
  1956. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  1957. <returns>
  1958. <para>Returns the number of results placed in the results array.</para>
  1959. </returns>
  1960. </member>
  1961. <member name="M:UnityEngine.Physics2D.OverlapCapsuleAll(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.CapsuleDirection2D,System.Single,System.Int32,System.Single,System.Single)">
  1962. <summary>
  1963. <para>Get a list of all colliders that fall within a capsule area.</para>
  1964. </summary>
  1965. <param name="point">Center of the capsule.</param>
  1966. <param name="size">Size of the capsule.</param>
  1967. <param name="direction">The direction of the capsule.</param>
  1968. <param name="angle">Angle of the capsule.</param>
  1969. <param name="layerMask">Filter to check objects only on specific layers.</param>
  1970. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  1971. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  1972. <returns>
  1973. <para>The cast results returned.</para>
  1974. </returns>
  1975. </member>
  1976. <member name="M:UnityEngine.Physics2D.OverlapCapsuleNonAlloc(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.CapsuleDirection2D,System.Single,UnityEngine.Collider2D[],System.Int32,System.Single,System.Single)">
  1977. <summary>
  1978. <para>Get a list of all colliders that fall within a capsule area.</para>
  1979. </summary>
  1980. <param name="point">Center of the capsule.</param>
  1981. <param name="size">Size of the capsule.</param>
  1982. <param name="direction">The direction of the capsule.</param>
  1983. <param name="angle">Angle of the capsule.</param>
  1984. <param name="results">Array to receive results.</param>
  1985. <param name="layerMask">Filter to check objects only on specific layers.</param>
  1986. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than this value.</param>
  1987. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than this value.</param>
  1988. <returns>
  1989. <para>Returns the number of results placed in the results array.</para>
  1990. </returns>
  1991. </member>
  1992. <member name="M:UnityEngine.Physics2D.OverlapCircle(UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  1993. <summary>
  1994. <para>Checks if a collider falls within a circular area.</para>
  1995. </summary>
  1996. <param name="point">Centre of the circle.</param>
  1997. <param name="radius">Radius of the circle.</param>
  1998. <param name="layerMask">Filter to check objects only on specific layers.</param>
  1999. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  2000. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  2001. <returns>
  2002. <para>The collider overlapping the circle.</para>
  2003. </returns>
  2004. </member>
  2005. <member name="M:UnityEngine.Physics2D.OverlapCircle(UnityEngine.Vector2,System.Single,UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  2006. <summary>
  2007. <para>Checks if a collider is within a circular area.</para>
  2008. </summary>
  2009. <param name="point">Centre of the circle.</param>
  2010. <param name="radius">Radius of the circle.</param>
  2011. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.</param>
  2012. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  2013. <returns>
  2014. <para>Returns the number of results placed in the results array.</para>
  2015. </returns>
  2016. </member>
  2017. <member name="M:UnityEngine.Physics2D.OverlapCircleAll(UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  2018. <summary>
  2019. <para>Get a list of all colliders that fall within a circular area.</para>
  2020. </summary>
  2021. <param name="point">Center of the circle.</param>
  2022. <param name="radius">Radius of the circle.</param>
  2023. <param name="layerMask">Filter to check objects only on specified layers.</param>
  2024. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  2025. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  2026. <returns>
  2027. <para>The cast results.</para>
  2028. </returns>
  2029. </member>
  2030. <member name="M:UnityEngine.Physics2D.OverlapCircleNonAlloc(UnityEngine.Vector2,System.Single,UnityEngine.Collider2D[],System.Int32,System.Single,System.Single)">
  2031. <summary>
  2032. <para>Get a list of all colliders that fall within a circular area.</para>
  2033. </summary>
  2034. <param name="point">Center of the circle.</param>
  2035. <param name="radius">Radius of the circle.</param>
  2036. <param name="results">Array to receive results.</param>
  2037. <param name="layerMask">Filter to check objects only on specific layers.</param>
  2038. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  2039. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  2040. <returns>
  2041. <para>Returns the number of results placed in the results array.</para>
  2042. </returns>
  2043. </member>
  2044. <member name="M:UnityEngine.Physics2D.OverlapCollider(UnityEngine.Collider2D,UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  2045. <summary>
  2046. <para>Get a list of all colliders that overlap collider.</para>
  2047. </summary>
  2048. <param name="collider">The collider that defines the area used to query for other collider overlaps.</param>
  2049. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.</param>
  2050. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  2051. <returns>
  2052. <para>Returns the number of results placed in the results array.</para>
  2053. </returns>
  2054. </member>
  2055. <member name="M:UnityEngine.Physics2D.OverlapPoint(UnityEngine.Vector2,System.Int32,System.Single,System.Single)">
  2056. <summary>
  2057. <para>Checks if a collider overlaps a point in space.</para>
  2058. </summary>
  2059. <param name="point">A point in world space.</param>
  2060. <param name="layerMask">Filter to check objects only on specific layers.</param>
  2061. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  2062. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  2063. <returns>
  2064. <para>The collider overlapping the point.</para>
  2065. </returns>
  2066. </member>
  2067. <member name="M:UnityEngine.Physics2D.OverlapPoint(UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  2068. <summary>
  2069. <para>Checks if a collider overlaps a point in world space.</para>
  2070. </summary>
  2071. <param name="point">A point in world space.</param>
  2072. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.</param>
  2073. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  2074. <returns>
  2075. <para>Returns the number of results placed in the results array.</para>
  2076. </returns>
  2077. </member>
  2078. <member name="M:UnityEngine.Physics2D.OverlapPointAll(UnityEngine.Vector2,System.Int32,System.Single,System.Single)">
  2079. <summary>
  2080. <para>Get a list of all colliders that overlap a point in space.</para>
  2081. </summary>
  2082. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  2083. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  2084. <param name="point">A point in space.</param>
  2085. <param name="layerMask">Filter to check objects only on specific layers.</param>
  2086. <returns>
  2087. <para>The cast results returned.</para>
  2088. </returns>
  2089. </member>
  2090. <member name="M:UnityEngine.Physics2D.OverlapPointNonAlloc(UnityEngine.Vector2,UnityEngine.Collider2D[],System.Int32,System.Single,System.Single)">
  2091. <summary>
  2092. <para>Get a list of all colliders that overlap a point in space.</para>
  2093. </summary>
  2094. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  2095. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  2096. <param name="point">A point in space.</param>
  2097. <param name="results">Array to receive results.</param>
  2098. <param name="layerMask">Filter to check objects only on specific layers.</param>
  2099. <returns>
  2100. <para>Returns the number of results placed in the results array.</para>
  2101. </returns>
  2102. </member>
  2103. <member name="M:UnityEngine.Physics2D.Raycast(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  2104. <summary>
  2105. <para>Casts a ray against colliders in the scene.</para>
  2106. </summary>
  2107. <param name="origin">The point in 2D space where the ray originates.</param>
  2108. <param name="direction">The vector representing the direction of the ray.</param>
  2109. <param name="distance">Maximum distance over which to cast the ray.</param>
  2110. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  2111. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  2112. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  2113. <returns>
  2114. <para>The cast results returned.</para>
  2115. </returns>
  2116. </member>
  2117. <member name="M:UnityEngine.Physics2D.Raycast(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.RaycastHit2D[],System.Single)">
  2118. <summary>
  2119. <para>Casts a ray against colliders in the Scene.</para>
  2120. </summary>
  2121. <param name="origin">The point in 2D space where the ray originates.</param>
  2122. <param name="direction">The vector representing the direction of the ray.</param>
  2123. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  2124. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  2125. <param name="distance">Maximum distance over which to cast the ray.</param>
  2126. <returns>
  2127. <para>Returns the number of results placed in the results array.</para>
  2128. </returns>
  2129. </member>
  2130. <member name="M:UnityEngine.Physics2D.RaycastAll(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Single)">
  2131. <summary>
  2132. <para>Casts a ray against colliders in the scene, returning all colliders that contact with it.</para>
  2133. </summary>
  2134. <param name="origin">The point in 2D space where the ray originates.</param>
  2135. <param name="direction">The vector representing the direction of the ray.</param>
  2136. <param name="distance">Maximum distance over which to cast the ray.</param>
  2137. <param name="layerMask">Filter to detect Colliders only on certain layers.</param>
  2138. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  2139. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  2140. <returns>
  2141. <para>The cast results returned.</para>
  2142. </returns>
  2143. </member>
  2144. <member name="M:UnityEngine.Physics2D.RaycastNonAlloc(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.RaycastHit2D[],System.Single,System.Int32,System.Single,System.Single)">
  2145. <summary>
  2146. <para>Casts a ray into the scene.</para>
  2147. </summary>
  2148. <param name="minDepth">Only include objects with a Z coordinate (depth) greater than or equal to this value.</param>
  2149. <param name="maxDepth">Only include objects with a Z coordinate (depth) less than or equal to this value.</param>
  2150. <param name="origin">The point in 2D space where the ray originates.</param>
  2151. <param name="direction">The vector representing the direction of the ray.</param>
  2152. <param name="results">Array to receive results.</param>
  2153. <param name="distance">Maximum distance over which to cast the ray.</param>
  2154. <param name="layerMask">Filter to check objects only on specific layers.</param>
  2155. <returns>
  2156. <para>Returns the number of results placed in the results array.</para>
  2157. </returns>
  2158. </member>
  2159. <member name="M:UnityEngine.Physics2D.SetLayerCollisionMask(System.Int32,System.Int32)">
  2160. <summary>
  2161. <para>Set the collision layer mask that indicates which layer(s) the specified layer can collide with.</para>
  2162. </summary>
  2163. <param name="layer">The layer to set the collision layer mask for.</param>
  2164. <param name="layerMask">A mask where each bit indicates a layer and whether it can collide with layer or not.</param>
  2165. </member>
  2166. <member name="M:UnityEngine.Physics2D.Simulate(System.Single)">
  2167. <summary>
  2168. <para>Simulate physics in the scene.</para>
  2169. </summary>
  2170. <param name="step">The time to advance physics by.</param>
  2171. <returns>
  2172. <para>Whether the simulation was run or not. Running the simulation during physics callbacks will always fail.</para>
  2173. </returns>
  2174. </member>
  2175. <member name="M:UnityEngine.Physics2D.SyncTransforms">
  2176. <summary>
  2177. <para>Synchronizes.</para>
  2178. </summary>
  2179. </member>
  2180. <member name="T:UnityEngine.PhysicsJobOptions2D">
  2181. <summary>
  2182. <para>A set of options that control how physics operates when using the job system to multithread the physics simulation.</para>
  2183. </summary>
  2184. </member>
  2185. <member name="P:UnityEngine.PhysicsJobOptions2D.clearBodyForcesPerJob">
  2186. <summary>
  2187. <para>Controls the minimum number of bodies to be cleared in each simulation job.</para>
  2188. </summary>
  2189. </member>
  2190. <member name="P:UnityEngine.PhysicsJobOptions2D.clearFlagsPerJob">
  2191. <summary>
  2192. <para>Controls the minimum number of flags to be cleared in each simulation job.</para>
  2193. </summary>
  2194. </member>
  2195. <member name="P:UnityEngine.PhysicsJobOptions2D.collideContactsPerJob">
  2196. <summary>
  2197. <para>Controls the minimum number of contacts to collide in each simulation job.</para>
  2198. </summary>
  2199. </member>
  2200. <member name="P:UnityEngine.PhysicsJobOptions2D.findNearestContactsPerJob">
  2201. <summary>
  2202. <para>Controls the minimum number of nearest contacts to find in each simulation job.</para>
  2203. </summary>
  2204. </member>
  2205. <member name="P:UnityEngine.PhysicsJobOptions2D.interpolationPosesPerJob">
  2206. <summary>
  2207. <para>Controls the minimum number of Rigidbody2D being interpolated in each simulation job.</para>
  2208. </summary>
  2209. </member>
  2210. <member name="P:UnityEngine.PhysicsJobOptions2D.islandSolverBodiesPerJob">
  2211. <summary>
  2212. <para>Controls the minimum number of bodies to solve in each simulation job when performing island solving.</para>
  2213. </summary>
  2214. </member>
  2215. <member name="P:UnityEngine.PhysicsJobOptions2D.islandSolverBodyCostScale">
  2216. <summary>
  2217. <para>Scales the cost of each body during discrete island solving.</para>
  2218. </summary>
  2219. </member>
  2220. <member name="P:UnityEngine.PhysicsJobOptions2D.islandSolverContactCostScale">
  2221. <summary>
  2222. <para>Scales the cost of each contact during discrete island solving.</para>
  2223. </summary>
  2224. </member>
  2225. <member name="P:UnityEngine.PhysicsJobOptions2D.islandSolverContactsPerJob">
  2226. <summary>
  2227. <para>Controls the minimum number of contacts to solve in each simulation job when performing island solving.</para>
  2228. </summary>
  2229. </member>
  2230. <member name="P:UnityEngine.PhysicsJobOptions2D.islandSolverCostThreshold">
  2231. <summary>
  2232. <para>The minimum threshold cost of all bodies, contacts and joints in an island during discrete island solving.</para>
  2233. </summary>
  2234. </member>
  2235. <member name="P:UnityEngine.PhysicsJobOptions2D.islandSolverJointCostScale">
  2236. <summary>
  2237. <para>Scales the cost of each joint during discrete island solving.</para>
  2238. </summary>
  2239. </member>
  2240. <member name="P:UnityEngine.PhysicsJobOptions2D.newContactsPerJob">
  2241. <summary>
  2242. <para>Controls the minimum number of new contacts to find in each simulation job.</para>
  2243. </summary>
  2244. </member>
  2245. <member name="P:UnityEngine.PhysicsJobOptions2D.syncContinuousFixturesPerJob">
  2246. <summary>
  2247. <para>Controls the minimum number of fixtures to synchronize in the broadphase during continuous island solving in each simulation job.</para>
  2248. </summary>
  2249. </member>
  2250. <member name="P:UnityEngine.PhysicsJobOptions2D.syncDiscreteFixturesPerJob">
  2251. <summary>
  2252. <para>Controls the minimum number of fixtures to synchronize in the broadphase during discrete island solving in each simulation job.</para>
  2253. </summary>
  2254. </member>
  2255. <member name="P:UnityEngine.PhysicsJobOptions2D.updateTriggerContactsPerJob">
  2256. <summary>
  2257. <para>Controls the minimum number of trigger contacts to update in each simulation job.</para>
  2258. </summary>
  2259. </member>
  2260. <member name="P:UnityEngine.PhysicsJobOptions2D.useConsistencySorting">
  2261. <summary>
  2262. <para>Should physics simulation sort multi-threaded results to maintain processing order consistency?</para>
  2263. </summary>
  2264. </member>
  2265. <member name="P:UnityEngine.PhysicsJobOptions2D.useMultithreading">
  2266. <summary>
  2267. <para>Should physics simulation use multithreading?</para>
  2268. </summary>
  2269. </member>
  2270. <member name="T:UnityEngine.PhysicsMaterial2D">
  2271. <summary>
  2272. <para>Asset type that defines the surface properties of a Collider2D.</para>
  2273. </summary>
  2274. </member>
  2275. <member name="P:UnityEngine.PhysicsMaterial2D.bounciness">
  2276. <summary>
  2277. <para>The degree of elasticity during collisions.</para>
  2278. </summary>
  2279. </member>
  2280. <member name="P:UnityEngine.PhysicsMaterial2D.friction">
  2281. <summary>
  2282. <para>Coefficient of friction.</para>
  2283. </summary>
  2284. </member>
  2285. <member name="T:UnityEngine.PhysicsUpdateBehaviour2D">
  2286. <summary>
  2287. <para>A base type for 2D physics components that required a callback during FixedUpdate.</para>
  2288. </summary>
  2289. </member>
  2290. <member name="T:UnityEngine.PlatformEffector2D">
  2291. <summary>
  2292. <para>Applies "platform" behaviour such as one-way collisions etc.</para>
  2293. </summary>
  2294. </member>
  2295. <member name="P:UnityEngine.PlatformEffector2D.rotationalOffset">
  2296. <summary>
  2297. <para>The rotational offset angle from the local 'up'.</para>
  2298. </summary>
  2299. </member>
  2300. <member name="P:UnityEngine.PlatformEffector2D.sideArc">
  2301. <summary>
  2302. <para>The angle of an arc that defines the sides of the platform centered on the local 'left' and 'right' of the effector. Any collision normals within this arc are considered for the 'side' behaviours.</para>
  2303. </summary>
  2304. </member>
  2305. <member name="P:UnityEngine.PlatformEffector2D.surfaceArc">
  2306. <summary>
  2307. <para>The angle of an arc that defines the surface of the platform centered of the local 'up' of the effector.</para>
  2308. </summary>
  2309. </member>
  2310. <member name="P:UnityEngine.PlatformEffector2D.useOneWay">
  2311. <summary>
  2312. <para>Should the one-way collision behaviour be used?</para>
  2313. </summary>
  2314. </member>
  2315. <member name="P:UnityEngine.PlatformEffector2D.useOneWayGrouping">
  2316. <summary>
  2317. <para>Ensures that all contacts controlled by the one-way behaviour act the same.</para>
  2318. </summary>
  2319. </member>
  2320. <member name="P:UnityEngine.PlatformEffector2D.useSideBounce">
  2321. <summary>
  2322. <para>Should bounce be used on the platform sides?</para>
  2323. </summary>
  2324. </member>
  2325. <member name="P:UnityEngine.PlatformEffector2D.useSideFriction">
  2326. <summary>
  2327. <para>Should friction be used on the platform sides?</para>
  2328. </summary>
  2329. </member>
  2330. <member name="T:UnityEngine.PointEffector2D">
  2331. <summary>
  2332. <para>Applies forces to attract/repulse against a point.</para>
  2333. </summary>
  2334. </member>
  2335. <member name="P:UnityEngine.PointEffector2D.angularDrag">
  2336. <summary>
  2337. <para>The angular drag to apply to rigid-bodies.</para>
  2338. </summary>
  2339. </member>
  2340. <member name="P:UnityEngine.PointEffector2D.distanceScale">
  2341. <summary>
  2342. <para>The scale applied to the calculated distance between source and target.</para>
  2343. </summary>
  2344. </member>
  2345. <member name="P:UnityEngine.PointEffector2D.drag">
  2346. <summary>
  2347. <para>The linear drag to apply to rigid-bodies.</para>
  2348. </summary>
  2349. </member>
  2350. <member name="P:UnityEngine.PointEffector2D.forceMagnitude">
  2351. <summary>
  2352. <para>The magnitude of the force to be applied.</para>
  2353. </summary>
  2354. </member>
  2355. <member name="P:UnityEngine.PointEffector2D.forceMode">
  2356. <summary>
  2357. <para>The mode used to apply the effector force.</para>
  2358. </summary>
  2359. </member>
  2360. <member name="P:UnityEngine.PointEffector2D.forceSource">
  2361. <summary>
  2362. <para>The source which is used to calculate the centroid point of the effector. The distance from the target is defined from this point.</para>
  2363. </summary>
  2364. </member>
  2365. <member name="P:UnityEngine.PointEffector2D.forceTarget">
  2366. <summary>
  2367. <para>The target for where the effector applies any force.</para>
  2368. </summary>
  2369. </member>
  2370. <member name="P:UnityEngine.PointEffector2D.forceVariation">
  2371. <summary>
  2372. <para>The variation of the magnitude of the force to be applied.</para>
  2373. </summary>
  2374. </member>
  2375. <member name="T:UnityEngine.PolygonCollider2D">
  2376. <summary>
  2377. <para>Collider for 2D physics representing an arbitrary polygon defined by its vertices.</para>
  2378. </summary>
  2379. </member>
  2380. <member name="P:UnityEngine.PolygonCollider2D.autoTiling">
  2381. <summary>
  2382. <para>Determines whether the PolygonCollider2D's shape is automatically updated based on a SpriteRenderer's tiling properties.</para>
  2383. </summary>
  2384. </member>
  2385. <member name="P:UnityEngine.PolygonCollider2D.pathCount">
  2386. <summary>
  2387. <para>The number of paths in the polygon.</para>
  2388. </summary>
  2389. </member>
  2390. <member name="P:UnityEngine.PolygonCollider2D.points">
  2391. <summary>
  2392. <para>Corner points that define the collider's shape in local space.</para>
  2393. </summary>
  2394. </member>
  2395. <member name="M:UnityEngine.PolygonCollider2D.CreatePrimitive(System.Int32,UnityEngine.Vector2,UnityEngine.Vector2)">
  2396. <summary>
  2397. <para>Creates as regular primitive polygon with the specified number of sides.</para>
  2398. </summary>
  2399. <param name="sides">The number of sides in the polygon. This must be greater than two.</param>
  2400. <param name="scale">The X/Y scale of the polygon. These must be greater than zero.</param>
  2401. <param name="offset">The X/Y offset of the polygon.</param>
  2402. </member>
  2403. <member name="M:UnityEngine.PolygonCollider2D.GetPath(System.Int32)">
  2404. <summary>
  2405. <para>Gets a path from the Collider by its index.</para>
  2406. </summary>
  2407. <param name="index">The index of the path to retrieve.</param>
  2408. <returns>
  2409. <para>An ordered array of the vertices or points in the selected path.</para>
  2410. </returns>
  2411. </member>
  2412. <member name="M:UnityEngine.PolygonCollider2D.GetTotalPointCount">
  2413. <summary>
  2414. <para>Return the total number of points in the polygon in all paths.</para>
  2415. </summary>
  2416. </member>
  2417. <member name="M:UnityEngine.PolygonCollider2D.SetPath(System.Int32,UnityEngine.Vector2[])">
  2418. <summary>
  2419. <para>Define a path by its constituent points.</para>
  2420. </summary>
  2421. <param name="index">Index of the path to set.</param>
  2422. <param name="points">Points that define the path.</param>
  2423. </member>
  2424. <member name="T:UnityEngine.RaycastHit2D">
  2425. <summary>
  2426. <para>Information returned about an object detected by a raycast in 2D physics.</para>
  2427. </summary>
  2428. </member>
  2429. <member name="P:UnityEngine.RaycastHit2D.centroid">
  2430. <summary>
  2431. <para>The centroid of the primitive used to perform the cast.</para>
  2432. </summary>
  2433. </member>
  2434. <member name="P:UnityEngine.RaycastHit2D.collider">
  2435. <summary>
  2436. <para>The collider hit by the ray.</para>
  2437. </summary>
  2438. </member>
  2439. <member name="P:UnityEngine.RaycastHit2D.distance">
  2440. <summary>
  2441. <para>The distance from the ray origin to the impact point.</para>
  2442. </summary>
  2443. </member>
  2444. <member name="P:UnityEngine.RaycastHit2D.fraction">
  2445. <summary>
  2446. <para>Fraction of the distance along the ray that the hit occurred.</para>
  2447. </summary>
  2448. </member>
  2449. <member name="P:UnityEngine.RaycastHit2D.normal">
  2450. <summary>
  2451. <para>The normal vector of the surface hit by the ray.</para>
  2452. </summary>
  2453. </member>
  2454. <member name="P:UnityEngine.RaycastHit2D.point">
  2455. <summary>
  2456. <para>The point in world space where the ray hit the collider's surface.</para>
  2457. </summary>
  2458. </member>
  2459. <member name="P:UnityEngine.RaycastHit2D.rigidbody">
  2460. <summary>
  2461. <para>The Rigidbody2D attached to the object that was hit.</para>
  2462. </summary>
  2463. </member>
  2464. <member name="P:UnityEngine.RaycastHit2D.transform">
  2465. <summary>
  2466. <para>The Transform of the object that was hit.</para>
  2467. </summary>
  2468. </member>
  2469. <member name="T:UnityEngine.RelativeJoint2D">
  2470. <summary>
  2471. <para>Keeps two Rigidbody2D at their relative orientations.</para>
  2472. </summary>
  2473. </member>
  2474. <member name="P:UnityEngine.RelativeJoint2D.angularOffset">
  2475. <summary>
  2476. <para>The current angular offset between the Rigidbody2D that the joint connects.</para>
  2477. </summary>
  2478. </member>
  2479. <member name="P:UnityEngine.RelativeJoint2D.autoConfigureOffset">
  2480. <summary>
  2481. <para>Should both the linearOffset and angularOffset be calculated automatically?</para>
  2482. </summary>
  2483. </member>
  2484. <member name="P:UnityEngine.RelativeJoint2D.correctionScale">
  2485. <summary>
  2486. <para>Scales both the linear and angular forces used to correct the required relative orientation.</para>
  2487. </summary>
  2488. </member>
  2489. <member name="P:UnityEngine.RelativeJoint2D.linearOffset">
  2490. <summary>
  2491. <para>The current linear offset between the Rigidbody2D that the joint connects.</para>
  2492. </summary>
  2493. </member>
  2494. <member name="P:UnityEngine.RelativeJoint2D.maxForce">
  2495. <summary>
  2496. <para>The maximum force that can be generated when trying to maintain the relative joint constraint.</para>
  2497. </summary>
  2498. </member>
  2499. <member name="P:UnityEngine.RelativeJoint2D.maxTorque">
  2500. <summary>
  2501. <para>The maximum torque that can be generated when trying to maintain the relative joint constraint.</para>
  2502. </summary>
  2503. </member>
  2504. <member name="P:UnityEngine.RelativeJoint2D.target">
  2505. <summary>
  2506. <para>The world-space position that is currently trying to be maintained.</para>
  2507. </summary>
  2508. </member>
  2509. <member name="T:UnityEngine.Rigidbody2D">
  2510. <summary>
  2511. <para>Rigidbody physics component for 2D sprites.</para>
  2512. </summary>
  2513. </member>
  2514. <member name="P:UnityEngine.Rigidbody2D.angularDrag">
  2515. <summary>
  2516. <para>Coefficient of angular drag.</para>
  2517. </summary>
  2518. </member>
  2519. <member name="P:UnityEngine.Rigidbody2D.angularVelocity">
  2520. <summary>
  2521. <para>Angular velocity in degrees per second.</para>
  2522. </summary>
  2523. </member>
  2524. <member name="P:UnityEngine.Rigidbody2D.attachedColliderCount">
  2525. <summary>
  2526. <para>Returns the number of Collider2D attached to this Rigidbody2D.</para>
  2527. </summary>
  2528. </member>
  2529. <member name="P:UnityEngine.Rigidbody2D.bodyType">
  2530. <summary>
  2531. <para>The physical behaviour type of the Rigidbody2D.</para>
  2532. </summary>
  2533. </member>
  2534. <member name="P:UnityEngine.Rigidbody2D.centerOfMass">
  2535. <summary>
  2536. <para>The center of mass of the rigidBody in local space.</para>
  2537. </summary>
  2538. </member>
  2539. <member name="P:UnityEngine.Rigidbody2D.collisionDetectionMode">
  2540. <summary>
  2541. <para>The method used by the physics engine to check if two objects have collided.</para>
  2542. </summary>
  2543. </member>
  2544. <member name="P:UnityEngine.Rigidbody2D.constraints">
  2545. <summary>
  2546. <para>Controls which degrees of freedom are allowed for the simulation of this Rigidbody2D.</para>
  2547. </summary>
  2548. </member>
  2549. <member name="P:UnityEngine.Rigidbody2D.drag">
  2550. <summary>
  2551. <para>Coefficient of drag.</para>
  2552. </summary>
  2553. </member>
  2554. <member name="P:UnityEngine.Rigidbody2D.fixedAngle">
  2555. <summary>
  2556. <para>Should the rigidbody be prevented from rotating?</para>
  2557. </summary>
  2558. </member>
  2559. <member name="P:UnityEngine.Rigidbody2D.freezeRotation">
  2560. <summary>
  2561. <para>Controls whether physics will change the rotation of the object.</para>
  2562. </summary>
  2563. </member>
  2564. <member name="P:UnityEngine.Rigidbody2D.gravityScale">
  2565. <summary>
  2566. <para>The degree to which this object is affected by gravity.</para>
  2567. </summary>
  2568. </member>
  2569. <member name="P:UnityEngine.Rigidbody2D.inertia">
  2570. <summary>
  2571. <para>The rigidBody rotational inertia.</para>
  2572. </summary>
  2573. </member>
  2574. <member name="P:UnityEngine.Rigidbody2D.interpolation">
  2575. <summary>
  2576. <para>Physics interpolation used between updates.</para>
  2577. </summary>
  2578. </member>
  2579. <member name="P:UnityEngine.Rigidbody2D.isKinematic">
  2580. <summary>
  2581. <para>Should this rigidbody be taken out of physics control?</para>
  2582. </summary>
  2583. </member>
  2584. <member name="P:UnityEngine.Rigidbody2D.mass">
  2585. <summary>
  2586. <para>Mass of the Rigidbody.</para>
  2587. </summary>
  2588. </member>
  2589. <member name="P:UnityEngine.Rigidbody2D.position">
  2590. <summary>
  2591. <para>The position of the rigidbody.</para>
  2592. </summary>
  2593. </member>
  2594. <member name="P:UnityEngine.Rigidbody2D.rotation">
  2595. <summary>
  2596. <para>The rotation of the rigidbody.</para>
  2597. </summary>
  2598. </member>
  2599. <member name="P:UnityEngine.Rigidbody2D.sharedMaterial">
  2600. <summary>
  2601. <para>The PhysicsMaterial2D that is applied to all Collider2D attached to this Rigidbody2D.</para>
  2602. </summary>
  2603. </member>
  2604. <member name="P:UnityEngine.Rigidbody2D.simulated">
  2605. <summary>
  2606. <para>Indicates whether the rigid body should be simulated or not by the physics system.</para>
  2607. </summary>
  2608. </member>
  2609. <member name="P:UnityEngine.Rigidbody2D.sleepMode">
  2610. <summary>
  2611. <para>The sleep state that the rigidbody will initially be in.</para>
  2612. </summary>
  2613. </member>
  2614. <member name="P:UnityEngine.Rigidbody2D.useAutoMass">
  2615. <summary>
  2616. <para>Should the total rigid-body mass be automatically calculated from the Collider2D.density of attached colliders?</para>
  2617. </summary>
  2618. </member>
  2619. <member name="P:UnityEngine.Rigidbody2D.useFullKinematicContacts">
  2620. <summary>
  2621. <para>Should kinematickinematic and kinematicstatic collisions be allowed?</para>
  2622. </summary>
  2623. </member>
  2624. <member name="P:UnityEngine.Rigidbody2D.velocity">
  2625. <summary>
  2626. <para>Linear velocity of the rigidbody.</para>
  2627. </summary>
  2628. </member>
  2629. <member name="P:UnityEngine.Rigidbody2D.worldCenterOfMass">
  2630. <summary>
  2631. <para>Gets the center of mass of the rigidBody in global space.</para>
  2632. </summary>
  2633. </member>
  2634. <member name="M:UnityEngine.Rigidbody2D.AddForce(UnityEngine.Vector2,UnityEngine.ForceMode2D)">
  2635. <summary>
  2636. <para>Apply a force to the rigidbody.</para>
  2637. </summary>
  2638. <param name="force">Components of the force in the X and Y axes.</param>
  2639. <param name="mode">The method used to apply the specified force.</param>
  2640. </member>
  2641. <member name="M:UnityEngine.Rigidbody2D.AddForceAtPosition(UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.ForceMode2D)">
  2642. <summary>
  2643. <para>Apply a force at a given position in space.</para>
  2644. </summary>
  2645. <param name="force">Components of the force in the X and Y axes.</param>
  2646. <param name="position">Position in world space to apply the force.</param>
  2647. <param name="mode">The method used to apply the specified force.</param>
  2648. </member>
  2649. <member name="M:UnityEngine.Rigidbody2D.AddRelativeForce(UnityEngine.Vector2,UnityEngine.ForceMode2D)">
  2650. <summary>
  2651. <para>Adds a force to the rigidbody2D relative to its coordinate system.</para>
  2652. </summary>
  2653. <param name="relativeForce">Components of the force in the X and Y axes.</param>
  2654. <param name="mode">The method used to apply the specified force.</param>
  2655. </member>
  2656. <member name="M:UnityEngine.Rigidbody2D.AddTorque(System.Single,UnityEngine.ForceMode2D)">
  2657. <summary>
  2658. <para>Apply a torque at the rigidbody's centre of mass.</para>
  2659. </summary>
  2660. <param name="torque">Torque to apply.</param>
  2661. <param name="mode">The force mode to use.</param>
  2662. </member>
  2663. <member name="M:UnityEngine.Rigidbody2D.Cast(UnityEngine.Vector2,UnityEngine.RaycastHit2D[],System.Single)">
  2664. <summary>
  2665. <para>All the Collider2D shapes attached to the Rigidbody2D are cast into the scene starting at each collider position ignoring the colliders attached to the same Rigidbody2D.</para>
  2666. </summary>
  2667. <param name="direction">Vector representing the direction to cast each Collider2D shape.</param>
  2668. <param name="results">Array to receive results.</param>
  2669. <param name="distance">Maximum distance over which to cast the shape(s).</param>
  2670. <returns>
  2671. <para>The number of results returned.</para>
  2672. </returns>
  2673. </member>
  2674. <member name="M:UnityEngine.Rigidbody2D.Cast(UnityEngine.Vector2,UnityEngine.ContactFilter2D,UnityEngine.RaycastHit2D[],System.Single)">
  2675. <summary>
  2676. <para>All the Collider2D shapes attached to the Rigidbody2D are cast into the scene starting at each collider position ignoring the colliders attached to the same Rigidbody2D.</para>
  2677. </summary>
  2678. <param name="direction">Vector representing the direction to cast each Collider2D shape.</param>
  2679. <param name="contactFilter">Filter results defined by the contact filter.</param>
  2680. <param name="results">Array to receive results.</param>
  2681. <param name="distance">Maximum distance over which to cast the shape(s).</param>
  2682. <returns>
  2683. <para>The number of results returned.</para>
  2684. </returns>
  2685. </member>
  2686. <member name="M:UnityEngine.Rigidbody2D.Distance(UnityEngine.Collider2D)">
  2687. <summary>
  2688. <para>Calculates the minimum distance of this collider against all Collider2D attached to this Rigidbody2D.</para>
  2689. </summary>
  2690. <param name="collider">A collider used to calculate the minimum distance against all colliders attached to this Rigidbody2D.</param>
  2691. <returns>
  2692. <para>The minimum distance of collider against all colliders attached to this Rigidbody2D.</para>
  2693. </returns>
  2694. </member>
  2695. <member name="M:UnityEngine.Rigidbody2D.GetAttachedColliders(UnityEngine.Collider2D[])">
  2696. <summary>
  2697. <para>Returns all Collider2D that are attached to this Rigidbody2D.</para>
  2698. </summary>
  2699. <param name="results">An array of Collider2D used to receive the results.</param>
  2700. <returns>
  2701. <para>Returns the number of Collider2D placed in the results array.</para>
  2702. </returns>
  2703. </member>
  2704. <member name="M:UnityEngine.Rigidbody2D.GetContacts(UnityEngine.ContactPoint2D[])">
  2705. <summary>
  2706. <para>Retrieves all contact points for all of the collider(s) attached to this rigidbody.</para>
  2707. </summary>
  2708. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  2709. <returns>
  2710. <para>Returns the number of contacts placed in the contacts array.</para>
  2711. </returns>
  2712. </member>
  2713. <member name="M:UnityEngine.Rigidbody2D.GetContacts(UnityEngine.Collider2D[])">
  2714. <summary>
  2715. <para>Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody.</para>
  2716. </summary>
  2717. <param name="colliders">An array of Collider2D used to receive the results.</param>
  2718. <returns>
  2719. <para>Returns the number of colliders placed in the colliders array.</para>
  2720. </returns>
  2721. </member>
  2722. <member name="M:UnityEngine.Rigidbody2D.GetContacts(UnityEngine.ContactFilter2D,UnityEngine.ContactPoint2D[])">
  2723. <summary>
  2724. <para>Retrieves all contact points for all of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D.</para>
  2725. </summary>
  2726. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  2727. <param name="contacts">An array of ContactPoint2D used to receive the results.</param>
  2728. <returns>
  2729. <para>Returns the number of contacts placed in the contacts array.</para>
  2730. </returns>
  2731. </member>
  2732. <member name="M:UnityEngine.Rigidbody2D.GetContacts(UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  2733. <summary>
  2734. <para>Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D.</para>
  2735. </summary>
  2736. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  2737. <param name="colliders">An array of Collider2D used to receive the results.</param>
  2738. <returns>
  2739. <para>Returns the number of colliders placed in the colliders array.</para>
  2740. </returns>
  2741. </member>
  2742. <member name="M:UnityEngine.Rigidbody2D.GetPoint(UnityEngine.Vector2)">
  2743. <summary>
  2744. <para>Get a local space point given the point point in rigidBody global space.</para>
  2745. </summary>
  2746. <param name="point">The global space point to transform into local space.</param>
  2747. </member>
  2748. <member name="M:UnityEngine.Rigidbody2D.GetPointVelocity(UnityEngine.Vector2)">
  2749. <summary>
  2750. <para>The velocity of the rigidbody at the point Point in global space.</para>
  2751. </summary>
  2752. <param name="point">The global space point to calculate velocity for.</param>
  2753. </member>
  2754. <member name="M:UnityEngine.Rigidbody2D.GetRelativePoint(UnityEngine.Vector2)">
  2755. <summary>
  2756. <para>Get a global space point given the point relativePoint in rigidBody local space.</para>
  2757. </summary>
  2758. <param name="relativePoint">The local space point to transform into global space.</param>
  2759. </member>
  2760. <member name="M:UnityEngine.Rigidbody2D.GetRelativePointVelocity(UnityEngine.Vector2)">
  2761. <summary>
  2762. <para>The velocity of the rigidbody at the point Point in local space.</para>
  2763. </summary>
  2764. <param name="relativePoint">The local space point to calculate velocity for.</param>
  2765. </member>
  2766. <member name="M:UnityEngine.Rigidbody2D.GetRelativeVector(UnityEngine.Vector2)">
  2767. <summary>
  2768. <para>Get a global space vector given the vector relativeVector in rigidBody local space.</para>
  2769. </summary>
  2770. <param name="relativeVector">The local space vector to transform into a global space vector.</param>
  2771. </member>
  2772. <member name="M:UnityEngine.Rigidbody2D.GetVector(UnityEngine.Vector2)">
  2773. <summary>
  2774. <para>Get a local space vector given the vector vector in rigidBody global space.</para>
  2775. </summary>
  2776. <param name="vector">The global space vector to transform into a local space vector.</param>
  2777. </member>
  2778. <member name="M:UnityEngine.Rigidbody2D.IsAwake">
  2779. <summary>
  2780. <para>Is the rigidbody "awake"?</para>
  2781. </summary>
  2782. </member>
  2783. <member name="M:UnityEngine.Rigidbody2D.IsSleeping">
  2784. <summary>
  2785. <para>Is the rigidbody "sleeping"?</para>
  2786. </summary>
  2787. </member>
  2788. <member name="M:UnityEngine.Rigidbody2D.IsTouching(UnityEngine.Collider2D)">
  2789. <summary>
  2790. <para>Checks whether the collider is touching any of the collider(s) attached to this rigidbody or not.</para>
  2791. </summary>
  2792. <param name="collider">The collider to check if it is touching any of the collider(s) attached to this rigidbody.</param>
  2793. <returns>
  2794. <para>Whether the collider is touching any of the collider(s) attached to this rigidbody or not.</para>
  2795. </returns>
  2796. </member>
  2797. <member name="M:UnityEngine.Rigidbody2D.IsTouching(UnityEngine.Collider2D,UnityEngine.ContactFilter2D)">
  2798. <summary>
  2799. <para>Checks whether the collider is touching any of the collider(s) attached to this rigidbody or not with the results filtered by the ContactFilter2D.</para>
  2800. </summary>
  2801. <param name="collider">The collider to check if it is touching any of the collider(s) attached to this rigidbody.</param>
  2802. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  2803. <returns>
  2804. <para>Whether the collider is touching any of the collider(s) attached to this rigidbody or not.</para>
  2805. </returns>
  2806. </member>
  2807. <member name="M:UnityEngine.Rigidbody2D.IsTouching(UnityEngine.ContactFilter2D)">
  2808. <summary>
  2809. <para>Checks whether any collider is touching any of the collider(s) attached to this rigidbody or not with the results filtered by the ContactFilter2D.</para>
  2810. </summary>
  2811. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.</param>
  2812. <returns>
  2813. <para>Whether any collider is touching any of the collider(s) attached to this rigidbody or not.</para>
  2814. </returns>
  2815. </member>
  2816. <member name="M:UnityEngine.Rigidbody2D.IsTouchingLayers(System.Int32)">
  2817. <summary>
  2818. <para>Checks whether any of the collider(s) attached to this rigidbody are touching any colliders on the specified layerMask or not.</para>
  2819. </summary>
  2820. <param name="layerMask">Any colliders on any of these layers count as touching.</param>
  2821. <returns>
  2822. <para>Whether any of the collider(s) attached to this rigidbody are touching any colliders on the specified layerMask or not.</para>
  2823. </returns>
  2824. </member>
  2825. <member name="M:UnityEngine.Rigidbody2D.MovePosition(UnityEngine.Vector2)">
  2826. <summary>
  2827. <para>Moves the rigidbody to position.</para>
  2828. </summary>
  2829. <param name="position">The new position for the Rigidbody object.</param>
  2830. </member>
  2831. <member name="M:UnityEngine.Rigidbody2D.MoveRotation(System.Single)">
  2832. <summary>
  2833. <para>Rotates the rigidbody to angle (given in degrees).</para>
  2834. </summary>
  2835. <param name="angle">The new rotation angle for the Rigidbody object.</param>
  2836. </member>
  2837. <member name="M:UnityEngine.Rigidbody2D.OverlapCollider(UnityEngine.ContactFilter2D,UnityEngine.Collider2D[])">
  2838. <summary>
  2839. <para>Get a list of all colliders that overlap all colliders attached to this Rigidbody2D.</para>
  2840. </summary>
  2841. <param name="contactFilter">The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.</param>
  2842. <param name="results">The array to receive results. The size of the array determines the maximum number of results that can be returned.</param>
  2843. <returns>
  2844. <para>Returns the number of results placed in the results array.</para>
  2845. </returns>
  2846. </member>
  2847. <member name="M:UnityEngine.Rigidbody2D.OverlapPoint(UnityEngine.Vector2)">
  2848. <summary>
  2849. <para>Check if any of the Rigidbody2D colliders overlap a point in space.</para>
  2850. </summary>
  2851. <param name="point">A point in world space.</param>
  2852. <returns>
  2853. <para>Whether the point overlapped any of the Rigidbody2D colliders.</para>
  2854. </returns>
  2855. </member>
  2856. <member name="M:UnityEngine.Rigidbody2D.Sleep">
  2857. <summary>
  2858. <para>Make the rigidbody "sleep".</para>
  2859. </summary>
  2860. </member>
  2861. <member name="M:UnityEngine.Rigidbody2D.WakeUp">
  2862. <summary>
  2863. <para>Disables the "sleeping" state of a rigidbody.</para>
  2864. </summary>
  2865. </member>
  2866. <member name="T:UnityEngine.RigidbodyConstraints2D">
  2867. <summary>
  2868. <para>Use these flags to constrain motion of the Rigidbody2D.</para>
  2869. </summary>
  2870. </member>
  2871. <member name="F:UnityEngine.RigidbodyConstraints2D.FreezeAll">
  2872. <summary>
  2873. <para>Freeze rotation and motion along all axes.</para>
  2874. </summary>
  2875. </member>
  2876. <member name="F:UnityEngine.RigidbodyConstraints2D.FreezePosition">
  2877. <summary>
  2878. <para>Freeze motion along the X-axis and Y-axis.</para>
  2879. </summary>
  2880. </member>
  2881. <member name="F:UnityEngine.RigidbodyConstraints2D.FreezePositionX">
  2882. <summary>
  2883. <para>Freeze motion along the X-axis.</para>
  2884. </summary>
  2885. </member>
  2886. <member name="F:UnityEngine.RigidbodyConstraints2D.FreezePositionY">
  2887. <summary>
  2888. <para>Freeze motion along the Y-axis.</para>
  2889. </summary>
  2890. </member>
  2891. <member name="F:UnityEngine.RigidbodyConstraints2D.FreezeRotation">
  2892. <summary>
  2893. <para>Freeze rotation along the Z-axis.</para>
  2894. </summary>
  2895. </member>
  2896. <member name="F:UnityEngine.RigidbodyConstraints2D.None">
  2897. <summary>
  2898. <para>No constraints.</para>
  2899. </summary>
  2900. </member>
  2901. <member name="T:UnityEngine.RigidbodyInterpolation2D">
  2902. <summary>
  2903. <para>Interpolation mode for Rigidbody2D objects.</para>
  2904. </summary>
  2905. </member>
  2906. <member name="F:UnityEngine.RigidbodyInterpolation2D.Extrapolate">
  2907. <summary>
  2908. <para>Smooth an object's movement based on an estimate of its position in the next frame.</para>
  2909. </summary>
  2910. </member>
  2911. <member name="F:UnityEngine.RigidbodyInterpolation2D.Interpolate">
  2912. <summary>
  2913. <para>Smooth movement based on the object's positions in previous frames.</para>
  2914. </summary>
  2915. </member>
  2916. <member name="F:UnityEngine.RigidbodyInterpolation2D.None">
  2917. <summary>
  2918. <para>Do not apply any smoothing to the object's movement.</para>
  2919. </summary>
  2920. </member>
  2921. <member name="T:UnityEngine.RigidbodySleepMode2D">
  2922. <summary>
  2923. <para>Settings for a Rigidbody2D's initial sleep state.</para>
  2924. </summary>
  2925. </member>
  2926. <member name="F:UnityEngine.RigidbodySleepMode2D.NeverSleep">
  2927. <summary>
  2928. <para>Rigidbody2D never automatically sleeps.</para>
  2929. </summary>
  2930. </member>
  2931. <member name="F:UnityEngine.RigidbodySleepMode2D.StartAsleep">
  2932. <summary>
  2933. <para>Rigidbody2D is initially asleep.</para>
  2934. </summary>
  2935. </member>
  2936. <member name="F:UnityEngine.RigidbodySleepMode2D.StartAwake">
  2937. <summary>
  2938. <para>Rigidbody2D is initially awake.</para>
  2939. </summary>
  2940. </member>
  2941. <member name="T:UnityEngine.RigidbodyType2D">
  2942. <summary>
  2943. <para>The physical behaviour type of the Rigidbody2D.</para>
  2944. </summary>
  2945. </member>
  2946. <member name="F:UnityEngine.RigidbodyType2D.Dynamic">
  2947. <summary>
  2948. <para>Sets the Rigidbody2D to have dynamic behaviour.</para>
  2949. </summary>
  2950. </member>
  2951. <member name="F:UnityEngine.RigidbodyType2D.Kinematic">
  2952. <summary>
  2953. <para>Sets the Rigidbody2D to have kinematic behaviour.</para>
  2954. </summary>
  2955. </member>
  2956. <member name="F:UnityEngine.RigidbodyType2D.Static">
  2957. <summary>
  2958. <para>Sets the Rigidbody2D to have static behaviour.</para>
  2959. </summary>
  2960. </member>
  2961. <member name="T:UnityEngine.SliderJoint2D">
  2962. <summary>
  2963. <para>Joint that restricts the motion of a Rigidbody2D object to a single line.</para>
  2964. </summary>
  2965. </member>
  2966. <member name="P:UnityEngine.SliderJoint2D.angle">
  2967. <summary>
  2968. <para>The angle of the line in space (in degrees).</para>
  2969. </summary>
  2970. </member>
  2971. <member name="P:UnityEngine.SliderJoint2D.autoConfigureAngle">
  2972. <summary>
  2973. <para>Should the angle be calculated automatically?</para>
  2974. </summary>
  2975. </member>
  2976. <member name="P:UnityEngine.SliderJoint2D.jointSpeed">
  2977. <summary>
  2978. <para>The current joint speed.</para>
  2979. </summary>
  2980. </member>
  2981. <member name="P:UnityEngine.SliderJoint2D.jointTranslation">
  2982. <summary>
  2983. <para>The current joint translation.</para>
  2984. </summary>
  2985. </member>
  2986. <member name="P:UnityEngine.SliderJoint2D.limits">
  2987. <summary>
  2988. <para>Restrictions on how far the joint can slide in each direction along the line.</para>
  2989. </summary>
  2990. </member>
  2991. <member name="P:UnityEngine.SliderJoint2D.limitState">
  2992. <summary>
  2993. <para>Gets the state of the joint limit.</para>
  2994. </summary>
  2995. </member>
  2996. <member name="P:UnityEngine.SliderJoint2D.motor">
  2997. <summary>
  2998. <para>Parameters for a motor force that is applied automatically to the Rigibody2D along the line.</para>
  2999. </summary>
  3000. </member>
  3001. <member name="P:UnityEngine.SliderJoint2D.referenceAngle">
  3002. <summary>
  3003. <para>The angle (in degrees) referenced between the two bodies used as the constraint for the joint.</para>
  3004. </summary>
  3005. </member>
  3006. <member name="P:UnityEngine.SliderJoint2D.useLimits">
  3007. <summary>
  3008. <para>Should motion limits be used?</para>
  3009. </summary>
  3010. </member>
  3011. <member name="P:UnityEngine.SliderJoint2D.useMotor">
  3012. <summary>
  3013. <para>Should a motor force be applied automatically to the Rigidbody2D?</para>
  3014. </summary>
  3015. </member>
  3016. <member name="M:UnityEngine.SliderJoint2D.GetMotorForce(System.Single)">
  3017. <summary>
  3018. <para>Gets the motor force of the joint given the specified timestep.</para>
  3019. </summary>
  3020. <param name="timeStep">The time to calculate the motor force for.</param>
  3021. </member>
  3022. <member name="T:UnityEngine.SpringJoint2D">
  3023. <summary>
  3024. <para>Joint that attempts to keep two Rigidbody2D objects a set distance apart by applying a force between them.</para>
  3025. </summary>
  3026. </member>
  3027. <member name="P:UnityEngine.SpringJoint2D.autoConfigureDistance">
  3028. <summary>
  3029. <para>Should the distance be calculated automatically?</para>
  3030. </summary>
  3031. </member>
  3032. <member name="P:UnityEngine.SpringJoint2D.dampingRatio">
  3033. <summary>
  3034. <para>The amount by which the spring force is reduced in proportion to the movement speed.</para>
  3035. </summary>
  3036. </member>
  3037. <member name="P:UnityEngine.SpringJoint2D.distance">
  3038. <summary>
  3039. <para>The distance the spring will try to keep between the two objects.</para>
  3040. </summary>
  3041. </member>
  3042. <member name="P:UnityEngine.SpringJoint2D.frequency">
  3043. <summary>
  3044. <para>The frequency at which the spring oscillates around the distance distance between the objects.</para>
  3045. </summary>
  3046. </member>
  3047. <member name="T:UnityEngine.SurfaceEffector2D">
  3048. <summary>
  3049. <para>Applies tangent forces along the surfaces of colliders.</para>
  3050. </summary>
  3051. </member>
  3052. <member name="P:UnityEngine.SurfaceEffector2D.forceScale">
  3053. <summary>
  3054. <para>The scale of the impulse force applied while attempting to reach the surface speed.</para>
  3055. </summary>
  3056. </member>
  3057. <member name="P:UnityEngine.SurfaceEffector2D.speed">
  3058. <summary>
  3059. <para>The speed to be maintained along the surface.</para>
  3060. </summary>
  3061. </member>
  3062. <member name="P:UnityEngine.SurfaceEffector2D.speedVariation">
  3063. <summary>
  3064. <para>The speed variation (from zero to the variation) added to base speed to be applied.</para>
  3065. </summary>
  3066. </member>
  3067. <member name="P:UnityEngine.SurfaceEffector2D.useBounce">
  3068. <summary>
  3069. <para>Should bounce be used for any contact with the surface?</para>
  3070. </summary>
  3071. </member>
  3072. <member name="P:UnityEngine.SurfaceEffector2D.useContactForce">
  3073. <summary>
  3074. <para>Should the impulse force but applied to the contact point?</para>
  3075. </summary>
  3076. </member>
  3077. <member name="P:UnityEngine.SurfaceEffector2D.useFriction">
  3078. <summary>
  3079. <para>Should friction be used for any contact with the surface?</para>
  3080. </summary>
  3081. </member>
  3082. <member name="T:UnityEngine.TargetJoint2D">
  3083. <summary>
  3084. <para>The joint attempts to move a Rigidbody2D to a specific target position.</para>
  3085. </summary>
  3086. </member>
  3087. <member name="P:UnityEngine.TargetJoint2D.anchor">
  3088. <summary>
  3089. <para>The local-space anchor on the rigid-body the joint is attached to.</para>
  3090. </summary>
  3091. </member>
  3092. <member name="P:UnityEngine.TargetJoint2D.autoConfigureTarget">
  3093. <summary>
  3094. <para>Should the target be calculated automatically?</para>
  3095. </summary>
  3096. </member>
  3097. <member name="P:UnityEngine.TargetJoint2D.dampingRatio">
  3098. <summary>
  3099. <para>The amount by which the target spring force is reduced in proportion to the movement speed.</para>
  3100. </summary>
  3101. </member>
  3102. <member name="P:UnityEngine.TargetJoint2D.frequency">
  3103. <summary>
  3104. <para>The frequency at which the target spring oscillates around the target position.</para>
  3105. </summary>
  3106. </member>
  3107. <member name="P:UnityEngine.TargetJoint2D.maxForce">
  3108. <summary>
  3109. <para>The maximum force that can be generated when trying to maintain the target joint constraint.</para>
  3110. </summary>
  3111. </member>
  3112. <member name="P:UnityEngine.TargetJoint2D.target">
  3113. <summary>
  3114. <para>The world-space position that the joint will attempt to move the body to.</para>
  3115. </summary>
  3116. </member>
  3117. <member name="A:UnityEngine.Physics2DModule">
  3118. <summary>
  3119. <para>The Physics2d module implements 2D physics in Unity.</para>
  3120. </summary>
  3121. </member>
  3122. <member name="T:UnityEngine.WheelJoint2D">
  3123. <summary>
  3124. <para>The wheel joint allows the simulation of wheels by providing a constraining suspension motion with an optional motor.</para>
  3125. </summary>
  3126. </member>
  3127. <member name="P:UnityEngine.WheelJoint2D.jointAngle">
  3128. <summary>
  3129. <para>The current joint angle (in degrees) defined as the relative angle between the two Rigidbody2D that the joint connects to.</para>
  3130. </summary>
  3131. </member>
  3132. <member name="P:UnityEngine.WheelJoint2D.jointLinearSpeed">
  3133. <summary>
  3134. <para>The current joint linear speed in meters/sec.</para>
  3135. </summary>
  3136. </member>
  3137. <member name="P:UnityEngine.WheelJoint2D.jointSpeed">
  3138. <summary>
  3139. <para>The current joint rotational speed in degrees/sec.</para>
  3140. </summary>
  3141. </member>
  3142. <member name="P:UnityEngine.WheelJoint2D.jointTranslation">
  3143. <summary>
  3144. <para>The current joint translation.</para>
  3145. </summary>
  3146. </member>
  3147. <member name="P:UnityEngine.WheelJoint2D.motor">
  3148. <summary>
  3149. <para>Parameters for a motor force that is applied automatically to the Rigibody2D along the line.</para>
  3150. </summary>
  3151. </member>
  3152. <member name="P:UnityEngine.WheelJoint2D.suspension">
  3153. <summary>
  3154. <para>Set the joint suspension configuration.</para>
  3155. </summary>
  3156. </member>
  3157. <member name="P:UnityEngine.WheelJoint2D.useMotor">
  3158. <summary>
  3159. <para>Should a motor force be applied automatically to the Rigidbody2D?</para>
  3160. </summary>
  3161. </member>
  3162. <member name="M:UnityEngine.WheelJoint2D.GetMotorTorque(System.Single)">
  3163. <summary>
  3164. <para>Gets the motor torque of the joint given the specified timestep.</para>
  3165. </summary>
  3166. <param name="timeStep">The time to calculate the motor torque for.</param>
  3167. </member>
  3168. </members>
  3169. </doc>