Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RigidBody

刚体组件。

Hierarchy

Index

Constructors

constructor

Properties

Private __prefab

__prefab: CompPrefabInfo | null = null

Private _allowSleep

_allowSleep: boolean = true

Private _angularDamping

_angularDamping: number = 0.1

Private _angularFactor

_angularFactor: Vec3 = new Vec3(1, 1, 1)

Private _body

_body: IRigidBody | null = null

Private _enabled

_enabled: boolean = true

Private _group

_group: number = PhysicsSystem.PhysicsGroup.DEFAULT

Private _id

_id: string = idGenerator.getNewId()

For internal usage.

Private _linearDamping

_linearDamping: number = 0.1

Private _linearFactor

_linearFactor: Vec3 = new Vec3(1, 1, 1)

Private _mass

_mass: number = 1

Protected _name

_name: string

_objFlags

_objFlags: number

Private sceneGetter

sceneGetter: null | (() => RenderScene) = null

Private _type

_type: ERigidBodyType = ERigidBodyType.DYNAMIC

Private _useGravity

_useGravity: boolean = true

node

node: Node = NullNode

该组件被附加到的节点。组件总会附加到一个节点。

example
import { log } from 'cc';
log(comp.node);

Static Readonly Type

Type: EnumAlias<typeof ERigidBodyType> = ERigidBodyType

刚体类型的枚举。

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null

Protected assertOnLoadCalled

  • get assertOnLoadCalled(): boolean

isOnLoadCalled

  • get isOnLoadCalled(): number

allowSleep

  • get allowSleep(): boolean
  • set allowSleep(v: boolean): void

angularDamping

  • get angularDamping(): number
  • set angularDamping(value: number): void

angularFactor

  • get angularFactor(): Vec3
  • set angularFactor(value: Vec3): void

body

  • get body(): null | IRigidBody

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

enabledInHierarchy

  • get enabledInHierarchy(): boolean

group

  • get group(): number
  • set group(v: number): void

isAwake

  • get isAwake(): boolean

isDynamic

  • get isDynamic(): boolean
  • set isDynamic(v: boolean): void

isKinematic

  • get isKinematic(): boolean
  • set isKinematic(v: boolean): void

isSleeping

  • get isSleeping(): boolean

isSleepy

  • get isSleepy(): boolean

isStatic

  • get isStatic(): boolean
  • set isStatic(v: boolean): void

isValid

  • get isValid(): boolean
  • 表示该对象是否可用(被 destroy 后将不可用)。
    当一个对象的 destroy 调用以后,会在这一帧结束后才真正销毁。
    因此从下一帧开始 isValid 就会返回 false,而当前帧内 isValid 仍然会是 true。
    如果希望判断当前帧是否调用过 destroy,请使用 isValid(obj, true),不过这往往是特殊的业务需求引起的,通常情况下不需要这样。

    default

    true

    readonly
    example
    import { Node, log } from 'cc';
    const node = new Node();
    log(node.isValid);    // true
    node.destroy();
    log(node.isValid);    // true, still valid in this frame
    // after a frame...
    log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

linearDamping

  • get linearDamping(): number
  • set linearDamping(value: number): void

linearFactor

  • get linearFactor(): Vec3
  • set linearFactor(value: Vec3): void

mass

  • get mass(): number
  • set mass(value: number): void

name

  • get name(): string
  • set name(value: string): void

sleepThreshold

  • get sleepThreshold(): number
  • set sleepThreshold(v: number): void

type

useGravity

  • get useGravity(): boolean
  • set useGravity(value: boolean): void

uuid

  • get uuid(): string

Methods

Optional Private preload

  • __preload(): void
  • __preload 在每次onLoad之前调用。
    它用于在内部初始化内置组件,
    以避免在每次公有方法调用之前检查是否调用了onLoad。
    如果支持脚本优先级,则应删除此方法。

    Returns void

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void
  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Optional Private getLocalBounds

  • getLocalBounds(out_rect: Rect): void
  • 如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。

    Parameters

    • out_rect: Rect

      The rect to store the result bounding rect

    Returns void

Private getRenderScene

  • _getRenderScene(): RenderScene

instantiate

  • instantiate(cloned: any): any

onPreDestroy

  • _onPreDestroy(): void

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null

addGroup

  • addGroup(v: number): void

addMask

  • addMask(v: number): void

applyForce

  • applyForce(force: Vec3, relativePoint?: Vec3): void

applyImpulse

  • applyImpulse(impulse: Vec3, relativePoint?: Vec3): void

applyLocalForce

  • applyLocalForce(force: Vec3, localPoint?: Vec3): void

applyLocalImpulse

  • applyLocalImpulse(impulse: Vec3, localPoint?: Vec3): void

applyLocalTorque

  • applyLocalTorque(torque: Vec3): void

applyTorque

  • applyTorque(torque: Vec3): void

clearForces

  • clearForces(): void

clearState

  • clearState(): void

clearVelocity

  • clearVelocity(): void

destroy

  • destroy(): boolean

getAngularVelocity

  • getAngularVelocity(out: Vec3): void

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null
  • 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Type parameters

    Parameters

    • classConstructor: Constructor<T>

      The class of component to be retrieved or to be created

    Returns T | null

  • 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Parameters

    • className: string

      A string for the class name of the component

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]

getGroup

  • getGroup(): number

getLinearVelocity

  • getLinearVelocity(out: Vec3): void

getMask

  • getMask(): number

Protected Optional lateUpdate

  • lateUpdate(dt: number): void
  • 如果该组件启用,则每帧调用 LateUpdate。
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

Protected onDestroy

  • onDestroy(): void

Protected onDisable

  • onDisable(): void

Protected onEnable

  • onEnable(): void

Optional onFocusInEditor

  • onFocusInEditor(): void

Protected onLoad

  • onLoad(): void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

Protected Optional onRestore

  • onRestore(): void
  • onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。

    如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。

    编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。 然而,在极端的情况下,它可能无法良好运作。
    那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。 一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

    同样的,编辑可能无法在极端情况下正确地重置您的组件。
    于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
    一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
    此方法仅在编辑器下会被调用。

    Returns void

removeGroup

  • removeGroup(v: number): void

removeMask

  • removeMask(v: number): void

Optional resetInEditor

  • resetInEditor(): void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void
  • 调度一个自定义的回调任务。
    如果回调任务已调度,那么将不会重复调度它,只会更新时间间隔参数。

    example
    import { log } from 'cc';
    this.schedule((dt) => void log(`time: ${dt}`), 1);

    Parameters

    • callback: any

      The callback function of the task

    • Default value interval: number = 0

      The time interval between each invocation

    • Default value repeat: number = legacyCC.macro.REPEAT_FOREVER

      The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever

    • Default value delay: number = 0

      The delay time for the first invocation, Unit: s

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void
  • 调度一个只运行一次的回调任务,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

    method

    scheduleOnce

    see

    schedule

    example
    import { log } from 'cc';
    this.scheduleOnce((dt) => void log(`time: ${dt}`), 2);

    Parameters

    • callback: any

      The callback function of the task

    • Default value delay: number = 0

      The delay time for the first invocation, Unit: s

    Returns void

setAngularVelocity

  • setAngularVelocity(value: Vec3): void

setGroup

  • setGroup(v: number): void

setLinearVelocity

  • setLinearVelocity(value: Vec3): void

setMask

  • setMask(v: number): void

sleep

  • sleep(): void

Protected Optional start

  • start(): void
  • 如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Returns void

unschedule

  • unschedule(callback_fn: any): void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void

Protected Optional update

  • update(dt: number): void
  • 如果该组件启用,则每帧调用 update。
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

wakeUp

  • wakeUp(): void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc