name | type | arguments | Default | description |
---|---|---|---|---|
texture | string | Phaser.Textures.Texture |
The texture to be used for this Grid. Must be a Texture instance. Can also be a string but only if the |
||
frame | string | number | <optional> |
The name or index of the frame within the Texture. |
|
mesh | Phaser.GameObjects.Mesh | <optional> |
If specified, the vertices of the generated grid will be added to this Mesh Game Object. |
|
width | number | <optional> | 1 |
The width of the grid in 3D units. If you wish to get a pixel accurate grid based on a texture, you can use an Ortho Mesh or the |
height | number | <optional> | width |
The height of the grid in 3D units. |
widthSegments | number | <optional> | 1 |
The number of segments to split the grid horizontally in to. |
heightSegments | number | <optional> | widthSegments |
The number of segments to split the grid vertically in to. |
x | number | <optional> | 0 |
Offset the grid x position by this amount. |
y | number | <optional> | 0 |
Offset the grid y position by this amount. |
colors | number | Array.<number> | <optional> | 0xffffff |
An array of colors, one per vertex, or a single color value applied to all vertices. |
alphas | number | Array.<number> | <optional> | 1 |
An array of alpha values, one per vertex, or a single alpha value applied to all vertices. |
tile | boolean | <optional> | false |
Should the texture tile (repeat) across the grid segments, or display as a single texture? |
isOrtho | boolean | <optional> | false |
If set and using a texture with an ortho Mesh, the |
flipY | boolean | <optional> | false |
If set and using a texture, vertically flipping render result. |