Class Smoke

Represents a fancy smoke circle on the map.

Hierarchy (View Summary)

GameObject
- Smoke

Index

Constructors

Properties

age color game maxAge? radius rspeed tile? width x y

Methods

delete draw isDeleted setPosition step

Constructors

constructor

new Smoke(
    game: Game,
    x: number,
    y: number,
    timeout?: number,
    radius?: number,
    rspeed?: number,
): Smoke
Creates a new Smoke particle.
Parameters
- game: Game
  The game instance.
- x: number
  X coordinate.
- y: number
  Y coordinate.
- timeout: number = 300
  Lifetime in ms.
- radius: number = 10
  Initial radius.
- rspeed: number = 1
  Radius shrinking speed.
Returns Smoke
Overrides GameObject.constructor
- Defined in entities/smoke.ts:22

Properties

age

age: number = 0

time (in milliseconds) for how long the object already exists in the game

color

color: string = "rgba(40, 40, 40, 0.3)"

game

game: Game

The game instance.

`Optional`maxAge

maxAge?: number

optional duration in milliseconds for how long the object should still exist in the game

radius

radius: number

rspeed

rspeed: number

`Optional`tile

tile?: Tile

width

width: number = 0

x

x: number = 0

y

y: number = 0

Methods

delete

delete(): void
Marks the object as deleted.

Returns void
Inherited from GameObject.delete
- Defined in entities/updatable.ts:18

draw

draw(context: CanvasRenderingContext2D): void
Draws the smoke particle.
Parameters
- context: CanvasRenderingContext2D
  The context.
Returns void
Overrides GameObject.draw
- Defined in entities/smoke.ts:37

isDeleted

isDeleted(): boolean
Is the object marked as deleted?

Returns boolean
Inherited from GameObject.isDeleted
- Defined in entities/updatable.ts:25

setPosition

setPosition(coord: Coord): void
Update the position of the object on the map
Parameters
- coord: Coord
  a coordinate tuple (x, y)
Returns void
Inherited from GameObject.setPosition
- Defined in entities/gameobject.ts:28

step

step(_dt: number): void
Update method called every frame.
Parameters
- _dt: number
  The time elapsed since the last frame in milliseconds.
Returns void
Inherited from GameObject.step
- Defined in entities/updatable.ts:33