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

    Interface Player3DWithTransitionsProps

    Props for Player3DWithTransitions component

    interface Player3DWithTransitionsProps {
        archetype: PlayerArchetype;
        attackAnimation?: string;
        balance: BalanceState;
        bloodLoss?: number;
        bodyFacing?: BodyFacing;
        consciousness: number;
        currentAnimation: PlayerAnimation;
        enableEyeTracking?: boolean;
        enableFacialExpressions?: boolean;
        enableStanceAudio?: boolean;
        enableStanceSymbol?: boolean;
        enableTransitionEffects?: boolean;
        facialDamage?: FacialDamageState;
        facialExpression?: FacialExpression;
        facing?: "left" | "right";
        health: number;
        isBlocking: boolean;
        isCountering?: boolean;
        isMobile: boolean;
        isStunned?: boolean;
        ki: number;
        laterality?: "left" | "right";
        maxHealth: number;
        name?: { english: string; korean: string };
        onAnimationComplete?: () => void;
        onBodyFacingUpdate?: (bodyFacing: BodyFacing) => void;
        onStanceTransitionComplete?: (stance: TrigramStance) => void;
        onStanceTransitionStart?: (
            fromStance: TrigramStance,
            toStance: TrigramStance,
        ) => void;
        opponentPosition?: [number, number, number];
        pain: number;
        playerId: string;
        position: [number, number, number];
        rotation: number;
        scale?: number;
        showDetails?: boolean;
        showHealthBar?: boolean;
        showStanceIndicator?: boolean;
        stamina: number;
        stance: TrigramStance;
        transitionDuration?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    archetype attackAnimation? balance bloodLoss? bodyFacing? consciousness currentAnimation enableEyeTracking? enableFacialExpressions? enableStanceAudio? enableStanceSymbol? enableTransitionEffects? facialDamage? facialExpression? facing? health isBlocking isCountering? isMobile isStunned? ki laterality? maxHealth name? onAnimationComplete? onBodyFacingUpdate? onStanceTransitionComplete? onStanceTransitionStart? opponentPosition? pain playerId position rotation scale? showDetails? showHealthBar? showStanceIndicator? stamina stance transitionDuration?

    Properties

    archetype: PlayerArchetype

    Player archetype determining visual style and theming

    원형

    attackAnimation?: string

    Specific attack animation name (for attack state)

    balance: BalanceState

    Balance/stability state in combat

    균형상태

    bloodLoss?: number

    Blood loss amount (0-100) Optional since not all game modes track blood loss

    출혈

    bodyFacing?: BodyFacing

    Body facing state for automatic opponent tracking (optional)

    몸향하기상태

    consciousness: number

    Consciousness level (0-100)

    의식

    currentAnimation: PlayerAnimation

    Current animation state

    현재애니메이션

    enableEyeTracking?: boolean

    Whether to enable eye tracking (opt-in, default: false)

    눈추적사용

    enableFacialExpressions?: boolean

    Whether to enable facial expressions (opt-in, default: false)

    표정사용

    enableStanceAudio?: boolean

    Enable stance change audio (default: true)

    enableStanceSymbol?: boolean

    Enable floating stance symbol (default: true)

    enableTransitionEffects?: boolean

    Enable stance transition effects (default: true)

    facialDamage?: FacialDamageState

    Facial damage state (optional, defaults to no damage)

    얼굴손상

    facialExpression?: FacialExpression

    Current facial expression (optional, auto-calculated if not provided)

    얼굴표정

    facing?: "left" | "right"

    Direction the player is facing

    방향

    health: number

    Current health points (0-maxHealth)

    건강

    isBlocking: boolean

    Whether player is currently blocking

    방어중

    isCountering?: boolean

    Whether player is countering

    반격중

    isMobile: boolean

    Whether rendering for mobile device (affects scaling and detail)

    모바일여부

    isStunned?: boolean

    Whether player is stunned

    기절

    ki: number

    Current Ki/energy points (0-100)

    기

    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)

    maxHealth: number

    Maximum health points

    최대건강

    name?: { english: string; korean: string }

    Player display name (Korean and English)

    이름

    onAnimationComplete?: () => void

    Callback when animation completes

    애니메이션완료콜백

    onBodyFacingUpdate?: (bodyFacing: BodyFacing) => void

    Callback to update body facing state

    몸향하기업데이트콜백

    onStanceTransitionComplete?: (stance: TrigramStance) => void

    Callback when stance transition completes

    onStanceTransitionStart?: (
        fromStance: TrigramStance,
        toStance: TrigramStance,
    ) => void

    Callback when stance transition starts

    opponentPosition?: [number, number, number]

    Opponent position for eye tracking (optional)

    상대위치

    pain: number

    Pain level affecting balance and performance (0-100)

    통증

    playerId: string

    Unique identifier for the player

    플레이어ID

    position: [number, number, number]

    3D world position [x, y, z]

    위치

    rotation: number

    Rotation in radians (Y-axis)

    회전

    scale?: number

    Scale multiplier for the model (default: 1)

    크기

    showDetails?: boolean

    Whether to show Html overlay with stats

    세부정보표시

    showHealthBar?: boolean

    Whether to show health bar

    체력바표시

    showStanceIndicator?: boolean

    Whether to show stance indicator

    자세표시기표시

    stamina: number

    Current stamina points (0-100)

    체력

    stance: TrigramStance

    Current trigram stance (1 of 8)

    현재자세

    transitionDuration?: number

    Transition duration in seconds (default: 0.5)

    Settings

    Member Visibility

    On This Page

    Properties