Author Topic: List of variables...  (Read 2032 times)

vinenator

  • Newbie
  • *
  • Posts: 8
    • View Profile
List of variables...
« on: February 08, 2012, 04:12:04 PM »
is there a list of the variables (isRound, RoundNum, etc.) ?
the help in the software doesn't list them all.


Corey Cooper

  • Administrator
  • Hero Member
  • *****
  • Posts: 5402
    • View Profile
Re: List of variables...
« Reply #1 on: February 08, 2012, 04:53:56 PM »
The user manual does list all of the variables available in version 2.  I still have not completed updating the user manual in version 3.  It's my least favorite thing to do.  :-)


So for version 3, here are the variables directly from the code, along with my comments on what they represent.  The comments should be up-to-date, but no promises.


Tournament variables.  These refer to the state of the tournament.

  // current round number
  RoundNum

  // current break number, 0 if not currently in break
  BreakNum

  // current level number
  Level

  // (boolean) 1 if current level is a round, 0 if level is a break
  IsRound

  // (boolean) 1 if next level is a round, 0 if level is a break
  NextIsRound

  // 0 = before, 1 = countdown, 2 = in tournament, 3 = after
  State

  // "before",  "countdown", "inprogress", "after"
  StateDesc

  // total number of buyins
  Buyins

  // the total amount collected from buy-ins
  TotalBuyinsAmount

  // the total amount raked from buy-ins
  TotalBuyinsRake

  // the total number of chips received from the initial buy-in
  TotalBuyinsChips

  // total number of bought-in players who are also members of the league to which the tournament belongs
  NumberOfLeagueMembers

  // the amount of money in the pot
  Pot

  // the current number of players
  PlayersLeft

  // the current number of tables in play
  TablesLeft

  // the number of seconds left on the clock
  SecondsLeft

  // the number of seconds that have elapsed in the current level (or countdown)
  SecondsElapsed

  // (boolean) 1 if clock is paused, 0 if clock is running
  ClockPaused

  // the number of seconds the clock has been paused
  ClockPausedSeconds

  // military style (0, 10000, 120000, 230000, etc (includes seconds))
  TimeOfDay

  // current time (internal format)
  Time

  // the time of day (same format as TimeOfDay) that the last player movement suggestion was accepted
  LastPlayerMoveTime

  // the fee for a buy-in, as listed on the Game tab
  DefaultBuyinFee

  // the rake for a buy-in, as listed on the Game tab
  DefaultBuyinRake

  // the chips received (starting chips) for a buy-in, as listed on the Game tab
  DefaultBuyinChips

  // the fee for a rebuy, as listed on the Game tab
  DefaultRebuyFee

  // the rake for a rebuy, as listed on the Game tab
  DefaultRebuyRake

  // the chips received for a rebuy, as listed on the Game tab
  DefaultRebuyChips

  // the fee for an add-on, as listed on the Game tab
  DefaultAddOnFee

  // the rake for an add-on, as listed on the Game tab
  DefaultAddOnRake

  // the chips received for an add-on, as listed on the Game tab
  DefaultAddOnChips

  // the guaranteed pot amount, as listed on the Game tab
  GuaranteedPot

  // the pot amount as computed before adding any to reach the specified guaranteed pot
  PreGuaranteedPot

  // the amount the house needs to add to reach the guaranteed pot amount
  HouseAdds

  // the house contribution amount, as listed on the Game tab
  HouseContribution

  // (boolean) 1 if rebuys are currently allowed, 0 otherwise (as listed on the Game tab)
  RebuysAllowed

  // (boolean) 1 if the rebuy period has expired, 0 otherwise
  RebuysOver

  // the number of rebuys remaining
  RebuysLeft

  // the amount of time (seconds) left in the rebuy period, if it is configured to end on a particular level
  RebuysSecondsLeft

  // the total number of rebuys in the tournament
  TotalRebuys

  // the total amount collected from rebuys
  TotalRebuysAmount

  // the total amount raked from rebuys
  TotalRebuysRake

  // the total number of chips bought via rebuys
  TotalRebuysChips

  // (boolean) 1 if add-ons are currently allowed, 0 otherwise
  AddOnsAllowed

  // (boolean) 1 if the add-on period has expired, 0 otherwise
  AddOnsOver

  // the number of add-ons remaining
  AddOnsLeft

  // the amount of time (seconds) left in the add-on period, if it is configured to end on a particular level
  AddOnsSecondsLeft

  // the total number of add-ons in the tournament
  TotalAddOns

  // the total amount collected from add-ons
  TotalAddOnsAmount

  // the total amount raked from add-ons
  TotalAddOnsRake

  // the total number of chips bought via add-ons
  TotalAddOnsChips

  // the highest rank that is in the money
  InTheMoneyRank

  // the total collected by the fixed rake
  TotalFixedRake

  // the Buyin Fixed Rake divided by the number of entries
  FixedRake

  // the current ante amount
  Ante

  // the current small blind amount
  SmallBlind

  // the current big blind amount
  BigBlind

  // the current limit1 amount
  Limit1

  // the current limit2 amount
  Limit2

  // 0 = limit, 1 = pot limit, 2 = no limit
  GameType

  // the name of the game for the current round
  GameName

  // the ante amount next round
  NextAnte

  // the small blind amount next round
  NextSmallBlind

  // the big blind amount next round
  NextBigBlind

  // the big limit1 amount next round
  NextLimit1

  // the big limit2 amount next round
  NextLimit2

  // same as gametype, for next round
  NextGameType

  // the name of the game for the next round
  NextGameName

  // the current chip count (total chips in play)
  ChipCount



Player variables.  These refer to a specific player.

  // the amount this player spent buying in
  BuyinCost

  // the amount raked from this player's buy-in
  BuyinRake

  // the number of bounty chips the player bought
  NumberOfBountyChips

  // the amount the player paid for all bounty chips purchased
  BountyChipCost

  // the number of rebuys for a player
  NumberOfRebuys

  // the total amount the player paid for all rebuys purchased
  RebuyCost

  // the total amount raked from all rebuys purchased by this player
  RebuyRake

  // the number of add-ons for a player
  NumberOfAddOns

  // the total amount the player paid for all add-ons purchased
  AddOnCost

  // the total amount raked from all add-ons purchased by this player
  AddOnRake

  // the total amount the player paid for participating in the tournament
  TotalCost

  // the total amount raked from all money this player has paid
  TotalRake

  // the number of hits a player has made
  NumberOfHits

  // the number of bounty chips a player has won
  NumberOfBountiesWon

  // the amount of money won by this player by busting other players out
  BountyWinnings

  // the number of bounty chips a player has kept
  NumberOfBountiesKept

  // the amount of money the player paid for bounty chips and did not lose
  BountyMoneyKept

  // the amount of money won by this player from prizes
  PrizeWinnings

  // the total amount of money won by this player
  TotalWinnings

  // the total profit for this player
  Take

  // the rank of a player
  Rank

  // (boolean) 1 if this player has ranked "in the money", 0 otherwise
  InTheMoney

  // (boolean) 1 if this player made the final table, 0 otherwise
  FinalTable

  // the number of seconds that this player was active (not busted out)
  PlayingTime

  // the round in which this player busted out
  RoundOut

  // the position of a player
  Position

  // (boolean) 1 if this player is a member of the tournament's league, else 0
  InLeague

  // This player's rank relative to other league members
  LeagueRank

  // This player's UUID
  InternalID

  // This player's ID
  ID

  // The player's current chip stack (count); (ChipCount is already a tournament variable for all chips in play)
  ChipStack

  // The number of players (including this player) seated at the player's table
  PlayersAtSameTable



Conditions variables.  Where conditions can be specified with a formula (events, layout items), the Tournament variables are active plus the following:

  // number of seconds left on a hand timer
  HandTimerSecondsLeft

  // (boolean) 1 if this prize is a bounty prize, 0 otherwise
  IsBountyPrize

vinenator

  • Newbie
  • *
  • Posts: 8
    • View Profile
Re: List of variables...
« Reply #2 on: February 08, 2012, 09:14:48 PM »
a 1000 thanks!

Bixby

  • Newbie
  • *
  • Posts: 45
  • Guinness is Goodness
    • View Profile
Re: List of variables...
« Reply #3 on: February 09, 2012, 07:13:12 AM »
This is helpful information. Perhaps this post should get pinned.
My KARMA ran over your DOGMA

Corey Cooper

  • Administrator
  • Hero Member
  • *****
  • Posts: 5402
    • View Profile
Re: List of variables...
« Reply #4 on: February 09, 2012, 10:17:59 AM »
Good idea.

Corey Cooper

  • Administrator
  • Hero Member
  • *****
  • Posts: 5402
    • View Profile
Re: List of variables...
« Reply #5 on: May 26, 2013, 09:49:23 AM »
Version 3.2 now has a cheat sheet built into the software, which gives the definitive list of variables, functions, and operators that can be used in formulas and conditions.  I'm going to un-sticky this topic now...