Phaser API Documentation

  Version: 
Filter
Namespace: Origin
Phaser.GameObjects.Components.Origin

Members

<private> _originComponent: boolean
Focus
Focus

Description:

A property indicating that a Game Object has this component.

Type:
boolean
Default: true
Since: 3.2.0
Focus
Focus
displayOriginX: number
Focus
Focus

Description:

The horizontal display origin of this Game Object. The origin is a normalized value between 0 and 1. The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.

Type:
number
Since: 3.0.0
Focus
Focus
displayOriginY: number
Focus
Focus

Description:

The vertical display origin of this Game Object. The origin is a normalized value between 0 and 1. The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.

Type:
number
Since: 3.0.0
Focus
Focus
originX: number
Focus
Focus

Description:

The horizontal origin of this Game Object. The origin maps the relationship between the size and position of the Game Object. The default value is 0.5, meaning all Game Objects are positioned based on their center. Setting the value to 0 means the position now relates to the left of the Game Object.

Type:
number
Default: 0.5
Since: 3.0.0
Focus
Focus
originY: number
Focus
Focus

Description:

The vertical origin of this Game Object. The origin maps the relationship between the size and position of the Game Object. The default value is 0.5, meaning all Game Objects are positioned based on their center. Setting the value to 0 means the position now relates to the top of the Game Object.

Type:
number
Default: 0.5
Since: 3.0.0
Focus
Focus

Methods

setOrigin([x], [y])
Focus
Focus

Description:

Sets the origin of this Game Object.

The values are given in the range 0 to 1.

Parameters:

name type arguments Default description
x number <optional> 0.5

The horizontal origin value.

y number <optional> x

The vertical origin value. If not defined it will be set to the value of x.

Returns:
Description:

This Game Object instance.

Since: 3.0.0
Focus
Focus
setOriginFromFrame()
Focus
Focus

Description:

Sets the origin of this Game Object based on the Pivot values in its Frame.

Returns:
Description:

This Game Object instance.

Since: 3.0.0
Focus
Focus
setDisplayOrigin([x], [y])
Focus
Focus

Description:

Sets the display origin of this Game Object. The difference between this and setting the origin is that you can use pixel values for setting the display origin.

Parameters:

name type arguments Default description
x number <optional> 0

The horizontal display origin value.

y number <optional> x

The vertical display origin value. If not defined it will be set to the value of x.

Returns:
Description:

This Game Object instance.

Since: 3.0.0
Focus
Focus
updateDisplayOrigin()
Focus
Focus

Description:

Updates the Display Origin cached values internally stored on this Game Object. You don't usually call this directly, but it is exposed for edge-cases where you may.

Returns:
Description:

This Game Object instance.

Since: 3.0.0
Focus
Focus