类 CharacterController

En

CharacterController class is used to create a character controller.

Zh

CharacterController 类用于创建角色控制器。

层级 (查看层级一览)

PhysicsColliderComponent
- CharacterController

属性

_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

脚本文件的路径。

访问器

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

centerOffset

get centerOffset(): Vector3
返回 Vector3
En
The center offset of the capsule.

Zh
胶囊的本地偏移
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:135
set centerOffset(value: Vector3): void
参数
- value: Vector3
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:139

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

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
gravity.

Zh
重力。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:152
set gravity(value: Vector3): void
参数
- value: Vector3
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:156

height

get height(): number
返回 number
En
The capsule height.

Zh
胶囊高度。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:104
set height(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:108

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

jumpSpeed

get jumpSpeed(): number
返回 number
En
The jump speed.

Zh
起跳速度。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:265
set jumpSpeed(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:268

maxSlope

get maxSlope(): number
返回 number
En
The maximum slope angle that the character can climb. If the slope angle exceeds the set value, the character will be unable to continue moving upward and may start sliding down or stop at the bottom of the slope.

Zh
角色行走的最大坡度。如果坡度角度超过设定的值，角色将无法继续向上移动，可能会开始滑落或停在斜坡下方。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:188
set maxSlope(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:192

minDistance

get minDistance(): number
返回 number
En
The minimum distance

Zh
最小距离。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:120
set minDistance(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:124

position

get position(): Vector3
返回 Vector3
En
The character's position.

Zh
角色位置
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:233
set position(v: Vector3): void
参数
- v: Vector3
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:241

pushForce

get pushForce(): number
返回 number
En
The magnitude of the push force.

Zh
推动力的大小。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:251
set pushForce(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:254

radius

get radius(): number
返回 number
En
The capsule radius.

Zh
胶囊半径。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:88
set radius(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:92

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

skinWidth

get skinWidth(): number
返回 number
En
The skin width of the CharacterController.
- This property is only effective in the PhysX engine.
- It defines the distance between the collider surface and where collision detection actually occurs. This helps in triggering collision detection and response earlier, improving the stability and reliability of the object's physical simulation.
Zh
碰撞器外表的宽度;
- 该属性仅在 PhysX 引擎中有效。
- 用于定义碰撞器表面与实际发生碰撞检测的距离，用于提前触发碰撞检测和响应，从而提高物体在物理模拟中的稳定性和可靠性。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:171
set skinWidth(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:175

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

stepHeight

get stepHeight(): number
返回 number
En
The height of the character's step. It represents the maximum height that the character can step over.

Zh
角色行走的脚步高度，表示可跨越的最大高度。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:203
set stepHeight(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:207

upAxis

get upAxis(): Vector3
返回 Vector3
En
The up axis of the character.

Zh
角色的Up轴。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:218
set upAxis(value: Vector3): void
参数
- value: Vector3
返回 void
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:222

方法

destroy

destroy(): void
返回 void
En
Destroy components

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

getVerticalVel

getVerticalVel(): number
返回 number
En
Gets the velocity.

Zh
获取速度。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:286

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

jump

jump(velocity?: Vector3): void
参数
- velocity: Vector3 = null
  The jump velocity.
返回 void
En
Jumps.

Zh
跳跃。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:308

move

move(movement: Vector3): void
参数
- movement: Vector3
  The movement vector.
返回 void
En
Moves the character by the specified movement vector.

Zh
通过指定移动向量移动角色。
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:296

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
The frame loop.

Zh
帧循环
重写了 PhysicsColliderComponent.onUpdate
- 定义于 src/layaAir/laya/d3/physics/CharacterController.ts:76

类 CharacterController

En

Zh

层级 (查看层级一览)

索引

属性

访问器

方法

属性

_extra

En

Zh

_id

En

Zh

_singleton

En

Zh

owner

En

Zh

runInEditor

En

Zh

scriptPath

En

Zh

访问器

awaked

返回 boolean

En

Zh

canCollideWith

返回 number

En

Zh

参数

返回 void

centerOffset

返回 Vector3

En

Zh

参数

返回 void

collider

返回 ICollider

En

Zh

colliderShape

返回 Physics3DColliderShape

En

Zh

参数

返回 void

collisionGroup

返回 number

En

Zh

参数

返回 void

destroyed

返回 boolean

En

Zh

dynamicFriction

返回 number

En

Zh

参数

返回 void

enabled

返回 boolean

En

Zh

参数

返回 void

friction

返回 number

En

Zh