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,
unless the includeParent
argument is set to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
output | Phaser.Types.Math.Vector2Like | <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? |
The values stored in the output object.
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,
unless the includeParent
argument is set to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
output | Phaser.Types.Math.Vector2Like | <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? |
The values stored in the output object.
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,
unless the includeParent
argument is set to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
output | Phaser.Types.Math.Vector2Like | <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? |
The values stored in the output object.
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,
unless the includeParent
argument is set to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
output | Phaser.Types.Math.Vector2Like | <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? |
The values stored in the output object.
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,
unless the includeParent
argument is set to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
output | Phaser.Types.Math.Vector2Like | <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? |
The values stored in the output object.
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,
unless the includeParent
argument is set to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
output | Phaser.Types.Math.Vector2Like | <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? |
The values stored in the output object.
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,
unless the includeParent
argument is set to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
output | Phaser.Types.Math.Vector2Like | <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? |
The values stored in the output object.
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,
unless the includeParent
argument is set to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
output | Phaser.Types.Math.Vector2Like | <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? |
The values stored in the output object.
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,
unless the includeParent
argument is set to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
output | Phaser.Types.Math.Vector2Like | <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? |
The values stored in the output object.
Gets the bounds of this Game Object, regardless of origin.
The values are stored and returned in a Rectangle, or Rectangle-like, object.
name | type | arguments | description |
---|---|---|---|
output | object | Phaser.Geom.Rectangle | <optional> |
An object to store the values in. If not provided a new Rectangle will be created. |
The values stored in the output object.