beautypg.com

Boolean properties, Integer properties, Float properties – ETC Unison Mosaic Designer v1.11.0 User Manual

Page 236: Colour properties, Gradient properties

background image

Unison Mosaic Designer User Manual

name

is a string and must be unique within a custom preset and must not contain spaces. This name will be used

as the name of a global variable that is available in your script, whose value will depend on what has been set for
a given instance of your custom preset.

type

is the type of the property. It can be one of the following values: BOOLEAN, INTEGER, FLOAT, COLOUR and

GRADIENT

. This determines what sort of control is presented to the user when placing a custom preset on a

timeline.

default_value

is the initial value of a property when first added to a timeline. The value passed in here

depends on the type of the property, and this is outlined below.

Certain types of properties also allow some addition arguments to be specified, and these will also be described
for each type below:

Boolean properties

property("invert", BOOLEAN, true)

The default value should be true or false.

Integer properties

property("count", INTEGER, number, [min], [max], [step])

The default value should be a number between min and max.

l

min

is the minimum allowed value (default: -2147483648)

l

max

is the maximum allowed value (default: 2147483647)

l

step

is the difference between allowed values (default: 1)

min

, max and step are optional.

Float properties

property("count", FLOAT, number, [min], [max], [resolution])

The default value should be a number between min and max.

l

min

is the minimum allowed value

l

max

is the maximum allowed value

l

resolution

is the number of decimal places to display (default: 2)

min

, max and resolution are optional.

Colour properties

property("background", COLOUR, red, green, blue)

red

, green and blue are the default values of the components of the colour.

Gradient properties

property("gradient", GRADIENT, {fraction, red, green, blue}, ...)

- 236 -