Phaser.GameObjects

Scope: static

Source: src/gameobjects/index.js#L7

Classs:

Public Members

Private Members

Namespaces:

Public Members

Private Members

Methods:

Public Members

BuildGameObject

<static> BuildGameObject(scene, gameObject, config)

Description:

Builds a Game Object using the provided configuration object.

Parameters:

nametypeoptionaldescription
scenePhaser.SceneNoA reference to the Scene.
gameObjectPhaser.GameObjects.GameObjectNoThe initial GameObject.
configPhaser.Types.GameObjects.GameObjectConfigNoThe config to build the GameObject with.

Returns: Phaser.GameObjects.GameObject - The built Game Object.

Source: src/gameobjects/BuildGameObject.js#L10
Since: 3.0.0


BuildGameObjectAnimation

<static> BuildGameObjectAnimation(sprite, config)

Description:

Adds an Animation component to a Sprite and populates it based on the given config.

Parameters:

nametypeoptionaldescription
spritePhaser.GameObjects.SpriteNoThe sprite to add an Animation component to.
configobjectNoThe animation config.

Returns: Phaser.GameObjects.Sprite - The updated Sprite.

Source: src/gameobjects/BuildGameObjectAnimation.js#L9
Since: 3.0.0


GetCalcMatrix

<static> GetCalcMatrix(src, camera, [parentMatrix])

Description:

Calculates the Transform Matrix of the given Game Object and Camera, factoring in the parent matrix if provided.

Note that the object this results contains references to the Transform Matrices, not new instances of them. Therefore, you should use their values immediately, or copy them to your own matrix, as they will be replaced as soon as another Game Object is rendered.

Parameters:

nametypeoptionaldescription
srcPhaser.GameObjects.GameObjectNoThe Game Object to calculate the transform matrix for.
cameraPhaser.Cameras.Scene2D.CameraNoThe camera being used to render the Game Object.
parentMatrixPhaser.GameObjects.Components.TransformMatrixYesThe transform matrix of the parent container, if any.

Returns: Phaser.Types.GameObjects.GetCalcMatrixResults - The results object containing the updated transform matrices.

Source: src/gameobjects/GetCalcMatrix.js#L15
Since: 3.50.0


GetTextSize

<static> GetTextSize(text, size, lines)

Description:

Returns an object containing dimensions of the Text object.

Parameters:

nametypeoptionaldescription
textPhaser.GameObjects.TextNoThe Text object to calculate the size from.
sizePhaser.Types.GameObjects.Text.TextMetricsNoThe Text metrics to use when calculating the size.
linesArray.<string>NoThe lines of text to calculate the size from.

Returns: Phaser.Types.GameObjects.Text.GetTextSizeObject - An object containing dimensions of the Text object.

Source: src/gameobjects/text/GetTextSize.js#L7
Since: 3.0.0


MeasureText

<static> MeasureText(textStyle)

Description:

Calculates the ascent, descent and fontSize of a given font style.

Parameters:

nametypeoptionaldescription
textStylePhaser.GameObjects.TextStyleNoThe TextStyle object to measure.

Returns: Phaser.Types.GameObjects.Text.TextMetrics - An object containing the ascent, descent and fontSize of the TextStyle.

Source: src/gameobjects/text/MeasureText.js#L9
Since: 3.0.0


Private Members

Updated on