Variables that can be called

What this covers

common variables you will find useful in making a overlay, check the schemas folders for additional useful information if you want to get more in-depth or the debug overlay.

This debug-template conveniently lists all these in the correct notation to work in the slippi-HUD. I recommend referencing it over this page.

Syntax

${this.playerData[X].zz.yy} is used to call data that is assigned per player

${this.generalData.zz.yy} is used to call data that is not assigned per player

X is either a 0 or 1 (0 being lowest port player, and 1 being highest ported player)

zz calls

slippi - generally allows you to access game data (generalData and playerData)
player - is names stored in dashboard (playerData)
tournament - keeps track of tournament name and other text data (generalData)
score - tracks score (playerData)

Slippi variables

generalData.slippi.
   gameInfo.
      started - boolean
      finished - boolean
      elapsedFrames - number
      isTeams -boolean
      timer.
         minutes - number
         seconds - number
         milliseconds - number
         formatted - string (text output MM.SS.XXX)
         rawFrames - number
         framerate - number
      stage.
         id - number
         fullName - string
         shortName - string

playerData[X].slippi.
   id - number
   index - number
   port - number
   character.
         id - number
         fullName - string
         shortName - string
         costumeId - number
         costumeName - string
   stockCountStart - number
   stockCountNow - number
   tag - string
   damage - number
   display - string (slippi display name)
   connect - string (slippi connect code)
   controller.
         mainStickX - number (-1 to 1)
         mainStickY - number (-1 to 1)
         cStickX - number (-1 to 1)
         cStickY - number (-1 to 1)
         rawButtons - number
         leftTrigger - number (0 to 1)
         rightTrigger - number (0 to 1)
         pressedButtons.
            A - boolean (true when pressed)
            B - boolean (true when pressed)
            X - boolean (true when pressed)
            Y - boolean (true when pressed)
            Z - boolean (true when pressed)
            L - boolean (true when pressed)
            R - boolean (true when pressed)
            START - boolean (true when pressed)
            D_UP - boolean (true when pressed)
            D_RIGHT - boolean (true when pressed)
            D_DOWN - boolean (true when pressed)
            D_LEFT - boolean (true when pressed)

Other Variables

this.playerData[X].score.score - number
this.playerData[X].player.name - string
this.playerData[X].player.sponsor - string
this.playerData[X].player.pronouns - string
this.generalData.tournament.name - string
this.generalData.tournament.round - string
this.generalData.tournament.bestOf - number
this.generalData.tournament.commentators[X].id - number
this.generalData.tournament.commentators[X].name - string
this.generalData.tournament.commentators[X].info - string