Skip to main content
Version: Phaser v4.0.0-rc.6

Types.GameObjects

DecomposeMatrixResults

<static> DecomposeMatrixResults

nametypeoptionaldescription
translateXnumberNoThe translated x value.
translateYnumberNoThe translated y value.
rotationnumberNoThe rotation value.
scaleXnumberNoThe scale x value.
scaleYnumberNoThe scale y value.

Type: object

Member of: Phaser.Types.GameObjects

Source: src/gameobjects/typedefs/DecomposeMatrixResults.js#L1
Since: 3.60.0


FiltersInternalExternal

<static> FiltersInternalExternal

nametypeoptionaldescription
internalPhaser.GameObjects.Components.FilterListNoThe internal filter list of the Game Object. These filters are applied first, in the local space of the Game Object.
externalPhaser.GameObjects.Components.FilterListNoThe external filter list of the Game Object. These filters are applied last, in the parent space of the Game Object.

Type: object

Member of: Phaser.Types.GameObjects

Source: src/gameobjects/typedefs/FiltersInternalExternal.js#L1
Since: 4.0.0


GameObjectConfig

<static> GameObjectConfig

nametypeoptionaldefaultdescription
xnumber | objectYes0The x position of the Game Object.
ynumber | objectYes0The y position of the Game Object.
depthnumberYes0The depth of the GameObject.
flipXbooleanYesfalseThe horizontally flipped state of the Game Object.
flipYbooleanYesfalseThe vertically flipped state of the Game Object.
scalenumber | objectYesnullThe scale of the GameObject.
scrollFactornumber | objectYesnullThe scroll factor of the GameObject.
rotationnumber | objectYes0The rotation angle of the Game Object, in radians.
anglenumber | objectYesnullThe rotation angle of the Game Object, in degrees.
alphanumber | objectYes1The alpha (opacity) of the Game Object.
originnumber | objectYesnullThe origin of the Game Object.
scaleModenumberYes"ScaleModes.DEFAULT"The scale mode of the GameObject.
blendModenumberYes"BlendModes.DEFAULT"The blend mode of the GameObject.
visiblebooleanYestrueThe visible state of the Game Object.
addbooleanYestrueAdd the GameObject to the scene.

Type: object

Member of: Phaser.Types.GameObjects

Source: src/gameobjects/typedefs/GameObjectConfig.js#L1
Since: 3.0.0


GetCalcMatrixResults

<static> GetCalcMatrixResults

nametypeoptionaldescription
cameraExternalPhaser.GameObjects.Components.TransformMatrixNoThe calculated Camera external matrix (where the camera is on the screen).
cameraPhaser.GameObjects.Components.TransformMatrixNoThe calculated Camera view matrix, including scroll modified by scroll factor.
spritePhaser.GameObjects.Components.TransformMatrixNoThe calculated Sprite (Game Object) matrix (world position).
calcPhaser.GameObjects.Components.TransformMatrixNoThe calculated results matrix, factoring all others in.

Type: object

Member of: Phaser.Types.GameObjects

Source: src/gameobjects/typedefs/GetCalcMatrixResults.js#L1
Since: 3.50.0


JSONGameObject

<static> JSONGameObject

nametypeoptionaldescription
namestringNoThe name of this Game Object.
typestringNoA textual representation of this Game Object, i.e. sprite.
xnumberNoThe x position of this Game Object.
ynumberNoThe y position of this Game Object.
scaleobjectNoThe scale of this Game Object
scale.xnumberNoThe horizontal scale of this Game Object.
scale.ynumberNoThe vertical scale of this Game Object.
originobjectNoThe origin of this Game Object.
origin.xnumberNoThe horizontal origin of this Game Object.
origin.ynumberNoThe vertical origin of this Game Object.
flipXbooleanNoThe horizontally flipped state of the Game Object.
flipYbooleanNoThe vertically flipped state of the Game Object.
rotationnumberNoThe angle of this Game Object in radians.
alphanumberNoThe alpha value of the Game Object.
visiblebooleanNoThe visible state of the Game Object.
scaleModenumberNoThe Scale Mode being used by this Game Object.
blendModenumber | stringNoSets the Blend Mode being used by this Game Object.
textureKeystringNoThe texture key of this Game Object.
frameKeystringNoThe frame key of this Game Object.
dataobjectNoThe data of this Game Object.

Type: object

Member of: Phaser.Types.GameObjects

Source: src/gameobjects/typedefs/JSONGameObject.js#L1
Since: 3.0.0


RenderWebGLStep

<static> RenderWebGLStep

A function which performs a rendering operation on the given Game Object.

This is usually the renderWebGL method of the Game Object itself,

but Phaser.GameObjects.Components.RenderSteps allows you to define

a series of steps that are run in sequence.

The function is not expected to run in any particular scope,

so it should not use this. Instead, all required properties should be

accessed via gameObject.

Type: function

Member of: Phaser.Types.GameObjects

Source: src/gameobjects/typedefs/RenderWebGLStep.js#L1
Since: 4.0.0