player.set_objective_allegiance_name

a.k.a. player.set_round_card_text

Typically, at the start of a round in most game modes, the player sees a small informational popup with a brief blurb describing their objective; this is unofficially called the "round card." The round card can also display an icon and name, usually used if the player is allied with some in-game faction; this function changes that name.

If the text passed in differs from that used in the previous frame, then this function will also trigger display of the round card.

Arguments

text

The icon caption text to display. This is a persistent format string.

Example

--
-- Relevant code from Invasion:
--
for each player do
   if current_player.team == team[1] then 
      current_player.set_round_card_icon(covenant)
      current_player.set_round_card_text("Elite")
   end
end
for each player do
   if current_player.team == team[0] then 
      current_player.set_round_card_icon(noble)
      current_player.set_round_card_text("Spartan")
   end
end

Notes

See also