Skip to main content
The Player type represents a competitor in the tournament, including their personal information, current score, character selection, and tournament seeding.

​
Type Definition

type Player = {
    score: number,
    sponsor: string,
    name: string,
    losers: boolean,
    pronouns: string,
    twitter: string,
    country: string,
    state: string,
    character?: Character,
    characterColor?: CharacterColor,
    seed: number,
}

​
Fields

​
score
number
required
Current score (games won in the set)
​
sponsor
string
required
Player’s sponsor or team tag (empty string if none)
​
name
string
required
Player’s gamer tag or name
​
losers
boolean
required
Whether the player is currently in the losers bracket
​
pronouns
string
required
Player’s pronouns (e.g., “he/him”, “she/her”, “they/them”)
​
twitter
string
required
Player’s Twitter/X handle (without @ symbol)
​
country
string
required
Player’s country code (e.g., “US”, “CA”, “JP”)
​
state
string
required
Player’s state or region (e.g., “CA”, “NY”, “Tokyo”)
​
character
Character
Selected Melee character (see Character enum below)
​
characterColor
CharacterColor
Selected character color/costume (see CharacterColor enum below)
​
seed
number
required
Player’s tournament seeding number

​
Character

Melee character roster: 
enum Character {
    CAPTAIN_FALCON = 0,
    DONKEY_KONG = 1,
    FOX = 2,
    MR_GAME_AND_WATCH = 3,
    KIRBY = 4,
    BOWSER = 5,
    LINK = 6,
    LUIGI = 7,
    MARIO = 8,
    MARTH = 9,
    MEWTWO = 10,
    NESS = 11,
    PEACH = 12,
    PIKACHU = 13,
    ICE_CLIMBERS = 14,
    JIGGLYPUFF = 15,
    SAMUS = 16,
    YOSHI = 17,
    ZELDA = 18,
    SHEIK = 19,
    FALCO = 20,
    YOUNG_LINK = 21,
    DR_MARIO = 22,
    ROY = 23,
    PICHU = 24,
    GANONDORF = 25,
}

​
CharacterColor

Character costume colors: 
enum CharacterColor {
    DEFAULT,
    BLACK,
    RED,
    WHITE,
    GREEN,
    BLUE,
    ORANGE,
    YELLOW,
    PINK,
    PURPLE,
    CYAN,
    PEACH_DAISY,
}
Not all characters have all color options. The available colors for each character are defined in the CHARACTER_COLORS mapping in the source code.

Build docs developers (and LLMs) love

Get started for freeTalk to us