• A hook event fired by the system when an actor's ActorPF.performRest is called.

    Parameters

    • actor: ActorPF

      The actor who is resting.

    • restOptions: ActorRestOptions

      The options passed to the method's call. Mutating this data will not affect the system's calculations, as they are finished when this hook is fired. This data can be used to base different rest calculations on, however.

    • updateData: Record<string, unknown>

      The data the resting actor will be updated with. This data object can be mutated to affect the update (e.g. the number of hit points).

    • itemUpdates: Record<string, unknown>[]

      An array of item updates to be applied to the resting actor. This array can be mutated to affect the update (e.g. which item's uses are restored).

    Returns boolean

    Explicitly return false to prevent the actor from resting.

    Remarks

    Called by Hooks.call

    See

    ActorPF#performRest

Generated using TypeDoc