# Player Flag Check

Grammar — Player player state is on
Flags — Native | Function

Returns true if the specified flag is enabled.

# Arguments

• int — Player
• int<preset::PlayerState> — Player Flag

Returns — bool

native bool PlayerGetState(int inPlayer, int inState);

# Related

Category: Player / Player Settings

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

# Examples

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:4537

    // Automatic Variable Declarations
    // Implementation
    return PlayerGetState(1, c_playerStateStartingRallyEnabled);
}

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignMissionLib.galaxy:3811

    // Automatic Variable Declarations
    // Implementation
    return PlayerGetState(1, c_playerStateStartingRallyEnabled);
}

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCMI.galaxy:3922

bool libNCMI_gf_NM_StartingWorkerAutoHarvestEnabled () {
    // Implementation
    return PlayerGetState(1, c_playerStateStartingRallyEnabled);
}

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOMI.galaxy:11690

    // Automatic Variable Declarations
    // Implementation
    return PlayerGetState(1, c_playerStateStartingRallyEnabled);
}

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:3430

    // Automatic Variable Declarations
    // Implementation
    return PlayerGetState(1, c_playerStateStartingRallyEnabled);
}