@lands.io/mod-sdk / RetreatActionHooks

Interface: RetreatActionHooks¶

Hooks for customizing RetreatAction behavior.

Table of contents¶

Properties¶

canActivate¶

• Optional canActivate: (ctx: ActionContext, allowed: boolean) => boolean

Hook for canActivate - receives context and base allowed result

Type declaration¶

▸ (ctx, allowed): boolean

Parameters¶

Name	Type
`ctx`	`ActionContext`
`allowed`	`boolean`

Returns¶

boolean

createExecution¶

• Optional createExecution: (ctx: ActionContext, target: RetreatTarget, execution: Execution) => Execution

Hook for createExecution - receives context, target, and base execution

Type declaration¶

▸ (ctx, target, execution): Execution

Parameters¶

Name	Type
`ctx`	`ActionContext`
`target`	`RetreatTarget`
`execution`	`Execution`

Returns¶

Execution

Source Code¶

View full implementation

/**
 * Hooks for customizing RetreatAction behavior.
 */
export interface RetreatActionHooks {
  /** Hook for canActivate - receives context and base allowed result */
  canActivate?: (ctx: ActionContext, allowed: boolean) => boolean;

  /** Hook for createExecution - receives context, target, and base execution */
  createExecution?: (
    ctx: ActionContext,
    target: RetreatTarget,
    execution: Execution
  ) => Execution;
}