Class Alignment

constructor

• new Alignment(alignment: any): Alignment

  Parameters

  • alignment: any

    The alignment string to parse

  Returns Alignment

alignment

base

chaotic

• get chaotic(): boolean

  Returns boolean

evil

• get evil(): boolean

  Returns boolean

good

• get good(): boolean

  Returns boolean

label

• get label(): string

  Retrieve the localized label for this alignment

  Returns string

  • The localized label

lawful

• get lawful(): boolean

  Returns boolean

neutral

• get neutral(): boolean

  Returns boolean

trueNeutral

• get trueNeutral(): boolean

  Returns boolean

change

• change(alignmentChange: any): void

  Change this alignment based on the provided parameters.

  Parameters

  • alignmentChange: any

    Alignment change object

  Returns void

stepsTo

• stepsTo(alignment: string | Alignment): number

  Returns the number of steps between two different alignments

  Parameters

  • alignment: string | Alignment

    The alignment to compare it to

  Returns number

  • The number of steps between the two alignments

toString

• toString(): any

  Returns the alignment string.

  Returns any

  • The alignment string, e.g. "lg", "n", "ce"

Staticparse

• parse(align: string | Alignment): Alignment

  Turn an arbitrary input into an alignment object, if possible.

  Parameters

  • align: string | Alignment

    Alignment string or instance.

  Returns Alignment

  • An alignment instance

StaticstepsBetween

• stepsBetween(
      alignment1: string | Alignment,
      alignment2: string | Alignment,
  ): number

  Returns the number of steps between two different alignments.

  Parameters

  • alignment1: string | Alignment

    The base alignment

  • alignment2: string | Alignment

    The alignment to compare it to

  Returns number

  • The number of steps between the two alignments