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.
Global alpha value.
Alpha for the bottom-left corner.
Alpha for the bottom-right corner.
Alpha for the top-left corner.
Alpha for the top-right corner.
Angle in degrees.
Blend mode.
If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.
ReadonlybottomBottom scroll offset limit.
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:
Canvas element.
Canvas 2D context.
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.
Default pipeline.
Depth value.
Display height value.
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.
Display origin x value.
Display origin y value.
Display width value.
Horizontal flip state.
Vertical flip state.
Frame reference.
True if post pipelines are present.
Height value.
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().
True if this object is cropped.
ReadonlyisTrue if tinted.
Letter spacing value.
Line spacing value.
Current mask.
The name of this Game Object. Empty by default and never populated by Phaser, this is left for developers to use.
Origin x value.
Origin y value.
Padding values.
Bottom padding.
Left padding.
Right padding.
Top padding.
The parent Container of this Game Object, if it has one.
Current pipeline.
Pipeline data storage.
Post-FX component.
Post pipeline data storage.
Post pipeline list.
Pre-FX component.
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.
Rotation in radians.
Uniform scale.
Scale x.
Scale y.
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.
Scroll factor X.
Scroll factor Y.
Current vertical scroll offset.
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.
Current resolved style object.
Normalized vertical scroll position.
The Tab Index of the Game Object. Reserved for future use by plugins and the Input Manager.
Current text content.
Texture reference.
Unified tint value.
Tint for the bottom-left corner.
Tint for the bottom-right corner.
True if tint fill mode is enabled.
Tint for the top-left corner.
Tint for the top-right corner.
ReadonlytopTop scroll offset limit.
A textual representation of this Game Object, i.e. sprite.
Used internally by Phaser but is available for your own custom classes to populate.
Current url cursor style.
Visibility flag.
W position.
Width value.
X position.
Y position.
Z position.
Static ReadonlyRENDER_The bitmask that GameObject.renderFlags is compared against to determine if the Game Object will render or not.
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.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: anyThe context to invoke the listener with. Default this.
Add to vertical scroll offset.
Delta value.
Optionalclamp: booleanTrue to clamp within bounds.
This instance.
Add to normalized vertical scroll position.
Delta value.
Optionalclamp: booleanTrue to clamp within bounds.
This instance.
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.
OptionaldisplayList: DisplayList | LayerThe Display List to add to. Defaults to the Scene Display List.
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(time, delta) within it, or it may fail to process required operations,
such as Sprite animations.
Append text content.
Text content to append.
OptionaladdCR: booleanTrue to add a line break before text.
This instance.
Clear alpha for all corners.
This instance.
Clear all FX pipelines.
This instance.
Clear the current mask.
OptionaldestroyMask: booleanTrue to destroy the mask.
This instance.
Clear tint.
This instance.
Copy position from another vector.
Source vector.
This instance.
Create a bitmap mask.
Optionalrenderable: GameObjectRenderable used to create the mask.
The bitmap mask.
Create a geometry mask.
Optionalgraphics: GraphicsGraphics used to create the mask.
The geometry mask.
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.
OptionalfromScene: booleanTrue if this Game Object is being destroyed by the Scene, false if not. Default 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.
OptionalresetCursor: booleanShould the currently active Input cursor, if any, be reset to the default cursor? Default false.
Draw bounds of interactive areas.
Graphics object to draw to.
Optionalcolor: numberLine color.
This instance.
Calls each of the listeners registered for a given event.
The event name.
Additional arguments that will be passed to the event handler.
Return an array listing the events for which the emitter has registered listeners.
Generate a texture from text.
Texture key.
Optionalx: numberSource x.
Optionaly: numberSource y.
Optionalwidth: numberSource width.
Optionalheight: numberSource height.
This instance.
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.
The key of the value to retrieve, or an array of keys.
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.
Get hit area key from world coordinates.
World x.
World y.
Scene camera.
Hit area key.
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.
Get local transform matrix.
OptionaltempMatrix: TransformMatrixOptional temp matrix.
The local transform matrix.
Get parent rotation.
Parent rotation in radians.
Get current pipeline name.
Pipeline name.
Get plain text without tags.
Optionalstart: numberStart index.
Optionalend: numberEnd index.
The plain text.
Get plain text from a provided string.
Optionaltext: stringSource text.
Optionalstart: numberStart index.
Optionalend: numberEnd index.
The plain text.
Get a post pipeline by name or class.
Pipeline name or class.
The pipeline or pipelines.
Get a substring.
Optionalstart: numberStart index.
Optionalend: numberEnd index.
The substring.
Get a substring from a provided string.
Optionaltext: stringSource text.
Optionalstart: numberStart index.
Optionalend: numberEnd index.
The substring.
Get text with tags.
Optionalstart: numberStart index.
Optionalend: numberEnd index.
The text.
Get text with tags from a provided string.
Optionaltext: stringSource text.
Optionalstart: numberStart index.
Optionalend: numberEnd index.
The text.
Get world transform matrix.
OptionaltempMatrix: TransformMatrixOptional temp matrix.
OptionalparentMatrix: TransformMatrixOptional parent matrix.
The world transform matrix.
Get wrapped text lines.
Optionalstart: numberStart index.
Optionalend: numberEnd index.
Wrapped lines.
Get wrapped text lines from a provided string.
Optionaltext: stringSource text.
Optionalstart: numberStart index.
Optionalend: numberEnd index.
Wrapped lines.
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.
The key to change the value for.
Optionalamount: numberThe amount to increase the given key by. Pass a negative value to decrease the key. Default 1.
Initialize pipeline.
Optionalpipeline: string | WebGLPipelinePipeline key or instance.
True if initialized.
Initialize post pipeline.
OptionalpreFX: booleanTrue to enable pre-FX.
Return the number of listeners listening to a given event.
The event name.
Return the listeners registered for a given event.
The event name.
Measure text margins.
String for measurement.
Optionalout: TextMarginsTypeOptional output object.
The margins object.
Remove the listeners of a given event.
The event name.
Optionalfn: FunctionOnly remove the listeners that match this function.
Optionalcontext: anyOnly remove the listeners that have this context.
Optionalonce: booleanOnly remove one-time listeners.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: anyThe context to invoke the listener with. Default this.
Add a one-time listener for a given event.
The event name.
The listener function.
Optionalcontext: anyThe context to invoke the listener with. Default this.
Remove all listeners, or those of the specified event.
Optionalevent: string | symbolThe event name.
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.
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.
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.
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.)
OptionalresetCursor: booleanShould the currently active Input cursor, if any, be reset to the default cursor? Default false.
Remove the listeners of a given event.
The event name.
Optionalfn: FunctionOnly remove the listeners that match this function.
Optionalcontext: anyOnly remove the listeners that have this context.
Optionalonce: booleanOnly remove one-time listeners.
Remove a post pipeline.
Pipeline name or instance.
This instance.
Reset both flip states to false.
This instance.
Reset pipeline.
OptionalresetData: booleanTrue to reset pipeline data.
True if reset.
Reset post pipelines.
OptionalresetData: booleanTrue to reset pipeline data.
Resize the text object.
Optionalwidth: numberWidth value.
Optionalheight: numberHeight value.
This instance.
Scroll to the bottom.
This instance.
Scroll to the top.
This 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.
True if this Game Object should be set as active, false if not.
Set alignment.
Optionalalign: "left" | "right" | "center"Horizontal alignment.
This instance.
Set alpha for each corner.
OptionaltopLeft: numberAlpha for top-left.
OptionaltopRight: numberAlpha for top-right.
OptionalbottomLeft: numberAlpha for bottom-left.
OptionalbottomRight: numberAlpha for bottom-right.
This instance.
Set angle in degrees.
Optionaldegrees: numberAngle in degrees.
This instance.
Set background colors and gradient direction.
Optionalcolor: string | number | nullPrimary background color.
Optionalcolor2: string | number | nullSecondary background color.
OptionalisHorizontalGradient: booleanTrue for horizontal gradient.
This instance.
Set background corner radius.
Optionalradius: numberCorner radius.
Optionaliteration: numberCorner iteration.
This instance.
Set background stroke color and width.
Optionalcolor: string | number | nullStroke color.
OptionallineWidth: numberStroke width.
This instance.
Set text color.
Optionalcolor: string | number | nullColor value.
This instance.
Set a crop rectangle.
Optionalx: number | RectangleX or a rectangle.
Optionaly: numberY value.
Optionalwidth: numberCrop width.
Optionalheight: numberCrop height.
This 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.
The key to set the value for. Or an object of key value pairs. If an object the data argument is ignored.
Optionaldata: anyThe value to set for the given key. If an object is provided as the key this argument is ignored.
Adds a Data Manager component to this Game Object.
Set depth value.
Depth value.
This instance.
Set display origin.
Optionalx: numberDisplay origin x.
Optionaly: numberDisplay origin y.
This instance.
Set display size.
Display width.
Display height.
This instance.
Set fill color.
Optionalcolor: string | number | nullColor value.
This instance.
Set fixed size.
Optionalwidth: numberFixed width.
Optionalheight: numberFixed height.
This instance.
Set both horizontal and vertical flip states.
True to flip horizontally.
True to flip vertically.
This instance.
Set horizontal flip state.
True to flip horizontally.
This instance.
Set vertical flip state.
True to flip vertically.
This instance.
Set font configuration.
Font configuration.
This instance.
Set font family.
Font family name.
This instance.
Set font size.
Font size.
This instance.
Set font style.
Font style string.
This instance.
Set horizontal alignment.
Optionalalign: "left" | "right" | "center"Horizontal alignment.
This 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.
OptionalhitArea: anyEither 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.
Optionalcallback: HitAreaCallbackThe 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.
OptionaldropZone: booleanShould this Game Object be treated as a drop zone target? Default false.
Set letter spacing.
Letter spacing value.
This instance.
Set line spacing.
Line spacing value.
This instance.
Set maximum line count.
Optionalmax: numberMax lines.
This 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.
The name to be given to this Game Object.
Set origin.
Optionalx: numberOrigin x.
Optionaly: numberOrigin y.
This instance.
Set origin from frame data.
This instance.
Set padding.
Optionalleft: number | { bottom?: number; left?: number; right?: number; top?: number }Left padding or padding object.
Optionalbottom?: numberBottom padding.
Optionalleft?: numberLeft padding.
Optionalright?: numberRight padding.
Optionaltop?: numberTop padding.
Optionaltop: numberTop padding.
Optionalright: numberRight padding.
Optionalbottom: numberBottom padding.
This instance.
Set the pipeline.
Pipeline key or instance.
OptionalpipelineData: objectOptional pipeline data.
OptionalcopyData: booleanTrue to copy data.
This instance.
Set pipeline data value.
Data key.
Optionalvalue: anyData value.
This instance.
Set position.
Optionalx: numberX position.
Optionaly: numberY position.
Optionalz: numberZ position.
Optionalw: numberW position.
This instance.
Set post pipelines.
Pipeline(s) to set.
OptionalpipelineData: objectOptional pipeline data.
OptionalcopyData: booleanTrue to copy data.
This instance.
Set post pipeline data value.
Data key.
Optionalvalue: anyData value.
This instance.
Set a random position within a rectangle.
Optionalx: numberX origin.
Optionaly: numberY origin.
Optionalwidth: numberWidth range.
Optionalheight: numberHeight range.
This instance.
Set render resolution.
Resolution value.
This instance.
Set rotation in radians.
Optionalradians: numberRotation in radians.
This instance.
Enable or disable RTL layout.
Optionalrtl: booleanTrue to enable RTL.
This instance.
Set scale.
Scale x.
Optionaly: numberScale y.
This instance.
Set scroll factor.
Scroll factor x.
Optionaly: numberScroll factor y.
This instance.
Set vertical scroll offset.
Offset value.
Optionalclamp: booleanTrue to clamp within bounds.
This instance.
Set shadow properties.
Optionalx: numberShadow offset x.
Optionaly: numberShadow offset y.
Optionalcolor: string | number | nullShadow color.
Optionalblur: numberShadow blur.
OptionalshadowStroke: booleanTrue to apply to stroke.
OptionalshadowFill: booleanTrue to apply to fill.
This instance.
Set shadow blur.
Blur value.
This instance.
Set shadow color.
Optionalcolor: string | number | nullShadow color.
This instance.
Enable or disable shadow on fill.
Optionalenabled: booleanTrue to enable.
This instance.
Set shadow offset.
Offset x.
Offset y.
This instance.
Enable or disable shadow on stroke.
Optionalenabled: booleanTrue to enable.
This instance.
Set size.
Optionalwidth: numberWidth value.
Optionalheight: numberHeight value.
This 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.
The state of the Game Object.
Set strikethrough color, thickness, and offset.
Optionalcolor: string | number | nullStrikethrough color.
Optionalthickness: numberStrikethrough thickness.
Optionalofset: numberStrikethrough offset.
This instance.
Set strikethrough color.
Optionalcolor: string | number | nullStrikethrough color.
This instance.
Set strikethrough offset.
Strikethrough offset.
This instance.
Set strikethrough thickness.
Strikethrough thickness.
This instance.
Set stroke color and thickness.
Optionalcolor: string | number | nullStroke color.
Optionalthickness: numberStroke thickness.
This instance.
Set normalized vertical scroll position.
Normalized value.
Optionalclamp: booleanTrue to clamp within bounds.
This instance.
Set test string used for measurements.
Test string.
This instance.
Set text content.
Text content.
This instance.
Set text metrics.
Metrics object.
Font configuration.
This instance.
Set corner tints.
OptionaltopLeft: numberTint for top-left.
OptionaltopRight: numberTint for top-right.
OptionalbottomLeft: numberTint for bottom-left.
OptionalbottomRight: numberTint for bottom-right.
This instance.
Set corner tints and enable fill.
OptionaltopLeft: numberTint for top-left.
OptionaltopRight: numberTint for top-right.
OptionalbottomLeft: numberTint for bottom-left.
OptionalbottomRight: numberTint for bottom-right.
This instance.
Set underline color, thickness, and offset.
Optionalcolor: string | number | nullUnderline color.
Optionalthickness: numberUnderline thickness.
Optionalofset: numberUnderline offset.
This instance.
Set underline color.
Optionalcolor: string | number | nullUnderline color.
This instance.
Set underline offset.
Underline offset.
This instance.
Set underline thickness.
Underline thickness.
This instance.
Set cursor for url tags.
Optionalcursor: stringCursor style.
This instance.
Set vertical alignment.
Optionalalign: "center" | "top" | "bottom"Vertical alignment.
This instance.
Set visibility.
True to show.
This instance.
Set w position.
Optionalvalue: numberW value.
This instance.
Set word wrap width.
Wrap width.
This instance.
Set wrap mode.
Wrap mode value.
This instance.
Set wrap width.
Wrap width.
This instance.
Set x position.
Optionalvalue: numberX value.
This instance.
Set x offset.
X offset value.
This instance.
Set y position.
Optionalvalue: numberY value.
This instance.
Set z position.
Optionalvalue: numberZ value.
This instance.
Removes all listeners.
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.
The key to toggle the value for.
Toggle horizontal flip.
This instance.
Toggle vertical flip.
This instance.
Returns a JSON representation of the Game Object.
To be overridden by custom GameObjects. Allows base objects to be used in a Pool.
args
Update display origin from size and origin.
Update text layout and rendering.
OptionalrunWrap: booleanTrue to re-run wrapping.
This instance.
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.
The Camera to check against this Game Object.
Tag text game object rendered on a canvas.