👤Player

Table to work with CPlayer. CPlayer extends <mark

style="color:purple">CEntity

PrepareUnitOrders(player: CPlayer, type: Enum.UnitOrder, target: CEntity|nil, pos: Vector, ability: CAbility|nil, issuer: Enum.PlayerOrderIssuer, issuer_npc: CNPC|CNPC[], queue [?]: boolean, show_effects [?]: boolean, callback [?]: boolean, execute_fast [?]: boolean, identifier [?]: string): nil

Provides ability to execute such game actions as moving, attacking, or casting spells etc.

HoldPosition(player: CPlayer, issuer_npc: CNPC, queue [?]: boolean, push [?]: boolean, execute_fast [?]: boolean, identifier [?]: string): nil

Sends the hold position action.

AttackTarget(player: CPlayer, issuer_npc: CNPC, target: CNPC, queue [?]: boolean, push [?]: boolean, execute_fast [?]: boolean, identifier [?]: string): nil

Sends the attack target position.

GetPlayerID(player: CPlayer): integer

Returns the player ID within the current game session. If the player ID is not valid, it will return -1.

GetPlayerSlot(player: CPlayer): integer

Returns the player slot number within the current game session.

GetPlayerTeamSlot(player: CPlayer): integer

Returns the team slot number assigned to the player within their respective team.

GetName(player: CPlayer): string

Returns the player nickname.

GetPlayerData(player: CPlayer): ``

Returns the player data table.

GetTeamData(player: CPlayer): ``

Returns the player team data table. Team data is only available for players on the local team.

GetNeutralStashItems(player: CPlayer): {item: CItem }[]

Returns table with CItems available in the neutral stash.

GetTeamPlayer(player: CPlayer): ``

Returns Team Player Data table

IsMuted(player: CPlayer): boolean

Returns the player mute status.

GetSelectedUnits(player: CPlayer): CNPC[]

Returns table of selected units by player.

AddSelectedUnit(player: CPlayer, NPC: CNPC): nil

Adds unit to player selection.

ClearSelectedUnits(player: CPlayer): nil

Clears player selection.

GetQuickBuyInfo(player: CPlayer): {m_quickBuyItems:integer[], m_quickBuyIsPurchasable:boolean[]}

Returns table with m_quickBuyItems(item ids) and m_quickBuyIsPurchasable(table of booleans).

GetTotalGold(player: CPlayer): integer

Returns total gold of player.

GetAssignedHero(player: CPlayer): CHero|nil

Returns player's assigned hero.

GetActiveAbility(player: CPlayer): CAbility|nil

Returns player's active ability.