@nice2dev/game-engine 1.3.13 → 1.3.14

package/dist/types/systems/NiceObjective.d.ts

@@ -1,395 +0,0 @@
-/**
- * NiceObjective - Mission Objective System
- *
- * Comprehensive system for managing game objectives, missions,
- * and goals with tracking and completion handling.
- *
- * Features:
- * - Multiple objective types
- * - Objective chains
- * - Progress tracking
- * - Time limits
- * - Optional objectives
- * - Failure conditions
- * - Objective markers
- * - Checkpoints
- * - Branching objectives
- * - Rewards system
- * - Objective categories
- * - Statistics tracking
- *
- * @packageDocumentation
- */
-import { EventEmitter } from 'events';
-/** Unique objective ID */
-export type ObjectiveId = string;
-/** Unique mission ID */
-export type MissionId = string;
-/** Objective type */
-export type ObjectiveType = 'reach' | 'collect' | 'kill' | 'protect' | 'escort' | 'survive' | 'interact' | 'use' | 'talk' | 'investigate' | 'destroy' | 'capture' | 'defend' | 'stealth' | 'race' | 'custom';
-/** Objective state */
-export type ObjectiveState = 'locked' | 'available' | 'active' | 'completed' | 'failed' | 'expired';
-/** Mission state */
-export type MissionState = 'locked' | 'available' | 'active' | 'completed' | 'failed';
-/** Objective priority */
-export type ObjectivePriority = 'primary' | 'secondary' | 'bonus' | 'hidden';
-/** 3D Position */
-export interface Position3D {
-    x: number;
-    y: number;
-    z: number;
-}
-/** Objective marker */
-export interface ObjectiveMarker {
-    id: string;
-    position: Position3D;
-    icon?: string;
-    color?: string;
-    label?: string;
-    visible: boolean;
-    trackable: boolean;
-    distanceVisible: boolean;
-    pulseEffect?: boolean;
-}
-/** Progress requirement */
-export interface ProgressRequirement {
-    current: number;
-    target: number;
-    unit?: string;
-}
-/** Time constraint */
-export interface TimeConstraint {
-    enabled: boolean;
-    duration: number;
-    remaining: number;
-    started?: number;
-    paused?: boolean;
-    showTimer?: boolean;
-    warningThreshold?: number;
-}
-/** Objective reward */
-export interface ObjectiveReward {
-    experience?: number;
-    currency?: Record<string, number>;
-    items?: Array<{
-        itemId: string;
-        quantity: number;
-    }>;
-    reputation?: Record<string, number>;
-    unlocks?: string[];
-    custom?: Record<string, unknown>;
-}
-/** Failure condition */
-export interface FailureCondition {
-    id: string;
-    type: 'death' | 'timeout' | 'detected' | 'target_lost' | 'damage' | 'custom';
-    threshold?: number;
-    current?: number;
-    message?: string;
-}
-/** Objective definition */
-export interface ObjectiveDefinition {
-    id: ObjectiveId;
-    missionId: MissionId;
-    name: string;
-    description: string;
-    type: ObjectiveType;
-    priority: ObjectivePriority;
-    state: ObjectiveState;
-    progress: ProgressRequirement;
-    timeConstraint?: TimeConstraint;
-    markers?: ObjectiveMarker[];
-    rewards?: ObjectiveReward;
-    failureConditions?: FailureCondition[];
-    prerequisiteIds?: ObjectiveId[];
-    unlockObjectiveIds?: ObjectiveId[];
-    optional: boolean;
-    hidden: boolean;
-    trackable: boolean;
-    autoComplete: boolean;
-    hints?: string[];
-    currentHint?: number;
-    customData?: Record<string, unknown>;
-    completedAt?: number;
-    failedAt?: number;
-}
-/** Mission definition */
-export interface MissionDefinition {
-    id: MissionId;
-    name: string;
-    description: string;
-    briefing?: string;
-    category: string;
-    state: MissionState;
-    objectives: ObjectiveId[];
-    primaryObjectives: ObjectiveId[];
-    secondaryObjectives: ObjectiveId[];
-    bonusObjectives: ObjectiveId[];
-    prerequisiteMissionIds?: MissionId[];
-    rewards?: ObjectiveReward;
-    failureConditions?: FailureCondition[];
-    timeConstraint?: TimeConstraint;
-    difficulty?: number;
-    recommendedLevel?: number;
-    location?: string;
-    giver?: string;
-    checkpoints?: Checkpoint[];
-    currentCheckpoint?: number;
-    startedAt?: number;
-    completedAt?: number;
-    failedAt?: number;
-    customData?: Record<string, unknown>;
-}
-/** Checkpoint */
-export interface Checkpoint {
-    id: string;
-    name: string;
-    objectiveId: ObjectiveId;
-    position?: Position3D;
-    savedAt?: number;
-}
-/** Tracked objective display info */
-export interface TrackedObjective {
-    objectiveId: ObjectiveId;
-    missionId: MissionId;
-    missionName: string;
-    name: string;
-    description: string;
-    progress: ProgressRequirement;
-    priority: ObjectivePriority;
-    markers: ObjectiveMarker[];
-    timeRemaining?: number;
-    hints?: string[];
-}
-/** Objective update */
-export interface ObjectiveUpdate {
-    objectiveId: ObjectiveId;
-    type: 'progress' | 'state' | 'marker' | 'time';
-    oldValue?: unknown;
-    newValue: unknown;
-}
-/** Mission statistics */
-export interface MissionStatistics {
-    missionsCompleted: number;
-    missionsFailed: number;
-    objectivesCompleted: number;
-    objectivesFailed: number;
-    optionalCompleted: number;
-    totalPlayTime: number;
-    fastestCompletion?: Record<MissionId, number>;
-    attemptsPerMission: Record<MissionId, number>;
-}
-/** Objective event types */
-export type ObjectiveEventType = 'mission_started' | 'mission_completed' | 'mission_failed' | 'mission_updated' | 'objective_started' | 'objective_progress' | 'objective_completed' | 'objective_failed' | 'objective_expired' | 'checkpoint_reached' | 'checkpoint_loaded' | 'time_warning' | 'hint_revealed' | 'marker_updated';
-/** Objective event data */
-export interface ObjectiveEvent {
-    type: ObjectiveEventType;
-    timestamp: number;
-    missionId?: MissionId;
-    objectiveId?: ObjectiveId;
-    data?: unknown;
-}
-/** Objective event callback */
-export type ObjectiveEventCallback = (event: ObjectiveEvent) => void;
-/** Objective system configuration */
-export interface ObjectiveConfig {
-    maxTrackedObjectives: number;
-    autoTrackPrimary: boolean;
-    showCompletionPopup: boolean;
-    showFailurePopup: boolean;
-    timeWarningThreshold: number;
-    enableCheckpoints: boolean;
-    maxCheckpoints: number;
-    hintDelay: number;
-    markerUpdateInterval: number;
-}
-/** Default configuration */
-export declare const DEFAULT_OBJECTIVE_CONFIG: ObjectiveConfig;
-/**
- * Mission objective management system
- */
-export declare class NiceObjective extends EventEmitter {
-    private config;
-    private missions;
-    private objectives;
-    private activeMission?;
-    private trackedObjectives;
-    private statistics;
-    private timerInterval?;
-    private hintTimers;
-    private sessionStartTime;
-    constructor(config?: Partial<ObjectiveConfig>);
-    /**
-     * Emit objective event
-     */
-    private emitEvent;
-    /**
-     * Start timer loop
-     */
-    private startTimerLoop;
-    /**
-     * Update timers
-     */
-    private updateTimers;
-    /**
-     * Update time constraint
-     */
-    private updateTimeConstraint;
-    /**
-     * Create mission
-     */
-    createMission(definition: Omit<MissionDefinition, 'objectives' | 'primaryObjectives' | 'secondaryObjectives' | 'bonusObjectives'>): MissionDefinition;
-    /**
-     * Get mission
-     */
-    getMission(missionId: MissionId): MissionDefinition | undefined;
-    /**
-     * Get all missions
-     */
-    getAllMissions(state?: MissionState): MissionDefinition[];
-    /**
-     * Start mission
-     */
-    startMission(missionId: MissionId): boolean;
-    /**
-     * Complete mission
-     */
-    completeMission(missionId: MissionId): boolean;
-    /**
-     * Fail mission
-     */
-    failMission(missionId: MissionId, reason?: string): boolean;
-    /**
-     * Get active mission
-     */
-    getActiveMission(): MissionDefinition | undefined;
-    /**
-     * Create objective
-     */
-    createObjective(definition: ObjectiveDefinition): ObjectiveDefinition;
-    /**
-     * Get objective
-     */
-    getObjective(objectiveId: ObjectiveId): ObjectiveDefinition | undefined;
-    /**
-     * Start objective
-     */
-    startObjective(objectiveId: ObjectiveId): boolean;
-    /**
-     * Update objective progress
-     */
-    updateProgress(objectiveId: ObjectiveId, amount?: number): ObjectiveUpdate | undefined;
-    /**
-     * Set objective progress directly
-     */
-    setProgress(objectiveId: ObjectiveId, value: number): boolean;
-    /**
-     * Complete objective
-     */
-    completeObjective(objectiveId: ObjectiveId): boolean;
-    /**
-     * Fail objective
-     */
-    failObjective(objectiveId: ObjectiveId, reason?: string): boolean;
-    /**
-     * Expire objective
-     */
-    expireObjective(objectiveId: ObjectiveId): boolean;
-    /**
-     * Check failure condition
-     */
-    checkFailureCondition(objectiveId: ObjectiveId, conditionId: string, value: number): boolean;
-    /**
-     * Track objective
-     */
-    trackObjective(objectiveId: ObjectiveId): boolean;
-    /**
-     * Untrack objective
-     */
-    untrackObjective(objectiveId: ObjectiveId): boolean;
-    /**
-     * Get tracked objectives
-     */
-    getTrackedObjectives(): TrackedObjective[];
-    /**
-     * Is objective tracked
-     */
-    isTracked(objectiveId: ObjectiveId): boolean;
-    /**
-     * Add marker to objective
-     */
-    addMarker(objectiveId: ObjectiveId, marker: ObjectiveMarker): boolean;
-    /**
-     * Remove marker
-     */
-    removeMarker(objectiveId: ObjectiveId, markerId: string): boolean;
-    /**
-     * Update marker position
-     */
-    updateMarkerPosition(objectiveId: ObjectiveId, markerId: string, position: Position3D): boolean;
-    /**
-     * Get all active markers
-     */
-    getAllMarkers(): Array<ObjectiveMarker & {
-        objectiveId: ObjectiveId;
-    }>;
-    /**
-     * Save checkpoint
-     */
-    saveCheckpoint(missionId: MissionId, checkpointId: string): boolean;
-    /**
-     * Load checkpoint
-     */
-    loadCheckpoint(missionId: MissionId, checkpointId?: string): boolean;
-    /**
-     * Setup hint timer
-     */
-    private setupHintTimer;
-    /**
-     * Schedule next hint
-     */
-    private scheduleNextHint;
-    /**
-     * Reveal hint
-     */
-    revealHint(objectiveId: ObjectiveId): boolean;
-    /**
-     * Get current hints for objective
-     */
-    getHints(objectiveId: ObjectiveId): string[];
-    /**
-     * Get statistics
-     */
-    getStatistics(): MissionStatistics;
-    /**
-     * Get mission completion percentage
-     */
-    getMissionCompletionPercentage(missionId: MissionId): number;
-    /**
-     * Export state
-     */
-    exportState(): object;
-    /**
-     * Import state
-     */
-    importState(data: {
-        missions: Array<[MissionId, MissionDefinition]>;
-        objectives: Array<[ObjectiveId, ObjectiveDefinition]>;
-        activeMission?: MissionId;
-        trackedObjectives: ObjectiveId[];
-        statistics: MissionStatistics;
-    }): void;
-    /**
-     * Reset all missions
-     */
-    resetAll(): void;
-    /**
-     * Destroy objective system
-     */
-    destroy(): void;
-}
-/**
- * Create objective system instance
- */
-export declare function createObjectiveSystem(config?: Partial<ObjectiveConfig>): NiceObjective;
-export default NiceObjective;