Create items

It is necessary to know

Here is the creation of items, skills, classes, weapons, etc...

Creating an item

Solution 1: Static file

In main/server/database/potion.ts

import { Item } from '@rpgjs/database'

@Item({
    id: 'potion',
    name: 'Potion',
    description: 'Gives 100 HP',
    price: 200,
    hpValue: 100
})
export default class Potion { }

TIP

If you want to add other parameters, just create properties:

import { Item } from '@rpgjs/database'

@Item({  
   
})
export class Potion {
    otherParam = 'value'
}

TIP

You also have hooks

import { Item } from '@rpgjs/database'

@Item({  
   
})
export class Potion {
    onAdd(player: RpgPlayer) {

    }
}

take a look at the database APIs to see what else is possible: [/database/item.html](Items Database)

Solution 2: Dynamic data

With backend (example with axios request):

In main/server.ts :

import { RpgServerEngineHooks, RpgServerEngine } from '@rpgjs/server'
import axios from 'axios'

const server: RpgServerEngineHooks = {
    async onStart(server: RpgServerEngine) {
        const res = await axios.get('https://my-backend-game/items')
        for (let item of res.data) {
             server.addInDatabase(item.id, item, 'item') // Put items in memory. The third parameter is the type, it could be weapon, armor, etc.
        }  
    }
}

export default server

Here it is at server loading but you can load items in other situations (when opening a maps, calling an event, etc.)

Add the item to your game

Add the main/server/database/items/potion.ts file

import { RpgServer, RpgModule } from '@rpgjs/server'
import { Potion } from './database/items/potion.ts'

@RpgModule<RpgServer>({
    database: {
        Potion
    }
})
export default class RpgServerEngine { }

Using the item in an event

Add the main/server/events/chara.ts file

import { RpgEvent, EventData, RpgPlayer } from '@rpgjs/server'

@EventData({
    name: 'EV-1'
})
export class CharaEvent extends RpgEvent {
    async onAction(player: RpgPlayer) {
       await player.showText('I give you a potion')
       player.addItem('potion') // id of item
    }
}

Bests Pratices

Either use the item's class or id: player.addItem(Potion) or player.addItem('potion'). The identifier is useful for dynamic objects or those retrieved via APIs. If this isn't the case, use the class, which will allow you to set a Typescript control.

In fact, you can use the class type to retrieve the item

const potion = player.getItem<Potion>('potion')

Create items ​

It is necessary to know ​

Creating an item ​

Solution 1: Static file ​

Solution 2: Dynamic data ​

Add the item to your game ​

Using the item in an event ​