PhysicsUpdraftEvent

Represents a physics updraft event

Hierarchy

PhysicsUpdraftEvent

Index

Constructors

constructor

Methods

Constructors

constructor

Find examples in Playground

new PhysicsUpdraftEvent(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions): PhysicsUpdraftEvent

Initializes the physics updraft event

Parameters
- _scene: Scene
  
  BabylonJS scene
- _origin: Vector3
  
  The origin position of the updraft
- _options: PhysicsUpdraftEventOptions
  
  The options for the updraft event
Returns PhysicsUpdraftEvent

Methods

disable

Find examples in Playground

disable(): void

Disables the updraft.

Returns void

dispose

Find examples in Playground

dispose(force?: boolean): void

Disposes the cylinder.

Parameters
- Optional force: boolean
  
  Specifies if the updraft should be disposed by force
Returns void

enable

Find examples in Playground

enable(): void

Enables the updraft.

Returns void

getData

Find examples in Playground

getData(): PhysicsUpdraftEventData

Returns the data related to the updraft event (cylinder).

Returns PhysicsUpdraftEventData

A physics updraft event

Generated using TypeDoc