类 Rigidbody3D

En

Rigidbody3D is a component that creates a rigidbody collider.

Zh

Rigidbody3D 类用于创建刚体碰撞器。

层级 (查看层级一览)

PhysicsColliderComponent
- Rigidbody3D

属性

_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

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

owner

owner: Sprite3D

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

脚本文件的路径。

访问器

angularDamping

get angularDamping(): number
返回 number
En
The angular damping of the rigidbody.

Zh
刚体的角阻力。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:105
set angularDamping(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:109

angularFactor

get angularFactor(): Vector3
返回 Vector3
En
The angular motion scaling factor for each axis of the rigidbody. If the value of any axis is 0, it means that the angular motion is frozen on that axis.

Zh
刚体每个轴的角度运动缩放因子。如果某一轴的值为0表示冻结在该轴的角度运动。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:169
set angularFactor(value: Vector3): void
参数
- value: Vector3
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:173

angularVelocity

get angularVelocity(): Vector3
返回 Vector3
En
The angular velocity of the rigidbody.

Zh
刚体的角速度。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:184
set angularVelocity(value: Vector3): void
参数
- value: Vector3
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:192

awaked

get awaked(): boolean
返回 boolean
En
whether the component has been awakened.

Zh
组件是否已经被唤醒。
继承自 PhysicsColliderComponent.awaked
- 定义于 src/layaAir/laya/components/Component.ts:133

canCollideWith

get canCollideWith(): number
返回 number
En
The collision groups this collider can collide with, based on bitwise operations.

Zh
此碰撞器可以与之碰撞的碰撞组，基于位运算。
继承自 PhysicsColliderComponent.canCollideWith
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:273
set canCollideWith(value: number): void
参数
- value: number
返回 void
继承自 PhysicsColliderComponent.canCollideWith
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:277

collider

get collider(): ICollider
返回 ICollider
En
The collider object.

Zh
碰撞器对象。
继承自 PhysicsColliderComponent.collider
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:96

colliderShape

get colliderShape(): Physics3DColliderShape
返回 Physics3DColliderShape
En
The collider shape of the physics collider.

Zh
物理碰撞器的碰撞形状。
继承自 PhysicsColliderComponent.colliderShape
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:234
set colliderShape(value: Physics3DColliderShape): void
参数
- value: Physics3DColliderShape
返回 void
继承自 PhysicsColliderComponent.colliderShape
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:238

collisionDetectionMode

get collisionDetectionMode(): number
返回 number
En
The collision detection mode of the rigidbody.

Zh
刚体的碰撞检测模式。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:252
set collisionDetectionMode(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:255

collisionGroup

get collisionGroup(): number
返回 number
En
The collision group this collider belongs to.

Zh
此碰撞器所属的碰撞组。
继承自 PhysicsColliderComponent.collisionGroup
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:253
set collisionGroup(value: number): void
参数
- value: number
返回 void
继承自 PhysicsColliderComponent.collisionGroup
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:257

destroyed

get destroyed(): boolean
返回 boolean
En
whether the component has been destroyed.

Zh
组件是否已经被销毁。
继承自 PhysicsColliderComponent.destroyed
- 定义于 src/layaAir/laya/components/Component.ts:141

dynamicFriction

get dynamicFriction(): number
返回 number
En
The dynamic friction of the collider.

Zh
碰撞器的动态摩擦力。
继承自 PhysicsColliderComponent.dynamicFriction
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:155
set dynamicFriction(value: number): void
参数
- value: number
返回 void
继承自 PhysicsColliderComponent.dynamicFriction
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:159

enabled

get enabled(): boolean
返回 boolean
En
whether the component is enabled.

Zh
是否启用组件。
继承自 PhysicsColliderComponent.enabled
- 定义于 src/layaAir/laya/components/Component.ts:117
set enabled(value: boolean): void
参数
- value: boolean
返回 void
继承自 PhysicsColliderComponent.enabled
- 定义于 src/layaAir/laya/components/Component.ts:121

friction

get friction(): number
返回 number
En
The friction of the collider.

Zh
碰撞器的摩擦力。
继承自 PhysicsColliderComponent.friction
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:119
set friction(value: number): void
参数
- value: number
返回 void
继承自 PhysicsColliderComponent.friction
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:123

frictionCombine

get frictionCombine(): PhysicsCombineMode
返回 PhysicsCombineMode
En
Friction combination mode, used to define how the friction coefficients of two objects are combined during a collision to determine the final friction force. The values include:
- Average: The friction coefficients of the two objects are averaged.
- Minimum: The minimum friction coefficient of the two objects is used.
- Maximum: The maximum friction coefficient of the two objects is used.
- Multiply: The friction coefficients of the two objects are multiplied to get the final friction coefficient.
Zh
摩擦力组合模式，用于定义在两个物体发生碰撞时，如何组合它们的摩擦系数，以确定最终的摩擦力。值包括：
- Average（平均值）：两个物体的摩擦系数取平均值。
- Minimum（最小值）：使用两个物体摩擦系数中的最小值。
- Maximum（最大值）：使用两个物体摩擦系数中的最大值。
- Multiply（乘积）：将两个物体的摩擦系数相乘，得到最终的摩擦系数。
继承自 PhysicsColliderComponent.frictionCombine
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:194
set frictionCombine(value: PhysicsCombineMode): void
参数
- value: PhysicsCombineMode
返回 void
继承自 PhysicsColliderComponent.frictionCombine
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:198

gravity

get gravity(): Vector3
返回 Vector3
En
The gravity applied to the rigidbody.

Zh
应用于刚体的重力。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:120
set gravity(value: Vector3): void
参数
- value: Vector3
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:124

hideFlags

get hideFlags(): number
返回 number
En
The hide flags that determine the hiding behavior of the component.

Zh
确定组件隐藏行为的标志。
继承自 PhysicsColliderComponent.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:67
set hideFlags(value: number): void
参数
- value: number
返回 void
继承自 PhysicsColliderComponent.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:71

id

get id(): number
返回 number
En
The unique identifier for the component.

Zh
组件的唯一标识。
继承自 PhysicsColliderComponent.id
- 定义于 src/layaAir/laya/components/Component.ts:109

isKinematic

get isKinematic(): boolean
返回 boolean
En
Determines if the rigidbody is kinematic. If true, the rigidbody can only be moved by transform property, not by other force-related properties.

Zh
确定刚体是否为运动物体。如果为true仅可通过transform属性移动物体,而非其他力相关属性。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:75
set isKinematic(value: boolean): void
参数
- value: boolean
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:79

linearDamping

get linearDamping(): number
返回 number
En
The linear damping of the rigidbody.

Zh
刚体的线阻力。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:90
set linearDamping(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:94

linearFactor

get linearFactor(): Vector3
返回 Vector3
En
The linear motion scaling factor for each axis of the rigidbody. If the value of any axis is 0, it means that the linear motion is frozen on that axis.

Zh
刚体每个轴的线性运动缩放因子。如果某一轴的值为0表示冻结在该轴的线性运动。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:135
set linearFactor(value: Vector3): void
参数
- value: Vector3
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:139

linearVelocity

get linearVelocity(): Vector3
返回 Vector3
En
The linear velocity of the rigidbody.

Zh
刚体的线速度。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:150
set linearVelocity(value: Vector3): void
参数
- value: Vector3
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:158

mass

get mass(): number
返回 number
En
The mass of the rigidbody.

Zh
刚体的质量。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:60
set mass(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:64

orientation

set orientation(q: Quaternion): void
参数
- q: Quaternion
返回 void
En
Directly sets the physical rotation of the rigidbody.

Zh
直接设置刚体的物理旋转。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:228

position

set position(pos: Vector3): void
参数
- pos: Vector3
返回 void
En
Directly sets the physical position of the rigidbody.

Zh
直接设置刚体的物理位置。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:218

restitution

get restitution(): number
返回 number
En
The restitution of the collider (also known as bounciness).

Zh
碰撞器的弹力（也叫Bounciness）。
继承自 PhysicsColliderComponent.restitution
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:104
set restitution(value: number): void
参数
- value: number
返回 void
继承自 PhysicsColliderComponent.restitution
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:108

restitutionCombine

get restitutionCombine(): PhysicsCombineMode
返回 PhysicsCombineMode
En
The restitution mode of the collider. The values include:
- Average: The friction coefficients of the two objects are averaged.
- Minimum: The minimum friction coefficient of the two objects is used.
- Maximum: The maximum friction coefficient of the two objects is used.
- Multiply: The friction coefficients of the two objects are multiplied to get the final friction coefficient.
Zh
弹力组合模式，用于定义在两个物体发生碰撞时，如何组合它们的弹力系数，以确定最终的弹力。值为：
- Average（平均值）：两个物体的摩擦系数取平均值。
- Minimum（最小值）：使用两个物体摩擦系数中的最小值。
- Maximum（最大值）：使用两个物体摩擦系数中的最大值。
- Multiply（乘积）：将两个物体的摩擦系数相乘，得到最终的摩擦系数。
继承自 PhysicsColliderComponent.restitutionCombine
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:219
set restitutionCombine(value: PhysicsCombineMode): void
参数
- value: PhysicsCombineMode
返回 void
继承自 PhysicsColliderComponent.restitutionCombine
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:223

rollingFriction

get rollingFriction(): number
返回 number
En
The rolling friction of the collider.

Zh
碰撞器的滚动摩擦力。
继承自 PhysicsColliderComponent.rollingFriction
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:137
set rollingFriction(value: number): void
参数
- value: number
返回 void
继承自 PhysicsColliderComponent.rollingFriction
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:141

sleepAngularVelocity

get sleepAngularVelocity(): number
返回 number
已被弃用
刚体睡眠的角速度阈值。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:396
set sleepAngularVelocity(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:400

sleepLinearVelocity

get sleepLinearVelocity(): number
返回 number
已被弃用
刚体睡眠的线速度阈值。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:384
set sleepLinearVelocity(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:388

sleepThreshold

get sleepThreshold(): number
返回 number
En
The linear velocity threshold below which the rigidbody will go to sleep.

Zh
刚体进入睡眠状态的线速度阈值。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:203
set sleepThreshold(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:207

staticFriction

get staticFriction(): number
返回 number
En
The static friction of the collider.

Zh
碰撞器的静态摩擦力。
继承自 PhysicsColliderComponent.staticFriction
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:169
set staticFriction(value: number): void
参数
- value: number
返回 void
继承自 PhysicsColliderComponent.staticFriction
- 定义于 src/layaAir/laya/d3/physics/PhysicsColliderComponent.ts:173

trigger

get trigger(): boolean
返回 boolean
En
If the rigidbody is a trigger.

Zh
刚体是否为触发器。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:238
set trigger(value: boolean): void
参数
- value: boolean
返回 void
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:241

方法

applyForce

applyForce(force: Vector3, localOffset?: Vector3): void
参数
- force: Vector3
  The force to apply.
- localOffset: Vector3 = null
  The offset, if it is null, it is the center point.
返回 void
En
Applies a force to the rigidbody.

Zh
应用作用力。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:323

applyForceXYZ

applyForceXYZ(fx: number, fy: number, fz: number, localOffset?: Vector3): void
参数
- fx: number
  x轴方向的力
- fy: number
  y轴方向的力
- fz: number
  z轴方向的力
- localOffset: Vector3 = null
  受力点距离质点的偏移
返回 void
已被弃用
应用作用力
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:412

applyImpulse

applyImpulse(impulse: Vector3, localOffset?: Vector3): void
参数
- impulse: Vector3
  The impulse vector to apply.
- localOffset: Vector3 = null
  The offset at which the impulse is applied, relative to the rigidbody's center of mass. If null, the impulse is applied at the center.
返回 void
En
Applies an impulse to the rigidbody.

Zh
对刚体应用冲量。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:349

applyTorque

applyTorque(torque: Vector3): void
参数
- torque: Vector3
  The torque vector to apply.
返回 void
En
Applies a torque to the rigidbody.

Zh
对刚体应用扭转力。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:335

applyTorqueImpulse

applyTorqueImpulse(torqueImpulse: Vector3): void
参数
- torqueImpulse: Vector3
  The torque impulse vector to apply.
返回 void
En
Applies a torque impulse (rotational impulse) to the rigidbody.

Zh
对刚体应用扭转冲量（旋转冲量）。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:361

destroy

destroy(): void
返回 void
En
Destroy components

Zh
销毁组件
继承自 PhysicsColliderComponent.destroy
- 定义于 src/layaAir/laya/components/Component.ts:289

hasHideFlag

hasHideFlag(flag: number): boolean
参数
- flag: number
  The hide flag to check for.
返回 boolean
En
Checks if the component has a specific hide flag set.

Zh
检查组件是否设置了特定的隐藏标志。
继承自 PhysicsColliderComponent.hasHideFlag
- 定义于 src/layaAir/laya/components/Component.ts:101

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。
继承自 PhysicsColliderComponent.onAdded
- 定义于 src/layaAir/laya/components/Component.ts:329

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
组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。
继承自 PhysicsColliderComponent.onAwake
- 定义于 src/layaAir/laya/components/Component.ts:344

onDestroy

onDestroy(): void
返回 void
En
Executed when the node is destroyed manually.

Zh
手动调用节点销毁时执行。
继承自 PhysicsColliderComponent.onDestroy
- 定义于 src/layaAir/laya/components/Component.ts:395

onDisable

onDisable(): void
返回 void
En
Executed when the component is disabled, such as when the node is removed from the stage.

Zh
组件被禁用时执行，比如从节点从舞台移除后。
继承自 PhysicsColliderComponent.onDisable
- 定义于 src/layaAir/laya/components/Component.ts:388

onEnable

onEnable(): void
返回 void
En
Executed after the component is enabled, such as when the node is added to the stage.

Zh
组件被启用后执行，比如节点被添加到舞台后。
继承自 PhysicsColliderComponent.onEnable
- 定义于 src/layaAir/laya/components/Component.ts:351

`可选`onLateUpdate

onLateUpdate(): void
返回 void
En
Executed every frame during the late update phase, after the update phase.

Zh
每帧更新时执行，在 late update 阶段，update 阶段之后。
继承自 PhysicsColliderComponent.onLateUpdate
- 定义于 src/layaAir/laya/components/Component.ts:370

`可选`onPostRender

onPostRender(): void
返回 void
En
Executed after rendering.

Zh
渲染之后执行。
继承自 PhysicsColliderComponent.onPostRender
- 定义于 src/layaAir/laya/components/Component.ts:382

`可选`onPreRender

onPreRender(): void
返回 void
En
Executed before rendering.

Zh
渲染之前执行。
继承自 PhysicsColliderComponent.onPreRender
- 定义于 src/layaAir/laya/components/Component.ts:376

`可选`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
将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。如果没有重置，则不会进行回收复用。
继承自 PhysicsColliderComponent.onReset
- 定义于 src/layaAir/laya/components/Component.ts:338

`可选`onStart

onStart(): void
返回 void
En
Executed once, before the first update.

Zh
在第一次执行 update 之前执行，只会执行一次。
继承自 PhysicsColliderComponent.onStart
- 定义于 src/layaAir/laya/components/Component.ts:358

`可选`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 方法。
继承自 PhysicsColliderComponent.onUpdate
- 定义于 src/layaAir/laya/components/Component.ts:364

wakeUp

wakeUp(): void
返回 void
En
Wakes up the rigidbody.

Zh
唤醒刚体。
- 定义于 src/layaAir/laya/d3/physics/Rigidbody3D.ts:371

类 Rigidbody3D

En

Zh

层级 (查看层级一览)

索引

属性

访问器

方法

属性

_extra

En

Zh

_id

En

Zh

_singleton

En

Zh

owner

En

Zh

runInEditor

En

Zh

scriptPath

En

Zh

访问器

angularDamping

返回 number

En

Zh

参数

返回 void

angularFactor

返回 Vector3

En

Zh

参数

返回 void

angularVelocity

返回 Vector3

En

Zh

参数

返回 void

awaked

返回 boolean

En

Zh

canCollideWith

返回 number

En

Zh

参数

返回 void

collider

返回 ICollider

En

Zh

colliderShape

返回 Physics3DColliderShape

En

Zh

参数

返回 void

collisionDetectionMode

返回 number

En

Zh

参数

返回 void

collisionGroup

返回 number

En

Zh

参数

返回 void

destroyed

返回 boolean