# Player Color

Grammar — option|Current/Default player player color
Flags — Native | Function

Returns the player color of the player.

# Arguments

• int — Player
• bool [ preset::PlayerColorOption ] — Option

Returns — int [ playercolor ]

native int PlayerGetColorIndex(
	int inPlayer,
	bool inDefault,
);

# Related

Category: Player / Player Settings

• [F] — void — Modify Player Property (Integer) — ( PlayerModifyPropertyInt )
• [F] — void — Modify Player Property (Real) — ( PlayerModifyPropertyFixed )
• [F] — int — Player Property (Integer) — ( PlayerGetPropertyInt )
• [F] — fixed — Player Property (Real) — ( PlayerGetPropertyFixed )
• [F] — void — Modify Player Score (Integer) — ( PlayerScoreValueSetFromInt )
• [F] — void — Modify Player Score (Real) — ( PlayerScoreValueSetFromFixed )
• [F] — int — Player Score Value (Integer) — ( PlayerScoreValueGetAsInt )
• [F] — fixed — Player Score Value (Real) — ( PlayerScoreValueGetAsFixed )
• [F] — void — Turn Player Flag On/Off — ( PlayerSetState )
• [F] — bool — Player Flag Check — ( PlayerGetState )
• [F] — bool — Player License Check — ( PlayerHasLicense )
• [F] — bool — Player Access Check — ( PlayerHasAccessTo )
• [F] — bool — Player Has Reward — ( PlayerHasReward )
• [F] — bool — Player Has Talent — ( PlayerHasTalent )
• [F] — text — Name Of Player — ( PlayerName )
• [F] — string — Handle Of Player — ( PlayerHandle )
• [F] — string [ gamelink::Race ] — Race Of Player — ( PlayerRace )
• [F] — string [ gamelink::Hero ] — Hero Of Player — ( PlayerHero )
• [F] — string [ gamelink::Skin ] — Skin Of Player — ( PlayerSkin )
• [F] — string [ gamelink::Mount ] — Mount Of Player — ( PlayerMount )
• [F] — string [ gamelink::Spray ] — Spray Of Player — ( PlayerSpray )
• [F] — string [ gamelink::Artifact ] — Artifact Of Player — ( PlayerArtifact )
• [F] — int — Artifact Rank Of Player — ( PlayerArtifactRank )
• [F] — string [ gamelink::Commander ] — Commander Of Player — ( PlayerCommander )
• [F] — int — Commander Level Of Player — ( PlayerCommanderLevel )
• [F] — int — Commander Mastery Level Of Player — ( PlayerCommanderMasteryLevel )
• [F] — int — Commander Mastery Talent Rank Of Player — ( PlayerCommanderMasteryTalentRank )
• [F] — int — Commander Selected Prestige Of Player — ( PlayerCommanderSelectedPrestige )
• [F] — int — Brutal Plus Difficulty of Player — ( PlayerBrutalPlusDifficulty )
• [F] — int — Retry Mutation Index of Player — ( PlayerRetryMutation )
• [F] — int — Allied Commander Enemy Wave Type — ( PlayerACEnemyWaveType )
• [F] — point — Start Location Of Player — ( PlayerStartLocation )
• [F] — int [ preset::PlayerController ] — Controller Of Player — ( PlayerType )
• [F] — int [ preset::PlayerStatus ] — Status Of Player — ( PlayerStatus )
• [F] — void — Set Player Color — ( PlayerSetColorIndex )
• [F] — void — Set Player Race — ( PlayerSetRace )
• [F] — void — Set Player Hero — ( PlayerSetHero )
• [F] — void — Set Player Skin — ( PlayerSetSkin )
• [F] — void — Set Player Console Skin — ( PlayerSetConsoleSkin )
• [F] — void — Apply Player Skin — ( PlayerApplySkin )
• [F] — void — Apply Player Skin (Replacing Existing Unit) — ( libNtve_gf_PlayerApplySkinReplacingExistingUnit )
• [F] — void — Set Player Mount — ( PlayerSetMount )
• [F] — void — Set Player Spray — ( PlayerSetSpray )
• [F] — void — Set Player Commander — ( PlayerSetCommander )
• [F] — void — Set Player Commander Level — ( PlayerSetCommanderLevel )
• [F] — void — Set Player Commander Mastery Level — ( PlayerSetCommanderMasteryLevel )
• [F] — void — Set Player Death Timer — ( PlayerSetDeathTimer )
• [F] — void — Set Player Bounds — ( PlayerSetBounds )
• [F] — void — Add Player Talent — ( PlayerAddTalent )
• [F] — void — Remove Player Talent — ( PlayerRemoveTalent )
• [F] — void — Add Player Response — ( PlayerAddResponse )
• [F] — void — Remove Player Response — ( PlayerRemoveResponse )
• [F] — void — Clear Player Response — ( PlayerClearResponse )
• [F] — int [ playercolor ] — Player Color — ( PlayerGetColorIndex )
• [F] — void — Override Player Option — ( PlayerOptionOverride )
• [F] — string — Player Hotkey Profile — ( PlayerGetHotkeyProfile )
• [F] — void — Player Property Changed — ( TriggerAddEventPlayerPropChange )
• [F] — void — Player Joins Game — ( TriggerAddEventPlayerJoin )
• [F] — void — Player Leaves Game — ( TriggerAddEventPlayerLeft )
• [F] — int — Triggering Player — ( EventPlayer )
• [F] — int [ preset::Player_Property_Get ] — Triggering Player Property — ( EventPlayerProperty )
• [F] — int — Triggering Player Property Change (Integer) — ( EventPlayerPropertyChangeInt )
• [F] — fixed — Triggering Player Property Change (Real) — ( EventPlayerPropertyChangeFixed )
• [F] — void — Player Add Label — ( PlayerAddLabel )
• [F] — void — Player Remove Label — ( PlayerRemoveLabel )
• [F] — void — Player Remove All Labels — ( PlayerRemoveAllLabels )
• [F] — bool — Player Has Label — ( PlayerHasLabel )
• [F] — void — Player Add Reward — ( PlayerAddReward )

# Examples

# campaigns/swarm.sc2campaign

— MapScript.galaxy

// L842
PlayerGetColorIndex(gv_pLAYER_02_ZERG, false)

// L811
PlayerGetColorIndex(gv_pLAYER_01_USER, false)

// L842
PlayerGetColorIndex(gv_pLAYER_02_ZERG, false)

// L811
PlayerGetColorIndex(gv_pLAYER_01_USER, false)

# mods/core.sc2mod

— DebugAI.galaxy

// L26
PlayerGetColorIndex(player, false)

// L26
PlayerGetColorIndex(player, false)

# mods/heroesdata.stormmod

— GameLib.galaxy

// L10018
PlayerGetColorIndex(libGame_gf_ComputerPlayerInTeam(lp_team), false)

# mods/heroesdata.stormmod

— HeroesLib.galaxy

// L3795
PlayerGetColorIndex(0, false)

# mods/liberty.sc2mod

— LibertyLib.galaxy

// L155
PlayerGetColorIndex(lp_player, false)

// L242
PlayerGetColorIndex(lp_player, false)

// L335
PlayerGetColorIndex(lp_player, false)

# mods/starcoop/starcoop.sc2mod

— LibCOUI.galaxy

// L760
PlayerGetColorIndex(1, false)

// L762
PlayerGetColorIndex(2, false)

// L766
PlayerGetColorIndex(2, false)

// L768
PlayerGetColorIndex(1, false)

// L973
PlayerGetColorIndex(lp_player, false)

// L984
PlayerGetColorIndex(libCOOC_gf_CC_PlayerAlly(lp_player), false)

// L5988
PlayerGetColorIndex(2, false)

// L5991
PlayerGetColorIndex(1, false)

# mods/warcoop/warclassic.sc2mod

— WarClassic.galaxy

// L1064
PlayerGetColorIndex(lv_p, false)

# mods/warcoop/warcoopdata.sc2mod

— WarCoopData.galaxy

// L937
PlayerGetColorIndex(lv_currentIndex, false)

// L3088
PlayerGetColorIndex(lv_player, false)

# mods/warcoop/warmeleeai.sc2mod

— DebugAIWar3.galaxy

// L26
PlayerGetColorIndex(player, false)