Skip to content
Docs
Open Promoeyes

fx

effectsset 82× in templates and rigs

A stackable effect on its parent node, by `type`: `orbit-aura` runs a neon comet around the node's outline, `grid` draws a line grid on a mesh's surface. Several apply in document order; any parameter can be keyed by a channel under the fx.

fx(type=orbit-aura glow=1 period=1)

Attributes

typetext`orbit-aura` or `grid`.82×
glownumberorbit-aura: the glow skirt's width, output pixels (default 8).80×
periodnumberorbit-aura: seconds per lap (default 3.4).80×
radiusnumberorbit-aura on a flat card: its corner radius in the node's own units (omitted, the corners are square).49×
colorstextorbit-aura: the comet's head, middle and tail colours, `#a,#b,#c`.32×
focusedtrue / falseorbit-aura: `true` lights only a short spark of the outline instead of the full ring.19×
visible_arcnumberorbit-aura with `focused`: the lit share of the outline, 0.02 to 1.19×
directionnumberorbit-aura: 1 or -1, the way round (default 1).17×
shapetextorbit-aura: `hull` (default, inflated shells or a rim card) or `silhouette` (the exact outline, at the cost of an extra scene draw).3×
borderHnumbergrid: the horizontal lines' thickness, in UV.2×
borderWnumbergrid: the vertical lines' thickness, in UV.2×
cellHnumbergrid: the height of one cell, in UV (0 to 1).2×
cellWnumbergrid: the width of one cell, in the surface's UV (0 to 1).2×
colorcolour #rrggbbgrid: the line colour.2×
thicknessnumberorbit-aura: the core band's width, output pixels (default 1.7).2×

Where it goes