Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/rulvar / effectiveEffectState

Function: effectiveEffectState()

ts
function effectiveEffectState(machine): EffectMachineState;

Defined in: packages/core/dist/index.d.ts

The compensated overlay (see the module doc): 'compensated' when a confirmed compensation cites a confirmed original, else the machine's own state.

Parameters

ParameterType
machineEffectMachine

Returns

EffectMachineState