Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICapsuleShape

Hierarchy

Index

Properties

Readonly attachedRigidBody

attachedRigidBody: RigidBody | null

Readonly collider

collider: Collider

getAABB

getAABB: (v: aabb) => void

Type declaration

    • Parameters

      Returns void

getBoundingSphere

getBoundingSphere: (v: sphere) => void

Type declaration

Readonly impl

impl: any

setAsTrigger

setAsTrigger: (v: boolean) => void

Type declaration

    • (v: boolean): void
    • Parameters

      • v: boolean

      Returns void

setCenter

setCenter: (v: IVec3Like) => void

Type declaration

setCylinderHeight

setCylinderHeight: (v: number) => void

Type declaration

    • (v: number): void
    • Parameters

      • v: number

      Returns void

setDirection

setDirection: (v: number) => void

Type declaration

    • (v: number): void
    • Parameters

      • v: number

      Returns void

setMaterial

setMaterial: (v: PhysicMaterial | null) => void

Type declaration

setRadius

setRadius: (v: number) => void

Type declaration

    • (v: number): void
    • Parameters

      • v: number

      Returns void

Methods

Optional Private preload

  • preload(component: any): void
  • __preload is called before every onLoad.
    It is used to initialize the builtin components internally,
    to avoid checking whether onLoad is called before every public method calls.
    This method should be removed if script priority is supported.

    Parameters

    • component: any

    Returns void

addGroup

  • addGroup(v: number): void

addMask

  • addMask(v: number): void

getGroup

  • getGroup(): number

getMask

  • getMask(): number

initialize

Optional lateUpdate

  • lateUpdate(dt: number): void
  • LateUpdate is called every frame, if the Component is enabled.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Parameters

    • dt: number

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

    Returns void

Optional onDestroy

  • onDestroy(): void
  • Called when this component will be destroyed.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Returns void

Optional onDisable

  • onDisable(): void
  • Called when this component becomes disabled or its node becomes inactive.
    This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

    Returns void

Optional onEnable

  • onEnable(): void
  • Called when this component becomes enabled and its node is active.
    This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

    Returns void

Optional onFocusInEditor

  • onFocusInEditor(): void

Optional onLoad

  • onLoad(): void
  • When attaching to an active node or its node first activated.
    onLoad is always called before any start functions, this allows you to order initialization of scripts.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Returns void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

Optional onRestore

  • onRestore(): void
  • onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

    If the component contains the "internal state", short for "temporary member variables which not included
    in its CCClass properties", then you may need to implement this function.

    The editor will call the getset accessors of your component to record/restore the component's state
    for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
    this function to manually synchronize your component's "internal states" with its public properties.
    Once you implement this function, all the getset accessors of your component will not be called when
    the user performs an undo/redo operation. Which means that only the properties with default value
    will be recorded or restored by editor.

    Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
    to support the reset menu, you should manually synchronize your component's "internal states" with its
    properties in this function. Once you implement this function, all the getset accessors of your component
    will not be called during reset operation. Which means that only the properties with default value
    will be reset by editor.

    This function is only called in editor mode.

    Returns void

removeGroup

  • removeGroup(v: number): void

removeMask

  • removeMask(v: number): void

Optional resetInEditor

  • resetInEditor(): void
  • Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.

    Returns void

setGroup

  • setGroup(v: number): void

setMask

  • setMask(v: number): void

Optional start

  • start(): void
  • Called before all scripts' update if the Component is enabled the first time.
    Usually used to initialize some logic which need to be called after all components' onload methods called.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Returns void

Optional update

  • update(dt: number): void
  • Update is called every frame, if the Component is enabled.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Parameters

    • dt: number

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

    Returns void

Generated using TypeDoc