Trigger API Reference DCEI Functions Player0 - funovus/editor-wiki GitHub Wiki
Table of Contents
- [Trigger API Reference\DCEI Functions\Player](#trigger-api-referencedcei-functionsplayer)
* [int GetPlayerCount()](#int-getplayercount)
* [int GetCurrentPlayerId()](#int-getcurrentplayerid)
* [void SetPlayerTeamId(int playerId, int teamId)](#void-setplayerteamidint-playerid-int-teamid)
* [int GetPlayerTeamId(int playerId)](#int-getplayerteamidint-playerid)
* [void AddGold(int playerId, int amount)](#void-addgoldint-playerid-int-amount)
* [void SetGold(int playerId, int amount)](#void-setgoldint-playerid-int-amount)
* [int GetGold(int playerId)](#int-getgoldint-playerid)
* [int GetUnitPlayerId(unit unit)](#int-getunitplayeridunit-unit)
* [int GetUnitTeamId(unit unit)](#int-getunitteamidunit-unit)
|
Trigger API Reference\DCEI Functions\Player {Trigger-API-ReferenceDCEI-FunctionsPlayer}
int GetPlayerCount()
Returns the number of players in the game.
local player_count = DCEI.GetPlayerCount()
int GetCurrentPlayerId()
Get the current player's id. Only useful in multiplayer.
void SetPlayerTeamId(int playerId, int teamId)
Used to set a player's team id.
local player_team_id = DCEI.GetPlayerTeamId(1)
if player_team_id = 1 then
DCEI.SetPlayerTeamId(1, 2)
end
int GetPlayerTeamId(int playerId)
local player_team_id = DCEI.GetPlayerTeamId(1)
void AddGold(int playerId, int amount)
Adds gold to a player. Maximum gold value for a player is 2,147,483,647 (2^31-1).
-
int
playerId
the ID of the player. -
int
amount
the amount of gold to be added. Use negative values to subtract gold.
function OnRegionEnter()
DCEI.AddGold(1, 10)
end
DCEI.TriggerAddUnitEnterRegionEvent(DCEI.UnitAny, DCEI.RegionAny, OnRegionEnter)
void SetGold(int playerId, int amount)
Sets a player's gold value. Maximum gold value for a player is 2,147,483,647 (2^31-1).
function OnRegionEnter()
DCEI.SetGold(1, 10)
end
DCEI.TriggerAddUnitEnterRegionEvent(DCEI.UnitAny, DCEI.RegionAny, OnRegionEnter)
int GetGold(int playerId)
Returns a player's gold value.
function OnRegionEnter()
local player_gold = DCEI.GetGold(1)
if (player_gold + 10) > 2147483647 then
DCEI.SetGold(1, 2147483647)
else
DCEI.AddGold(1, 10)
end
end
DCEI.TriggerAddUnitEnterRegionEvent(DCEI.UnitAny, DCEI.RegionAny, OnRegionEnter)
int GetUnitPlayerId(unit unit)
Returns the player ID of the owner of a unit.
local region = DCEI.FindRegion("region_0")
local team_id = 1
local player_id = 1
local unit_type = "Standard MeleeUnit"
local x, y = 16, 16
local unit = DCEI.CreateUnit(team_id, player_id, unit_type, x, y)
DCEI.LogMessage("Unit's Player ID: " .. DCEI.GetUnitPlayerId(unit))
int GetUnitTeamId(unit unit)
Returns the team ID of a unit.
local region = DCEI.FindRegion("region_0")
local team_id = 1
local player_id = 1
local unit_type = "Standard MeleeUnit"
local x, y = 16, 16
local unit = DCEI.CreateUnit(team_id, player_id, unit_type, x, y)
DCEI.LogMessage("Unit Team ID: " .. DCEI.GetUnitTeamId(unit))