phaser-percent-bar v1.1.5

What

This is part of the Phaser Component Library.

A percentage bar is a self-contained, self-updating bar with solid foreground and background colors. It can be attached to a sprite or created in a static location on the camera.

How

npm install phaser-percent-bar

Then, in your Phaser source code

import HealthBar from 'phaser-percent-bar'

// Sprite to track
const sprite = this.game.add.sprite(0, 0, 'your-key')

// Set health and max-health values
sprite.health = 100
sprite.maxHealth = 100

// Create percentage bar as health bar
const healthBar = this.game.add.existing(new HealthBar({
    game: this.game,
    host: sprite
}))

This will create a functioning, auto-updating health bar and attach it to the given sprite. When the sprite's health changes, the bar will update to reflect that.

API

new PercentBar( { options } )

options

bgSprite

Type: string

Key to the desired sprite for the percent-bar background. Use sprite for setting this and fgSprite to the same sprite.

bgTint

Type: hex Default: 0x00cc00

Hex value of the tint of the percentage bar's foreground (the bar itself).

fgSprite

Type: string

Key to the desired sprite for the percent bar itself. Use sprite for setting this and bgSprite to the same sprite.

fgTint

Type: hex Default: 0x333333 Hex value of the tint of the percentage bar's background.

game

Required Type: Phaser.Game

Host game for the percent-bar.

height

Type: number Default: 10

The height, in pixels, of the percentage bar.

host

Required Type: Phaser.Sprite

The parent sprite for this percentage bar.

resize

Type: boolean Default: false

If false, the bar will crop rather than growing or shrinking. If true, the bar will grow and shrink rather than cropping.

sprite

Type: string

Shortcut to setting both bgSprite and fgSprite. Key of the sprite to use as the percentage bar.

watch

Type: Object

The values that the percentage bar will represent. Accepts the following properties:

• host - Object containing the value to watch (optional - default top-level host)
• value - String with the name of the property to watch (optional - default 'health')
• max - Number indicating the maximum value of the progress bar (optional - default host.maxHealth)

Example implementation:

new PercentBar({
    // ...
    watch: {
        host: hostSprite,
        value: 'health',
        max: 100
    }
    // ...
})

width

Type: number Default: width of host

The width, in pixels, of the percentage bar.

xOffset

Type: number Default: 0

Number of pixels to offset from the host sprite horizontally.

yOffset

Type: number Default: -25

Number of pixels to offset from the host sprite vertically.

Methods

hide()

Parameters: none

Shortcut for setAlpha(0).

setAlpha( newAlpha )

Parameters:

• newAlpha (number) - new alpha value for percent bar components

Set health bar components to a given opacity.

show()

Parameters: none

Shortcut for setAlpha(1).

Versions

• 1.1.5 - TypeScript definitions, tint bugfix (thanks @sohan)
• 1.1.4 - Added show, hide, and setAlpha functions
• 1.1.31 - Added defaults for watch and updated readme
• 1.1.2 - Added xOffset
• 1.1.0 - Automatically centers bar to host on X axis. Added custom sprite support.
• 1.0.0 - First release