VisualModifierHost
Defined in: renderer/src/VisualModifiers.ts:73
Transient render-only contributions for one visual component.
The host stores offsets and factors, never the component’s base values.
DisplaySystem combines the current world transform with these values every
render, so gameplay and physics remain authoritative while modifiers are
active.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new VisualModifierHost(
appearanceChanged?):VisualModifierHost
Defined in: renderer/src/VisualModifiers.ts:84
Parameters
Section titled “Parameters”appearanceChanged?
Section titled “appearanceChanged?”() => void
Returns
Section titled “Returns”VisualModifierHost
Accessors
Section titled “Accessors”hasTransformModifiers
Section titled “hasTransformModifiers”Get Signature
Section titled “Get Signature”get hasTransformModifiers():
boolean
Defined in: renderer/src/VisualModifiers.ts:117
Whether at least one transform contribution is active.
Returns
Section titled “Returns”boolean
opacityFactor
Section titled “opacityFactor”Get Signature
Section titled “Get Signature”get opacityFactor():
number
Defined in: renderer/src/VisualModifiers.ts:102
Combined multiplicative opacity factor.
Returns
Section titled “Returns”number
positionOffset
Section titled “positionOffset”Get Signature
Section titled “Get Signature”get positionOffset():
Vec2
Defined in: renderer/src/VisualModifiers.ts:87
Combined additive position offset.
Returns
Section titled “Returns”Vec2
rotationOffset
Section titled “rotationOffset”Get Signature
Section titled “Get Signature”get rotationOffset():
number
Defined in: renderer/src/VisualModifiers.ts:92
Combined additive rotation offset in radians.
Returns
Section titled “Returns”number
scaleFactor
Section titled “scaleFactor”Get Signature
Section titled “Get Signature”get scaleFactor():
Vec2
Defined in: renderer/src/VisualModifiers.ts:97
Combined multiplicative scale factor.
Returns
Section titled “Returns”Vec2
Get Signature
Section titled “Get Signature”get size():
number
Defined in: renderer/src/VisualModifiers.ts:112
Number of active contributions across every visual property.
Returns
Section titled “Returns”number
visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: renderer/src/VisualModifiers.ts:107
Whether every active visibility contribution permits drawing.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”_destroy()
Section titled “_destroy()”_destroy():
void
Defined in: renderer/src/VisualModifiers.ts:222
Internal
Invalidates every outstanding handle during component teardown.
Returns
Section titled “Returns”void
addOpacity()
Section titled “addOpacity()”addOpacity(
factor?):VisualOpacityModifierHandle
Defined in: renderer/src/VisualModifiers.ts:169
Add one independently removable opacity factor.
Parameters
Section titled “Parameters”factor?
Section titled “factor?”number = 1
Returns
Section titled “Returns”addTransform()
Section titled “addTransform()”addTransform(
options?):VisualTransformModifierHandle
Defined in: renderer/src/VisualModifiers.ts:122
Add one independently removable transform contribution.
Parameters
Section titled “Parameters”options?
Section titled “options?”VisualTransformModifierOptions = {}
Returns
Section titled “Returns”addVisibility()
Section titled “addVisibility()”addVisibility(
visible?):VisualVisibilityModifierHandle
Defined in: renderer/src/VisualModifiers.ts:197
Add one independently removable visibility condition.
Parameters
Section titled “Parameters”visible?
Section titled “visible?”boolean = true