Phaser.GameObjects.Components.AlphaSingle

Scope: static

Source: src/gameobjects/components/AlphaSingle.js#L12
Since: 3.22.0

Public Members

alpha

alpha: number

Description:

The alpha value of the Game Object.

This is a global value, impacting the entire Game Object, not just a region of it.

Source: src/gameobjects/components/AlphaSingle.js#L68
Since: 3.0.0


Private Members

_alpha

_alpha: number

Description:

Private internal value. Holds the global alpha value.

Access: private

Source: src/gameobjects/components/AlphaSingle.js#L22
Since: 3.0.0


Methods:

Public Members

clearAlpha

<instance> clearAlpha()

Description:

Clears all alpha values associated with this Game Object.

Immediately sets the alpha levels back to 1 (fully opaque).

Returns: Phaser.GameObjects.Components.AlphaSingle - This Game Object instance.

Source: src/gameobjects/components/AlphaSingle.js#L33
Since: 3.0.0


setAlpha

<instance> setAlpha([value])

Description:

Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders. Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.

Parameters:

nametypeoptionaldefaultdescription
valuenumberYes1The alpha value applied across the whole Game Object.

Returns: Phaser.GameObjects.Components.AlphaSingle - This Game Object instance.

Source: src/gameobjects/components/AlphaSingle.js#L48
Since: 3.0.0


Private Members

Updated on