mirror of
https://github.com/photonstorm/phaser
synced 2024-09-20 14:31:55 +00:00
Updated docs. Fix #5128
This commit is contained in:
Richard Davey
parent
dea68135fd
commit
64c58bc592
2 changed files with 113 additions and 110 deletions
|
|
@ -64,7 +64,7 @@
|
|||
|
||||
My thanks to the following for helping with the Phaser 3 Examples, Docs and TypeScript definitions, either by reporting errors, fixing them or helping author the docs:
|
||||
|
||||
@samme @SanderVanhove @SirJosh3917 @mooreInteractive @A-312 @lozzajp @mikewesthad @j-waters
|
||||
@samme @SanderVanhove @SirJosh3917 @mooreInteractive @A-312 @lozzajp @mikewesthad @j-waters @futuremarc
|
||||
|
||||
## Version 3.23 - Ginro - 27th April 2020
|
||||
|
||||
|
|
|
|||
|
|
@ -16,51 +16,54 @@ var Vector4 = require('../../math/Vector4');
|
|||
/**
|
||||
* @classdesc
|
||||
* DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.
|
||||
*
|
||||
*
|
||||
* In order for DOM Elements to display you have to enable them by adding the following to your game
|
||||
* configuration object:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* dom {
|
||||
* createContainer: true
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
*
|
||||
* When this is added, Phaser will automatically create a DOM Container div that is positioned over the top
|
||||
* of the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of
|
||||
* settings within the Scale Manager, the dom container is resized accordingly.
|
||||
*
|
||||
*
|
||||
* You can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing
|
||||
* Element that you wish to be placed under the control of Phaser. For example:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* this.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');
|
||||
* ```
|
||||
*
|
||||
*
|
||||
* The above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in
|
||||
* the 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,
|
||||
* it will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.
|
||||
*
|
||||
*
|
||||
* You should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control
|
||||
* alignment and positioning of the elements next to regular game content.
|
||||
*
|
||||
*
|
||||
* Rather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the
|
||||
* cache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other
|
||||
* methods available in this class to help construct your elements.
|
||||
*
|
||||
*
|
||||
* Once the element has been created you can then control it like you would any other Game Object. You can set its
|
||||
* position, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped
|
||||
* at the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that
|
||||
* they appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have
|
||||
* a DOM Element, then a Sprite, then another DOM Element behind it.
|
||||
*
|
||||
*
|
||||
* They also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event
|
||||
* listeners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas
|
||||
* entirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you
|
||||
* change the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.
|
||||
*
|
||||
*
|
||||
* Also, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.
|
||||
*
|
||||
*
|
||||
* Note that you should only have DOM Elements in a Scene with a _single_ Camera. If you require multiple cameras,
|
||||
* use parallel scenes to achieve this.
|
||||
*
|
||||
* DOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert
|
||||
* a login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.
|
||||
* Or a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and
|
||||
|
|
@ -111,7 +114,7 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* A reference to the parent DOM Container that the Game instance created when it started.
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#parent
|
||||
* @type {Element}
|
||||
* @since 3.17.0
|
||||
|
|
@ -120,7 +123,7 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* A reference to the HTML Cache.
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#cache
|
||||
* @type {Phaser.Cache.BaseCache}
|
||||
* @since 3.17.0
|
||||
|
|
@ -130,7 +133,7 @@ var DOMElement = new Class({
|
|||
/**
|
||||
* 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.
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#node
|
||||
* @type {Element}
|
||||
* @since 3.17.0
|
||||
|
|
@ -142,10 +145,10 @@ var DOMElement = new Class({
|
|||
* 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.
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#transformOnly
|
||||
* @type {boolean}
|
||||
* @since 3.17.0
|
||||
|
|
@ -154,9 +157,9 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* The angle, in radians, by which to skew the DOM Element on the horizontal axis.
|
||||
*
|
||||
*
|
||||
* https://developer.mozilla.org/en-US/docs/Web/CSS/transform
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#skewX
|
||||
* @type {number}
|
||||
* @since 3.17.0
|
||||
|
|
@ -165,9 +168,9 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* The angle, in radians, by which to skew the DOM Element on the vertical axis.
|
||||
*
|
||||
*
|
||||
* https://developer.mozilla.org/en-US/docs/Web/CSS/transform
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#skewY
|
||||
* @type {number}
|
||||
* @since 3.17.0
|
||||
|
|
@ -176,13 +179,13 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* A Vector4 that contains the 3D rotation of this DOM Element around a fixed axis in 3D space.
|
||||
*
|
||||
*
|
||||
* All values in the Vector4 are treated as degrees, unless the `rotate3dAngle` property is changed.
|
||||
*
|
||||
*
|
||||
* For more details see the following MDN page:
|
||||
*
|
||||
*
|
||||
* https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#rotate3d
|
||||
* @type {Phaser.Math.Vector4}
|
||||
* @since 3.17.0
|
||||
|
|
@ -192,9 +195,9 @@ var DOMElement = new Class({
|
|||
/**
|
||||
* 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
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#rotate3dAngle
|
||||
* @type {string}
|
||||
* @since 3.17.0
|
||||
|
|
@ -203,11 +206,11 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* The 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.
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#width
|
||||
* @type {number}
|
||||
* @readonly
|
||||
|
|
@ -217,11 +220,11 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* The 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.
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#height
|
||||
* @type {number}
|
||||
* @readonly
|
||||
|
|
@ -231,9 +234,9 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* The 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.
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#displayWidth
|
||||
* @type {number}
|
||||
* @readonly
|
||||
|
|
@ -243,9 +246,9 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* The 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.
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#displayHeight
|
||||
* @type {number}
|
||||
* @readonly
|
||||
|
|
@ -255,7 +258,7 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* Internal native event handler.
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#handler
|
||||
* @type {number}
|
||||
* @private
|
||||
|
|
@ -299,7 +302,7 @@ var DOMElement = new Class({
|
|||
{
|
||||
var node = this.node;
|
||||
var style = node.style;
|
||||
|
||||
|
||||
if (node)
|
||||
{
|
||||
style.display = (sys.settings.visible) ? 'block' : 'none';
|
||||
|
|
@ -308,7 +311,7 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* @method Phaser.GameObjects.DOMElement#setSkew
|
||||
|
|
@ -316,7 +319,7 @@ var DOMElement = new Class({
|
|||
*
|
||||
* @param {number} [x=0] - The angle, in radians, by which to skew the DOM Element on the horizontal axis.
|
||||
* @param {number} [y=x] - The angle, in radians, by which to skew the DOM Element on the vertical axis.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
setSkew: function (x, y)
|
||||
|
|
@ -335,16 +338,16 @@ var DOMElement = new Class({
|
|||
* 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.**
|
||||
*
|
||||
* @method Phaser.GameObjects.DOMElement#setPerspective
|
||||
* @since 3.17.0
|
||||
*
|
||||
* @param {number} value - The perspective value, in pixels, that determines the distance between the z plane and the user.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
setPerspective: function (value)
|
||||
|
|
@ -359,11 +362,11 @@ var DOMElement = new Class({
|
|||
* 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.**
|
||||
*
|
||||
*
|
||||
* @name Phaser.GameObjects.DOMElement#perspective
|
||||
* @type {number}
|
||||
* @since 3.17.0
|
||||
|
|
@ -385,14 +388,14 @@ var DOMElement = new Class({
|
|||
/**
|
||||
* 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:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* var div = this.add.dom(x, y, element);
|
||||
*
|
||||
*
|
||||
* div.addListener('click');
|
||||
*
|
||||
*
|
||||
* div.on('click', handler);
|
||||
* ```
|
||||
*
|
||||
|
|
@ -400,7 +403,7 @@ var DOMElement = new Class({
|
|||
* @since 3.17.0
|
||||
*
|
||||
* @param {string} events - The DOM event/s to listen for. You can specify multiple events by separating them with spaces.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
addListener: function (events)
|
||||
|
|
@ -425,7 +428,7 @@ var DOMElement = new Class({
|
|||
* @since 3.17.0
|
||||
*
|
||||
* @param {string} events - The DOM event/s to stop listening for. You can specify multiple events by separating them with spaces.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
removeListener: function (events)
|
||||
|
|
@ -460,22 +463,22 @@ var DOMElement = new Class({
|
|||
/**
|
||||
* 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`:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* 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:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* this.add.dom().createElement('div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');
|
||||
* ```
|
||||
*
|
||||
*
|
||||
* And using a style object:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* var style = {
|
||||
* 'background-color': 'lime';
|
||||
|
|
@ -483,10 +486,10 @@ var DOMElement = new Class({
|
|||
* '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.
|
||||
*
|
||||
|
|
@ -496,7 +499,7 @@ var DOMElement = new Class({
|
|||
* @param {string} tagName - 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.
|
||||
* @param {(string|any)} [style] - Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be ready from.
|
||||
* @param {string} [innerText] - A DOMString that holds the text that will be set as the innerText of the created element.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
createElement: function (tagName, style, innerText)
|
||||
|
|
@ -507,34 +510,34 @@ var DOMElement = new Class({
|
|||
/**
|
||||
* 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:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* <h1 id="heading">Phaser</h1>
|
||||
*
|
||||
* this.add.dom().setElement('heading');
|
||||
* ```
|
||||
*
|
||||
*
|
||||
* Or a reference to an Element instance:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* <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:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* this.add.dom().setElement(h1, 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');
|
||||
* ```
|
||||
*
|
||||
*
|
||||
* And using a style object:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* var style = {
|
||||
* 'background-color': 'lime';
|
||||
|
|
@ -542,7 +545,7 @@ var DOMElement = new Class({
|
|||
* 'height': '100px';
|
||||
* 'font': '48px Arial';
|
||||
* };
|
||||
*
|
||||
*
|
||||
* this.add.dom().setElement(h1, style, 'Phaser');
|
||||
* ```
|
||||
*
|
||||
|
|
@ -552,7 +555,7 @@ var DOMElement = new Class({
|
|||
* @param {(string|Element)} element - If a string it is passed to `getElementById()`, or it should be a reference to an existing Element.
|
||||
* @param {(string|any)} [style] - Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be ready from.
|
||||
* @param {string} [innerText] - A DOMString that holds the text that will be set as the innerText of the created element.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
setElement: function (element, style, innerText)
|
||||
|
|
@ -626,38 +629,38 @@ var DOMElement = new Class({
|
|||
* 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`:
|
||||
*
|
||||
*
|
||||
* ```html
|
||||
* <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">
|
||||
* ```
|
||||
*
|
||||
*
|
||||
* Which is loaded into your game using the cache key 'login':
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* this.load.html('login', 'assets/loginform.html');
|
||||
* ```
|
||||
*
|
||||
*
|
||||
* You can create a DOM Element from it using the cache key:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* 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.
|
||||
*
|
||||
* @method Phaser.GameObjects.DOMElement#createFromCache
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @param {string} The key of the html cache entry to use for this DOM Element.
|
||||
* @param {string} [tagName='div'] - The tag name of the element into which all of the loaded html will be inserted. Defaults to a plain div tag.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
createFromCache: function (key, tagName)
|
||||
|
|
@ -675,32 +678,32 @@ var DOMElement = new Class({
|
|||
/**
|
||||
* 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.
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* 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:
|
||||
*
|
||||
*
|
||||
* ```javascript
|
||||
* 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.
|
||||
*
|
||||
* @method Phaser.GameObjects.DOMElement#createFromHTML
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @param {string} A string of html to be set as the `innerHTML` property of the created element.
|
||||
* @param {string} [tagName='div'] - The tag name of the element into which all of the html will be inserted. Defaults to a plain div tag.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
createFromHTML: function (html, tagName)
|
||||
|
|
@ -738,7 +741,7 @@ var DOMElement = new Class({
|
|||
*
|
||||
* @method Phaser.GameObjects.DOMElement#removeElement
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
removeElement: function ()
|
||||
|
|
@ -757,12 +760,12 @@ var DOMElement = new Class({
|
|||
* Internal method that calls `getBoundingClientRect` on the `node` and then sets the bounds width
|
||||
* and height into 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.
|
||||
*
|
||||
* @method Phaser.GameObjects.DOMElement#updateSize
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
updateSize: function ()
|
||||
|
|
@ -787,10 +790,10 @@ var DOMElement = new Class({
|
|||
*
|
||||
* @method Phaser.GameObjects.DOMElement#getChildByProperty
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @param {string} property - The property to search the children for.
|
||||
* @param {string} value - The value the property must strictly equal.
|
||||
*
|
||||
*
|
||||
* @return {?Element} The first matching child DOM Element, or `null` if not found.
|
||||
*/
|
||||
getChildByProperty: function (property, value)
|
||||
|
|
@ -814,14 +817,14 @@ var DOMElement = new Class({
|
|||
/**
|
||||
* 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.
|
||||
*
|
||||
* @method Phaser.GameObjects.DOMElement#getChildByID
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @param {string} id - The id to search the children for.
|
||||
*
|
||||
*
|
||||
* @return {?Element} The first matching child DOM Element, or `null` if not found.
|
||||
*/
|
||||
getChildByID: function (id)
|
||||
|
|
@ -832,14 +835,14 @@ var DOMElement = new Class({
|
|||
/**
|
||||
* 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.
|
||||
*
|
||||
* @method Phaser.GameObjects.DOMElement#getChildByName
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @param {string} name - The name to search the children for.
|
||||
*
|
||||
*
|
||||
* @return {?Element} The first matching child DOM Element, or `null` if not found.
|
||||
*/
|
||||
getChildByName: function (name)
|
||||
|
|
@ -852,9 +855,9 @@ var DOMElement = new Class({
|
|||
*
|
||||
* @method Phaser.GameObjects.DOMElement#setClassName
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @param {string} className - A string representing the class or space-separated classes of the element.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
setClassName: function (className)
|
||||
|
|
@ -871,14 +874,14 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* Sets the `innerText` property of the DOM Element node and updates the internal sizes.
|
||||
*
|
||||
*
|
||||
* Note that only certain types of Elements can have `innerText` set on them.
|
||||
*
|
||||
* @method Phaser.GameObjects.DOMElement#setText
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @param {string} text - A DOMString representing the rendered text content of the element.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
setText: function (text)
|
||||
|
|
@ -898,9 +901,9 @@ var DOMElement = new Class({
|
|||
*
|
||||
* @method Phaser.GameObjects.DOMElement#setHTML
|
||||
* @since 3.17.0
|
||||
*
|
||||
*
|
||||
* @param {string} html - A DOMString of html to be set as the `innerHTML` property of the element.
|
||||
*
|
||||
*
|
||||
* @return {this} This DOM Element instance.
|
||||
*/
|
||||
setHTML: function (html)
|
||||
|
|
@ -935,7 +938,7 @@ var DOMElement = new Class({
|
|||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @method Phaser.GameObjects.DOMElement#willRender
|
||||
|
|
|
|||
Loading…
Reference in a new issue