Interface IUsableActionExecutionOptions

Hierarchy

IUsableActionExecutionOptions

Index

Properties

debounce? notUsable? silent?

Methods

isUsable? onPreUsabilityCheck?

Properties

`Optional` debounce

debounce?: true

Whether to debounce error messages & sounds.

`Optional` notUsable

notUsable?: UsableActionUsability

An optional UsableActionUsability failure to skip all checks and fail with this result instead

`Optional` silent

silent?: true

Whether failing actions should be silent

Methods

`Optional` isUsable

isUsable(action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>, using: IUsableActionPossibleUsing, isUsable: ((using: IUsableActionPossibleUsing) => UsableActionUsability)): UsableActionUsability
An optional replacement for the default isUsable check on the action
Parameters
- action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>
- using: IUsableActionPossibleUsing
- isUsable: ((using: IUsableActionPossibleUsing) => UsableActionUsability)
  
  The default isUsable check
  - - (using: IUsableActionPossibleUsing): UsableActionUsability
    - Parameters
      
      using: IUsableActionPossibleUsing
      
      Returns UsableActionUsability
Returns UsableActionUsability
- Defined in src/game/ui/screen/screens/game/IGameScreenApi.ts:79

`Optional` onPreUsabilityCheck

onPreUsabilityCheck(action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>, using: IUsableActionPossibleUsing): any
An optional handler for before isUsable is checked
Parameters
- action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>
- using: IUsableActionPossibleUsing
Returns any
- Defined in src/game/ui/screen/screens/game/IGameScreenApi.ts:83

Generated using TypeDoc