Namespace: GetBounds

Methods

---

getBottomCenter( [output] [, includeParent])

Gets the bottom-center coordinate of this Game Object, regardless of origin. The returned point is calculated in local space and does not factor in any parent containers

Parameters:

Name	Type	Argument	Default	Description
output	Phaser.Math.Vector2 | object	<optional>		An object to store the values in. If not provided a new Vector2 will be created.
includeParent	boolean	<optional>	false	If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?

Since: 3.18.0

Source: src/gameobjects/components/GetBounds.js (Line 221)

Returns:

The values stored in the output object.

Type

Phaser.Math.Vector2 | object

---

getBottomLeft( [output] [, includeParent])

Gets the bottom-left corner coordinate of this Game Object, regardless of origin. The returned point is calculated in local space and does not factor in any parent containers

Parameters:

Name	Type	Argument	Default	Description
output	Phaser.Math.Vector2 | object	<optional>		An object to store the values in. If not provided a new Vector2 will be created.
includeParent	boolean	<optional>	false	If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?

Since: 3.0.0

Source: src/gameobjects/components/GetBounds.js (Line 197)

Returns:

The values stored in the output object.

Type

Phaser.Math.Vector2 | object

---

getBottomRight( [output] [, includeParent])

Gets the bottom-right corner coordinate of this Game Object, regardless of origin. The returned point is calculated in local space and does not factor in any parent containers

Parameters:

Name	Type	Argument	Default	Description
output	Phaser.Math.Vector2 | object	<optional>		An object to store the values in. If not provided a new Vector2 will be created.
includeParent	boolean	<optional>	false	If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?

Since: 3.0.0

Source: src/gameobjects/components/GetBounds.js (Line 245)

Returns:

The values stored in the output object.

Type

Phaser.Math.Vector2 | object

---

getBounds( [output])

Gets the bounds of this Game Object, regardless of origin. The values are stored and returned in a Rectangle, or Rectangle-like, object.

Parameters:

Name	Type	Argument	Description
output	Phaser.Geom.Rectangle | object	<optional>	An object to store the values in. If not provided a new Rectangle will be created.

Since: 3.0.0

Source: src/gameobjects/components/GetBounds.js (Line 269)

Returns:

The values stored in the output object.

Type

Phaser.Geom.Rectangle | object

---

getCenter( [output])

Gets the center coordinate of this Game Object, regardless of origin. The returned point is calculated in local space and does not factor in any parent containers

Parameters:

Name	Type	Argument	Description
output	Phaser.Math.Vector2 | object	<optional>	An object to store the values in. If not provided a new Vector2 will be created.

Since: 3.0.0

Source: src/gameobjects/components/GetBounds.js (Line 54)

Returns:

The values stored in the output object.

Type

Phaser.Math.Vector2 | object

---

getLeftCenter( [output] [, includeParent])

Gets the left-center coordinate of this Game Object, regardless of origin. The returned point is calculated in local space and does not factor in any parent containers

Parameters:

Name	Type	Argument	Default	Description
output	Phaser.Math.Vector2 | object	<optional>		An object to store the values in. If not provided a new Vector2 will be created.
includeParent	boolean	<optional>	false	If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?

Since: 3.18.0

Source: src/gameobjects/components/GetBounds.js (Line 149)

Returns:

The values stored in the output object.

Type

Phaser.Math.Vector2 | object

---

getRightCenter( [output] [, includeParent])

Gets the right-center coordinate of this Game Object, regardless of origin. The returned point is calculated in local space and does not factor in any parent containers

Parameters:

Name	Type	Argument	Default	Description
output	Phaser.Math.Vector2 | object	<optional>		An object to store the values in. If not provided a new Vector2 will be created.
includeParent	boolean	<optional>	false	If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?

Since: 3.18.0

Source: src/gameobjects/components/GetBounds.js (Line 173)

Returns:

The values stored in the output object.

Type

Phaser.Math.Vector2 | object

---

getTopCenter( [output] [, includeParent])

Gets the top-center coordinate of this Game Object, regardless of origin. The returned point is calculated in local space and does not factor in any parent containers

Parameters:

Name	Type	Argument	Default	Description
output	Phaser.Math.Vector2 | object	<optional>		An object to store the values in. If not provided a new Vector2 will be created.
includeParent	boolean	<optional>	false	If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?

Since: 3.18.0

Source: src/gameobjects/components/GetBounds.js (Line 101)

Returns:

The values stored in the output object.

Type

Phaser.Math.Vector2 | object

---

getTopLeft( [output] [, includeParent])

Gets the top-left corner coordinate of this Game Object, regardless of origin. The returned point is calculated in local space and does not factor in any parent containers

Parameters:

Name	Type	Argument	Default	Description
output	Phaser.Math.Vector2 | object	<optional>		An object to store the values in. If not provided a new Vector2 will be created.
includeParent	boolean	<optional>	false	If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?

Since: 3.0.0

Source: src/gameobjects/components/GetBounds.js (Line 77)

Returns:

The values stored in the output object.

Type

Phaser.Math.Vector2 | object

---

getTopRight( [output] [, includeParent])

Gets the top-right corner coordinate of this Game Object, regardless of origin. The returned point is calculated in local space and does not factor in any parent containers

Parameters:

Name	Type	Argument	Default	Description
output	Phaser.Math.Vector2 | object	<optional>		An object to store the values in. If not provided a new Vector2 will be created.
includeParent	boolean	<optional>	false	If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?

Since: 3.0.0

Source: src/gameobjects/components/GetBounds.js (Line 125)

Returns:

The values stored in the output object.

Type

Phaser.Math.Vector2 | object