Black Trigram (흑괘) - Korean Martial Arts Combat Simulator API - v0.7.9
    Preparing search index...

    Function useMatchCountdown

    • useMatchCountdown Hook

      Manages the complete match start countdown flow:

      1. Idle state waiting for match start
      2. Ready state shows "Ready?" message (1s)
      3. Counting state counts down from 3 to 1 (1s intervals)
      4. Fight state shows "Fight!" message (1s)
      5. Complete state signals combat can begin

      Parameters

      • config: MatchCountdownConfig = {}

        Configuration for countdown timings

      • OptionalonComplete: () => void

        Callback when countdown completes

      Returns UseMatchCountdownResult

      Match countdown state and control functions

      const {
      state,
      currentNumber,
      startCountdown,
      skipCountdown,
      } = useMatchCountdown(
      { startNumber: 3 },
      () => {
      // Enable combat inputs
      enableCombatControls();
      }
      );

      // When match initializes
      startCountdown();