Skill Commands

Learn, forget, and use skills from the server-side player API.

Skill Commands

Learn, forget, and use skills from the server-side player API.

Members

• _type
• coefficient
• createSkillInstance
• description
• forgetSkill
• forgetSkill
• getSkill
• getSkill
• hitRate
• id
• learnSkill
• learnSkill
• name
• onForget
• onLearn
• onUse
• onUseFailed
• power
• resolveSkillsSnapshot
• spCost
• useSkill
• useSkill
• WithSkillManager

_type

Type marker for database

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillObject

Signature

_type: 'skill'

coefficient

Coefficient multipliers for damage calculation

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillObject

Signature

coefficient: Record<string, number>

createSkillInstance

Create a skill instance without learning side effects.

• Source: packages/server/src/Player/SkillManager.ts
• Kind: method

Signature

createSkillInstance(skillInput: SkillClass | SkillObject | string)

Parameters

• skillInput: SkillClass | SkillObject | string

description

Description of the skill

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillObject

Signature

description: string

forgetSkill

Forget a learned skill

Removes a skill from the player’s skill list.

• Source: packages/server/src/Player/SkillManager.ts
• Kind: method

Signature

forgetSkill(skillInput: SkillClass | SkillObject | string, options?: SkillChangeOptions): any

Parameters

• skillInput: SkillClass | SkillObject | string
• options.source: Optional source reported to player.onSkillChange. Defaults to manual.
• options.level: Optional level reported to player.onSkillChange.

Returns

The forgotten skill data

Examples

player.forgetSkill('fire');
// or
player.forgetSkill(FireSkill);

forgetSkill

Forget a skill

• Source: packages/server/src/Player/SkillManager.ts
• Kind: method
• Defined in: ISkillManager

Signature

forgetSkill(skillInput: SkillClass | SkillObject | string, options?: SkillChangeOptions): any

Parameters

• skillInput: SkillClass | SkillObject | string
• options.source: Optional source reported to player.onSkillChange. Defaults to manual.
• options.level: Optional level reported to player.onSkillChange.

Returns

The forgotten skill data

getSkill

Retrieves a learned skill

Searches the player’s learned skills by ID, class, or object.

• Source: packages/server/src/Player/SkillManager.ts
• Kind: method

Signature

getSkill(skillInput: SkillClass | SkillObject | string): Skill | null

Parameters

• skillInput: SkillClass | SkillObject | string

Returns

The skill data if found, null otherwise

Examples

const skill = player.getSkill('fire');
if (skill) {
  console.log(`Fire skill costs ${skill.spCost} SP`);
}

getSkill

Retrieves a learned skill. Returns null if not found

• Source: packages/server/src/Player/SkillManager.ts
• Kind: method
• Defined in: ISkillManager

Signature

getSkill(skillInput: SkillClass | SkillObject | string): any | null

Parameters

• skillInput: SkillClass | SkillObject | string

Returns

The skill data or null

hitRate

Hit rate (0-1) - probability of successful skill usage

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillObject

Signature

hitRate: number

Default

1

id

Unique identifier for the skill If not provided, one will be auto-generated

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillObject

Signature

id: string

learnSkill

Learn a new skill

Adds a skill to the player’s skill list. Supports three input formats:

• String ID: Retrieves the skill from the database

• Class: Creates an instance and adds to database if needed

• Object: Uses directly and adds to database if needed

• Source: packages/server/src/Player/SkillManager.ts

• Kind: method

Signature

learnSkill(skillInput: SkillClass | SkillObject | string, options?: SkillChangeOptions): any

Parameters

• skillInput: SkillClass | SkillObject | string
• options.source: Optional source reported to player.onSkillChange. Defaults to manual.
• options.level: Optional level reported to player.onSkillChange.

Returns

The learned skill data

Examples

// From database
player.learnSkill('fire');

// From class
player.learnSkill(FireSkill);

// From object
player.learnSkill({
  id: 'custom-skill',
  name: 'Custom Skill',
  spCost: 20,
  onLearn(player) {
    console.log('Learned custom skill!');
  }
});

learnSkill

Learn a skill

Supports three input formats:

• String ID: Retrieves from database

• Class: Creates instance and adds to database

• Object: Uses directly and adds to database

• Source: packages/server/src/Player/SkillManager.ts

• Kind: method

• Defined in: ISkillManager

Signature

learnSkill(skillInput: SkillClass | SkillObject | string, options?: SkillChangeOptions): any

Parameters

• skillInput: SkillClass | SkillObject | string
• options.source: Optional source reported to player.onSkillChange. Defaults to manual.
• options.level: Optional level reported to player.onSkillChange.

Returns

The learned skill data

name

Display name of the skill

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillObject

Signature

name: string

onForget

Called when the skill is forgotten

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillHooks

Signature

onForget: (player: RpgPlayer) => void | Promise<void>

Parameters

• “ - The player forgetting the skill

onLearn

Called when the skill is learned by the player

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillHooks

Signature

onLearn: (player: RpgPlayer) => void | Promise<void>

Parameters

• “ - The player learning the skill

onUse

Called when the skill is successfully used

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillHooks

Signature

onUse: (player: RpgPlayer, target?: RpgPlayer | RpgPlayer[]) => void | Promise<void>

Parameters

• “ - The target player(s) if any

onUseFailed

Called when the skill usage fails (e.g., chance roll failed)

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillHooks

Signature

onUseFailed: (player: RpgPlayer, target?: RpgPlayer | RpgPlayer[]) => void | Promise<void>

Parameters

• “ - The intended target player(s) if any

power

Base power of the skill for damage calculation

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillObject

Signature

power: number

resolveSkillsSnapshot

Resolve skill snapshot entries into Skill instances without side effects.

• Source: packages/server/src/Player/SkillManager.ts
• Kind: method

Signature

resolveSkillsSnapshot(snapshot: { skills?: any[] }, mapOverride?: any)

Parameters

• snapshot: { skills?: any[] }
• mapOverride?: any

spCost

SP (Skill Points) cost to use the skill

• Source: packages/server/src/Player/SkillManager.ts
• Kind: property
• Defined in: SkillObject

Signature

spCost: number

Default

0

useSkill

Use a learned skill

Executes a skill, consuming SP and applying effects to targets. The skill must be learned and the player must have enough SP.

• Source: packages/server/src/Player/SkillManager.ts
• Kind: method

Signature

useSkill(skillInput: SkillClass | SkillObject | string, otherPlayer?: RpgPlayer | RpgPlayer[]): any

Parameters

• skillInput: SkillClass | SkillObject | string
• otherPlayer?: RpgPlayer | RpgPlayer[]

Returns

The used skill data

Examples

// Use skill without target
player.useSkill('fire');

// Use skill on a target
player.useSkill('fire', enemy);

// Use skill on multiple targets
player.useSkill('fire', [enemy1, enemy2]);

useSkill

Use a skill

• Source: packages/server/src/Player/SkillManager.ts
• Kind: method
• Defined in: ISkillManager

Signature

useSkill(skillInput: SkillClass | SkillObject | string, otherPlayer?: RpgPlayer | RpgPlayer[]): any

Parameters

• skillInput: SkillClass | SkillObject | string
• otherPlayer?: RpgPlayer | RpgPlayer[]

Returns

The used skill data

WithSkillManager

Skill Manager Mixin

Provides skill management capabilities to any class. This mixin handles learning, forgetting, and using skills, including SP cost management, hit rate calculations, and skill effects application.

Supports three input formats for skills:

• String ID: References a skill in the database

• Class: A skill class that will be instantiated

• Object: A skill object with properties and hooks

• Source: packages/server/src/Player/SkillManager.ts

• Kind: function

Signature

WithSkillManager(Base: TBase): TBase

Parameters

• Base: TBase

Returns

Extended class with skill management methods

Examples

// Using string ID (from database)
player.learnSkill('fire');

// Using skill class
player.learnSkill(FireSkill);

// Using skill object
player.learnSkill({
  id: 'ice',
  name: 'Ice',
  spCost: 15,
  onUse(player) {
    console.log('Ice spell cast!');
  }
});