Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Engine

Hierarchy

  • Challenge
    • Engine

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns Engine

Properties

Protected _onDidRequestNextChallenge

_onDidRequestNextChallenge: EventEmitter<void> = new EventEmitter()

_shorthands

_shorthands: object

Type declaration

  • [K: string]: Function

_steps

_steps: any[]

_stores

_stores: object

Type declaration

  • [K: string]: any

Protected aliases

aliases: IDisposable[] = []

Protected editor

editor: Editor

Protected helpers

helpers: IStepHelper[] = []

Protected stepHelpers

stepHelpers: IStepHelper[] = []

stepIndex

stepIndex: number

steps

steps: any[]

stepsMappings

stepsMappings: Map<number, number> = new Map()

Protected subscriptions

subscriptions: IDisposable[] = []

widgets

widgets: Map<string, IEditorWidget> = new Map()

Accessors

onDidRequestNextChallenge

onDidRequestNextChallenge:

onDidUpdateStepIndex

onDidUpdateStepIndex:

Methods

_checkEvent

  • _checkEvent(validation: any, e: any): boolean

  • Parameters

    • validation: any
    • e: any

    Returns boolean

_expandSteps

  • _expandSteps(): any[]

  • Returns any[]

_expandStepsWithMappings

  • _expandStepsWithMappings(): object

  • Returns object

_updateStep

  • _updateStep(): void

  • Returns void

addMatchFallback

  • addMatchFallback(name: string, check: IFallbackAction): void

  • Parameters

    • name: string
    • check: IFallbackAction

    Returns void

addOppositeAction

  • addOppositeAction(expected: string, actual: string, action: IOppositeAction): void

  • Parameters

    • expected: string
    • actual: string
    • action: IOppositeAction

    Returns void

addToStore

  • addToStore(store: string, name: string, value: any): void

  • Parameters

    • store: string
    • name: string
    • value: any

    Returns void

addValidation

  • addValidation(name: string, check: IEventChecker): void

  • Parameters

    • name: string
    • check: IEventChecker

    Returns void

createStore

  • createStore(name: string): void

  • Parameters

    • name: string

    Returns void

defineBehavior

  • defineBehavior(name: string, enter: IBehaviorAction, exit: IBehaviorAction): void

  • Parameters

    • name: string
    • enter: IBehaviorAction
    • exit: IBehaviorAction

    Returns void

definePropertyProcessor

  • definePropertyProcessor(props: string[], processor: Function): void

  • Parameters

    • props: string[]
    • processor: Function

    Returns void

defineShorthand

  • defineShorthand(name: string, check: IShorthand): void

  • Parameters

    • name: string
    • check: IShorthand

    Returns void

dispose

  • dispose(): void

  • Returns void

getExpandedStepIndex

  • getExpandedStepIndex(sourceIndex: number): number

  • Parameters

    • sourceIndex: number

    Returns number

getFromStore

  • getFromStore(store: string, name: string): any

  • Parameters

    • store: string
    • name: string

    Returns any

nextStep

  • nextStep(): void

  • Returns void

onEnd

  • onEnd(): void

  • Returns void

registerAlias

  • registerAlias(alias: string, target: string): void

  • Parameters

    • alias: string
    • target: string

    Returns void

registerHelper

  • Parameters

    Returns void

setSteps

  • setSteps(steps: any[]): void

  • Parameters

    • steps: any[]

    Returns void

start

  • start(): void

  • Returns void

trigger

  • trigger(name: string): void

  • Parameters

    • name: string

    Returns void

triggerEvent

  • triggerEvent(name: string, data: any): void

  • Parameters

    • name: string
    • Optional data: any

    Returns void

Generated using TypeDoc