Class: Piece

Piece

The common interface for all pieces

Methods


<static> applyToClass(structure [, skips])

Applies this interface to a class
Parameters:
Name Type Argument Default Description
structure Object The structure to apply this interface to
skips Array.<string> <optional>
[] The methods to skip when applying this interface
Since:
  • 0.1.1
Source:
lib/structures/interfaces/Piece.js#L75

disable()

Disables this piece
Since:
  • 0.0.1
Source:
lib/structures/interfaces/Piece.js#L43
Returns:
This piece
Type
Piece

enable()

Enables this piece
Since:
  • 0.0.1
Source:
lib/structures/interfaces/Piece.js#L54
Returns:
This piece
Type
Piece

<async> reload()

Reloads this piece
Since:
  • 0.0.1
Source:
lib/structures/interfaces/Piece.js#L21
Returns:
The newly loaded piece
Type
Piece

toString()

Defines toString behavior for pieces
Since:
  • 0.3.0
Source:
lib/structures/interfaces/Piece.js#L65
Returns:
This piece name
Type
string

unload()

Unloads this piece
Since:
  • 0.0.1
Source:
lib/structures/interfaces/Piece.js#L33
Returns:
Type
void