Skip to main content

WCS

CreateServer()

Creates a Server object and returns it. If called more than once returns the same server object.

Returns:

CreateClient()

Creates a Client object and returns it. If called more than once returns the same client object.

Returns:

RegisterStatusEffect(name, extendsFrom)

Registers a new status effect with name specified in an argument.

Parameters:

  • Name: string
  • ExtendsFrom: StatusEffectImpl

Returns:

RegisterSkill(name, extendsFrom)

Registers a new skill with name specified in an argument.

Parameters:

  • Name: string
  • ExtendsFrom: Skill

Returns:

RegisterHoldableSkill(name, extendsFrom)

Registers a new holdable skill with name specified in an argument.

Parameters:

  • Name: string
  • ExtendsFrom: Skill

Returns:

DefineMessage(fn, config)

Registers a message.

Parameters:

  • Function: function
  • Config: MessageConfig

Character @readonly

An exported character class.

CreateMoveset(name, skills, constructorArgs)

Creates a Moveset object and returns it. Accepts the name and array of skills.

Parameters:

  • Name: string
  • Skills: {AnySkillConstructor}
  • ConstructorArguments: {[string | SkillImpl]: any[]} - an object that contains array of ConstructorArguments that skill should get instantiated with.

Returns:

GetMovesetObjectByName(name)

Retrieves Moveset object by its name if registered.

Parameters:

  • Name: string

Returns:

SkillType

An exported skill type enum.

Members:

Default,
Holdable