1681-engine / index / ColorGradeOptions
Interface: ColorGradeOptions ​
Defined in: src/ambient/ColorGrade.ts:8
Properties ​
parent? ​
ts
optional parent?: Container<ContainerChild>;Defined in: src/ambient/ColorGrade.ts:12
The container the sheet is added to (default the stage's screen layer).
placement? ​
ts
optional placement?: GradePlacement;Defined in: src/ambient/ColorGrade.ts:18
'top' (the default) adds the sheet over everything already in parent, so it tints a HUD made before it and not one made after. 'bottom' puts it under every child parent has or will have: on the screen layer that is over the world and under every HUD, whatever order they were made in — usually what a grade wants.
readEveryMs? ​
ts
optional readEveryMs?: number;Defined in: src/ambient/ColorGrade.ts:10
How often (ms) the grade is read again: the hour moves slowly, so not every frame (default 500).