TParticlesComponent

Component for an actor. Only contains updater and cannot be rendered.

Hierarchy

• default
  • TParticlesComponent

Implements

• TActorComponentWithOnUpdate

Index

Constructors

• constructor

Properties

• actor
• canRender
• collider
• colorFilter
• dead
• height
• instanceUVScales
• layer
• parentComponent
• shouldRender
• texture
• transform
• uuid
• width

Accessors

• angularVelocity
• bodyOptions
• linearVelocity

Methods

• applyCentralForce
• applyCentralImpulse
• applyTexture
• applyTransform
• attachTo
• destroy
• getRenderTask
• getWorldTransform
• onUpdate
• setAngularDamping
• setAngularVelocity
• setBodyType
• setFixedRotation
• setFriction
• setIsTrigger
• setLinearDamping
• setLinearVelocity
• setMesh
• setOrigin
• setTexture
• updatePhysicsBody

Constructors

constructor

• new TParticlesComponent(engine: default, actor: default, particleWidth: number, particleHeight: number, systemConfig: TParticleSystemConfig, layer?: TSpriteLayer, bodyOptions?: TPhysicsBodyOptions): default

• Overrides default.constructor

  Parameters

  • engine: default

  • actor: default

  • particleWidth: number

  • particleHeight: number

  • systemConfig: TParticleSystemConfig

  • layer: TSpriteLayer = TSpriteLayer.Foreground_0

  • optionalbodyOptions: TPhysicsBodyOptions

  Returns default

Properties

publicactor

actor: default

Implementation of TActorComponentWithOnUpdate.actor

Inherited from default.actor

publiccanRender

canRender: boolean = false

Inherited from default.canRender

Indicates whether a component has the ability to be rendered.

publicoptionalcollider

collider?: ICollider

Inherited from default.collider

Collider for this component.

publicoptionalcolorFilter

colorFilter?: vec4

Inherited from default.colorFilter

publicdead

dead: boolean = false

Implementation of TActorComponentWithOnUpdate.dead

Inherited from default.dead

publicheight

height: number

Inherited from default.height

publicoptionalinstanceUVScales

instanceUVScales?: [number, number]

Inherited from default.instanceUVScales

publiclayer

layer: TSpriteLayer = TSpriteLayer.Foreground_0

Inherited from default.layer

publicoptionalparentComponent

parentComponent?: default

Inherited from default.parentComponent

Parent of this component. If undefined, it is a root component.

publicshouldRender

shouldRender: boolean = false

Inherited from default.shouldRender

Indicates whether a component should be rendered

publictexture

texture: default = ...

Inherited from default.texture

publictransform

transform: default = ...

Inherited from default.transform

Transform relative to the parent or actor (if has no parent).

publicuuid

uuid: string = ...

Implementation of TActorComponentWithOnUpdate.uuid

Inherited from default.uuid

publicwidth

width: number

Inherited from default.width

Accessors

publicangularVelocity

• get angularVelocity(): undefined | vec3

• Inherited from TSpriteComponent.angularVelocity

  Returns undefined | vec3

publicbodyOptions

• get bodyOptions(): TPhysicsBodyOptions

• Inherited from TSpriteComponent.bodyOptions

  Get physics body config for scene component

  ---

  Returns TPhysicsBodyOptions

publiclinearVelocity

• get linearVelocity(): undefined | vec3

• Inherited from TSpriteComponent.linearVelocity

  Returns undefined | vec3

Methods

publicapplyCentralForce

• applyCentralForce(force: vec3): void

• Inherited from default.applyCentralForce

  Parameters

  • force: vec3

  Returns void

publicapplyCentralImpulse

• applyCentralImpulse(impulse: vec3): void

• Inherited from default.applyCentralImpulse

  Parameters

  • impulse: vec3

  Returns void

publicapplyTexture

• applyTexture(engine: default, texturePath: string | default): Promise<void>

• Inherited from default.applyTexture

  Assigns a given texture to this component.

  ---

  Parameters

  • engine: default

  • texturePath: string | default

  Returns Promise<void>

publicapplyTransform

• applyTransform(): void

• Inherited from default.applyTransform

  Apply transforms ensure transform updates get propagated to the physics world

  ---

  Returns void

publicattachTo

• attachTo(parentComponent: default): void

• Inherited from default.attachTo

  Attaches the component as a child to the given component.

  ---

  Parameters

  • parentComponent: default

  Returns void

publicdestroy

• destroy(): void

• Implementation of TActorComponentWithOnUpdate.destroy

  Inherited from default.destroy

  Returns void

publicgetRenderTask

• getRenderTask(): undefined | TSerializedRenderTask

• Overrides default.getRenderTask

  Returns undefined | TSerializedRenderTask

publicgetWorldTransform

• getWorldTransform(): default

• Inherited from default.getWorldTransform

  Gets the component to world transform

  ---

  Returns default

publiconUpdate

• onUpdate(engine: default, delta: number): Promise<void>

• Implementation of TActorComponentWithOnUpdate.onUpdate

  Parameters

  • engine: default

  • delta: number

  Returns Promise<void>

publicsetAngularDamping

• setAngularDamping(damping: number): void

• Inherited from default.setAngularDamping

  Parameters

  • damping: number

  Returns void

publicsetAngularVelocity

• setAngularVelocity(velocity: vec3): void

• Inherited from default.setAngularVelocity

  Parameters

  • velocity: vec3

  Returns void

publicsetBodyType

• setBodyType(type: TPhysicsBodyType): void

• Inherited from default.setBodyType

  Parameters

  • type: TPhysicsBodyType

  Returns void

publicsetFixedRotation

• setFixedRotation(fixedRotation: boolean): void

• Inherited from default.setFixedRotation

  Parameters

  • fixedRotation: boolean

  Returns void

publicsetFriction

• setFriction(friction: number): void

• Inherited from default.setFriction

  Parameters

  • friction: number

  Returns void

publicsetIsTrigger

• setIsTrigger(isTrigger: boolean): void

• Inherited from default.setIsTrigger

  Triggers don't collide with other objects, but they still trigger collision events

  ---

  Parameters

  • isTrigger: boolean

  Returns void

publicsetLinearDamping

• setLinearDamping(damping: number): void

• Inherited from default.setLinearDamping

  Parameters

  • damping: number

  Returns void

publicsetLinearVelocity

• setLinearVelocity(velocity: vec3): void

• Inherited from default.setLinearVelocity

  Parameters

  • velocity: vec3

  Returns void

publicsetMesh

• setMesh(engine: default, positions: number[], normals: number[], indexes: number[], uvs: number[]): Promise<void>

• Inherited from default.setMesh

  Parameters

  • engine: default

  • positions: number[]

  • normals: number[]

  • indexes: number[]

  • uvs: number[]

  Returns Promise<void>

publicsetOrigin

• setOrigin(origin: TOriginPoint): void

• Inherited from default.setOrigin

  Parameters

  • origin: TOriginPoint

  Returns void

publicsetTexture

• setTexture(texture: default): void

• Inherited from default.setTexture

  Parameters

  • texture: default

  Returns void

publicupdatePhysicsBody

• updatePhysicsBody(body: undefined | TPhysicsBody): void

• Inherited from default.updatePhysicsBody

  Set physics body for this component, this is automatically called by the physics world. Changing this will not update the physics world, use the various set methods instead.

  ---

  Parameters

  • body: undefined | TPhysicsBody

  Returns void