osrs-tools
Version:
A comprehensive TypeScript library for Old School RuneScape (OSRS) data and utilities, including quest data, skill requirements, and game item information
52 lines • 2.06 kB
TypeScript
import { ItemRequirement, Requirement } from "../Requirement";
export interface DiaryTask {
description: string;
requirements: Requirement[];
notes?: string;
}
export interface DiaryLevel {
itemReward?: string;
rewards?: any;
tasks: DiaryTask[];
itemsRequired?: string[];
itemRequirements?: ItemRequirement[];
questsRequired?: string[];
skillsRequired?: any[];
}
/**
* Diary interface representing the structure of a RuneScape diary, including its name, rewards, and tasks for each difficulty level. Tasks include descriptions, requirements (such as quests and skills), and optional notes.
* The diaries are built from a JSON resource file and can be accessed by name or retrieved as a list of all diaries.
* Example usage:
* const ardougneDiary = getDiaryByName("Ardougne Diary");
* if (ardougneDiary) {
* console.log(ardougneDiary.name); // "Ardougne Diary"
* console.log(ardougneDiary.easy.tasks[0].description); // Description of the first easy task
* console.log(ardougneDiary.easy.tasks[0].requirements); // Requirements for the first easy task
* }
*/
export interface Diary {
name: string;
itemReward?: string;
rewards?: any;
easy: DiaryLevel;
medium: DiaryLevel;
hard: DiaryLevel;
elite: DiaryLevel;
}
export declare function getDiaryByName(name: string): Diary | undefined;
export declare function getAllDiaries(): Diary[];
declare const diaries: Record<string, Diary>;
export default diaries;
export declare const ArdougneDiary: Diary;
export declare const DesertDiary: Diary;
export declare const FaladorDiary: Diary;
export declare const FremennikDiary: Diary;
export declare const KandarinDiary: Diary;
export declare const KaramjaDiary: Diary;
export declare const KourendKebosDiary: Diary;
export declare const LumbridgeDraynorDiary: Diary;
export declare const MorytaniaDiary: Diary;
export declare const VarrockDiary: Diary;
export declare const WesternProvincesDiary: Diary;
export declare const WildernessDiary: Diary;
//# sourceMappingURL=Diary.d.ts.map