UnityEngine.VehiclesModule.xml 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.VehiclesModule</name>
  6. </assembly>
  7. <member name="A:UnityEngine.VehiclesModule">
  8. <summary>
  9. <para>The Vehicles module implements vehicle physics simulation through the WheelCollider component.</para>
  10. </summary>
  11. </member>
  12. <member name="T:UnityEngine.WheelCollider">
  13. <summary>
  14. <para>A special collider for vehicle wheels.</para>
  15. </summary>
  16. </member>
  17. <member name="P:UnityEngine.WheelCollider.brakeTorque">
  18. <summary>
  19. <para>Brake torque expressed in Newton metres.</para>
  20. </summary>
  21. </member>
  22. <member name="P:UnityEngine.WheelCollider.center">
  23. <summary>
  24. <para>The center of the wheel, measured in the object's local space.</para>
  25. </summary>
  26. </member>
  27. <member name="P:UnityEngine.WheelCollider.forceAppPointDistance">
  28. <summary>
  29. <para>Application point of the suspension and tire forces measured from the base of the resting wheel.</para>
  30. </summary>
  31. </member>
  32. <member name="P:UnityEngine.WheelCollider.forwardFriction">
  33. <summary>
  34. <para>Properties of tire friction in the direction the wheel is pointing in.</para>
  35. </summary>
  36. </member>
  37. <member name="P:UnityEngine.WheelCollider.isGrounded">
  38. <summary>
  39. <para>Indicates whether the wheel currently collides with something (Read Only).</para>
  40. </summary>
  41. </member>
  42. <member name="P:UnityEngine.WheelCollider.mass">
  43. <summary>
  44. <para>The mass of the wheel, expressed in kilograms. Must be larger than zero. Typical values would be in range (20,80).</para>
  45. </summary>
  46. </member>
  47. <member name="P:UnityEngine.WheelCollider.motorTorque">
  48. <summary>
  49. <para>Motor torque on the wheel axle expressed in Newton metres. Positive or negative depending on direction.</para>
  50. </summary>
  51. </member>
  52. <member name="P:UnityEngine.WheelCollider.radius">
  53. <summary>
  54. <para>The radius of the wheel, measured in local space.</para>
  55. </summary>
  56. </member>
  57. <member name="P:UnityEngine.WheelCollider.rpm">
  58. <summary>
  59. <para>Current wheel axle rotation speed, in rotations per minute (Read Only).</para>
  60. </summary>
  61. </member>
  62. <member name="P:UnityEngine.WheelCollider.sidewaysFriction">
  63. <summary>
  64. <para>Properties of tire friction in the sideways direction.</para>
  65. </summary>
  66. </member>
  67. <member name="P:UnityEngine.WheelCollider.sprungMass">
  68. <summary>
  69. <para>The mass supported by this WheelCollider.</para>
  70. </summary>
  71. </member>
  72. <member name="P:UnityEngine.WheelCollider.steerAngle">
  73. <summary>
  74. <para>Steering angle in degrees, always around the local y-axis.</para>
  75. </summary>
  76. </member>
  77. <member name="P:UnityEngine.WheelCollider.suspensionDistance">
  78. <summary>
  79. <para>Maximum extension distance of wheel suspension, measured in local space.</para>
  80. </summary>
  81. </member>
  82. <member name="P:UnityEngine.WheelCollider.suspensionExpansionLimited">
  83. <summary>
  84. <para>Limits the expansion velocity of the Wheel Collider's suspension. If you set this property on a Rigidbody that has several Wheel Colliders, such as a vehicle, then it affects all other Wheel Colliders on the Rigidbody.</para>
  85. </summary>
  86. <param name="active">Turns on/off the property</param>
  87. </member>
  88. <member name="P:UnityEngine.WheelCollider.suspensionSpring">
  89. <summary>
  90. <para>The parameters of wheel's suspension. The suspension attempts to reach a target position by applying a linear force and a damping force.</para>
  91. </summary>
  92. </member>
  93. <member name="P:UnityEngine.WheelCollider.wheelDampingRate">
  94. <summary>
  95. <para>The damping rate of the wheel. Must be larger than zero.</para>
  96. </summary>
  97. </member>
  98. <member name="M:UnityEngine.WheelCollider.ConfigureVehicleSubsteps(System.Single,System.Int32,System.Int32)">
  99. <summary>
  100. <para>Configure vehicle sub-stepping parameters.</para>
  101. </summary>
  102. <param name="speedThreshold">The speed threshold of the sub-stepping algorithm.</param>
  103. <param name="stepsBelowThreshold">Amount of simulation sub-steps when vehicle's speed is below speedThreshold.</param>
  104. <param name="stepsAboveThreshold">Amount of simulation sub-steps when vehicle's speed is above speedThreshold.</param>
  105. </member>
  106. <member name="M:UnityEngine.WheelCollider.GetGroundHit(UnityEngine.WheelHit&amp;)">
  107. <summary>
  108. <para>Gets ground collision data for the wheel.</para>
  109. </summary>
  110. <param name="hit"></param>
  111. </member>
  112. <member name="M:UnityEngine.WheelCollider.GetWorldPose(UnityEngine.Vector3&amp;,UnityEngine.Quaternion&amp;)">
  113. <summary>
  114. <para>Gets the world space pose of the wheel accounting for ground contact, suspension limits, steer angle, and rotation angle (angles in degrees).</para>
  115. </summary>
  116. <param name="pos">Position of the wheel in world space.</param>
  117. <param name="quat">Rotation of the wheel in world space.</param>
  118. </member>
  119. <member name="M:UnityEngine.WheelCollider.ResetSprungMasses">
  120. <summary>
  121. <para>Reset the sprung masses of the vehicle.</para>
  122. </summary>
  123. </member>
  124. <member name="T:UnityEngine.WheelHit">
  125. <summary>
  126. <para>Contact information for the wheel, reported by WheelCollider.</para>
  127. </summary>
  128. </member>
  129. <member name="P:UnityEngine.WheelHit.collider">
  130. <summary>
  131. <para>The other Collider the wheel is hitting.</para>
  132. </summary>
  133. </member>
  134. <member name="P:UnityEngine.WheelHit.force">
  135. <summary>
  136. <para>The magnitude of the force being applied for the contact.</para>
  137. </summary>
  138. </member>
  139. <member name="P:UnityEngine.WheelHit.forwardDir">
  140. <summary>
  141. <para>The direction the wheel is pointing in.</para>
  142. </summary>
  143. </member>
  144. <member name="P:UnityEngine.WheelHit.forwardSlip">
  145. <summary>
  146. <para>Tire slip in the rolling direction. Acceleration slip is negative, braking slip is positive.</para>
  147. </summary>
  148. </member>
  149. <member name="P:UnityEngine.WheelHit.normal">
  150. <summary>
  151. <para>The normal at the point of contact.</para>
  152. </summary>
  153. </member>
  154. <member name="P:UnityEngine.WheelHit.point">
  155. <summary>
  156. <para>The point of contact between the wheel and the ground.</para>
  157. </summary>
  158. </member>
  159. <member name="P:UnityEngine.WheelHit.sidewaysDir">
  160. <summary>
  161. <para>The sideways direction of the wheel.</para>
  162. </summary>
  163. </member>
  164. <member name="P:UnityEngine.WheelHit.sidewaysSlip">
  165. <summary>
  166. <para>Tire slip in the sideways direction.</para>
  167. </summary>
  168. </member>
  169. </members>
  170. </doc>