Athena.systems.inventory.factory ​

Functions ​

fromBaseToStored ​

Converts a base item into a stored item for reference.

Type parameters ​

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:391

fromBaseToStoredAsync ​

Converts a base item to a stored item asynchronously.

Type parameters ​

Parameters ​

Returns ​

Promise<player<CustomData>>

Defined in ​

server/systems/inventory/factory.ts:243

fromStoredItem ​

Converts an item from a player inventory, or toolbar to a full item set.

Also performs weight calculations.

Use when usage is not at server-start.

Type parameters ​

Parameters ​

Returns ​

player<CustomBehavior & player, CustomData> | undefined

Defined in ​

server/systems/inventory/factory.ts:327

fromStoredItemAsync ​

Converts an item from a player inventory, equipment, or toolbar to a full item set.

Also performs weight calculations.

Type parameters ​

Parameters ​

Returns ​

Promise<player<CustomBehavior & player, CustomData> | undefined>

Defined in ​

server/systems/inventory/factory.ts:175

getBaseItem ​

Get a base item based on dbName, and version if supplied.

Does not wait for database of items to load first.

Use when usage is not at server-start.

Type parameters ​

Parameters ​

Returns ​

player<player & CustomBehavior, CustomData>

Defined in ​

server/systems/inventory/factory.ts:284

getBaseItemAsync ​

Get a base item based on dbName, and version if supplied.

Type parameters ​

Parameters ​

Returns ​

Promise<player<player & CustomBehavior, CustomData>>

Defined in ​

server/systems/inventory/factory.ts:51

getBaseItemByFuzzySearch ​

Searches for a base item based on a fuzzy search. Specify either 'myitem', 'My_Item', or 'My Item'.

Will try to find a match in the following order:

• Exact dbname
• Exact name
• Partial name
• Partial dbname

Export

Type parameters ​

Parameters ​

Returns ​

player<player, CustomData> | undefined

Defined in ​

server/systems/inventory/factory.ts:463

getBaseItems ​

Does not wait for items to load, returns what base items are in the array.

Use this only during runtime; and not during startup.

Export

Returns ​

player[]

Defined in ​

server/systems/inventory/factory.ts:440

getBaseItemsAsync ​

Waits for the database items to finish loading before returning data.

Export

Returns ​

Promise<player[]>

Defined in ​

server/systems/inventory/factory.ts:423

isDoneLoadingAsync ​

Wait until the isDoneLoading variable is set to true before continuing.

Returns ​

Promise<void>

Defined in ​

server/systems/inventory/factory.ts:29

override ​

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:515

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:516

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:517

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:518

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:519

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:520

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:521

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:522

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:523

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:524

Used to override inventory item factory functionality

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:525

toStoredItem ​

Converts a full item, into a storeable version of the item.

Only certain parts of the item will be stored.

Use when usage is not at server-start.

Type parameters ​

Parameters ​

Returns ​

player<CustomData>

Defined in ​

server/systems/inventory/factory.ts:359

toStoredItemAsync ​

Converts a full item, into a storeable version of the item.

Only certain parts of the item will be stored.

Type parameters ​

Parameters ​

Returns ​

Promise<player<CustomData>>

Defined in ​

server/systems/inventory/factory.ts:207

upsertAsync ​

Updates or inserts a new database item into the database.

If a verison is specified and it does not find a matching version it will add a new item.

If a version is not specified; it will find a non-versioned item to replace.

Example ​

Athena.systems.inventory.factory.upsertAsync({
    dbName: 'burger',
    data: { health: 5 },
    icon: 'burger',
    name: 'Burger',
    maxStack: 8,
    weight: 25,
    behavior: {
        canDrop: true,
        canStack: true,
        canTrade: true,
        destroyOnDrop: false,
        isToolbar: true
    },
    consumableEventToCall: 'edible',
    customEventsToCall: [
         {
             name: 'Desconstruct',
             eventToCall: 'deconstruct-item-ingredients'
         }
   ]
});

Parameters ​

Returns ​

any

Defined in ​

server/systems/inventory/factory.ts:119