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

    Interface Player3DModelProps

    Props for the Player3DModel component. Configures the 3D character model appearance and behavior.

    interface Player3DModelProps {
        animationState?: PlayerAnimationState;
        facing?: "left" | "right";
        onVitalPointClick?: (vitalPointId: string) => void;
        onVitalPointHover?: (vitalPointId: string | null) => void;
        playerState: PlayerState;
        position?: [number, number, number];
        scale?: number;
        selectedVitalPoint?: string | null;
        showDetails?: boolean;
        showHealthBar?: boolean;
        showStanceIndicator?: boolean;
        showVitalPoints?: boolean;
        vitalPointSeverityFilter?: VitalPointSeverity[];
    }
    Index

    Properties

    animationState? facing? onVitalPointClick? onVitalPointHover? playerState position? scale? selectedVitalPoint? showDetails? showHealthBar? showStanceIndicator? showVitalPoints? vitalPointSeverityFilter?

    Properties

    animationState?: PlayerAnimationState

    Current animation state affecting model pose and movement

    facing?: "left" | "right"

    Direction the player is facing ("left" flips the model). Defaults to "right"

    onVitalPointClick?: (vitalPointId: string) => void

    Callback when a vital point is clicked

    onVitalPointHover?: (vitalPointId: string | null) => void

    Callback when a vital point is hovered

    playerState: PlayerState

    The current state of the player including health, stance, and combat status

    position?: [number, number, number]

    3D world position [x, y, z] of the player model. Defaults to [0, 0, 0]

    scale?: number

    Scale multiplier for the model. Defaults to 1.0

    selectedVitalPoint?: string | null

    Selected vital point ID for highlighting

    showDetails?: boolean

    Whether to show Html overlay with name, health bar, and status. Defaults to true

    showHealthBar?: boolean

    Whether to show health bar in Html overlay. Defaults to true

    showStanceIndicator?: boolean

    Whether to show stance indicator ring and symbol. Defaults to true

    showVitalPoints?: boolean

    Whether to show vital point markers. Defaults to false

    vitalPointSeverityFilter?: VitalPointSeverity[]

    Severity filter for vital point markers

    Settings

    Member Visibility

    On This Page

    Properties