Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Rule

A rule to be applied when parsing a game

Hierarchy

  • Rule

Index

Constructors

Properties

Constructors

constructor

  • new Rule(type: "event" | "tracking" | "sequence", script: string, params?: RuleParam[], ruleFunction?: RuleCbk | TrackingRuleCbk): Rule

  • Parameters

    • type: "event" | "tracking" | "sequence"
    • script: string
    • Optional params: RuleParam[]
    • Optional ruleFunction: RuleCbk | TrackingRuleCbk

    Returns Rule

Properties

name

name: string

Name of the rule

Optional params

params?: RuleParam[]

Array of parameters to be passed to the rule script.

script

script: string

Typescript script to be executed

type

type: "event" | "tracking" | "sequence"

type of the rule, may be "event", "tracking" or "sequence", the type of the rule will determine when it's script will be executed.