Skip to main content

​
Class Commands

Assign and inspect player classes and class-driven behaviors.

​
Members

​
animations

Animation names mapped to graphics, consumed by optional combat modules.
  • Source: packages/server/src/Player/ClassManager.ts
  • Kind: property
  • Defined in: ActorData

​
Signature

​
Change Actor

Replace the player’s active actor identity while preserving acquired progression. The new actor’s parameter curves are evaluated at the current level and HP/SP keep their previous fill ratios. Starting equipment is intentionally not granted. Runs on the authoritative server in standalone RPG and MMORPG modes. Animation bindings are available to optional combat modules through combatAnimations.
  • Source: packages/server/src/Player/ClassManager.ts
  • Kind: method
  • Member of: RpgPlayer

​
Signature

​
Parameters

  • actorInput: ActorInput

​
Returns

The resolved actor object.

​
Examples

​
changeActor

Change the active actor without granting starting equipment or resetting the player’s acquired progression.
  • Source: packages/server/src/Player/ClassManager.ts
  • Kind: method
  • Defined in: IClassManager

​
Signature

​
Parameters

  • actor: ActorInput

​
Returns

The resolved actor object

​
createClassInstance

Create a class instance without side effects.
  • Source: packages/server/src/Player/ClassManager.ts
  • Kind: method

​
Signature

​
Parameters

  • classInput: ClassInput

​
resolveClassSnapshot

Resolve class snapshot entry into a class instance without side effects.
  • Source: packages/server/src/Player/ClassManager.ts
  • Kind: method

​
Signature

​
Parameters

  • snapshot: { _class?: any }
  • mapOverride?: any

​
setActor

Set up the player as a specific actor archetype
  • Source: packages/server/src/Player/ClassManager.ts
  • Kind: method
  • Defined in: IClassManager

​
Signature

​
Parameters

  • actor: ActorInput

​
Returns

The resolved actor object

​
setClass

Assign a class to the player
  • Source: packages/server/src/Player/ClassManager.ts
  • Kind: method
  • Defined in: IClassManager

​
Signature

​
Parameters

  • _class: ClassInput

​
Returns

The instantiated class object

​
WithClassManager

Class Manager Mixin Provides class and actor management capabilities to any class. This mixin handles character class assignment and actor setup, including automatic parameter configuration, starting equipment, and skill progression based on class definitions.
  • Source: packages/server/src/Player/ClassManager.ts
  • Kind: function

​
Signature

​
Parameters

  • Base: TBase

​
Returns

Extended class with class management methods

​
Examples