Documentation

IHeatRule

Type interface

Defines interface for a heat rule.

Click here for more info

Inheritance

IHeatRule does not extend any other symbol.

IHeatRule is not extended by any other symbol.

Properties

customFunction #	Type `undefined` \| ( target: `Sprite`, minValue: `number`, maxValue: `number`, value: `any`) => `void` A custom function that will set target element's settings. Can be used to do custom manipulation on complex objects requiring more than modifying a setting.
dataField #	Type `string` Which data field to use when determining item's value.
key #	Type `undefined` \| `string` A setting key to set.
logarithmic #	Type `undefined` \| `false` \| `true` Default `false` Use logarithmic scale when calculating intermediate setting values.
max #	Type `any` The setting value to use for items if the highest value.
maxValue #	Type `undefined` \| `number` Custom highest value.
min #	Type `any` The setting value to use for items if the lowest value.
minValue #	Type `undefined` \| `number` Custom lowest value.
neutral #	Type `any` The setting value to use for items which do not have value at all.
target #	Type `Template` Target template.