Skip to content

CoverFadeData

Defined in: sdk/src/render/coverFade.ts:25

The fields of the CoverFade component.

enabled: boolean

Defined in: sdk/src/render/coverFade.ts:35

Off: the sprite stays as authored.


fadeTime: number

Defined in: sdk/src/render/coverFade.ts:29

Seconds the fade takes, either way.


margin: number

Defined in: sdk/src/render/coverFade.ts:31

Ground around the sprite’s edge, in world units, that counts as under it: the fade starts as a target steps up to the edge, not after it is in.


opacity: number

Defined in: sdk/src/render/coverFade.ts:27

The sprite’s alpha, as a share of its own, while something stands under it. 0 is gone, 1 is no fade.


round: boolean

Defined in: sdk/src/render/coverFade.ts:33

The covered ground is the ellipse inside the sprite’s rectangle, not the whole rectangle: a tree crown, not a roof.