Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Collider

碰撞体的基类。

abstract
see

用户手册//TODO

Hierarchy

Index

Properties

Readonly entity

entity: Entity

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

物理组件在节点上的执行顺序,排在渲染节点之后、用户脚本之前。

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

  • Align: number
  • Layout: number
  • Low: number
  • Physics: number
  • Render: number
  • Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

    • (...args: any[]): any
    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

active

  • get active(): boolean
  • set active(value: boolean): void
  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean
  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

attachedRigidbody

  • 获取碰撞体附着的刚体组件。

    Returns Rigidbody

bounds

  • 获取碰撞体的包围盒。
    组件未经历onAwake生命周期前,会获取到undefined。

    Returns ReadonlyBounds

contactOffset

  • get contactOffset(): number
  • set contactOffset(v: number): void
  • 设置碰撞体的contactOffset,必须为正数。
    一对碰撞体,如果他们之间的最近距离小于他们的contactOffset之和,那么物理系统在一次物理模拟后就会产生一次碰撞。

    Returns number

  • 设置碰撞体的contactOffset,必须为正数。
    一对碰撞体,如果他们之间的最近距离小于他们的contactOffset之和,那么物理系统在一次物理模拟后就会产生一次碰撞。

    Parameters

    • v: number

    Returns void

isTrigger

  • get isTrigger(): boolean
  • set isTrigger(v: boolean): void
  • 碰撞体是否是Trigger,开启后不参与碰撞,但是能触发Trigger系列的事件:
    onTriggerEnter, onTriggerStay, onTriggerExit

    default

    false

    Returns boolean

  • 碰撞体是否是Trigger,开启后不参与碰撞,但是能触发Trigger系列的事件:
    onTriggerEnter, onTriggerStay, onTriggerExit

    Parameters

    • v: boolean

    Returns void

material

  • 设置碰撞体的物理材质。
    设置后碰撞体持有的材质是原材质的深拷贝

    Returns PhysicMaterial

  • 设置碰撞体的物理材质。
    设置后碰撞体持有的材质是原材质的深拷贝

    Parameters

    Returns void

onCollisionEnter

  • 获取一个可以为onCollisionEnter事件添加回调的Delegate。
    在两个非Trigger碰撞体发生碰撞的第一帧,会生成一次onCollisionEnter事件。

    collider.onCollisionEnter.add(collision => {...});
    

    另一种添加onCollisionEnter(或其他物理)事件回调的方法,可以参考Script.onCollisionEnter

    Returns PhysicsDelegate<Collision>

onCollisionExit

  • 获取一个可以为onCollisionExit事件添加回调的Delegate。
    两个非Trigger碰撞体发生碰撞后,首次分开的那一帧,会生成一次onCollisionExit事件。

    Returns PhysicsDelegate<Collision>

onCollisionStay

  • 获取一个可以为onCollisionStay事件添加回调的Delegate。
    从两个非Trigger碰撞体发生碰撞后的第二帧开始,直到两个物体分开为止,会持续生成onCollisionStay事件。

    Returns PhysicsDelegate<Collision>

onTriggerEnter

  • 获取一个可以为onTriggerEnter事件添加回调的Delegate。
    在两个Trigger(或一个Trigger,一个非Trigger)碰撞体发生相交的第一帧,会生成一次onTriggerEnter事件。

    Returns PhysicsDelegate<TriggerCollision>

onTriggerExit

  • 获取一个可以为onTriggerExit事件添加回调的Delegate。
    两个Trigger(或一个Trigger,一个非Trigger)碰撞体发生相交后,首次分开的第一帧,会生成一次onTriggerExit事件。

    Returns PhysicsDelegate<TriggerCollision>

onTriggerStay

  • 获取一个可以为onTriggerStay事件添加回调的Delegate。
    从两个Trigger(或一个Trigger,一个非Trigger)碰撞体发生相交的第二帧开始,到两个物体分开,会持续生成onTriggerStay事件。

    Returns PhysicsDelegate<TriggerCollision>

type

  • Returns ColliderType

  • Parameters

    Returns void

Methods

destroy

  • destroy(): void
  • Returns void

getTypeName

  • getTypeName(): string

isDetached

  • isDetached(): boolean
  • Returns boolean

resetProperties

  • resetProperties(): void

Generated using TypeDoc