A row of a result-description table, mapping a test outcome to a descriptive label (e.g. "You go screaming down the halls in terror" rather than a bare "Critical Failure"). label / description / result may be a literal or a sohl.entity.expr.SafeExpression computed from the test bindings (successLevel, targetValue, lastDigit) — data, so the whole table serializes across clients. See the Result-description Tables guide.

interface LimitedDescription {
    description: string | sohl.entity.expr.SafeExpression;
    label: string | sohl.entity.expr.SafeExpression;
    lastDigits: number[];
    maxValue: number;
    result: number | sohl.entity.expr.SafeExpression;
    success: boolean;
}

Properties

description: string | sohl.entity.expr.SafeExpression

Result description — a literal string or a sohl.entity.expr.SafeExpression.

label: string | sohl.entity.expr.SafeExpression

Result label — a literal string, or a sohl.entity.expr.SafeExpression computing it from the test bindings (successLevel, targetValue, lastDigit). A SafeExpression is data (a source string), so the row — unlike a raw function — survives serialization across clients.

lastDigits: number[]

Roll last-digits this row applies to; an empty list matches any.

maxValue: number

Upper bound (inclusive) of target values this row matches.

result: number | sohl.entity.expr.SafeExpression

Numeric result/quality (e.g. star count) — a literal number or a sohl.entity.expr.SafeExpression computing it from the test bindings.

success: boolean

Whether this row represents a success.