analyze

Analyzes a given PokerHand which has been parsed by the HandHistory Parser hhp. Relative player positions are calculated, i.e. cutoff, button, etc. Players are included in order of action on flop.

The analyzed hand then can be visualized by hhv.

For an example of an analyzed hand please view json output of an analyzed hand.

analyze(hand: object): object
Parameters
hand (object) hand history as parsed by hhp
Returns
object: the analyzed hand

filterInactives

Filters all players who didn't act in the hand or just folded.

filterInactives(players: Array<Object>): Array<Object>
Parameters
players (Array<Object>) all players in the hand
Returns
Array<Object>: all players that were active in the hand

hha.script

Scripts what happened in a hand into a actions script array. This array can be read top down to replay the hand.

The players and info fields from the analyzed data are copied over. Each action includes the index at which the player that's executing the action can be found in the players array.

Structure of returned object:

info: object containing hand info
table: object containing info about the table like total seats
board: object cards on the board
players: array of all players at the table including all info about their stacks
actions:
 preflop  : array of preflop actions
 flop     : array of flop actions
 turn     : array of turn actions
 river    : array of river actions
 showdown : array of showdown actions
hha.script(data: object): object
Parameters
data (object) analyzed hand data @see hha()
Returns
object:

hha.storyboard

Takes a script of actions and calculates the states for each. Adds pointers to the state at the beginning of each script.

This is useful if you try to jump around in the hand and reset the state of the table.

hha.storyboard(script: Object)
Parameters
script (Object) created via @see hha:script

hha.summary

Converts a hand that was analyzed and then scripted to a summary representation.

The summary has the following properties:

  • header: contains game info, like room, pokertype, blinds, etc.
  • seats: lists the seats of the players including pos, chips and hero indicators
  • chipsStackRatio: hero's M for tournaments, his BBs for cash games
  • preflopSummary: hero's cards and position
  • preflopActions: action types + amounts of each player by position
  • flopSummary: pot at flop, board and playersInvolved
  • flopActions: same as preflopActions
  • turnSummary: pot at turn, turn card and playersInvolved
  • turnActions: same as preflopActions
  • riverSummary: pot at river, river card and playersInvolved
  • riverActions: same as preflopActions
  • totalPot: total money in the pot
  • spoilers: players whos cards are known by position
hha.summary(script: Object): Object
Parameters
script (Object)
Returns
Object: the hand summarized