Types.GameObjects.NoiseSimplex3D
NoiseSimplex3DConfig
<static> NoiseSimplex3DConfig
| name | type | optional | default | description |
|---|---|---|---|---|
| config | string | Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig | Yes | The configuration object this NoiseSimplex3D will use. | |
| width | number | Yes | 128 | The width of the Game Object. |
| height | number | Yes | 128 | The height of the Game Object. |
Type: object
Member of: Phaser.Types.GameObjects.NoiseSimplex3D
Source: src/gameobjects/noise/noisesimplex3d/typedefs/NoiseSimplex3DConfig.js#L1
Since: 4.0.0
NoiseSimplex3DQuadConfig
<static> NoiseSimplex3DQuadConfig
| name | type | optional | default | description |
|---|---|---|---|---|
| noiseCells | Array.<number> | Yes | "[ 32, 32, 32 ]" | The number of cells in each dimension. |
| noisePeriod | Array.<number> | Yes | How many cells in each dimension before the pattern repeats. By default, this is the same as noiseCells. | |
| noiseOffset | Array.<number> | Yes | "[ 0, 0, 0 ]" | The offset of the noise texture. |
| noiseFlow | number | Yes | 0 | The initial flow of the noise field. Use this to evolve the field along a period. |
| noiseWarpAmount | number | Yes | 0 | How much turbulence to apply to the noise field. |
| noiseIterations | number | Yes | 1 | How many octaves of noise to render, creating a more detailed output. |
| noiseWarpIterations | number | Yes | 1 | How many octaves of noise to apply as turbulence, if noiseWarpAmount is greater than 0. |
| noiseNormalMap | boolean | Yes | false | Whether to convert the noise to a normal map. |
| noiseNormalScale | number | Yes | 1 | How much curvature to include in the normal map, if noiseNormalMap is enabled. |
| noiseColorStart | number | string | Array.<number> | Phaser.Display.Color | Yes |
| noiseColorEnd | number | string | Array.<number> | Phaser.Display.Color | Yes |
| noiseDetailPower | number | Yes | 2 | How much to increase detail per octave. |
| noiseFlowPower | number | Yes | 2 | How much to increase flow per octave. |
| noiseContributionPower | number | Yes | 2 | How much to shrink the contribution per octave. |
| noiseWarpDetailPower | number | Yes | 2 | How much to increase warp detail per octave. |
| noiseWarpFlowPower | number | Yes | 2 | How much to increase warp flow per octave. |
| noiseWarpContributionPower | number | Yes | 2 | How much to shrink the warp contribution per octave. |
| noiseValueFactor | number | Yes | 0.5 | How much to scale the noise value for output. |
| noiseValueAdd | number | Yes | 0.5 | How much to add to the noise value for output. |
| noiseValuePower | number | Yes | 1 | Exponent to apply to the noise value for output. |
| noiseSeed | Array.<number> | Yes | "[ 1, 2, 3 ]" | The hash seed. Each seed creates a different pattern. The numbers must be integers. |
Type: object
Member of: Phaser.Types.GameObjects.NoiseSimplex3D
Source: src/gameobjects/noise/noisesimplex3d/typedefs/NoiseSimplex3DQuadConfig.js#L1
Since: 4.0.0