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

    Interface CombatResult

    interface CombatResult {
        animation?: {
            animationName: string;
            duration: number;
            speedModifier: number;
            techniqueDisplayName?: string;
        };
        attacker?: PlayerState;
        criticalHit: boolean;
        damage: number;
        defender?: PlayerState;
        effects: readonly StatusEffect[];
        hit: boolean;
        isBlocked: boolean;
        isCritical: boolean;
        knockback?: {
            displacement: { x: number; y: number; z: number };
            duration: number;
            recoveryWindow: number;
            shouldFall: boolean;
        };
        success: boolean;
        targetedVitalPointId?: string;
        technique?: KoreanTechnique;
        timestamp: number;
        vitalPointHit: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    animation?: {
        animationName: string;
        duration: number;
        speedModifier: number;
        techniqueDisplayName?: string;
    }

    Animation information for technique execution

    Type Declaration

    • ReadonlyanimationName: string

      Name of skeletal animation to play

    • Readonlyduration: number

      Duration in milliseconds (adjusted by speed modifier)

    • ReadonlyspeedModifier: number

      Speed modifier (0.8-1.2)

    • Optional ReadonlytechniqueDisplayName?: string

      Technique name to display (Korean)

    attacker?: PlayerState
    criticalHit: boolean
    damage: number
    defender?: PlayerState
    effects: readonly StatusEffect[]
    hit: boolean
    isBlocked: boolean
    isCritical: boolean
    knockback?: {
        displacement: { x: number; y: number; z: number };
        duration: number;
        recoveryWindow: number;
        shouldFall: boolean;
    }

    Knockback physics information (밀침 물리)

    Type Declaration

    • Readonlydisplacement: { x: number; y: number; z: number }

      Knockback displacement vector in world space

    • Readonlyduration: number

      Knockback animation duration in seconds

    • ReadonlyrecoveryWindow: number

      Recovery window (vulnerable state) in seconds

    • ReadonlyshouldFall: boolean

      Whether knockback triggers fall animation (넘어짐)

    success: boolean
    targetedVitalPointId?: string

    Optional vital point ID that was targeted in this attack

    technique?: KoreanTechnique
    timestamp: number
    vitalPointHit: boolean