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 value is clamped to the range [0, 1]. Setting alpha to 0 also clears the render flag, preventing the Game Object from being drawn until the alpha is raised above 0 again.
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 with 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.
A reference to the HTML Cache.
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:
Current cursor position.
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.
ReadonlydisplayThe computed display height of this Game Object, based on the getBoundingClientRect DOM call.
The property height holds the un-scaled height of this DOM Element.
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, expressed in pixels.
Unlike originX, which is a normalized value between 0 and 1, the display origin is the
calculated pixel offset derived from the Game Object's width multiplied by its originX value.
Setting this property updates originX accordingly.
The vertical display origin of this Game Object, expressed in pixels.
Unlike originY, which is a normalized value between 0 and 1, the display origin is the
calculated pixel offset derived from the Game Object's height multiplied by its originY value.
Setting this property updates originY accordingly.
ReadonlydisplayThe computed display width of this Game Object, based on the getBoundingClientRect DOM call.
The property width holds the un-scaled width of this DOM Element.
The Camera used for filters. You can use this to alter the perspective of filters. It is not necessary to use this camera for ordinary rendering.
This is only available if you use the enableFilters method.
ReadonlyfiltersThe filter lists for this Game Object.
This is an object with internal and external properties.
Each list is a Phaser.GameObjects.Components.FilterList object.
This is only available if you use the enableFilters method.
Whether filterCamera should update every frame
to focus on the Game Object.
Disable this if you want to manually control the camera.
Whether the filters should focus on the context, rather than attempt to focus on the Game Object. This is enabled automatically when enabling filters on objects which don't have well-defined bounds.
This effectively sets the internal filters to render the same way as the external filters.
This is only used if filtersAutoFocus is enabled.
The "context" is the framebuffer to which the Game Object is rendered. This is usually the main framebuffer, but might be another framebuffer. It can even be several different framebuffers if the Game Object is rendered multiple times.
Whether the Filters component should always draw to a framebuffer, even if there are no active filters.
Current font color.
ReadonlyhasA property indicating that a Game Object has this component.
ReadonlyheightThe native (un-scaled) height of this Game Object.
For a DOM Element this property is read-only.
The property displayHeight holds the computed bounds of this DOM Element, factoring in scaling.
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().
ReadonlyinputCurrent input type attribute.
ReadonlyisWhether this Game Object has been destroyed. Check this property to avoid bugs caused by calling methods on a destroyed Game Object, e.g. in a Tween or Timer.
This is a read-only property that is automatically set to true
when the Game Object is destroyed.
You should not set this property directly.
It is set before preDestroy is called or the DESTROY event is emitted.
ReadonlyisTrue when input element is focused.
The maximum size of the base filter texture. Filters may use a larger texture after the base texture is rendered. The maximum texture size is at least 4096 in WebGL, based on the hardware. You may set this lower to save memory or prevent resizing.
Current maximum length.
Current minimum length.
The name of this Game Object. Empty by default and never populated by Phaser, this is left for developers to use.
The actual DOM Element that this Game Object is bound to. For example, if you've created a <div>
then this property is a direct reference to that element within the dom.
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.
Set this value with setOrigin().
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.
Set this value with setOrigin().
A reference to the parent DOM Container that the Game instance created when it started.
The parent Container of this Game Object, if it has one.
The perspective CSS property value of the parent DOM Container. This determines the distance between the z=0 plane and the user in order to give a 3D-positioned element some perspective. Each 3D element with z > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined by the value of this property.
For more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective
Changing this value changes it globally for all DOM Elements, as they all share the same parent container.
Current placeholder text.
Sets the CSS pointerEvents attribute on the DOM Element during rendering.
This is 'auto' by default. Changing it may have unintended side-effects with internal Phaser input handling, such as dragging, so only change this if you understand the implications.
Whether any filters should be rendered on this Game Object.
This is true by default, even if there are no filters yet.
Disable this to skip filter rendering.
Use willRenderFilters() to see if there are any active filters.
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.
A Vector4 that contains the 3D rotation of this DOM Element around a fixed axis in 3D space.
The x, y, and z components define the direction of the rotation axis. The w component holds the
angle of rotation, in the unit defined by the rotate3dAngle property (degrees by default).
For more details see the following MDN page:
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d
The unit that represents the 3D rotation values. By default this is deg for degrees, but can
be changed to any supported unit. See this page for further details:
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d
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 into 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 into 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.
ReadonlyselectedCurrently selected text.
ReadonlyselectionSelection end index.
ReadonlyselectionSelection start index.
The angle, in radians, by which to skew the DOM Element on the horizontal axis.
The angle, in radians, by which to skew the DOM Element on the vertical axis.
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.
Current text value.
Current tooltip text.
By default a DOM Element will have its transform, display, opacity, zIndex and blend mode properties
updated when its rendered. If, for some reason, you don't want any of these changed other than the
CSS transform, then set this flag to true. When true only the CSS Transform is applied and it's
up to you to keep track of and set the other properties as required.
This can be handy if, for example, you've a nested DOM Element and you don't want the opacity to be picked-up by any of its children.
A textual representation of this Game Object, i.e. sprite.
Used internally by Phaser but is available for your own custom classes to populate.
The current vertex rounding mode of this Game Object. This is used by the WebGL Renderer to determine how to round the vertex positions. It can have several values:
off - No rounding is applied.safe - Rounding is applied if the object is 'safe'.safeAuto - Rounding is applied if the object is 'safe' and the camera has roundPixels enabled.full - Rounding is always applied.fullAuto - Rounding is always applied if the camera has roundPixels enabled.A 'safe' object is one that is not rotated or scaled by any transform matrix while rendering. The effective transform is a simple translation. In such cases, rounding will affect all vertices the same way.
Using full rounding can cause vertices to wobble, because they might not be aligned to the pixel grid. Full rounding gives a janky look like PS1 games.
You can use other values if you want to create your own custom rounding modes.
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.
ReadonlywidthThe native (un-scaled) width of this Game Object.
For a DOM Element this property is read-only.
The property displayWidth holds the computed bounds of this DOM Element, factoring in scaling.
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.
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 overridden 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.
Adds one or more native DOM event listeners onto the underlying Element of this Game Object. The event is then dispatched via this Game Objects standard event emitter.
For example:
var div = this.add.dom(x, y, element);
div.addListener('click');
div.on('click', handler);
The DOM event/s to listen for. You can specify multiple events by separating them with spaces.
This DOM Element instance.
Adds a render step function to this Game Object's WebGL render pipeline.
The first render step in _renderSteps is run first.
It should call the next render step in the list.
This allows render steps to control the rendering flow.
The render step function to add.
Optionalindex: number
The index in the render list to add the step to. Omit to add to the end.
This Game Object 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 temporarily
disable it from rendering, consider using the setVisible method, instead.
OptionaldisplayList: DisplayList | Layer
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: time and delta.
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.undefined
This Game Object.
Clears the alpha value associated with this Game Object.
Immediately sets the alpha back to 1 (fully opaque).undefined
This Game Object instance.
Copies an object's coordinates to this Game Object's position.
An object with numeric 'x', 'y', 'z', or 'w' properties. Undefined values are not copied.
This Game Object instance.
Creates a native DOM Element, adds it to the parent DOM Container and then binds it to this Game Object,
so you can control it. The tagName should be a string and is passed to document.createElement:
this.add.dom().createElement('div');
For more details on acceptable tag names see: https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement
You can also pass in a DOMString or style object to set the CSS on the created element, and an optional innerText
value as well. Here is an example of a DOMString:
this.add.dom().createElement('div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');
And using a style object:
var style = {
'background-color': 'lime';
'width': '200px';
'height': '100px';
'font': '48px Arial';
};
this.add.dom().createElement('div', style, 'Phaser');
If this Game Object already has an Element, it is removed from the DOM entirely first. Any event listeners you may have previously created will need to be re-created after this call.
A string that specifies the type of element to be created. The nodeName of the created element is initialized with the value of tagName. Don't use qualified names (like "html:a") with this method.
Optionalstyle: any
Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be read from.
OptionalinnerText: string
A DOMString that holds the text that will be set as the innerText of the created element.
This DOM Element instance.
Takes a block of html from the HTML Cache, that has previously been preloaded into the game, and then
creates a DOM Element from it. The loaded HTML is set as the innerHTML property of the created
element.
Assume the following html is stored in a file called loginform.html:
Which is loaded into your game using the cache key 'login':
this.load.html('login', 'assets/loginform.html');
You can create a DOM Element from it using the cache key:
this.add.dom().createFromCache('login');
The optional elementType argument controls the container that is created, into which the loaded html is inserted.
The default is a plain div object, but any valid tagName can be given.
If this Game Object already has an Element, it is removed from the DOM entirely first. Any event listeners you may have previously created will need to be re-created after this call.
The key of the html cache entry to use for this DOM Element.
OptionaltagName: string
The tag name of the element into which all of the loaded html will be inserted. Defaults to a plain div tag. Default 'div'.
This DOM Element instance.
Takes a string of html and then creates a DOM Element from it. The HTML is set as the innerHTML
property of the created element.
let form = `
<input type="text" name="nameField" placeholder="Enter your name" style="font-size: 32px">
<input type="button" name="playButton" value="Let's Play" style="font-size: 32px">
`;
You can create a DOM Element from it using the string:
this.add.dom().createFromHTML(form);
The optional elementType argument controls the type of container that is created, into which the html is inserted.
The default is a plain div object, but any valid tagName can be given.
If this Game Object already has an Element, it is removed from the DOM entirely first. Any event listeners you may have previously created will need to be re-created after this call.
A string of html to be set as the innerHTML property of the created element.
OptionaltagName: string
The tag name of the element into which all of the html will be inserted. Defaults to a plain div tag. Default 'div'.
This DOM Element instance.
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: boolean
True 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: boolean
Should the currently active Input cursor, if any, be reset to the default cursor? Default false.
This GameObject.
Calls each of the listeners registered for a given event.
The event name.
Additional arguments that will be passed to the event handler.
true if the event had listeners, else false.
Enable this Game Object to have filters.
You need to call this method if you want to use the filterCamera
and filters properties. It sets up the necessary data structures.
You may disable filter rendering with the renderFilters property.
This is a WebGL only feature. It will return early if not available.undefined
undefined
Return an array listing the events for which the emitter has registered listeners.undefined
undefined
Focus the filter camera.
This sets the size and position of the filter camera to match the GameObject.
This is called automatically on render if filtersAutoFocus is enabled.
This will focus on the GameObject's raw dimensions if available. If the GameObject has no dimensions, this will focus on the context: the camera belonging to the DrawingContext used to render the GameObject. Context focus occurs during rendering, as the context is not known until then.undefined
undefined
Focus the filter camera on a specific camera.
This is used internally when filtersFocusContext is enabled.
The camera to focus on.
undefined
Manually override the focus of the filter camera.
This allows you to set the size and position of the filter camera manually.
It deactivates filtersAutoFocus when called.
The camera will set scroll to place the game object at the
given position within a rectangle of the given width and height.
For example, calling focusFiltersOverride(400, 200, 800, 600)
will focus the camera to place the object's center
100 pixels above the center of the camera (which is at 400x300).
Optionalx: number
The x-coordinate of the focus point, relative to the filter size. Default is the center.
Optionaly: number
The y-coordinate of the focus point, relative to the filter size. Default is the center.
Optionalwidth: number
The width of the focus area. Default is the filter width.
Optionalheight: number
The height of the focus area. Default is the filter height.
undefined
Gets all children from this DOM Elements node, using querySelectorAll('*') and then iterates through
them, looking for the first one that has a matching id. It then returns this child if found, or null if not.
Be aware that class and id names are case-sensitive.
The id to search the children for.
The first matching child DOM Element, or null if not found.
Gets all children from this DOM Elements node, using querySelectorAll('*') and then iterates through
them, looking for the first one that has a matching name. It then returns this child if found, or null if not.
Be aware that class and id names are case-sensitive.
The name to search the children for.
The first matching child DOM Element, or null if not found.
Gets all children from this DOM Elements node, using querySelectorAll('*') and then iterates through
them, looking for the first one that has a property matching the given key and value. It then returns this child
if found, or null if not.
The property to search the children for.
The value the property must strictly equal.
The first matching child DOM Element, or null if not found.
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.
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.undefined
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.undefined
An array of display list position indexes.
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.
The translated point.
Gets the local transform matrix for this Game Object.
OptionaltempMatrix: TransformMatrix
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 Object's parent Containers.
The returned value is in radians and will be zero if this Game Object has no parent container.undefined
The sum total rotation, in radians, of all parent containers of this Game Object.
Get computed style value by key.
Style property name.
Style value.
Gets the world position of this Game Object, factoring in any parent Containers.
Optionalpoint: Vector2
A Vector2, or point-like object, to store the result in.
OptionaltempMatrix: TransformMatrix
A temporary matrix to hold the Game Object's values.
OptionalparentMatrix: TransformMatrix
A temporary matrix to hold parent values.
The world position of this Game Object.
Gets the world transform matrix for this Game Object, factoring in any parent Containers.
OptionaltempMatrix: TransformMatrix
The matrix to populate with the values from this Game Object.
OptionalparentMatrix: TransformMatrix
A temporary matrix to hold parent values during the calculations.
The populated Transform Matrix.
Increase a value for the given key within this Game Object's Data Manager. If the key doesn't already exist in the Data Manager then it is created with a value of 0 before being increased.
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: number
The amount to increase the given key by. Pass a negative value to decrease the key. Default 1.
This GameObject.
Return the number of listeners listening to a given event.
The event name.
The number of listeners.
Return the listeners registered for a given event.
The event name.
The registered listeners.
Remove the listeners of a given event.
The event name.
Optionalfn: Function
Only remove the listeners that match this function.
Optionalcontext: any
Only remove the listeners that have this context.
Optionalonce: boolean
Only remove one-time listeners.
this.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Add a one-time listener for a given event. The listener is automatically removed the first time the event is emitted, so it will never be called more than once.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Remove all listeners, or those of the specified event.
Optionalevent: string | symbol
The event name.
this.
This callback is invoked when this Game Object is removed from a Scene.
Can be overridden by custom Game Objects, but be aware of some Game Objects that will use this, such as Sprites, to remove themselves from the Update List.
You can also listen for the REMOVED_FROM_SCENE event from this Game Object.
Removes the current DOM Element bound to this Game Object from the DOM entirely and resets the
node property of this Game Object to be null.undefined
This DOM Element instance.
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 be 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 temporarily
disable it from rendering, consider using the setVisible method, instead.undefined
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.undefined
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.)
OptionalresetCursor: boolean
Should the currently active Input cursor, if any, be reset to the default cursor? Default false.
This GameObject.
Removes one or more native DOM event listeners from the underlying Element of this Game Object.
The DOM event/s to stop listening for. You can specify multiple events by separating them with spaces.
This DOM Element instance.
Render this object using filters.
This function's scope is not guaranteed, so it doesn't refer to this.
The WebGL Renderer instance to render with.
The Game Object being rendered.
The current drawing context.
OptionalparentMatrix: TransformMatrix
The parent matrix of the Game Object, if it has one.
OptionalrenderStep: number
The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions. Default 0.
undefined
Run a step in the render process. This is called automatically by the Render module.
In most cases, it just runs the renderWebGL function.
When _renderSteps has more than one entry,
such as when Filters are enabled for this object,
it allows those processes to defer renderWebGL
and otherwise manage the flow of rendering.
The WebGL Renderer instance to render with.
The Game Object being rendered.
The current drawing context.
OptionalparentMatrix: TransformMatrix
The parent matrix of the Game Object, if it has one.
OptionalrenderStep: number
Which step of the rendering process should be run? Default 0.
OptionaldisplayList: GameObject[]
The display list which is currently being rendered. If not provided, it will be created with the Game Object.
OptionaldisplayListIndex: number
The index of the Game Object within the display list. Default 0.
Resize DOM input element.
New width.
New height.
This input text instance.
Scroll input to bottom.
This input text instance.
Select all text.
This input text instance.
Select text range.
OptionalselectionStart: number
Start index.
OptionalselectionEnd: number
End index.
This input text instance.
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.
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.
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.
Optionalvalue: number
The alpha value applied across the whole Game Object. Default 1.
This Game Object instance.
Sets the angle of this Game Object.
Optionaldegrees: number
The rotation of this Game Object, in degrees. Default 0.
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.
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 with which blend modes are used.
The BlendMode value. Either a string, a CONST or a number.
This Game Object instance.
Blur input element.
This input text instance.
Sets the className property of the DOM Element node and updates the internal sizes.
A string representing the class or space-separated classes of the element.
This DOM Element instance.
Set cursor position.
Cursor index.
This input text 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.
Optionalvalue: any
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.undefined
This GameObject.
Sets the depth of this Game Object. If the value argument is not provided, the depth defaults to 0.
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.
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 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.
Optionalx: number
The horizontal display origin value. Default 0.
Optionaly: number
The vertical display origin value. If not defined it will be set to the value of x. Default x.
This Game Object instance.
Binds a new DOM Element to this Game Object. If this Game Object already has an Element it is removed from the DOM entirely first. Any event listeners you may have previously created will need to be re-created on the new element.
The element argument you pass to this method can be either a string tagName:
<h1 id="heading">Phaser</h1>
this.add.dom().setElement('heading');
Or a reference to an Element instance:
<h1 id="heading">Phaser</h1>
var h1 = document.getElementById('heading');
this.add.dom().setElement(h1);
You can also pass in a DOMString or style object to set the CSS on the created element, and an optional innerText
value as well. Here is an example of a DOMString:
this.add.dom().setElement(h1, 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');
And using a style object:
var style = {
'background-color': 'lime';
'width': '200px';
'height': '100px';
'font': '48px Arial';
};
this.add.dom().setElement(h1, style, 'Phaser');
If a string it is passed to getElementById(), or it should be a reference to an existing Element.
Optionalstyle: any
Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be read from.
OptionalinnerText: string
A DOMString that holds the text that will be set as the innerText of the created element.
This DOM Element instance.
Sets whether the filter camera should automatically re-focus on the Game Object every frame.
Sets the filtersAutoFocus property.
Whether filters should be updated every frame.
undefined
Set whether the filters should focus on the context.
Sets the filtersFocusContext property.
Whether the filters should focus on the context.
undefined
Set whether the filters should always draw to a framebuffer.
Sets the filtersForceComposite property.
Whether the object should always draw to a framebuffer, even if there are no active filters.
undefined
Set the base size of the filter camera. This is the size of the texture that internal filters will be drawn to. External filters are drawn to the size of the context (usually the game canvas).
This is typically the size of the GameObject.
It is set automatically when the Game Object is rendered
and filtersAutoFocus is enabled.
Turn off auto focus to set it manually.
Technically, larger framebuffers may be used to provide padding. This is the size of the final framebuffer used for "internal" rendering.
Base width of the filter texture.
Base height of the filter texture.
undefined
Focus input element.
This input text instance.
Set font color.
CSS color value.
This input text instance.
Sets the innerHTML property of the DOM Element node and updates the internal sizes.
A DOMString of html to be set as the innerHTML property of the element.
This DOM Element 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: any
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.
Optionalcallback: HitAreaCallback
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.
OptionaldropZone: boolean
Should this Game Object be treated as a drop zone target? Default false.
This GameObject.
Set maximum text length.
Maximum length.
This input text instance.
Set minimum text length.
Minimum length.
This input text 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.
This GameObject.
Sets the origin of this Game Object.
The values are given in the range 0 to 1.
Optionalx: number
The horizontal origin value. Default 0.5.
Optionaly: number
The vertical origin value. If not defined it will be set to the value of x. Default x.
This Game Object instance.
Sets the origin of this Game Object based on the Pivot values in its Frame.
If the Frame has a custom pivot point defined, the origin is set to match it.
If the Frame does not have a custom pivot, this method falls back to setOrigin(),
resetting the origin to the default value of 0.5 for both axes.undefined
This Game Object instance.
Sets the perspective CSS property of the parent DOM Container. This determines the distance between the z=0 plane and the user in order to give a 3D-positioned element some perspective. Each 3D element with z > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined by the value of this property.
For more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective
Changing this value changes it globally for all DOM Elements, as they all share the same parent container.
The perspective value, in pixels, that determines the distance between the z plane and the user.
This DOM Element instance.
Set placeholder text.
Placeholder string.
This input text instance.
Sets the position of this Game Object.
Optionalx: number
The x position of this Game Object. Default 0.
Optionaly: number
The y position of this Game Object. If not set it will use the x value. Default x.
Optionalz: number
The z position of this Game Object. Default 0.
Optionalw: number
The w position of this Game Object. Default 0.
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.
Optionalx: number
The x position of the top-left of the random area. Default 0.
Optionaly: number
The y position of the top-left of the random area. Default 0.
Optionalwidth: number
The width of the random area.
Optionalheight: number
The height of the random area.
This Game Object instance.
Set whether the filters should be rendered.
Sets the renderFilters property.
Whether the filters should be rendered.
undefined
Sets the rotation of this Game Object.
Optionalradians: number
The rotation of this Game Object, in radians. Default 0.
This Game Object instance.
Sets the scale of this Game Object.
Optionalx: number
The horizontal scale of this Game Object. Default 1.
Optionaly: number
The vertical scale of this Game Object. If not set it will use the x value. Default x.
This Game Object instance.
Sets the horizontal and vertical scroll factor of this Game Object. If only the x value is
provided, it is applied to both axes. This is a convenience method for setting scrollFactorX
and scrollFactorY in a single call.
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 into 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 horizontal scroll factor of this Game Object.
Optionaly: number
The vertical scroll factor of this Game Object. If not set it will use the x value. Default x.
This Game Object instance.
Sets the horizontal and vertical skew values of this DOM Element.
For more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/transform
Optionalx: number
The angle, in radians, by which to skew the DOM Element on the horizontal axis. Default 0.
Optionaly: number
The angle, in radians, by which to skew the DOM Element on the vertical axis. Default x.
This DOM Element 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.
This GameObject.
Set style value by key.
Style property name.
Optionalvalue: string | number
Style property value.
This input text instance.
Set text value.
Text to assign.
This input text 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.undefined
This Game Object instance.
Set tooltip text.
Tooltip string.
This input text 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.undefined
This Game Object instance.
Sets the vertex round mode of this Game Object. This is used by the WebGL Renderer to determine how to round the vertex positions.
The vertex round mode to set. Can be 'off', 'safe', 'safeAuto', 'full' or 'fullAuto'.
This GameObject.
Sets the visibility of this Game Object.
An invisible Game Object will skip rendering, but will still process update logic.
The visible state of the Game Object.
This Game Object instance.
Sets the w position of this Game Object.
Optionalvalue: number
The w position of this Game Object. Default 0.
This Game Object instance.
Sets the x position of this Game Object.
Optionalvalue: number
The x position of this Game Object. Default 0.
This Game Object instance.
Sets the y position of this Game Object.
Optionalvalue: number
The y position of this Game Object. Default 0.
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.
Optionalvalue: number
The z position of this Game Object. Default 0.
This Game Object instance.
Removes all listeners from this EventEmitter. This method is called automatically by the Scene Systems when the parent Scene shuts down, ensuring that all event bindings are cleared and no stale references remain.
Toggle a boolean value for the given key within this Game Object's Data Manager. If the key doesn't already exist in the Data Manager then it is created with a value of false before being toggled to true.
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.
This GameObject.
Returns a JSON representation of the Game Object.undefined
A JSON representation of the Game Object.
Override this method in your own custom Game Objects to perform per-frame update logic.
This method is called by the Scene's Update List on every game frame, if the Game Object
is on that list. It is not called automatically — the Game Object must be added to the
Update List via addToUpdateList or by having a preUpdate method.
This base implementation is intentionally empty, allowing Game Objects to be used in an Object Pool without requiring any update logic.
Any arguments that are passed to the update method.
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.undefined
This Game Object instance.
Internal method that sets the displayWidth and displayHeight properties, and the clientWidth
and clientHeight values into the width and height properties respectively.
This is called automatically whenever a new element is created or set.undefined
This DOM Element instance.
Compares the renderMask with the renderFlags to see if this Game Object will render or not.
DOMElements always return true as they need to still set values during the render pass, even if not visible.undefined
true if the Game Object should be rendered, otherwise false.
Whether this Game Object will render filters.
This is true if it has active filters,
and if the renderFilters property is also true.undefined
Whether the Game Object will render filters.
Checks if this Game Object should round its vertices,
based on the given Camera and the vertexRoundMode of this Game Object.
This is used by the WebGL Renderer to determine how to round the vertex positions.
You can override this method in your own custom Game Object classes to provide custom logic for vertex rounding.
The Camera to check against this Game Object.
If true, the object is only translated, not scaled or rotated.
True if the Game Object should be rounded, otherwise false.
DOM element wrapper for text input fields.