Skip to main content
Version: Phaser v4.0.0

Types.GameObjects.NoiseCell2D

NoiseCell2DConfig

<static> NoiseCell2DConfig

nametypeoptionaldefaultdescription
configstring | Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfigYesThe configuration object this NoiseCell2D will use.
widthnumberYes128The width of the Game Object.
heightnumberYes128The height of the Game Object.

Type: object

Member of: Phaser.Types.GameObjects.NoiseCell2D

Source: src/gameobjects/noise/noisecell2d/typedefs/NoiseCell2DConfig.js#L1
Since: 4.0.0


NoiseCell2DQuadConfig

<static> NoiseCell2DQuadConfig

nametypeoptionaldefaultdescription
noiseCellsArray.<number>Yes"[ 32, 32 ]"The number of cells in each dimension.
noiseWrapArray.<number>YesHow many cells in each dimension before the pattern repeats. noiseCells must be integers for this to work properly. By default, this is the same as noiseCells.
noiseOffsetArray.<number>Yes"[ 0, 0 ]"The offset of the noise texture.
noiseVariationArray.<number>Yes"[ 1, 1 ]"The variation of the cells away from a perfect grid.
noiseIterationsnumberYes1How many octaves of noise to render, creating a more detailed output.
noiseModenumberYes0Which mode to render. 0 is sharp edged cells. 1 is flat colored cells. 2 is soft edged cells.
noiseSmoothingnumberYes1How smooth to render in mode 2.
noiseNormalMapbooleanYesfalseWhether to convert the noise to a normal map.
noiseNormalScalenumberYes1How much curvature to include in the normal map, if noiseNormalMap is enabled.
noiseColorStartnumber | stringArray.<number>Phaser.Display.ColorYes
noiseColorEndnumber | stringArray.<number>Phaser.Display.ColorYes
noiseSeedArray.<number>Yes"[ 1, 2, 3, 4, 5, 6, 7, 8 ]"The seed which determines the cell pattern. A different seed creates an entirely different pattern.

Type: object

Member of: Phaser.Types.GameObjects.NoiseCell2D

Source: src/gameobjects/noise/noisecell2d/typedefs/NoiseCell2DQuadConfig.js#L1
Since: 4.0.0