A Nine Slice Game Object allows you to display a texture-based object that can be stretched both horizontally and vertically, but that retains fixed-sized corners. The dimensions of the corners are set via the parameters to this class.
This is extremely useful for UI and button like elements, where you need them to expand to accommodate the content without distorting the texture.
The texture you provide for this Game Object should be based on the following layout structure:
A B
+---+----------------------+---+
C | 1 | 2 | 3 |
+---+----------------------+---+
| | | |
| 4 | 5 | 6 |
| | | |
+---+----------------------+---+
D | 7 | 8 | 9 |
+---+----------------------+---+
When changing this objects width and / or height:
areas 1, 3, 7 and 9 (the corners) will remain unscaled
areas 2 and 8 will be stretched horizontally only
areas 4 and 6 will be stretched vertically only
area 5 will be stretched both horizontally and vertically
You can also create a 3 slice Game Object:
This works in a similar way, except you can only stretch it horizontally. Therefore, it requires less configuration:
A B
+---+----------------------+---+
| | | |
C | 1 | 2 | 3 |
| | | |
+---+----------------------+---+
When changing this objects width (you cannot change its height)
areas 1 and 3 will remain unscaled
area 2 will be stretched horizontally
The above configuration concept is adapted from the Pixi NineSlicePlane.
To specify a 3 slice object instead of a 9 slice you should only
provide the leftWidth
and rightWidth
parameters. To create a 9 slice
you must supply all parameters.
The minimum width this Game Object can be is the total of
leftWidth
+ rightWidth
. The minimum height this Game Object
can be is the total of topHeight
+ bottomHeight
.
If you need to display this object at a smaller size, you can scale it.
In terms of performance, using a 3 slice Game Object is the equivalent of having 3 Sprites in a row. Using a 9 slice Game Object is the equivalent of having 9 Sprites in a row. The vertices of this object are all batched together and can co-exist with other Sprites and graphics on the display list, without incurring any additional overhead.
As of Phaser 3.60 this Game Object is WebGL only.
As of Phaser 3.70 this Game Object can now populate its values automatically if they have been set within Texture Packer 7.1.0 or above and exported with the atlas json. If this is the case, you can just call this method without specifying anything more than the texture key and frame and it will pull the area data from the atlas.
new NineSlice(scene, x, y, texture, [frame], [width], [height], [leftWidth], [rightWidth], [topHeight], [bottomHeight])
name | type | arguments | Default | description |
---|---|---|---|---|
scene | Phaser.Scene |
The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time. |
||
x | number |
The horizontal position of the center of this Game Object in the world. |
||
y | number |
The vertical position of the center of this Game Object in the world. |
||
texture | string | Phaser.Textures.Texture |
The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager. |
||
frame | string | number | <optional> |
An optional frame from the Texture this Game Object is rendering with. |
|
width | number | <optional> | 256 |
The width of the Nine Slice Game Object. You can adjust the width post-creation. |
height | number | <optional> | 256 |
The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed. |
leftWidth | number | <optional> | 10 |
The size of the left vertical column (A). |
rightWidth | number | <optional> | 10 |
The size of the right vertical column (B). |
topHeight | number | <optional> | 0 |
The size of the top horizontal row (C). Set to zero or undefined to create a 3 slice object. |
bottomHeight | number | <optional> | 0 |
The size of the bottom horizontal row (D). Set to zero or undefined to create a 3 slice object. |
The active state of this Game Object.
A Game Object with an active state of true
is processed by the Scenes UpdateList, if added to it.
An active object is one which is having its logic and internal systems updated.
The alpha value of the Game Object.
This is a global value, impacting the entire Game Object, not just a region of it.
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.
Sets the Blend Mode being used by this Game Object.
This can be a const, such as Phaser.BlendModes.SCREEN
, or an integer, such as 4 (for Overlay)
Under WebGL only the following Blend Modes are available:
Canvas has more available depending on browser support.
You can also create your own custom Blend Modes in WebGL.
Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these reasons try to be careful about the construction of your Scene and the frequency of which blend modes are used.
If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.
The size of the bottom horizontal bar (D).
If this is a 3 slice object this property will be set to zero.
A bitmask that controls if this Game Object is drawn by a Camera or not.
Not usually set directly, instead call Camera.ignore
, however you can
set this property directly using the Camera.id property:
A Data Manager.
It allows you to store, query and get key/value paired information specific to this Game Object.
null
by default. Automatically created if you use getData
or setData
or setDataEnabled
.
The depth of this Game Object within the Scene. Ensure this value is only ever set to a number data-type.
The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order of Game Objects, without actually moving their position in the display list.
The default depth is zero. A Game Object with a higher depth value will always render in front of one with a lower value.
Setting the depth will queue a depth sort event within the Scene.
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.
Holds a reference to the Display List that contains this Game Object.
This is set automatically when this Game Object is added to a Scene or Layer.
You should treat this property as being read-only.
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.
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.
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.
The Texture Frame this Game Object is using to render with.
A property indicating that a Game Object has this component.
The displayed height of this Game Object.
Setting this value will adjust the way in which this Nine Slice object scales vertically, if configured to do so.
The minimum height this Game Object can be is the total of
topHeight
+ bottomHeight
. If you need to display this object
at a smaller size, you can also scale it.
If this is a 3-slice object, you can only stretch it horizontally and changing the height will be ignored.
This Game Object will ignore all calls made to its destroy method if this flag is set to true
.
This includes calls that may come from a Group, Container or the Scene itself.
While it allows you to persist a Game Object across Scenes, please understand you are entirely
responsible for managing references to and from this Game Object.
If this Game Object is enabled for input then this property will contain an InteractiveObject instance.
Not usually set directly. Instead call GameObject.setInteractive()
.
This property is true
if this Nine Slice Game Object was configured
with just leftWidth
and rightWidth
values, making it a 3-slice
instead of a 9-slice object.
Does this Game Object have a tint applied?
It checks to see if the tint property is set to a value other than 0xffffff. This indicates that a Game Object is tinted.
The size of the left vertical bar (A).
The Mask this Game Object is using during render.
The name of this Game Object. Empty by default and never populated by Phaser, this is left for developers to use.
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.
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.
The parent Container of this Game Object, if it has one.
The flags that are compared against RENDER_MASK
to determine if this Game Object will render or not.
The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.
If those components are not used by your custom class then you can use this bitmask as you wish.
The size of the right vertical bar (B).
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.
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.
The horizontal scale of this Game Object.
The vertical scale of this Game Object.
A reference to the Scene to which this Game Object belongs.
Game Objects can only belong to one Scene.
You should consider this property as being read-only. You cannot move a Game Object to another Scene by simply changing it.
The horizontal scroll factor of this Game Object.
The scroll factor controls the influence of the movement of a Camera upon this Game Object.
When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.
A value of 1 means it will move exactly in sync with a camera. A value of 0 means it will not move at all, even if the camera moves. Other values control the degree to which the camera movement is mapped to this Game Object.
Please be aware that scroll factor values other than 1 are not taken in to consideration when calculating physics collisions. Bodies always collide based on their world position, but changing the scroll factor is a visual adjustment to where the textures are rendered, which can offset them from physics bodies if not accounted for in your code.
The vertical scroll factor of this Game Object.
The scroll factor controls the influence of the movement of a Camera upon this Game Object.
When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.
A value of 1 means it will move exactly in sync with a camera. A value of 0 means it will not move at all, even if the camera moves. Other values control the degree to which the camera movement is mapped to this Game Object.
Please be aware that scroll factor values other than 1 are not taken in to consideration when calculating physics collisions. Bodies always collide based on their world position, but changing the scroll factor is a visual adjustment to where the textures are rendered, which can offset them from physics bodies if not accounted for in your code.
The current state of this Game Object.
Phaser itself will never modify this value, although plugins may do so.
Use this property to track the state of a Game Object during its lifetime. For example, it could change from a state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant in your game code), or a string. These are recommended to keep it light and simple, with fast comparisons. If you need to store complex data about your Game Object, look at using the Data Component instead.
The Tab Index of the Game Object. Reserved for future use by plugins and the Input Manager.
The Texture this Game Object is using to render with.
The tint value being applied to the top-left vertice of the Game Object. This value is interpolated from the corner to the center of the Game Object. The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.
The tint fill mode.
false
= An additive tint (the default), where vertices colors are blended with the texture.
true
= A fill tint, where the vertices colors replace the texture, but respects texture alpha.
The size of the top horizontal bar (C).
If this is a 3 slice object this property will be set to the height of the texture being used.
A textual representation of this Game Object, i.e. sprite
.
Used internally by Phaser but is available for your own custom classes to populate.
An array of Vertex objects that correspond to the quads that make-up this Nine Slice Game Object. They are stored in the following order:
Top Left - Indexes 0 - 5 Top Center - Indexes 6 - 11 Top Right - Indexes 12 - 17 Center Left - Indexes 18 - 23 Center - Indexes 24 - 29 Center Right - Indexes 30 - 35 Bottom Left - Indexes 36 - 41 Bottom Center - Indexes 42 - 47 Bottom Right - Indexes 48 - 53
Each quad is represented by 6 Vertex instances.
This array will contain 18 elements for a 3 slice object and 54 for a nine slice object.
You should never modify this array once it has been populated.
The visible state of the Game Object.
An invisible Game Object will skip rendering, but will still process update logic.
The w position of this Game Object.
The displayed width of this Game Object.
Setting this value will adjust the way in which this Nine Slice object scales horizontally, if configured to do so.
The minimum width this Game Object can be is the total of
leftWidth
+ rightWidth
. If you need to display this object
at a smaller size, you can also scale it.
The x position of this Game Object.
The y position of this Game Object.
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.
Add a listener for a given event.
name | type | arguments | Default | description |
---|---|---|---|---|
event | string | symbol |
The event name. |
||
fn | function |
The listener function. |
||
context | * | <optional> | this |
The context to invoke the listener with. |
this
.
Adds this Game Object to the given Display List.
If no Display List is specified, it will default to the Display List owned by the Scene to which this Game Object belongs.
A Game Object can only exist on one Display List at any given time, but may move freely between them.
If this Game Object is already on another Display List when this method is called, it will first be removed from it, before being added to the new list.
You can query which list it is on by looking at the Phaser.GameObjects.GameObject#displayList
property.
If a Game Object isn't on any display list, it will not be rendered. If you just wish to temporarly
disable it from rendering, consider using the setVisible
method, instead.
name | type | arguments | description |
---|---|---|---|
displayList | Phaser.GameObjects.DisplayList | Phaser.GameObjects.Layer | <optional> |
The Display List to add to. Defaults to the Scene Display List. |
This Game Object.
Adds this Game Object to the Update List belonging to the Scene.
When a Game Object is added to the Update List it will have its preUpdate
method called
every game frame. This method is passed two parameters: delta
and time
.
If you wish to run your own logic within preUpdate
then you should always call
super.preUpdate(delta, time)
within it, or it may fail to process required operations,
such as Sprite animations.
This Game Object.
This callback is invoked when this Game Object is added to a Scene.
Can be overriden by custom Game Objects, but be aware of some Game Objects that will use this, such as Sprites, to add themselves into the Update List.
You can also listen for the ADDED_TO_SCENE
event from this Game Object.
Clears all alpha values associated with this Game Object.
Immediately sets the alpha levels back to 1 (fully opaque).
This Game Object instance.
Clears the mask that this Game Object was using.
name | type | arguments | Default | description |
---|---|---|---|---|
destroyMask | boolean | <optional> | false |
Destroy the mask before clearing it? |
This Game Object instance.
Clears all tint values associated with this Game Object.
Immediately sets the color values back to 0xffffff and the tint type to 'additive', which results in no visible change to the texture.
This Game Object instance.
Copies an object's coordinates to this Game Object's position.
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. |
This Game Object instance.
Creates and returns a Bitmap Mask. This mask can be used by any Game Object, including this one, or a Dynamic Texture.
Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.
To create the mask you need to pass in a reference to a renderable Game Object. A renderable Game Object is one that uses a texture to render with, such as an Image, Sprite, Render Texture or BitmapText.
If you do not provide a renderable object, and this Game Object has a texture, it will use itself as the object. This means you can call this method to create a Bitmap Mask from any renderable texture-based Game Object.
name | type | arguments | description |
---|---|---|---|
maskObject | Phaser.GameObjects.GameObject | Phaser.Textures.DynamicTexture | <optional> |
The Game Object or Dynamic Texture that will be used as the mask. If |
x | number | <optional> |
If creating a Game Object, the horizontal position in the world. |
y | number | <optional> |
If creating a Game Object, the vertical position in the world. |
texture | string | Phaser.Textures.Texture | <optional> |
If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager. |
frame | string | number | Phaser.Textures.Frame | <optional> |
If creating a Game Object, an optional frame from the Texture this Game Object is rendering with. |
This Bitmap Mask that was created.
Creates and returns a Geometry Mask. This mask can be used by any Game Object, including this one.
To create the mask you need to pass in a reference to a Graphics Game Object.
If you do not provide a graphics object, and this Game Object is an instance of a Graphics object, then it will use itself to create the mask.
This means you can call this method to create a Geometry Mask from any Graphics Game Object.
name | type | arguments | description |
---|---|---|---|
graphics | Phaser.GameObjects.Graphics | Phaser.GameObjects.Shape | <optional> |
A Graphics Game Object, or any kind of Shape Game Object. The geometry within it will be used as the mask. |
This Geometry Mask that was created.
Destroys this Game Object removing it from the Display List and Update List and severing all ties to parent resources.
Also removes itself from the Input Manager and Physics Manager if previously enabled.
Use this to remove a Game Object from your game if you don't ever plan to use it again. As long as no reference to it exists within your own code it should become free for garbage collection by the browser.
If you just want to temporarily disable an object then look at using the Game Object Pool instead of destroying it, as destroyed objects cannot be resurrected.
name | type | arguments | Default | description |
---|---|---|---|---|
fromScene | boolean | <optional> | false |
|
If this Game Object has previously been enabled for input, this will disable it.
An object that is disabled for input stops processing or being considered for
input events, but can be turned back on again at any time by simply calling
setInteractive()
with no arguments provided.
If want to completely remove interaction from this Game Object then use removeInteractive
instead.
name | type | arguments | Default | description |
---|---|---|---|---|
resetCursor | boolean | <optional> | false |
Should the currently active Input cursor, if any, be reset to the default cursor? |
This GameObject.
Calls each of the listeners registered for a given event.
name | type | arguments | description |
---|---|---|---|
event | string | symbol |
The event name. |
|
args | * | <optional> |
Additional arguments that will be passed to the event handler. |
true
if the event had listeners, else false
.
Return an array listing the events for which the emitter has registered listeners.
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-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-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.
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.
Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.
You can also access values via the values
object. For example, if you had a key called gold
you can do either:
sprite.getData('gold');
Or access the value directly:
sprite.data.values.gold;
You can also pass in an array of keys, in which case an array of values will be returned:
sprite.getData([ 'gold', 'armor', 'health' ]);
This approach is useful for destructuring arrays in ES6.
name | type | description |
---|---|---|
key | string | Array.<string> |
The key of the value to retrieve, or an array of keys. |
The value belonging to the given key, or an array of values, the order of which will match the input array.
Returns a reference to the underlying display list array that contains this Game Object, which will be either the Scene's Display List or the internal list belonging to its parent Container, if it has one.
If this Game Object is not on a display list or in a container, it will return null
.
You should be very careful with this method, and understand that it returns a direct reference to the internal array used by the Display List. Mutating this array directly can cause all kinds of subtle and difficult to debug issues in your game.
The internal Display List array of Game Objects, or null
.
Returns an array containing the display list index of either this Game Object, or if it has one, its parent Container. It then iterates up through all of the parent containers until it hits the root of the display list (which is index 0 in the returned array).
Used internally by the InputPlugin but also useful if you wish to find out the display depth of this Game Object and all of its ancestors.
An array of display list position indexes.
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.
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.
name | type | arguments | 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. |
The translated point.
Gets the local transform matrix for this Game Object.
name | type | arguments | description |
---|---|---|---|
tempMatrix | Phaser.GameObjects.Components.TransformMatrix | <optional> |
The matrix to populate with the values from this Game Object. |
The populated Transform Matrix.
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.
The sum total rotation, in radians, of all parent containers of this Game 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 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-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-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 world transform matrix for this Game Object, factoring in any parent Containers.
name | type | arguments | 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. |
The populated Transform Matrix.
Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.
If the Game Object has not been enabled for data (via setDataEnabled
) then it will be enabled
before setting the value.
If the key doesn't already exist in the Data Manager then it is created.
When the value is first set, a setdata
event is emitted from this Game Object.
name | type | arguments | Default | description |
---|---|---|---|---|
key | string |
The key to change the value for. |
||
amount | number | <optional> | 1 |
The amount to increase the given key by. Pass a negative value to decrease the key. |
This GameObject.
Return the number of listeners listening to a given event.
name | type | description |
---|---|---|
event | string | symbol |
The event name. |
The number of listeners.
Return the listeners registered for a given event.
name | type | description |
---|---|---|
event | string | symbol |
The event name. |
The registered listeners.
Remove the listeners of a given event.
name | type | arguments | description |
---|---|---|---|
event | string | symbol |
The event name. |
|
fn | function | <optional> |
Only remove the listeners that match this function. |
context | * | <optional> |
Only remove the listeners that have this context. |
once | boolean | <optional> |
Only remove one-time listeners. |
this
.
Add a listener for a given event.
name | type | arguments | Default | description |
---|---|---|---|---|
event | string | symbol |
The event name. |
||
fn | function |
The listener function. |
||
context | * | <optional> | this |
The context to invoke the listener with. |
this
.
Add a one-time listener for a given event.
name | type | arguments | Default | description |
---|---|---|---|---|
event | string | symbol |
The event name. |
||
fn | function |
The listener function. |
||
context | * | <optional> | this |
The context to invoke the listener with. |
this
.
Remove all listeners, or those of the specified event.
name | type | arguments | description |
---|---|---|---|
event | string | symbol | <optional> |
The event name. |
this
.
Removes this Game Object from the Display List it is currently on.
A Game Object can only exist on one Display List at any given time, but may move freely removed and added back at a later stage.
You can query which list it is on by looking at the Phaser.GameObjects.GameObject#displayList
property.
If a Game Object isn't on any Display List, it will not be rendered. If you just wish to temporarly
disable it from rendering, consider using the setVisible
method, instead.
This Game Object.
Removes this Game Object from the Scene's Update List.
When a Game Object is on the Update List, it will have its preUpdate
method called
every game frame. Calling this method will remove it from the list, preventing this.
Removing a Game Object from the Update List will stop most internal functions working. For example, removing a Sprite from the Update List will prevent it from being able to run animations.
This Game Object.
If this Game Object has previously been enabled for input, this will queue it for removal, causing it to no longer be interactive. The removal happens on the next game step, it is not immediate.
The Interactive Object that was assigned to this Game Object will be destroyed, removed from the Input Manager and cleared from this Game Object.
If you wish to re-enable this Game Object at a later date you will need to
re-create its InteractiveObject by calling setInteractive
again.
If you wish to only temporarily stop an object from receiving input then use
disableInteractive
instead, as that toggles the interactive state, where-as
this erases it completely.
If you wish to resize a hit area, don't remove and then set it as being
interactive. Instead, access the hitarea object directly and resize the shape
being used. I.e.: sprite.input.hitArea.setSize(width, height)
(assuming the
shape is a Rectangle, which it is by default.)
name | type | arguments | Default | description |
---|---|---|---|---|
resetCursor | boolean | <optional> | false |
Should the currently active Input cursor, if any, be reset to the default cursor? |
This GameObject.
Remove the listeners of a given event.
name | type | arguments | description |
---|---|---|---|
event | string | symbol |
The event name. |
|
fn | function | <optional> |
Only remove the listeners that match this function. |
context | * | <optional> |
Only remove the listeners that have this context. |
once | boolean | <optional> |
Only remove one-time listeners. |
this
.
This callback is invoked when this Game Object is removed from a Scene.
Can be overriden by custom Game Objects, but be aware of some Game Objects that will use this, such as Sprites, to removed themselves from the Update List.
You can also listen for the REMOVED_FROM_SCENE
event from this Game Object.
Move this Game Object so that it appears above the given Game Object.
This means it will render immediately after the other object in the display list.
Both objects must belong to the same display list, or parent container.
This method does not change this Game Objects depth
value, it simply alters its list position.
name | type | description |
---|---|---|
gameObject | Phaser.GameObjects.GameObject |
The Game Object that this Game Object will be moved to be above. |
This Game Object instance.
Sets the active
property of this Game Object and returns this Game Object for further chaining.
A Game Object with its active
property set to true
will be updated by the Scenes UpdateList.
name | type | description |
---|---|---|
value | boolean |
True if this Game Object should be set as active, false if not. |
This GameObject.
Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders. Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.
name | type | arguments | Default | description |
---|---|---|---|---|
value | number | <optional> | 1 |
The alpha value applied across the whole Game Object. |
This Game Object instance.
Sets the angle of this Game Object.
name | type | arguments | description |
---|---|---|---|
degrees | number | <optional> |
The rotation of this Game Object, in degrees. |
This Game Object instance.
Move this Game Object so that it appears below the given Game Object.
This means it will render immediately under the other object in the display list.
Both objects must belong to the same display list, or parent container.
This method does not change this Game Objects depth
value, it simply alters its list position.
name | type | description |
---|---|---|
gameObject | Phaser.GameObjects.GameObject |
The Game Object that this Game Object will be moved to be below. |
This Game Object instance.
Sets the Blend Mode being used by this Game Object.
This can be a const, such as Phaser.BlendModes.SCREEN
, or an integer, such as 4 (for Overlay)
Under WebGL only the following Blend Modes are available:
Canvas has more available depending on browser support.
You can also create your own custom Blend Modes in WebGL.
Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these reasons try to be careful about the construction of your Scene and the frequency in which blend modes are used.
name | type | description |
---|---|---|
value | string | number | Phaser.BlendModes |
The BlendMode value. Either a string, a CONST or a number. |
This Game Object instance.
Allows you to store a key value pair within this Game Objects Data Manager.
If the Game Object has not been enabled for data (via setDataEnabled
) then it will be enabled
before setting the value.
If the key doesn't already exist in the Data Manager then it is created.
sprite.setData('name', 'Red Gem Stone');
You can also pass in an object of key value pairs as the first argument:
sprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });
To get a value back again you can call getData
:
sprite.getData('gold');
Or you can access the value directly via the values
property, where it works like any other variable:
sprite.data.values.gold += 50;
When the value is first set, a setdata
event is emitted from this Game Object.
If the key already exists, a changedata
event is emitted instead, along an event named after the key.
For example, if you updated an existing key called PlayerLives
then it would emit the event changedata-PlayerLives
.
These events will be emitted regardless if you use this method to set the value, or the direct values
setter.
Please note that the data keys are case-sensitive and must be valid JavaScript Object property strings.
This means the keys gold
and Gold
are treated as two unique values within the Data Manager.
name | type | arguments | description |
---|---|---|---|
key | string | object |
The key to set the value for. Or an object of key value pairs. If an object the |
|
data | * | <optional> |
The value to set for the given key. If an object is provided as the key this argument is ignored. |
This GameObject.
Adds a Data Manager component to this Game Object.
This GameObject.
The depth of this Game Object within the Scene.
The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order of Game Objects, without actually moving their position in the display list.
The default depth is zero. A Game Object with a higher depth value will always render in front of one with a lower value.
Setting the depth will queue a depth sort event within the Scene.
name | type | description |
---|---|---|
value | number |
The depth of this Game Object. Ensure this value is only ever a number data-type. |
This Game Object instance.
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.
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 |
This Game Object instance.
Sets the display size of this Game Object.
Calling this will adjust the scale.
name | type | description |
---|---|---|
width | number |
The width of this Game Object. |
height | number |
The height of this Game Object. |
This Game Object instance.
Sets the frame this Game Object will use to render with.
If you pass a string or index then the Frame has to belong to the current Texture being used by this Game Object.
If you pass a Frame instance, then the Texture being used by this Game Object will also be updated.
Calling setFrame
will modify the width
and height
properties of your Game Object.
It will also change the origin
if the Frame has a custom pivot point, as exported from packages like Texture Packer.
name | type | arguments | Default | description |
---|---|---|---|---|
frame | string | number | Phaser.Textures.Frame |
The name or index of the frame within the Texture, or a Frame instance. |
||
updateSize | boolean | <optional> | true |
Should this call adjust the size of the Game Object? |
updateOrigin | boolean | <optional> | true |
Should this call adjust the origin of the Game Object? |
This Game Object instance.
Pass this Game Object to the Input Manager to enable it for Input.
Input works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area for the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced input detection.
If no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If this isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific shape for it to use.
You can also provide an Input Configuration Object as the only argument to this method.
name | type | arguments | Default | description |
---|---|---|---|---|
hitArea | any | Phaser.Types.Input.InputConfiguration | <optional> |
Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame. |
|
callback | Phaser.Types.Input.HitAreaCallback | <optional> |
The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback. |
|
dropZone | boolean | <optional> | false |
Should this Game Object be treated as a drop zone target? |
This GameObject.
sprite.setInteractive();
sprite.setInteractive(new Phaser.Geom.Circle(45, 46, 45), Phaser.Geom.Circle.Contains);
graphics.setInteractive(new Phaser.Geom.Rectangle(0, 0, 128, 128), Phaser.Geom.Rectangle.Contains);
Sets the mask that this Game Object will use to render with.
The mask must have been previously created and can be either a GeometryMask or a BitmapMask. Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.
If a mask is already set on this Game Object it will be immediately replaced.
Masks are positioned in global space and are not relative to the Game Object to which they are applied. The reason for this is that multiple Game Objects can all share the same mask.
Masks have no impact on physics or input detection. They are purely a rendering component that allows you to limit what is visible during the render pass.
name | type | description |
---|---|---|
mask | Phaser.Display.Masks.BitmapMask | Phaser.Display.Masks.GeometryMask |
The mask this Game Object will use when rendering. |
This Game Object instance.
Sets the name
property of this Game Object and returns this Game Object for further chaining.
The name
property is not populated by Phaser and is presented for your own use.
name | type | description |
---|---|---|
value | string |
The name to be given to this Game Object. |
This GameObject.
Sets the origin of this Game Object.
The values are given in the range 0 to 1.
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 |
This Game Object instance.
Sets the origin of this Game Object based on the Pivot values in its Frame.
This Game Object instance.
Sets the position of this Game Object.
name | type | arguments | 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 |
z | number | <optional> | 0 |
The z position of this Game Object. |
w | number | <optional> | 0 |
The w position of this Game Object. |
This Game Object instance.
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.
name | type | arguments | description |
---|---|---|---|
x | number | <optional> |
The x position of the top-left of the random area. |
y | number | <optional> |
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. |
This Game Object instance.
Sets the rotation of this Game Object.
name | type | arguments | description |
---|---|---|---|
radians | number | <optional> |
The rotation of this Game Object, in radians. |
This Game Object instance.
Sets the scale of this Game Object.
name | type | arguments | Default | description |
---|---|---|---|---|
x | number | <optional> | 1 |
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 |
This Game Object instance.
Sets the scroll factor of this Game Object.
The scroll factor controls the influence of the movement of a Camera upon this Game Object.
When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.
A value of 1 means it will move exactly in sync with a camera. A value of 0 means it will not move at all, even if the camera moves. Other values control the degree to which the camera movement is mapped to this Game Object.
Please be aware that scroll factor values other than 1 are not taken in to consideration when calculating physics collisions. Bodies always collide based on their world position, but changing the scroll factor is a visual adjustment to where the textures are rendered, which can offset them from physics bodies if not accounted for in your code.
name | type | arguments | Default | description |
---|---|---|---|---|
x | number |
The horizontal scroll factor of this Game Object. |
||
y | number | <optional> | x |
The vertical scroll factor of this Game Object. If not set it will use the |
This Game Object instance.
Sets the size of this Game Object.
For a Nine Slice Game Object this means it will be stretched (or shrunk) horizontally and vertically depending on the dimensions given to this method, in accordance with how it has been configured for the various corner sizes.
If this is a 3-slice object, you can only stretch it horizontally and changing the height will be ignored.
If you have enabled this Game Object for input, changing the size will also change the size of the hit area.
name | type | description |
---|---|---|
width | number |
The width of this Game Object. |
height | number |
The height of this Game Object. |
This Game Object instance.
This method is included but does nothing for the Nine Slice Game Object, because the size of the object isn't based on the texture frame.
You should not call this method.
This Game Object instance.
Resets the width, height and slices for this NineSlice Game Object.
This allows you to modify the texture being used by this object and then reset the slice configuration, to avoid having to destroy this Game Object in order to use it for a different game element.
Please note that you cannot change a 9-slice to a 3-slice or vice versa.
name | type | arguments | Default | description |
---|---|---|---|---|
width | number | <optional> | 256 |
The width of the Nine Slice Game Object. You can adjust the width post-creation. |
height | number | <optional> | 256 |
The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed. |
leftWidth | number | <optional> | 10 |
The size of the left vertical column (A). |
rightWidth | number | <optional> | 10 |
The size of the right vertical column (B). |
topHeight | number | <optional> | 0 |
The size of the top horizontal row (C). Set to zero or undefined to create a 3 slice object. |
bottomHeight | number | <optional> | 0 |
The size of the bottom horizontal row (D). Set to zero or undefined to create a 3 slice object. |
skipScale9 | boolean | <optional> | false |
If this Nine Slice was created from Texture Packer scale9 atlas data, set this property to use the given column sizes instead of those specified in the JSON. |
This Game Object instance.
Sets the current state of this Game Object.
Phaser itself will never modify the State of a Game Object, although plugins may do so.
For example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'. The state value should typically be an integer (ideally mapped to a constant in your game code), but could also be a string. It is recommended to keep it light and simple. If you need to store complex data about your Game Object, look at using the Data Component instead.
name | type | description |
---|---|---|
value | number | string |
The state of the Game Object. |
This GameObject.
Sets the texture and frame this Game Object will use to render with.
Textures are referenced by their string-based keys, as stored in the Texture Manager.
Calling this method will modify the width
and height
properties of your Game Object.
It will also change the origin
if the Frame has a custom pivot point, as exported from packages like Texture Packer.
name | type | arguments | Default | description |
---|---|---|---|---|
key | string | Phaser.Textures.Texture |
The key of the texture to be used, as stored in the Texture Manager, or a Texture instance. |
||
frame | string | number | <optional> |
The name or index of the frame within the Texture. |
|
updateSize | boolean | <optional> | true |
Should this call adjust the size of the Game Object? |
updateOrigin | boolean | <optional> | true |
Should this call change the origin of the Game Object? |
This Game Object instance.
Sets an additive tint on this Game Object.
The tint works by taking the pixel color values from the Game Objects texture, and then multiplying it by the color value of the tint.
To modify the tint color once set, either call this method again with new values or use the
tint
property.
To remove a tint call clearTint
, or call this method with no parameters.
To swap this from being an additive tint to a fill based tint set the property tintFill
to true
.
name | type | arguments | Default | description |
---|---|---|---|---|
color | number | <optional> | 0xffffff |
The tint being applied to the entire Game Object. |
This Game Object instance.
Sets a fill-based tint on this Game Object.
Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture with those in the tint. You can use this for effects such as making a player flash 'white' if hit by something. The whole Game Object will be rendered in the given color.
To modify the tint color once set, either call this method again with new values or use the
tint
property.
To remove a tint call clearTint
, or call this method with no parameters.
To swap this from being a fill-tint to an additive tint set the property tintFill
to false
.
name | type | arguments | Default | description |
---|---|---|---|---|
color | number | <optional> | 0xffffff |
The tint being applied to the entire Game Object. |
This Game Object instance.
Sets this Game Object to the back of the display list, or the back of its parent container.
Being at the back means it will render below everything else.
This method does not change this Game Objects depth
value, it simply alters its list position.
This Game Object instance.
Sets this Game Object to be at the top of the display list, or the top of its parent container.
Being at the top means it will render on-top of everything else.
This method does not change this Game Objects depth
value, it simply alters its list position.
This Game Object instance.
Sets the visibility of this Game Object.
An invisible Game Object will skip rendering, but will still process update logic.
name | type | description |
---|---|---|
value | boolean |
The visible state of the Game Object. |
This Game Object instance.
Sets the w position of this Game Object.
name | type | arguments | description |
---|---|---|---|
value | number | <optional> |
The w position of this Game Object. |
This Game Object instance.
Sets the x position of this Game Object.
name | type | arguments | description |
---|---|---|---|
value | number | <optional> |
The x position of this Game Object. |
This Game Object instance.
Sets the y position of this Game Object.
name | type | arguments | description |
---|---|---|---|
value | number | <optional> |
The y position of this Game Object. |
This Game Object instance.
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.
name | type | arguments | description |
---|---|---|---|
value | number | <optional> |
The z position of this Game Object. |
This Game Object instance.
Removes all listeners.
Returns a JSON representation of the Game Object.
A JSON representation of the Game Object.
Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.
If the Game Object has not been enabled for data (via setDataEnabled
) then it will be enabled
before setting the value.
If the key doesn't already exist in the Data Manager then it is created.
When the value is first set, a setdata
event is emitted from this Game Object.
name | type | description |
---|---|---|
key | string |
The key to toggle the value for. |
This GameObject.
To be overridden by custom GameObjects. Allows base objects to be used in a Pool.
name | type | arguments | description |
---|---|---|---|
args | * | <optional> |
args |
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.
This Game Object instance.
Internally updates the position coordinates across all vertices of the given quad offset.
You should not typically need to call this method directly, but it is left public should an extended class require it.
name | type | description |
---|---|---|
offset | number |
The offset in the vertices array of the quad to update. |
x1 | number |
The top-left quad coordinate. |
y1 | number |
The top-left quad coordinate. |
x2 | number |
The bottom-right quad coordinate. |
y2 | number |
The bottom-right quad coordinate. |
Internally updates the UV coordinates across all vertices of the given quad offset, based on the frame size.
You should not typically need to call this method directly, but it is left public should an extended class require it.
name | type | description |
---|---|---|
offset | number |
The offset in the vertices array of the quad to update. |
u1 | number |
The top-left UV coordinate. |
v1 | number |
The top-left UV coordinate. |
u2 | number |
The bottom-right UV coordinate. |
v2 | number |
The bottom-right UV coordinate. |
Updates all of the vertice UV coordinates. This is called automatically when the NineSlice Game Object is created, or if the texture frame changes.
Unlike with the updateVertice
method, you do not need to call this
method if the Nine Slice changes size. Only if it changes texture frame.
Recalculates all of the vertices in this Nine Slice Game Object
based on the leftWidth
, rightWidth
, topHeight
and bottomHeight
properties, combined with the Game Object size.
This method is called automatically when this object is created or if it's origin is changed.
You should not typically need to call this method directly, but it is left public should you find a need to modify one of those properties after creation.
Compares the renderMask with the renderFlags to see if this Game Object will render or not. Also checks the Game Object against the given Cameras exclusion list.
name | type | description |
---|---|---|
camera | Phaser.Cameras.Scene2D.Camera |
The Camera to check against this Game Object. |
True if the Game Object should be rendered, otherwise false.