[Ironfist ver 1.3.0] "GetCurrentPlayer()" and "GetHeroOwner(hero)"

I'm trying to understand how it works.

On the Scripting Documentation page:

GetCurrentPlayer()
Returns a number (0-5) determining which player is active now.

GetHeroOwner(hero)
hero: The hero to get the owner of. (See, for example, GetHero).
Returns the owner of the given hero as an integer (0-5), or -1 if the hero is not owned by any player (i.e.: is or may become available for hire).

I did some tests.

This does not work:

Code:

function OnHeroMove(x, y)
  player = GetCurrentPlayer();
  if player == 0 then
    MessageBox("Player is 0.");
  elseif player == 1 then
    MessageBox("Player is 1.");
  end;
end

This works:

Code:

function OnHeroMove(x, y)
  hero = GetCurrentHero();
  owner = GetHeroOwner(hero);
  if owner == 0 then
    MessageBox("Owner is 0.");
  elseif owner == 1 then
    MessageBox("Owner is 1.");
  end;
end

This works:

Code:

function OnHeroMove(x, y)
  player = GetCurrentPlayer();
  gold = GetResource(player, RESOURCE_GOLD);
  gold = gold - 500;
  SetResource(player, RESOURCE_GOLD, gold);
  MessageBox("Player - 500 gold.");
end

This does not work:

Code:

function OnHeroMove(x, y)
  hero = GetCurrentHero();
  player = GetHeroOwner(hero);
  gold = GetResource(player, RESOURCE_GOLD);
  gold = gold - 500;
  SetResource(player, RESOURCE_GOLD, gold);
  MessageBox("Player - 500 gold.");
end

So, what is the difference between the two expressions and why it works in one case and not in the other? Is this normal?

It would be nice if someone could tell me.

The reason is that GetCurrentPlayer returns a player object, while GetHeroOwner returns a number. So, the documentation is incorrect. GetCurrentPlayer().color or GetPlayerColor(GetCurrentPlayer()) should do what you want it to do. It looks like this is a change that occurred during the scripting overhaul to deep-binding.

I will make it so GetHeroOwner also returns a player object, and update the documentation of both.

This has been done. Both examples now work using "player.color == 0" .

Thanks for the explanation and the change.