Athena.systems.inventory.crafting ​

Interfaces ​

• CraftRecipe

Type Aliases ​

ItemCombo ​

Ƭ ItemCombo: [dbName, dbName]

Defined in ​

server/systems/inventory/crafting.ts:9

Quantities ​

Ƭ Quantities: [number, number]

Defined in ​

server/systems/inventory/crafting.ts:11

dbName ​

Ƭ dbName: string

Defined in ​

server/systems/inventory/crafting.ts:7

Functions ​

addRecipe ​

Add a recipe in-memory. Does not store to database.

Example ​

Athena.systems.inventory.crafting.addRecipe({
  combo: ['burger', 'tomato'],
  quantities: [1, 1],
  uid: 'burger-with-tomato',
  result: { dbName: 'burger-with-tomato', quantity: 1 },
});

Parameters ​

Returns ​

boolean

Defined in ​

server/systems/inventory/crafting.ts:111

combineItems ​

Combine two slots given a data set. It will attempt to find a matching recipe and make modifications according to the combination. Returns an object with the modified dataSet, and a sound associated with the crafting recipe if provided in the recipe itself.

Parameters ​

Returns ​

{ dataSet: player[] ; sound?: string } | undefined

Defined in ​

server/systems/inventory/crafting.ts:183

findRecipe ​

Attempts to find a matching recipe. If a matching recipe is found; it is returned. Otherwise, returns undefined.

Parameters ​

Returns ​

CraftRecipe | undefined

Defined in ​

server/systems/inventory/crafting.ts:139

override ​

Used to override inventory crafting functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/crafting.ts:302

Used to override inventory crafting functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/crafting.ts:303

Used to override inventory crafting functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/crafting.ts:304