IntegerMan/angularIF

View on GitHub
src/app/engine/parser/token-classification.enum.ts

Summary

Maintainability
A
0 mins
Test Coverage
/**
 * Part of speech classifications for incoming tokens. This should be sorted in priority order with the most important tags at the top
 */
export enum TokenClassification {

  /**
   * This is a compass direction which typically will behave like either a noun or a verb in interactive fiction.
   * @type {string}
   */
  Direction = 'Direction',

  /**
   * Represents a verb such as eat, throw, or move
   * @type {string}
   */
  Verb = 'Verb',

  /**
   * Represents an object or target of an action
   * @type {string}
   */
  Noun = 'Noun',

  QuestionWord = 'QuestionWord',

  /**
   * This is a descriptive word modifying a noun.
   * @type {string}
   */
  Adjective = 'Adjective',

  Adverb = 'Adverb',

  /**
   * This is essentially an article such as 'the' and can be nearly universally ignored.
   * @type {string}
   */
  Determiner = 'Determiner',

  /**
   * This is a linking word such as 'to' or 'with' and can usually be ignored.
   * @type {string}
   */
  Preposition = 'Preposition',

  /**
   * This is a linking word such as 'and' and can usually be ignored.
   * @type {string}
   */
  Conjunction = 'Conjunction',

  /**
   * This includes common words that are typically best left out as they frequently mean nothing, for example the word 'please'
   * @type {string}
   */
  Ignorable = 'Ignorable',

  /**
   * Represents something that eludes classification.
   * @type {string}
   */
  Unknown = 'Unknown'

}