Skills Commands ​

Get Skill ​

• Method: player.getSkill(skillClass)
• Arguments:
  • { SkillClass | string} skillClass. or data id (Optional: false)
• Return: instance of SkillClass | null
• Usage:

Retrieves a learned skill. Returns null, if not found

import Fire from 'your-database/skills/fire'

player.getSkill(Fire)

Learn Skill ​

• Method: player.learnSkill(skillClass)
• Arguments:
  • { SkillClass | string} skillClass. or data id (Optional: false)
• Throws:

If the player already knows the skill

{
           id: SKILL_ALREADY_LEARNED,
           msg: '...'
       }
       ```
---
- **Return**: <Type type='instance of <a href="/database/skill.html">SkillClass</a>' />   
- **Usage**:

Learn a skill. Attributes the coefficient 1 to the parameter INT (intelligence) if cd is not present on the class.

`onLearn()` method is called on the SkillClass

```ts
import Fire from 'your-database/skills/fire'

player.learnSkill(Fire)

Forget Skill ​

• Method: player.learnSkill(skillClass)
• Arguments:
  • { SkillClass | string} skillClass. or data id (Optional: false)
• Throws:

If trying to forget a skill not learned

{
    id: SKILL_NOT_LEARNED,
    msg: '...'
}

• Return: instance of SkillClass
• Usage:

Forget a skill

onForget() method is called on the SkillClass

import Fire from 'your-database/skills/fire'

try {
     player.forgetSkill(Fire) 
}
catch (err) {
     console.log(err)
}

Use Skill ​

• Method: player.useSkill(skillClass,otherPlayer)
• Arguments:
  • { SkillClass | string} skillClass. or data id (Optional: false)
  • {Array< RpgPlayer> | RpgPlayer} otherPlayer. (Optional: true)
• Throws:

If the player has the Effect.CAN_NOT_SKILL effect

{
    id: RESTRICTION_SKILL,
    msg: '...'
}

If the player tries to use an unlearned skill

{
    id: SKILL_NOT_LEARNED,
    msg: '...'
}

If the player does not have enough SP to use the skill

{
    id: NOT_ENOUGH_SP,
    msg: '...'
}

If the chance to use the skill has failed (defined with the hitRate property)

{
    id: USE_CHANCE_SKILL_FAILED,
    msg: '...'
}

onUseFailed() method is called on the SkillClass

• Return: instance of SkillClass
• Usage:

Using a skill

onUse() method is called on the SkillClass

If other players are indicated then damage will be done to these other players. The method applyDamage() will be executed

import Fire from 'your-database/skills/fire'

try {
     player.useSkill(Fire) 
}
catch (err) {
     console.log(err)
}

or

• ts

import Fire from 'your-database/skills/fire'

try { player.useSkill(Fire, otherPlayer) } catch (err) { console.log(err) }