Namespace: Transform

Phaser.GameObjects.Components. Transform

Provides methods used for getting and setting the position, scale and rotation of a Game Object.

Since: 3.0.0
Source: src/gameobjects/components/Transform.js (Line 17)

Members

angle :number

The angle of this Game Object as expressed in degrees.

Phaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left and -90 is up.

If you prefer to work in radians, see the rotation property instead.

Type:
  • number
Since: 3.0.0
Default Value:
  • 0
Source: src/gameobjects/components/Transform.js (Line 200)

rotation :number

The angle of this Game Object in radians.

Phaser uses a right-hand clockwise rotation system, where 0 is right, PI/2 is down, +-PI is left and -PI/2 is up.

If you prefer to work in degrees, see the angle property instead.

Type:
  • number
Since: 3.0.0
Default Value:
  • 1
Source: src/gameobjects/components/Transform.js (Line 227)

scale :number

This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object to the same value, at the same time. When reading this value the result returned is (scaleX + scaleY) / 2.

Use of this property implies you wish the horizontal and vertical scales to be equal to each other. If this isn't the case, use the scaleX or scaleY properties instead.

Type:
  • number
Since: 3.18.0
Default Value:
  • 1
Source: src/gameobjects/components/Transform.js (Line 102)

scaleX :number

The horizontal scale of this Game Object.

Type:
  • number
Since: 3.0.0
Default Value:
  • 1
Source: src/gameobjects/components/Transform.js (Line 138)

scaleY :number

The vertical scale of this Game Object.

Type:
  • number
Since: 3.0.0
Default Value:
  • 1
Source: src/gameobjects/components/Transform.js (Line 169)

w :number

The w position of this Game Object.

Type:
  • number
Since: 3.0.0
Default Value:
  • 0
Source: src/gameobjects/components/Transform.js (Line 92)

x :number

The x position of this Game Object.

Type:
  • number
Since: 3.0.0
Default Value:
  • 0
Source: src/gameobjects/components/Transform.js (Line 59)

y :number

The y position of this Game Object.

Type:
  • number
Since: 3.0.0
Default Value:
  • 0
Source: src/gameobjects/components/Transform.js (Line 69)

z :number

The z position of this Game Object.

Note: The z position does not control the rendering order of 2D Game Objects. Use Phaser.GameObjects.Components.Depth#depth instead.

Type:
  • number
Since: 3.0.0
Default Value:
  • 0
Source: src/gameobjects/components/Transform.js (Line 79)

Methods

copyPosition(source)

Copies an object's coordinates to this Game Object's position.

Parameters:
Name Type Description
source Phaser.Types.Math.Vector2Like | Phaser.Types.Math.Vector3Like | Phaser.Types.Math.Vector4Like

An object with numeric 'x', 'y', 'z', or 'w' properties. Undefined values are not copied.
Since: 3.50.0
Source: src/gameobjects/components/Transform.js (Line 282)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform

getLocalPoint(x, y [, point] [, camera])

Takes the given x and y coordinates and converts them into local space for this Game Object, taking into account parent and local transforms, and the Display Origin.

The returned Vector2 contains the translated point in its properties.

A Camera needs to be provided in order to handle modified scroll factors. If no camera is specified, it will use the main camera from the Scene to which this Game Object belongs.

Parameters:
Name Type Argument Description
x number

The x position to translate.
y number

The y position to translate.
point Phaser.Math.Vector2 <optional>

A Vector2, or point-like object, to store the results in.
camera Phaser.Cameras.Scene2D.Camera <optional>

The Camera which is being tested against. If not given will use the Scene default camera.
Since: 3.50.0
Source: src/gameobjects/components/Transform.js (Line 527)
Returns:

The translated point.

Type
Phaser.Math.Vector2

getLocalTransformMatrix( [tempMatrix])

Gets the local transform matrix for this Game Object.

Parameters:
Name Type Argument Description
tempMatrix Phaser.GameObjects.Components.TransformMatrix <optional>

The matrix to populate with the values from this Game Object.
Since: 3.4.0
Source: src/gameobjects/components/Transform.js (Line 473)
Returns:

The populated Transform Matrix.

Type
Phaser.GameObjects.Components.TransformMatrix

getParentRotation()

Gets the sum total rotation of all of this Game Objects parent Containers.

The returned value is in radians and will be zero if this Game Object has no parent container.

Since: 3.18.0
Source: src/gameobjects/components/Transform.js (Line 577)
Returns:

The sum total rotation, in radians, of all parent containers of this Game Object.

Type
number

getWorldTransformMatrix( [tempMatrix] [, parentMatrix])

Gets the world transform matrix for this Game Object, factoring in any parent Containers.

Parameters:
Name Type Argument Description
tempMatrix Phaser.GameObjects.Components.TransformMatrix <optional>

The matrix to populate with the values from this Game Object.
parentMatrix Phaser.GameObjects.Components.TransformMatrix <optional>

A temporary matrix to hold parent values during the calculations.
Since: 3.4.0
Source: src/gameobjects/components/Transform.js (Line 490)
Returns:

The populated Transform Matrix.

Type
Phaser.GameObjects.Components.TransformMatrix

setAngle( [degrees])

Sets the angle of this Game Object.

Parameters:
Name Type Argument Default Description
degrees number <optional>
 0

The rotation of this Game Object, in degrees.
Since: 3.0.0
Source: src/gameobjects/components/Transform.js (Line 353)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform

setPosition( [x] [, y] [, z] [, w])

Sets the position of this Game Object.

Parameters:
Name Type Argument Default Description
x number <optional>
 0

The x position of this Game Object.
y number <optional>
 x

The y position of this Game Object. If not set it will use the x value.
z number <optional>
 0

The z position of this Game Object.
w number <optional>
 0

The w position of this Game Object.
Since: 3.0.0
Source: src/gameobjects/components/Transform.js (Line 254)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform

setRandomPosition( [x] [, y] [, width] [, height])

Sets the position of this Game Object to be a random position within the confines of the given area.

If no area is specified a random position between 0 x 0 and the game width x height is used instead.

The position does not factor in the size of this Game Object, meaning that only the origin is guaranteed to be within the area.

Parameters:
Name Type Argument Default Description
x number <optional>
 0

The x position of the top-left of the random area.
y number <optional>
 0

The y position of the top-left of the random area.
width number <optional>

The width of the random area.
height number <optional>

The height of the random area.
Since: 3.8.0
Source: src/gameobjects/components/Transform.js (Line 302)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform

setRotation( [radians])

Sets the rotation of this Game Object.

Parameters:
Name Type Argument Default Description
radians number <optional>
 0

The rotation of this Game Object, in radians.
Since: 3.0.0
Source: src/gameobjects/components/Transform.js (Line 334)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform

setScale(x [, y])

Sets the scale of this Game Object.

Parameters:
Name Type Argument Default Description
x number

The horizontal scale of this Game Object.
y number <optional>
 x

The vertical scale of this Game Object. If not set it will use the x value.
Since: 3.0.0
Source: src/gameobjects/components/Transform.js (Line 372)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform

setW( [value])

Sets the w position of this Game Object.

Parameters:
Name Type Argument Default Description
value number <optional>
 0

The w position of this Game Object.
Since: 3.0.0
Source: src/gameobjects/components/Transform.js (Line 454)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform

setX( [value])

Sets the x position of this Game Object.

Parameters:
Name Type Argument Default Description
value number <optional>
 0

The x position of this Game Object.
Since: 3.0.0
Source: src/gameobjects/components/Transform.js (Line 394)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform

setY( [value])

Sets the y position of this Game Object.

Parameters:
Name Type Argument Default Description
value number <optional>
 0

The y position of this Game Object.
Since: 3.0.0
Source: src/gameobjects/components/Transform.js (Line 413)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform

setZ( [value])

Sets the z position of this Game Object.

Note: The z position does not control the rendering order of 2D Game Objects. Use Phaser.GameObjects.Components.Depth#setDepth instead.

Parameters:
Name Type Argument Default Description
value number <optional>
 0

The z position of this Game Object.
Since: 3.0.0
Source: src/gameobjects/components/Transform.js (Line 432)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Transform