Weather.d overview

Table of contents

• utils
  • Weather (class)
    • destroy (method)
    • update (method)
    • _createBitmaps (method)
    • _createDimmer (method)
    • _updateDimmer (method)
    • _updateAllSprites (method)
    • _addSprite (method)
    • _removeSprite (method)
    • _updateSprite (method)
    • _updateRainSprite (method)
    • _updateStormSprite (method)
    • _updateSnowSprite (method)
    • _rebornSprite (method)
    • _width (property)
    • _height (property)
    • _sprites (property)
    • viewport (property)
    • type (property)
    • power (property)
    • origin (property)
    • _rainBitmap (property)
    • _stormBitmap (property)
    • _snowBitmap (property)
    • _dimmerSprite (property)
  • WeatherType (type alias)

utils

Weather (class)

The weather effect which displays rain, storm, or snow.

Signature

export declare class Weather {
  constructor()
}

destroy (method)

Destroys the weather.

Signature

destroy(): void

update (method)

Updates the weather for each frame.

Signature

update(): void

_createBitmaps (method)

Signature

_createBitmaps(): void

_createDimmer (method)

Signature

_createDimmer(): void

_updateDimmer (method)

Signature

_updateDimmer(): void

_updateAllSprites (method)

Signature

_updateAllSprites(): void

_addSprite (method)

Signature

_addSprite(): void

_removeSprite (method)

Signature

_removeSprite(): void

_updateSprite (method)

Signature

_updateSprite(sprite: WeatherSprite): void

_updateRainSprite (method)

Signature

_updateRainSprite(sprite: WeatherSprite): void

_updateStormSprite (method)

Signature

_updateStormSprite(sprite: WeatherSprite): void

_updateSnowSprite (method)

Signature

_updateSnowSprite(sprite: WeatherSprite): void

_rebornSprite (method)

Signature

_rebornSprite(sprite: WeatherSprite): void

_width (property)

Signature

_width: number

_height (property)

Signature

_height: number

_sprites (property)

Signature

_sprites: WeatherSprite[]

viewport (property)

Signature

viewport: Bitmap

type (property)

The type of the weather in [“none”, “rain”, “storm”, “snow”].

Signature

type: WeatherType

power (property)

The power of the weather in the range (0, 9).

Signature

power: number

origin (property)

The origin point of the weather for scrolling.

Signature

origin: Point

_rainBitmap (property)

Signature

_rainBitmap: Bitmap

_stormBitmap (property)

Signature

_stormBitmap: Bitmap

_snowBitmap (property)

Signature

_snowBitmap: Bitmap

_dimmerSprite (property)

Signature

_dimmerSprite: ScreenSprite

WeatherType (type alias)

Signature

export declare type WeatherType = 'none' | 'rain' | 'storm' | 'snow'