Types

TypeScript type definitions used throughout the SDK.

Quest Types

QuestRewards

interface QuestRewards {
    money?: number;
    xp?: number;
}

QuestEmployer

interface QuestEmployer {
    firstName?: string;
    lastName?: string;
    email?: string;
    avatar?: string;
}

QuestObjectiveDefinition

interface QuestObjectiveDefinition {
    name: string;
    description: string;
    info?: string;
    hint?: string;
    terminalCommand?: string;
    hidden?: boolean;
    unlocksAfter?: string[];
    trigger?: QuestObjectiveTrigger;
}

QuestObjectiveTrigger

interface QuestObjectiveTrigger {
    event: string;
    condition: (data: any) => boolean;
}

QuestMailDefinition

interface QuestMailDefinition {
    title: string;
    content: string;
    replyable?: boolean;
    attachment?: {
        name: string;
        extension: string;
        content: string;
    };
}

QuestDialogDefinition

type QuestDialogDefinition = Record<string, QuestDialogSpeech[]>;

QuestDialogSpeech

interface QuestDialogSpeech {
    speaker: string;
    text: string;
    audio?: string;
    isEnd?: boolean;
    timeout?: number;
    onEnd?: () => void;
    options?: QuestDialogOption[];
}

QuestDialogOption

interface QuestDialogOption {
    label: string;
    text: string;
    audio?: string;
    switchBranch?: string;
    nextIndex?: number;
    isEnd?: boolean;
    timeout?: number;
    onSelect?: () => void;
}

Website Types

WebsitePageDefinition

interface WebsitePageDefinition {
    path: string;
    title: string;
    html: string;
}

App Types

AppSize

interface AppSize {
    width: number;
    height: number;
}

AppStoreDefinition

interface AppStoreDefinition {
    title: string;
    description: string;
    ratings?: number;
}

Command Types

CommandAutoComplete

interface CommandAutoComplete {
    label: string;
    type: AutoCompleteType;
}

AutoCompleteType

type AutoCompleteType = "STRING" | "IP" | "FLAG" | "FILE" | "DIRECTORY" | "USER";

CommandTools

interface CommandTools {
    getArgs(): string[];
    println(text: string): void;
    printError(text: string): void;
    printWarning(text: string): void;
    printSuccess(text: string): void;
    sleep(ms: number): Promise<void>;
    clear(): void;
}

Network Types

NetworkPort

interface NetworkPort {
    external: number;
    internal: number;
    active: boolean;
    service: string;
}

NetworkUser

interface NetworkUser {
    id?: string;
    username: string;
    password?: string;
    firstName?: string;
    lastName?: string;
}

Mod Types

ModManifest

interface ModManifest {
    id: string;
    name: string;
    version: string;
    author: string;
    description: string;
    apiVersion: number;
    permissions?: ModPermission[];
    dependencies?: string[];
    cover?: string;
    tags?: string[];
    workshopId?: string;
}

ModPermission

type ModPermission = "filesystem" | "network" | "events" | "mail" | "bank" | "shell" | "ui";

ModSettingDefinition

interface ModSettingDefinition {
    key: string;
    label: string;
    type: "toggle" | "select" | "text" | "number" | "slider";
    default: any;
    options?: { label: string; value: string }[];
    min?: number;
    max?: number;
    step?: number;
}