Phaser 3 API Documentation

Name	Type	Description
`instance`	any	Represents an instance of an ad.
`placementID`	string	The Audience Network placement ID of this ad instance.
`shown`	boolean	Has this ad already been shown in-game?
`video`	boolean	Is this a video ad?

Parameters:

Name	Type	Description
`object1`	Phaser.Types.Physics.Arcade.GameObjectWithBody	The first Game Object.
`object2`	Phaser.Types.Physics.Arcade.GameObjectWithBody	The second Game Object.

Source: src/physics/arcade/typedefs/ArcadePhysicsCallback.js (Line 1)

CameraRotateCallback(camera, progress, angle)

Parameters:

Name	Type	Description
`camera`	Phaser.Cameras.Scene2D.Camera	The camera on which the effect is running.
`progress`	number	The progress of the effect. A value between 0 and 1.
`angle`	number	The Camera's new angle in radians.

Source: src/cameras/2d/effects/RotateTo.js (Line 131)

CenterFunction(triangle)

Parameters:

Name	Type	Description
`triangle`	Phaser.Geom.Triangle	The Triangle to return the center coordinates of.

Source: src/geom/triangle/CenterOn.js (Line 10)

Returns:

The center point of the Triangle according to the function.

Type: Phaser.Math.Vector2

ChooseContextConfig

A configuration object that may be applied to a Context Choose operation.

Type:

object

Source: plugins/fbinstant/src/FacebookInstantGamesPlugin.js (Line 1342)

ContentLoadedCallback()

Name	Type	Argument	Description
`filters`	Array.<ContextFilter>	<optional>	The set of filters to apply to the context suggestions: 'NEW_CONTEXT_ONLY', 'INCLUDE_EXISTING_CHALLENGES' or 'NEW_PLAYERS_ONLY'.
`maxSize`	number	<optional>	The maximum number of participants that a suggested context should ideally have.
`minSize`	number	<optional>	The minimum number of participants that a suggested context should ideally have.

Source: src/dom/DOMContentLoaded.js (Line 9)

ContextFilter

A filter that may be applied to a Context Choose operation.

'NEW_CONTEXT_ONLY' - Prefer to only surface contexts the game has not been played in before. 'INCLUDE_EXISTING_CHALLENGES' - Include the "Existing Challenges" section, which surfaces actively played-in contexts that the player is a part of. 'NEW_PLAYERS_ONLY' - In sections containing individuals, prefer people who have not played the game.

Type:

string

Source: plugins/fbinstant/src/FacebookInstantGamesPlugin.js (Line 1332)

CreateCallback(bob, index)

Parameters:

Name	Type	Description
`bob`	Phaser.GameObjects.Bob	The Bob that was created by the Blitter.
`index`	number	The position of the Bob within the Blitter display list.

Source: src/gameobjects/blitter/Blitter.js (Line 15)

DataEachCallback(parent, key, value [, args])

Parameters:

Name	Type	Argument	Description
`parent`	*		The parent object of the DataManager.
`key`	string		The key of the value.
`value`	*		The value.
`args`	*	<optional> <repeatable>	Additional arguments that will be passed to the callback, after the game object, key, and data.

Source: src/data/DataManager.js (Line 10)

EachContainerCallback(item [, args])

Parameters:

Name	Type	Argument	Description
`item`	*		The child Game Object of the Container.
`args`	*	<optional> <repeatable>	Additional arguments that will be passed to the callback, after the child.

Source: src/gameobjects/container/Container.js (Line 1094)

EachListCallback(item [, args])

Name	Type	Argument	Description
`item`	I		The item which is currently being processed.
`args`	*	<optional> <repeatable>	Additional arguments that will be passed to the callback, after the child.

Name	Type	Description
`key`	string	The key of the Map entry.
`entry`	E	The value of the Map entry.

Name	Type	Description
`entry`	E	The Set entry.
`index`	number	The index of the entry within the Set.

Name	Type	Argument	Description
`texture`	Phaser.Textures.Texture		Each texture in Texture Manager.
`args`	*	<optional> <repeatable>	Additional arguments that will be passed to the callback, after the child.

Name	Type	Description
`value`	Phaser.Tilemaps.Tile	The Tile.
`index`	number	The index of the tile.
`array`	Array.<Phaser.Tilemaps.Tile>	An array of Tile objects.

Name	Type	Description
`value`	Phaser.Tilemaps.Tile	The Tile.
`index`	number	The index of the tile.
`array`	Array.<Phaser.Tilemaps.Tile>	An array of Tile objects.

Name	Type	Description
`score`	integer	An integer score value.
`scoreFormatted`	string	The score value, formatted with the score format associated with the leaderboard.
`timestamp`	integer	The Unix timestamp of when the leaderboard entry was last updated.
`rank`	integer	The entry's leaderboard ranking.
`data`	string	The developer-specified payload associated with the score, or null if one was not set.
`playerName`	string	The player's localized display name.
`playerPhotoURL`	string	A url to the player's public profile photo.
`playerID`	string	The game's unique identifier for the player.

Name	Type	Description
`light`	Phaser.GameObjects.Light	The Light.

Name	Type	Argument	Description
`title`	string	<optional>	The title of the product.
`productID`	string	<optional>	The product's game-specified identifier.
`description`	string	<optional>	The product description.
`imageURI`	string	<optional>	A link to the product's associated image.
`price`	string	<optional>	The price of the product.
`priceCurrencyCode`	string	<optional>	The currency code for the product.

Name	Type	Argument	Description
`developerPayload`	string	<optional>	A developer-specified string, provided during the purchase of the product.
`paymentID`	string	<optional>	The identifier for the purchase transaction.
`productID`	string	<optional>	The product's game-specified identifier.
`purchaseTime`	string	<optional>	Unix timestamp of when the purchase occurred.
`purchaseToken`	string	<optional>	A token representing the purchase that may be used to consume the purchase.
`signedRequest`	string	<optional>	Server-signed encoding of the purchase request.

Name	Type	Description
`origin`	Phaser.Math.Vector3	[description]
`direction`	Phaser.Math.Vector3	[description]

Name	Type	Description
`text`	string	The string to wrap.
`textObject`	Phaser.GameObjects.Text	The Text instance.

Name	Type	Description
`value`	Phaser.GameObjects.GameObject	An object found in the filtered area.
`index`	number	The index of the object within the array.
`array`	Array.<Phaser.GameObjects.GameObject>	An array of all the objects found.

Name	Type	Description
`value`	Phaser.GameObjects.GameObject	An object found.
`index`	number	The index of the object within the array.
`array`	Array.<Phaser.GameObjects.GameObject>	An array of all the objects found.

Name	Type	Description
`renderer`	Phaser.Renderer.WebGL.WebGLRenderer	The WebGL Renderer which owns the context.

Parameters:

Name Type Argument Description

item I
The item which is currently being processed.

args * <optional>
<repeatable>

Additional arguments that will be passed to the callback, after the child.

Source: src/structs/List.js (Line 12)

EachMapCallback(key, entry)

Parameters:

Name Type Description

key string
The key of the Map entry.

entry E
The value of the Map entry.

Source: src/structs/Map.js (Line 9)

Returns:

The callback result.

Type

boolean

EachSetCallback(entry, index)

Parameters:

Name Type Description

entry E
The Set entry.

index number
The index of the entry within the Set.

Source: src/structs/Set.js (Line 9)

Returns:

The callback result.

Type

boolean

EachTextureCallback(texture [, args])

Parameters:

Name Type Argument Description

texture Phaser.Textures.Texture
Each texture in Texture Manager.

args * <optional>
<repeatable>

Additional arguments that will be passed to the callback, after the child.

Source: src/textures/TextureManager.js (Line 20)

EachTileCallback(value, index, array)

Parameters:

Name Type Description

value Phaser.Tilemaps.Tile
The Tile.

index number
The index of the tile.

array Array.<Phaser.Tilemaps.Tile>
An array of Tile objects.

Source: src/tilemaps/components/ForEachTile.js (Line 9)

FindTileCallback(value, index, array)

Parameters:

Name Type Description

value Phaser.Tilemaps.Tile
The Tile.

index number
The index of the tile.

array Array.<Phaser.Tilemaps.Tile>
An array of Tile objects.

Source: src/tilemaps/components/FindTile.js (Line 9)

Returns:

Return true if the callback should run, otherwise false.

Type

boolean

LeaderboardScore

Type:

object

Properties:

Name Type Description

score integer
An integer score value.

scoreFormatted string
The score value, formatted with the score format associated with the leaderboard.

timestamp integer
The Unix timestamp of when the leaderboard entry was last updated.

rank integer
The entry's leaderboard ranking.

data string
The developer-specified payload associated with the score, or null if one was not set.

playerName string
The player's localized display name.

playerPhotoURL string
A url to the player's public profile photo.

playerID string
The game's unique identifier for the player.

Source: plugins/fbinstant/src/LeaderboardScore.js (Line 7)

LightForEach(light)

Parameters:

Name Type Description

light Phaser.GameObjects.Light
The Light.

Source: src/gameobjects/lights/LightsManager.js (Line 17)

Product

Type:

object

Properties:

Name Type Argument Description

title string <optional>

The title of the product.

productID string <optional>

The product's game-specified identifier.

description string <optional>

The product description.

imageURI string <optional>

A link to the product's associated image.

price string <optional>

The price of the product.

priceCurrencyCode string <optional>

The currency code for the product.

Source: plugins/fbinstant/src/Product.js (Line 9)

Purchase

Type:

object

Properties:

Name Type Argument Description

developerPayload string <optional>

A developer-specified string, provided during the purchase of the product.

paymentID string <optional>

The identifier for the purchase transaction.

productID string <optional>

The product's game-specified identifier.

purchaseTime string <optional>

Unix timestamp of when the purchase occurred.

purchaseToken string <optional>

A token representing the purchase that may be used to consume the purchase.

signedRequest string <optional>

Server-signed encoding of the purchase request.

Source: plugins/fbinstant/src/Purchase.js (Line 9)

RayDef

Type:

object

Properties:

Name Type Description

origin Phaser.Math.Vector3
[description]

direction Phaser.Math.Vector3
[description]

Source: plugins/camera3d/src/Camera.js (Line 27)

TextStyleWordWrapCallback(text, textObject)

A custom function that will be responsible for wrapping the text.

Parameters:

Name Type Description

text string
The string to wrap.

textObject Phaser.GameObjects.Text
The Text instance.

Source: src/gameobjects/text/typedefs/TextWordWrap.js (Line 13)

Returns:

Should return the wrapped lines either as an array of lines or as a string with newline characters in place to indicate where breaks should happen.

Type

string | Array.<string>

TilemapFilterCallback(value, index, array)

Parameters:

Name Type Description

value Phaser.GameObjects.GameObject
An object found in the filtered area.

index number
The index of the object within the array.

array Array.<Phaser.GameObjects.GameObject>
An array of all the objects found.

Source: src/tilemaps/Tilemap.js (Line 21)

Returns:

The object.

Type

Phaser.GameObjects.GameObject

TilemapFindCallback(value, index, array)

Parameters:

Name Type Description

value Phaser.GameObjects.GameObject
An object found.

index number
The index of the object within the array.

array Array.<Phaser.GameObjects.GameObject>
An array of all the objects found.

Source: src/tilemaps/Tilemap.js (Line 31)

Returns:

true if the callback should be invoked, otherwise false.

Type

boolean

WebGLContextCallback(renderer)

Parameters:

Name Type Description

renderer Phaser.Renderer.WebGL.WebGLRenderer
The WebGL Renderer which owns the context.

Source: src/renderer/webgl/WebGLRenderer.js (Line 25)

Global

Members

Actions

AddBlendFS

AddToDOM

AddToDOM

AddToDOM

AdInstance

AdvanceKeyCombo

ALIGN_CONST

ALIGN_CONST

ALIGN_CONST

ALIGN_CONST

AlignIn

Angle

Angle

AngleBetween

AngleBetweenPoints

Animation

AnimationState

AnimationState

AnimationState

Arc

ArcadeImage

ArcadeSprite

ArcadeSprite

ArcRender

Arne16

ArrayRemove

ArrayRemove

ArrayRemove

ArrayShuffle

ArrayUtils

ArrayUtils

AssignTileProperties

AudioFile

Axis

Back

Base64Decode

Base64ToArrayBuffer

BaseCache

BaseCamera

BaseCamera

BasePlugin

BaseSound

BaseSound

BaseSound

BaseSoundManager

BaseSoundManager

BatchChar

Bernstein

Between

Between

BitmapMask

BitmapText

BitmapText

BitmapText

BitmapText

BlendModes

BlendModes

BlendModes

BlendModes

BlendModes

BlendModes

Blitter

Blitter

BlitterRender

Bodies

Bodies

Bodies

Bodies

Bodies

Bodies

Body

Body

Body

Body

Body

body1

body1