Class Floating

constructor

• new Floating(entity, options?): Floating

• Parameters

  • entity: Entity
  • options: FloatingOptions = {}

  Returns Floating

Readonlyentity

floatingIntensity

floatingRange

ReadonlyisScript

rotationIntensity

speed

userData

enabled

• get enabled(): boolean

• Indicates whether the component is enabled.

  Returns boolean

  Memberof

  Component

• set enabled(value): void

• Set whether the component is enabled.

  Parameters

  • value: boolean

  Returns void

  Memberof

  Component

scene

• get scene(): Scene

• Scene own the component

  Returns Scene

  Memberof

  Component

desrtoy

• desrtoy(): void

• Destroy component

  Returns void

  Memberof

  Component

dispose

• dispose(): void

• Clear subscribers

  Returns void

  Memberof

  EventDispatcher

emit

• emit(event): void

• Emit event

  Parameters

  • event: {
        type: string;
        [key: string]: any;
    }

    • [key: string]: any

    • type: string

  Returns void

  Memberof

  EventDispatcher

off

• off(type, callback?): void

• Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

  Parameters

  • type: string
  • Optionalcallback: SubscriberCallbackFn

    subscriber callback

  Returns void

  Memberof

  EventDispatcher

on

• on(type, callback, options?): void

• Subscribe a event

  Parameters

  • type: string

    event type
  • callback: SubscriberCallbackFn

    callback functions
  • Optionaloptions: {
        priority?: Priority;
        target?: any;
    }

    options

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

onAfterCameraRender

• onAfterCameraRender(camera): void

• Script after camera render, called per camera.

  Parameters

  • camera: Camera

  Returns void

  Memberof

  Script

onAwake

• onAwake(): void

• Awake script (Only call once when it's first enable)

  Returns void

  Memberof

  Script

onBeforeCameraRender

• onBeforeCameraRender(camera): void

• Script before camera render, called per camera.

  Parameters

  • camera: Camera

  Returns void

  Memberof

  Script

once

• once(type, callback, options?): void

• Subscribe a event, just emit once

  Parameters

  • type: string
  • callback: SubscriberCallbackFn

    subscriber callback
  • Optionaloptions: {
        priority?: Priority;
        target?: any;
    }

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

onDestroy

• onDestroy(): void

• Destroy script

  Returns void

  Memberof

  Script

onDisable

• onDisable(): void

• Disable the script

  Returns void

  Memberof

  Script

onDisableInScene

• onDisableInScene(): void

• Disable the script when detach from scene

  Returns void

  Memberof

  Script

onEnable

• onEnable(): void

• Enable the script

  Returns void

  Memberof

  Script

onLateUpdate

• onLateUpdate(timeSinceLastFrame, totalTime): void

• Script late update

  Parameters

  • timeSinceLastFrame: number

    time since last frame in seconds
  • totalTime: number

    total time in seconds

  Returns void

  Memberof

  Script

onPhysicsUpdate

• onPhysicsUpdate(): void

• Script physics update

  Returns void

  Memberof

  Script

onStart

• onStart(): void

• Start script (Call when the animation loop first start)

  Returns void

  Memberof

  Script

onUpdate

• onUpdate(timeSinceLastFrame, totalTime): void

• Update

  Parameters

  • timeSinceLastFrame: number
  • totalTime: number

  Returns void

  Memberof

  Floating