osrs-tools
Version:
A comprehensive TypeScript library for Old School RuneScape (OSRS) data and utilities, including quest data, skill requirements, and game item information
143 lines • 4.95 kB
TypeScript
/**
* Interface representing the JSON structure of an Item.
*/
export interface ItemJson {
id: number;
name: string;
examine: string;
value: number;
highAlch: number;
lowAlch: number;
weight: number;
members: boolean;
tradeable: boolean;
equipable: boolean;
releaseDate: string;
destroy: string;
questItem: boolean;
stackable: boolean;
noted: boolean;
officialWikiUrl: string;
iconUrl?: string;
attackStab?: number;
attackSlash?: number;
attackCrush?: number;
attackMagic?: number;
attackRanged?: number;
defenceStab?: number;
defenceSlash?: number;
defenceCrush?: number;
defenceMagic?: number;
defenceRanged?: number;
strengthBonus?: number;
rangedStrength?: number;
magicDamage?: number;
meleeStrength?: number;
prayer?: number;
}
/**
* Represents an item in the game. This class encapsulates all the properties and methods related to an item.
*/
export declare class Item {
id: number;
name: string;
examine: string;
value: number;
highAlch: number;
lowAlch: number;
weight: number;
members: boolean;
tradeable: boolean;
equipable: boolean;
releaseDate: string;
destroy: string;
questItem: boolean;
stackable: boolean;
noted: boolean;
notable: boolean;
officialWikiUrl: string;
iconUrl?: string;
attackStab?: number;
attackSlash?: number;
attackCrush?: number;
attackMagic?: number;
attackRanged?: number;
defenceStab?: number;
defenceSlash?: number;
defenceCrush?: number;
defenceMagic?: number;
defenceRanged?: number;
meleeStrength?: number;
rangedStrength?: number;
magicDamage?: number;
prayer?: number;
quantity: number;
constructor(id: number, name: string, examine: string, value: number, highAlch: number, lowAlch: number, weight: number, members: boolean, tradeable: boolean, equipable: boolean, releaseDate: string, destroy: string, questItem: boolean, stackable: boolean, noted: boolean, officialWikiUrl: string, iconUrl?: string, attackStab?: number, attackSlash?: number, attackCrush?: number, attackMagic?: number, attackRanged?: number, defenceStab?: number, defenceSlash?: number, defenceCrush?: number, defenceMagic?: number, defenceRanged?: number, meleeStrength?: number, rangedStrength?: number, magicDamage?: number, prayer?: number, quantity?: number, notable?: boolean);
get Id(): number;
set Id(value: number);
get Name(): string;
set Name(value: string);
get Examine(): string;
set Examine(value: string);
get Value(): number;
set Value(value: number);
get HighAlch(): number;
set HighAlch(value: number);
get LowAlch(): number;
set LowAlch(value: number);
get Weight(): number;
set Weight(value: number);
get Members(): boolean;
set Members(value: boolean);
get Tradeable(): boolean;
set Tradeable(value: boolean);
get Equipable(): boolean;
set Equipable(value: boolean);
get ReleaseDate(): string;
set ReleaseDate(value: string);
get Destroy(): string;
set Destroy(value: string);
get QuestItem(): boolean;
set QuestItem(value: boolean);
get Stackable(): boolean;
set Stackable(value: boolean);
get Noted(): boolean;
set Noted(value: boolean);
get OfficialWikiUrl(): string;
set OfficialWikiUrl(value: string);
get IconUrl(): string | undefined;
set IconUrl(value: string | undefined);
get AttackStab(): number | undefined;
set AttackStab(value: number | undefined);
get AttackSlash(): number | undefined;
set AttackSlash(value: number | undefined);
get AttackCrush(): number | undefined;
set AttackCrush(value: number | undefined);
get AttackMagic(): number | undefined;
set AttackMagic(value: number | undefined);
get AttackRanged(): number | undefined;
set AttackRanged(value: number | undefined);
get DefenceStab(): number | undefined;
set DefenceStab(value: number | undefined);
get DefenceSlash(): number | undefined;
set DefenceSlash(value: number | undefined);
get DefenceCrush(): number | undefined;
set DefenceCrush(value: number | undefined);
get DefenceMagic(): number | undefined;
set DefenceMagic(value: number | undefined);
get DefenceRanged(): number | undefined;
set DefenceRanged(value: number | undefined);
get MeleeStrength(): number | undefined;
set MeleeStrength(value: number | undefined);
get RangedStrength(): number | undefined;
set RangedStrength(value: number | undefined);
get MagicDamage(): number | undefined;
set MagicDamage(value: number | undefined);
get Prayer(): number | undefined;
set Prayer(value: number | undefined);
static fromJson(json: ItemJson): Item;
}
export interface ItemInstance extends Item {
quantity: number;
}
//# sourceMappingURL=Item.d.ts.map