Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: Size
Phaser.GameObjects.Components.Size

Members

<private> _sizeComponent: boolean
Focus
Focus

Description:

A property indicating that a Game Object has this component.

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

Description:

The displayed height of this Game Object.

This value takes into account the scale factor.

Setting this value will adjust the Game Object's scale property.

Type:
number
Since: 3.0.0
Focus
Focus
displayWidth: number
Focus
Focus

Description:

The displayed width of this Game Object.

This value takes into account the scale factor.

Setting this value will adjust the Game Object's scale property.

Type:
number
Since: 3.0.0
Focus
Focus
height: number
Focus
Focus

Description:

The native (un-scaled) height of this Game Object.

Changing this value will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or use the displayHeight property.

Type:
number
Since: 3.0.0
Focus
Focus
width: number
Focus
Focus

Description:

The native (un-scaled) width of this Game Object.

Changing this value will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or use the displayWidth property.

Type:
number
Since: 3.0.0
Focus
Focus

Methods

setSizeToFrame(frame)
Focus
Focus

Description:

Sets the size of this Game Object to be that of the given Frame.

This will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or call the setDisplaySize method, which is the same thing as changing the scale but allows you to do so by giving pixel values.

If you have enabled this Game Object for input, changing the size will not change the size of the hit area. To do this you should adjust the input.hitArea object directly.

Parameters:

name type description
frame Phaser.Textures.Frame

The frame to base the size of this Game Object on.

Returns:
Description:

This Game Object instance.

Examples:
Since: 3.0.0
Focus
Focus
setSize(width, height)
Focus
Focus

Description:

Sets the internal size of this Game Object, as used for frame or physics body creation.

This will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or call the setDisplaySize method, which is the same thing as changing the scale but allows you to do so by giving pixel values.

If you have enabled this Game Object for input, changing the size will not change the size of the hit area. To do this you should adjust the input.hitArea object directly.

Parameters:

name type description
width number

The width of this Game Object.

height number

The height of this Game Object.

Returns:
Description:

This Game Object instance.

Examples:
Since: 3.0.0
Focus
Focus
setDisplaySize(width, height)
Focus
Focus

Description:

Sets the display size of this Game Object.

Calling this will adjust the scale.

Parameters:

name type description
width number

The width of this Game Object.

height number

The height of this Game Object.

Returns:
Description:

This Game Object instance.

Examples:
Since: 3.0.0
Focus
Focus