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

    Interface UseSkeletalAnimationOptions

    Options for useSkeletalAnimation hook

    골격애니메이션훅옵션

    interface UseSkeletalAnimationOptions {
        attackAnimation?: string;
        currentAnimation: PlayerAnimation;
        isBlocking?: boolean;
        laterality?: "left" | "right";
        onAnimationComplete?: () => void;
        stance?: TrigramStance;
    }
    Index

    Properties

    attackAnimation? currentAnimation isBlocking? laterality? onAnimationComplete? stance?

    Properties

    attackAnimation?: string

    Specific attack animation name (for attack state)

    currentAnimation: PlayerAnimation

    Current animation name

    isBlocking?: boolean

    Whether player is blocking

    laterality?: "left" | "right"

    Stance laterality (left or right foot forward)

    • "left": Left foot forward (왼발서기 - Oenbal Seogi)
    • "right": Right foot forward (오른발서기 - Oreun Bal Seogi)

    This affects animation mirroring - techniques will be mirrored appropriately based on the laterality, creating 16 distinct stance configurations (8 trigrams × 2 laterality).

    Korean: 측면성 (Cheugmyeonseong - Laterality/Sidedness)

    onAnimationComplete?: () => void

    Callback when animation completes

    stance?: TrigramStance

    Current player stance for trigram-specific idle animations

    Settings

    Member Visibility

    On This Page

    Properties