ColorSampler#
*Config object requires the ‘library-image’ addon to use
A color sampler is a config defined function that assigns a color for every XZ coordinate pair. Color samplers are typically used to distribute things across the entire world by utilizing color data, for example using a heightmap to shape terrain, or an image to draw where biomes should go.
Color samplers differ from Image s in that they can provide colors for any XZ coordinate, whereas
Image s only work with a set size.
Types#
Different types of ColorSampler provide different behaviours and may have additional parameters for configuring that behavior.
The type is specified by setting the type parameter to the name of the type. If the same name is used by two different addons, you can prefix the name with ADDON_NAME: to specify which one to use.
A list of available types for ColorSampler are listed below:
COLOR#
Provides the same color for any input.
color ColorString - The color to output.
SINGLE_IMAGE#
Outputs the pixels of an Image, colors for coordinates outside the bounds of the image
are provided by a ‘fallback’ color sampler, which typically will be the COLOR type.
align Alignment
image Image - The image to be sampled
outside-sampler ColorSampler - The sampler that provides colors for coordinates outside the bounds of the Image .
TILED_IMAGE#
Outputs a repeating grid of pixels sourced from the provided Image .
align Alignment
ROTATE#
TRANSLATE#
Uses#
Used by 6 parameters:
-
color-sampler ColorSampler - The color sampler to extract channel values from.
In SINGLE_IMAGE in ColorSampler:
outside-sampler ColorSampler - The sampler that provides colors for coordinates outside the bounds of the
Image.