resolution_fixed type_patch (an actual patch, not a request for one) | by Forgon

The player properties "name" and "ai" are broken.

In One-Player Skirmish games (excluding challenges) and Multi Player games, AI players get "name" and "ai" properties assigned only if selected interactively through the widget system (see function 'displayPlayer()' in './src/multiint.cpp'), where the position of the chosen AI in a vector of known
skirmish AIs (set up by function 'readAIs()' in './src/multiint.cpp') determines the "ai" property. The displayed AI name is copied to the player's "name". Because "Nexus" is the first entry in that vector, it is the default AI with "ai" equal to '0' (see '/.src/multiint.cpp:732').

Otherwise, all AI players

• lack a "name" value (including Nexus)
• have an "ai" value equal to '0' (wrong unless Nexus)

Challenge games get all "name" values from their configuration files printed in the setup screen before the game starts, except for player 0 (the human player). All "ai" values given are set to 'AI_CUSTOM', i.e. '127'. Once the game starts, all "name" values are discarded through the variable 'nameOverrides' (see './src/multiint.cpp').

Ingame, a player without name usually still has a name displayed. AI players without "name" value
are addressed by their colour. If a "name" value exists, their colour and a dash are prepended to their string. In chat messages, all players without names are adressed as "Commander" (since
#4612). This is useful for tutorials and campaigns.

This patch fixes all those problems by guaranteeing that

• every AI player has a "name" value. If no "name" value is given and no AI name can be found, this will be "Commander".
• every AI player has a correct "ai" value. It is determined through the index of the AI in 'aidata', the vector of known skirmish AIs, or set to 'CUSTOM_AI' (i.e. 127) for custom AIs of challenges.
• no "name" values from challenge files are overwritten

The variable 'nameOverrides' is now removed, as is other bizarre code. To correctly display "name" and "ai" values before the setup screen appears, there are now ugly hacks into the function 'hostCampaign()' in './src/multiopt.cpp':

• for challenges, split up function 'loadMultiScripts()' from './src/multiint.cpp' which assigns
  "ai" values from challenge JSON files to AI players but is only called after the game starts. A new
  function 'setupChallengeAIs()' now performs that task early.
• for all skirmish games, afterwards assign "name" values to "ai" values.

The attached files 'test.json' and 'custom.json' provide a test challenge where all effects of this patch can be observed. I could not correctly test custom AIs, i.e. AIs exclusively available for challenges, possibly because they are not implemented. There are 8 combinations of "ai" and "name", corresponding to player numbers in the challenge file:

• 0. "ai" not given, "name" given and player is 0: copy "name", "ai" equals '0'
• 1. "ai" is known skirmish ai, "name" not given: copy "name" from the AI's JSON file, assign "ai" by 'aidata' index
• 2. "ai" is custom, "name" not given: copy "name" from the AI's JSON file, "ai" equals '127' ('AI_CUSTOM')
• 3. "ai" is custom but broken, "name" not given: "name" equals "Commander", "ai" equals '127' ('AI_CUSTOM')
• 4. "ai" not given, "name" not given: copy "name" from default skirmish AI's JSON file, "ai" equals '0'
• 5. "ai" is known skirmish ai, "name" given: copy "name", assign "ai" by 'aidata' index
• 6. "ai" is custom, "name" given: copy "name", "ai" equals '127' ('AI_CUSTOM')
• 7. "ai" not given, "name" given: copy "name", "ai" equals '0'

Issue migrated from trac:4628 at 2022-04-16 12:46:18 -0700