Class: Predictor

Koviko.Predictor()

A predictor which uses Predictions to calculate and estimate an entire action list.

Constructor

new Predictor()

Source:

Namespaces

helpers

Members

predictions :Object.<string, Prediction>

Prediction collection
Type:
  • Object.<string, Prediction>
Source:

totalDisplay :HTMLElement

Element that displays the total amount of mana used in the action list
Type:
  • HTMLElement
Source:

Methods

(static) initElements()

Build the element that shows the total mana required by the action list.
Source:

(static) initPredictions()

Build all of the necessary components to make predictions about each action.
Source:

(static) initStyle()

Build the style element responsible for the formatting of the predictor's values.
Source:

(static) predict(prediction, state)

Perform all ticks of a prediction
Parameters:
Name Type Description
prediction Koviko.Prediction Prediction object
state Koviko.Predictor~state State object
Source:

(static) template(affected, resources, snapshots, isValid) → {string}

Generate the element showing the resources accumulated for an action in the action list.
Parameters:
Name Type Description
affected Array.<string> Names of resources to display
resources Koviko.Predictor~Resources Accumulated resources
snapshots Object Snapshots with value comparisons
Properties
Name Type Description
stats Koviko.Snapshot Value comparisons of stats from one snapshot to the next
skills Koviko.Snapshot Value comparisons of skills from one snapshot to the next
isValid boolean Whether the amount of mana remaining is valid for this action
Source:
Returns:
HTML of the new element
Type
string

(static) test()

Run a fake action list containing every possible action so that, hopefully, every function is ran at least once.
Source:

(static) tick(prediction, state) → {boolean}

Perform one tick of a prediction.
Parameters:
Name Type Description
prediction Koviko.Prediction Prediction object
state Koviko.Predictor~State State object
Source:
Returns:
Whether another tick can occur
Type
boolean

(static) update(actions, containeropt, isDebugopt)

Update the action list view.
Parameters:
Name Type Attributes Description
actions Array.<IdleLoops~ListedAction> Actions in the action list
container HTMLElement <optional>
Parent element of the action list
isDebug boolean <optional>
Whether to log useful debug information
Source:

Type Definitions

Progress

Accumulated progress
Type:
Source:

Progression

Progression
Type:
  • Object
Properties:
Name Type Description
completed number The amount of total segments completed
progress number The amount of progress in segments beyond that already represented in `completed`
total number The amount of successful loops ever completed
Source:

Resources

Accumulated resources
Type:
  • Object.<string, number>
Source:

Skills

Accumulated skill experience
Type:
  • Object.<string, number>
Source:

State

State object
Type:
  • Object
Properties:
Name Type Description
stats Koviko.Predictor~Stats Accumulated stat experience
skills Koviko.Predictor~Skills Accumulated skill experience
resources Koviko.Predictor~Resources Accumulated resources
progress Koviko.Predictor~Progress Accumulated progress
Source:

Stats

Accumulated stat experience
Type:
  • Object.<string, number>
Source: