PhysicsBody3D
继承： CollisionObject3D < Node3D < Node < Object
派生： CharacterBody3D, PhysicalBone3D, RigidBody3D, StaticBody3D
Abstract base class for 3D game objects affected by physics.
描述
PhysicsBody3D is an abstract base class for 3D game objects affected by physics. All 3D physics bodies inherit from it.
Warning: With a non-uniform scale, this node will likely not behave as expected. It is advised to keep its scale the same on all axes and adjust its collision shape(s) instead.
属性
bool | axis_lock_angular_x |
bool | axis_lock_angular_y |
bool | axis_lock_angular_z |
bool | axis_lock_linear_x |
bool | axis_lock_linear_y |
bool | axis_lock_linear_z |
方法
void | add_collision_exception_with ( body: Node ) |
bool | get_axis_lock ( axis: BodyAxis ) const1 |
Array PhysicsBody3D | get_collision_exceptions ( ) |
Vector3 | get_gravity ( ) const1 |
KinematicCollision3D | move_and_collide ( motion: Vector3, test_only: bool = false, safe_margin: float = 0.001, recovery_as_collision: bool = false, max_collisions: int = 1 ) |
void | remove_collision_exception_with ( body: Node ) |
void | set_axis_lock ( axis: BodyAxis, lock: bool ) |
bool | test_move ( from: Transform3D, motion: Vector3, collision: KinematicCollision3D = null, safe_margin: float = 0.001, recovery_as_collision: bool = false, max_collisions: int = 1 ) |
属性说明
bool axis_lock_angular_x = false
Lock the body's rotation in the X axis.
bool axis_lock_angular_y = false
Lock the body's rotation in the Y axis.
bool axis_lock_angular_z = false
Lock the body's rotation in the Z axis.
bool axis_lock_linear_x = false
Lock the body's linear movement in the X axis.
bool axis_lock_linear_y = false
Lock the body's linear movement in the Y axis.
bool axis_lock_linear_z = false
Lock the body's linear movement in the Z axis.
方法说明
void add_collision_exception_with ( body: Node )
Adds a body to the list of bodies that this body can't collide with.
bool get_axis_lock ( axis: BodyAxis ) const1
Returns true if the specified linear or rotational axis is locked.
Array PhysicsBody3D get_collision_exceptions ( )
Returns an array of nodes that were added as collision exceptions for this body.
Vector3 get_gravity ( ) const1
Returns the gravity vector computed from all sources that can affect the body, including all gravity overrides from Area3D nodes and the global world gravity.
KinematicCollision3D move_and_collide ( motion: Vector3, test_only: bool = false, safe_margin: float = 0.001, recovery_as_collision: bool = false, max_collisions: int = 1 )
Moves the body along the vector motion. In order to be frame rate independent in Node._physics_process or Node._process, motion should be computed using delta.
The body will stop if it collides. Returns a KinematicCollision3D, which contains information about the collision when stopped, or when touching another body along the motion.
If test_only is true, the body does not move but the would-be collision information is given.
safe_margin is the extra margin used for collision recovery (see CharacterBody3D.safe_margin for more details).
If recovery_as_collision is true, any depenetration from the recovery phase is also reported as a collision; this is used e.g. by CharacterBody3D for improving floor detection during floor snapping.
max_collisions allows to retrieve more than one collision result.
void remove_collision_exception_with ( body: Node )
Removes a body from the list of bodies that this body can't collide with.
void set_axis_lock ( axis: BodyAxis, lock: bool )
Locks or unlocks the specified linear or rotational axis depending on the value of lock.
bool test_move ( from: Transform3D, motion: Vector3, collision: KinematicCollision3D = null, safe_margin: float = 0.001, recovery_as_collision: bool = false, max_collisions: int = 1 )
Checks for collisions without moving the body. In order to be frame rate independent in Node._physics_process or Node._process, motion should be computed using delta.
Virtually sets the node's position, scale and rotation to that of the given Transform3D, then tries to move the body along the vector motion. Returns true if a collision would stop the body from moving along the whole path.
collision is an optional object of type KinematicCollision3D, which contains additional information about the collision when stopped, or when touching another body along the motion.
safe_margin is the extra margin used for collision recovery (see CharacterBody3D.safe_margin for more details).
If recovery_as_collision is true, any depenetration from the recovery phase is also reported as a collision; this is useful for checking whether the body would touch any other bodies.
max_collisions allows to retrieve more than one collision result.
本方法通常需要用户覆盖才能生效。
本方法无副作用，不会修改该实例的任何成员变量。
本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。
本方法用于构造某个类型。
调用本方法无需实例，可直接使用类名进行调用。
本方法描述的是使用本类型作为左操作数的有效运算符。
这个值是由下列位标志构成位掩码的整数。
无返回值。