类 RigidBody

En

2D rigidbody, display objects are bound to the physics world through RigidBody to keep the positions of physics and display objects synchronized. Changes in the position of the physics world will be automatically synchronized to the display object, and the displacement and rotation of the display object itself (displacement of the parent object is invalid) will also be automatically synchronized to the physics world. If you want to move the physics world as a whole, you can set Physics2D.I.worldRoot = scene, and then move the scene. You can enable the display of physics auxiliary lines by enabling "Project Settings" - "2D Physics" - "Enable 2D Physics Drawing" in the IDE, or through the code Physics2D.I.enableDebugDraw = true.

Zh

2D刚体，显示对象通过RigidBody和物理世界进行绑定，保持物理和显示对象之间的位置同步。 物理世界的位置变化会自动同步到显示对象，显示对象本身的位移，旋转（父对象位移无效）也会自动同步到物理世界。 如果想整体位移物理世界，可以设置 Physics2D.I.worldRoot = 场景，然后移动场景即可。 可以通过IDE-"项目设置"-"2D物理"-"是否开启2D物理绘制" 开启物理辅助线显示，或者通过代码 Physics2D.I.enableDebugDraw = true。

层级 (查看层级一览)

构造函数

constructor

属性

_extra _id _singleton category group label mask owner runInEditor scriptPath

访问器

allowRotation allowSleep angularDamping angularVelocity awaked body bullet destroyed enabled gravityScale hideFlags id linearDamping linearVelocity position rotation type

方法

applyForce applyForceToCenter applyLinearImpulse applyLinearImpulseToCenter applyTorque destroy getBody getCenter getLocalPoint getMass getWorldCenter getWorldPoint hasHideFlag onAdded onAwake onDestroy onDisable onEnable onLateUpdate? onPostRender? onPreRender? onReset? onStart? onUpdate? setAngle setVelocity

构造函数

constructor

属性

_extra

_extra: IComponentExtra

En

Extra data of the node.

Zh

组件的额外数据。IDE内部使用。

_id

_id: number

En

Unique identifier for the component.

Zh

组件的唯一标识。

_singleton

_singleton: boolean

En

Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.

Zh

是否为单例，即同一个节点只能添加此类型的脚本一次。

category

category: number = 1

En

[Read-only] Collision category, specified using powers of 2, with 32 different collision categories available.

Zh

[只读] 碰撞类别，使用2的幂次方值指定，有32种不同的碰撞类别可用。

group

group: number = 0

En

[Read-only] Specifies the collision group to which the body belongs, default is 0, the collision rules are as follows:

  1. If the group values of two objects are equal:
    • If the group value is greater than zero, they will always collide.
    • If the group value is less than zero, they will never collide.
    • If the group value is equal to 0, then rule 3 is used.
  2. If the group values are not equal, then rule 3 is used.
  3. Each rigidbody has a category, this property receives a bit field, the range is the power of 2 in the range of [1,2^31]. Each rigidbody also has a mask category, which specifies the sum of the category values it collides with (the value is the result of bitwise AND of all categories).

Zh

[只读] 指定了该主体所属的碰撞组，默认为0，碰撞规则如下：

  1. 如果两个对象 group 相等：
    • group 值大于零，它们将始终发生碰撞。
    • group 值小于零，它们将永远不会发生碰撞。
    • group 值等于0，则使用规则3。
  2. 如果 group 值不相等，则使用规则3。
  3. 每个刚体都有一个 category 类别，此属性接收位字段，范围为 [1,2^31] 范围内的2的幂。 每个刚体也都有一个 mask 类别，指定与其碰撞的类别值之和（值是所有 category 按位 AND 的值）。

label

label: string = "RigidBody"

En

[Read-only] Custom label.

Zh

[只读] 自定义标签。

mask

mask: number = -1

En

[Read-only] Specifies the category of collision bit mask, the result of category bitwise operation. Each rigidbody also has a mask category, which specifies the sum of the category values it collides with (the value is the result of bitwise AND of all categories).

Zh

[只读] 指定冲突位掩码碰撞的类别，category 位操作的结果。 每个刚体也都有一个 mask 类别，指定与其碰撞的类别值之和（值是所有 category 按位 AND 的值）。

owner

owner: Sprite

En

Gets the owner Node to which the component belongs.

Zh

获取组件所属的 Node 节点。

runInEditor

runInEditor: boolean

En

Whether the script can run in the IDE environment.

Zh

是否可以在 IDE 环境中运行。

scriptPath

scriptPath: string

En

The path of the script file.

Zh

脚本文件的路径。

访问器

allowRotation

  • get allowRotation(): boolean

    返回 boolean

    En

    Allowing rotation means that when a force or impact is applied to the rigid body, it will naturally rotate according to physical rules. If you do not want the rigid body to rotate, set this to false.

    Zh

    允许旋转是指当力或者冲击作用于该刚体时，它会按照物理规则进行自然旋转，如果不希望刚体旋转，请设置为 false。

  • set allowRotation(value: boolean): void

    参数

    • value: boolean

    返回 void

allowSleep

  • get allowSleep(): boolean

    返回 boolean

    En

    Whether to allow sleeping. Allowing sleeping can improve performance but may result in the inability to respond immediately.

    Zh

    是否允许休眠，允许休眠能提高性能，但会导致无法即时响应。

  • set allowSleep(value: boolean): void

    参数

    • value: boolean

    返回 void

angularDamping

  • get angularDamping(): number

    返回 number

    En

    The angular damping coefficient. It can range from 0 to infinity, where 0 means no damping and infinity means full damping. Normally, the damping value should be between 0 and 0.1.

    Zh

    旋转速度阻尼系数，范围可以在 0 到无穷大之间，0 表示没有阻尼，无穷大表示满阻尼，通常阻尼的值应该在 0 到 0.1 之间。

  • set angularDamping(value: number): void

    参数

    • value: number

    返回 void

angularVelocity

awaked

body

bullet

destroyed

enabled

gravityScale

hideFlags

id

linearDamping

  • get linearDamping(): number

    返回 number

    En

    The linear damping coefficient. It can range from 0 to infinity, where 0 means no damping and infinity means full damping. Normally, the damping value should be between 0 and 0.1.

    Zh

    线性速度阻尼系数，范围可以在 0 到无穷大之间，0 表示没有阻尼，无穷大表示满阻尼，通常阻尼的值应该在 0 到 0.1 之间。

  • set linearDamping(value: number): void

    参数

    • value: number

    返回 void

linearVelocity

position

rotation

type

  • get type(): RigidBody2DType

    返回 RigidBody2DType

    En

    The type of the rigid body. Supports three types: static, dynamic, and kinematic.

    • static: Static type, stays still, not affected by gravity, has infinite mass, can be controlled by moving, rotating, and scaling the node.
    • dynamic: Dynamic type, affected by gravity.
    • kinematic: Kinematic type, not affected by gravity, can be moved by applying velocity or force.

    Zh

    刚体类型，支持三种类型：static、dynamic 和 kinematic。

    • static：静态类型，静止不动，不受重力影响，质量无限大，可以通过节点移动、旋转、缩放进行控制。
    • dynamic：动态类型，受重力影响。
    • kinematic：运动类型，不受重力影响，可以通过施加速度或者力的方式使其运动。
  • set type(value: RigidBody2DType): void

    参数

    • value: RigidBody2DType

    返回 void

方法

applyForce

  • applyForce(position: IV2, force: IV2): void

    参数

    • position: IV2

      The point where the force is applied, such as {x: 100, y: 100}, in global coordinates.

    • force: IV2

      The force to be applied, such as {x: 0.1, y: 0.1}.

    返回 void

    En

    Apply force to the rigid body.

    Zh

    对刚体施加力。

applyForceToCenter

  • applyForceToCenter(force: IV2): void

    参数

    • force: IV2

      The force to be applied, such as {x: 0.1, y: 0.1}.

    返回 void

    En

    Apply force to the center of the rigid body to prevent object rotation.

    Zh

    从中心点对刚体施加力，防止对象旋转。

applyLinearImpulse

  • applyLinearImpulse(position: IV2, impulse: IV2): void

    参数

    • position: IV2

      The point where the impulse is applied, such as {x: 100, y: 100}, in global coordinates.

    • impulse: IV2

      The velocity impulse to be applied, such as {x: 0.1, y: 0.1}.

    返回 void

    En

    Apply linear impulse. The added velocity impulse will be combined with the rigid body's original velocity to produce a new velocity.

    Zh

    施加速度冲量，添加的速度冲量会与刚体原有的速度叠加，产生新的速度。

applyLinearImpulseToCenter

  • applyLinearImpulseToCenter(impulse: IV2): void

    参数

    • impulse: IV2

      The velocity impulse to be applied, such as {x: 0.1, y: 0.1}.

    返回 void

    En

    Apply linear impulse to the center. The added velocity impulse will be combined with the rigid body's original velocity to produce a new velocity.

    Zh

    施加速度冲量，添加的速度冲量会与刚体原有的速度叠加，产生新的速度。

applyTorque

  • applyTorque(torque: number): void

    参数

    • torque: number

      The torque to be applied.

    返回 void

    En

    Apply torque to the rigid body to make it rotate.

    Zh

    对刚体施加扭矩，使其旋转。

destroy

getBody

getCenter

getLocalPoint

  • getLocalPoint(x: number, y: number): Readonly<Point>

    参数

    • x: number

      The x-coordinate in pixels.

    • y: number

      The y-coordinate in pixels.

    返回 Readonly<Point>

    En

    Get the local coordinates relative to the body.

    Zh

    获得相对于 body 的本地坐标。

getMass

getWorldCenter

  • getWorldCenter(): IV2

    返回 IV2

    En

    Get the world coordinates of the center of mass, relative to the Physics2D.I.worldRoot node.

    Zh

    获得质心的世界坐标，相对于 Physics2D.I.worldRoot 节点。

getWorldPoint

  • getWorldPoint(x: number, y: number): Readonly<Point>

    参数

    • x: number

      The x-coordinate in pixels.

    • y: number

      The y-coordinate in pixels.

    返回 Readonly<Point>

    En

    Get the world coordinates relative to the body.

    Zh

    获得相对于 body 的世界坐标。

hasHideFlag

onAdded

  • onAdded(): void

    返回 void

    En

    Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.

    Zh

    组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。

onAwake

  • onAwake(): void

    返回 void

    En

    Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.

    Zh

    组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。

onDestroy

onDisable

onEnable

可选onLateUpdate

可选onPostRender

可选onPreRender

可选onReset

  • onReset(): void

    返回 void

    En

    Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use. If not reset, it will not be recycled for reuse.

    Zh

    将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。 如果没有重置，则不会进行回收复用。

可选onStart

可选onUpdate

  • onUpdate(): void

    返回 void

    En

    Executed every frame during the update phase. Avoid writing complex loop logic or using the getComponent method here.

    Zh

    每帧更新时执行，在 update 阶段。尽量不要在这里写大循环逻辑或使用 getComponent 方法。

setAngle

setVelocity

显示设置

成员可见性

目录

构造函数
属性
访问器
方法