Body, Mind & Soul — API Reference
    Preparing search index...

    Variable HOOK_VARIABLESConst

    HOOK_VARIABLES: {
        [key: string]:
            | ((__namedParameters: [any, any]) => { damage: any })
            | (
                (
                    __namedParameters: [any, any],
                ) => {
                    restore: {
                        amount: any;
                        overflow: any;
                        surgeValue: any;
                        targetKey: any;
                    };
                }
            )
            | ((__namedParameters: [any, any]) => { rest: { type: any } })
            | ((__namedParameters: [any, any]) => { card: { name: any; value: any } })
            | (
                (
                    __namedParameters: [any, any],
                ) => {
                    resource: {
                        delta: number;
                        key: any;
                        label: any;
                        newValue: any;
                        oldValue: any;
                    };
                }
            )
            | (
                (
                    __namedParameters: [any, any],
                ) => { roll: { archetype: any; attribute: any; total: any } }
            )
            | ((__namedParameters: [any, any]) => { item: { name: any; type: any } })
            | (
                (
                    __namedParameters: [any, any],
                ) => { weapon: { damageMod: any; damageType: any; name: any } }
            )
            | (
                (
                    __namedParameters: [any, any, any],
                ) => {
                    card: { name: any; value: any };
                    stack: { grantedBy: any; label: any };
                }
            );
    } = ...

    Per-hook variable factories. Each entry maps a hook name to a function that receives hookArgs and returns a nested object of available variables. Used for {token} substitution in formulas/chat and hookVars in scripts.

    Type Declaration

    • [key: string]:
          | ((__namedParameters: [any, any]) => { damage: any })
          | (
              (
                  __namedParameters: [any, any],
              ) => {
                  restore: {
                      amount: any;
                      overflow: any;
                      surgeValue: any;
                      targetKey: any;
                  };
              }
          )
          | ((__namedParameters: [any, any]) => { rest: { type: any } })
          | ((__namedParameters: [any, any]) => { card: { name: any; value: any } })
          | (
              (
                  __namedParameters: [any, any],
              ) => {
                  resource: {
                      delta: number;
                      key: any;
                      label: any;
                      newValue: any;
                      oldValue: any;
                  };
              }
          )
          | (
              (
                  __namedParameters: [any, any],
              ) => { roll: { archetype: any; attribute: any; total: any } }
          )
          | ((__namedParameters: [any, any]) => { item: { name: any; type: any } })
          | (
              (
                  __namedParameters: [any, any],
              ) => { weapon: { damageMod: any; damageType: any; name: any } }
          )
          | (
              (
                  __namedParameters: [any, any, any],
              ) => {
                  card: { name: any; value: any };
                  stack: { grantedBy: any; label: any };
              }
          )

    Settings
    Member Visibility