@peacockproject/core/menus/planning.d.ts

Type definitions for Peacock's core.

import type { CompiledChallengeTreeCategory, GameVersion, MissionManifest, Unlockable, UserCentricContract, UserProfile } from "../types/types";
export type PlanningError = {
    error: boolean;
};
export type PlanningGroupData = {
    GroupId: string | undefined;
    GroupTitle: string | undefined;
    CompletedLevels: number | undefined;
    Completed: boolean | undefined;
    TotalLevels: number | undefined;
    BestScore: number | undefined;
    BestPlayer: string | undefined;
    BestLevel: number | undefined;
};
export type GamePlanningData = {
    Contract: MissionManifest;
    ElusiveContractState?: "not_completed" | string;
    UserCentric?: UserCentricContract;
    IsFirstInGroup: boolean;
    Creator: UserProfile;
    UserContract?: boolean;
    UnlockedEntrances?: string[] | null;
    UnlockedAgencyPickups?: string[] | null;
    Objectives?: unknown;
    GroupData?: PlanningGroupData;
    Entrances: Unlockable[] | null;
    Location: Unlockable;
    LoadoutData: unknown;
    LimitedLoadoutUnlockLevel: number;
    CharacterLoadoutData?: unknown | null;
    ChallengeData?: {
        Children: CompiledChallengeTreeCategory[];
    };
    Currency?: {
        Balance: number;
    };
    PaymentDetails?: {
        Currency: "Merces" | string;
        Amount: number | null;
        MaximumDeduction: number | null;
        Bonuses: null;
        Expenses: null;
        Entrance: null;
        Pickup: null;
        SideMission: null;
    };
    OpportunityData?: unknown[];
    PlayerProfileXpData?: {
        XP: number;
        Level: number;
        MaxLevel: number;
    };
};
export declare function getPlanningData(contractId: string, resetEscalation: boolean, userId: string, gameVersion: GameVersion): Promise<PlanningError | GamePlanningData>;