Options
All
  • Public
  • Public/Protected
  • All
Menu

Module view/actions/RegisterButton

Type aliases

Functions

Type aliases

ActionState

ActionState: object

Action of skillsReducer reducer

Type declaration

  • type: ActionType
  • Optional value?: undefined | number

ActionType

ActionType: "moving" | "mining" | "combat" | "reset"

Possible action types of skillsReducer reducer

Props

Props: ActionButtonProps & object

SkillState

SkillState: object

State of skillsReducer reducer

Type declaration

  • combat: number
  • mining: number
  • moving: number
  • valid: boolean

Functions

Const RegisterButton

  • RegisterButton(__namedParameters: object): Element

  • React Component representing action button for registering to the current game turn. It handles whether this action should be enabled, lets user select skills (which must be 100 in total) and registers him with given set of skills.

    Parameters

    • __namedParameters: object
      • block: undefined | BlockInfo
      • buttonProps: buttonProps
      • flowControl: object
        • setError: function
            • (msg: string): void

            • Parameters

              • msg: string

              Returns void

        • setStart: function
            • (): void

            • Returns void

        • setSuccess: function
            • (msg: string): void

            • Parameters

              • msg: string

              Returns void

      • player: undefined | PlayerInfo

    Returns Element

Const skillsReducer

  • skillsReducer(__namedParameters: object, __namedParameters: object): SkillState

  • Reducer function which sets skills currently selected by user and checks whether their sum is equal to 100 or not.

    Parameters

    • __namedParameters: object
      • combat: number
      • mining: number
      • moving: number
    • __namedParameters: object
      • type: "reset" | "moving" | "mining" | "combat"
      • value: undefined | number

    Returns SkillState

Generated using TypeDoc