Phaser.GameObjects.Components.RenderNodes
Scope: static
Source: src/gameobjects/components/RenderNodes.js#L9
Since: 4.0.0
Static functions
customRenderNodes
customRenderNodes: object
Description:
Customized WebGL render nodes of this Game Object.
RenderNodes are responsible for managing the rendering process of this Game Object.
A default set of RenderNodes are coded into the engine,
but they will check here first to see if a custom one exists.
Tags:
- webglOnly
Source: src/gameobjects/components/RenderNodes.js#L17
Since: 4.0.0
defaultRenderNodes
defaultRenderNodes: object
Description:
The default RenderNodes for this Game Object.
RenderNodes are responsible for managing the rendering process of this Game Object.
These are the nodes that are used if no custom ones are set.
RenderNodes are identified by a unique key for their role.
Common role keys include:
-
'Submitter': responsible for running other node roles for each element.
-
'Transformer': responsible for providing vertex coordinates for an element.
-
'Texturer': responsible for handling textures for an element.
Tags:
- webglOnly
Source: src/gameobjects/components/RenderNodes.js#L30
Since: 4.0.0
renderNodeData
renderNodeData: object
Description:
An object to store render node specific data in, to be read by the render nodes this Game Object uses.
Render nodes store their data under their own name, not their role.
Tags:
- webglOnly
Source: src/gameobjects/components/RenderNodes.js#L50
Since: 4.0.0
Static functions
initRenderNodes
<instance> initRenderNodes(defaultNodes)
Description:
Initializes the render nodes for this Game Object.
This method is called when the Game Object is added to the Scene.
It is responsible for setting up the default render nodes
this Game Object will use.
Tags:
- webglOnly
Parameters:
| name | type | optional | description |
|---|---|---|---|
| defaultNodes | Map.<string, string> | No | The default render nodes to set for this Game Object. |
Source: src/gameobjects/components/RenderNodes.js#L62
Since: 4.0.0
setRenderNodeData
<instance> setRenderNodeData(renderNode, key, value)
Description:
Adds an entry to the renderNodeData object of this game object.
If key is not set, it is created. If it is set, it is updated.
If value is undefined and key exists, the key is removed.
Tags:
- webglOnly
Parameters:
| name | type | optional | description |
|---|---|---|---|
| renderNode | string | Phaser.Renderer.WebGL.RenderNodes.RenderNode | No | The render node to set the data for. If a string, it should be the name of the render node. |
| key | string | No | The key of the property to set. |
| value | * | No | The value to set the property to. |
Returns: Phaser.GameObjects.Components.RenderNodes - This Game Object instance.
Source: src/gameobjects/components/RenderNodes.js#L167
Since: 4.0.0
setRenderNodeRole
<instance> setRenderNodeRole(key, renderNode, [renderNodeData], [copyData])
Description:
Sets the RenderNode for a given role.
Also sets the relevant render node data object, if specified.
If the node cannot be set, no changes are made.
Tags:
- webglOnly
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| key | string | No | The key of the role to set the render node for. | |
| renderNode | string | Phaser.Renderer.WebGL.RenderNodes.RenderNode | null | No | |
| renderNodeData | object | Yes | An object to store render node specific data in, to be read by the render nodes this Game Object uses. | |
| copyData | boolean | Yes | false | Should the data be copied from the renderNodeData object? |
Returns: Phaser.GameObjects.Components.RenderNodes - This Game Object instance.
Source: src/gameobjects/components/RenderNodes.js#L101
Since: 4.0.0