Skip to content

fix(network): correctly map PlayerIndex to SlotIndex in CRC validation #2857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fbraz3 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(network): correctly map PlayerIndex to SlotIndex in CRC validation #2857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Generals/Code/GameEngine/Include/Common/PlayerList.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ class PlayerList : public SubsystemInterface,
*/
Player *findPlayerWithNameKey(NameKeyType key);

void setSlotIndex(Int playerIndex, Byte slotIndex);
Byte getSlotIndex(Int playerIndex) const;
void resolveSlotIndices();

/**
Return the "local" player (ie, the human playing the game).
This will never return null.
Expand Down Expand Up @@ -162,6 +166,7 @@ class PlayerList : public SubsystemInterface,
Player *m_local;
Int m_playerCount;
Player *m_players[MAX_PLAYER_COUNT];
Byte m_slotIndices[MAX_PLAYER_COUNT];

};

Expand Down
47 changes: 46 additions & 1 deletion Generals/Code/GameEngine/Source/Common/RTS/PlayerList.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
#endif
#include "GameLogic/SidesList.h"
#include "GameNetwork/NetworkDefs.h"

#include "GameNetwork/GameInfo.h"

//-----------------------------------------------------------------------------
/*extern*/ PlayerList *ThePlayerList = nullptr;
Expand Down Expand Up @@ -110,6 +110,49 @@ Player *PlayerList::findPlayerWithNameKey(NameKeyType key)
return nullptr;
}

//-----------------------------------------------------------------------------
void PlayerList::setSlotIndex(Int playerIndex, Byte slotIndex)
{
if (playerIndex >= 0 && playerIndex < ARRAY_SIZE(m_slotIndices))
{
m_slotIndices[playerIndex] = slotIndex;
}
}

Comment thread
fbraz3 marked this conversation as resolved.
Byte PlayerList::getSlotIndex(Int playerIndex) const
{
if (playerIndex >= 0 && playerIndex < ARRAY_SIZE(m_slotIndices))
{
return m_slotIndices[playerIndex];
}

return -1;
}

void PlayerList::resolveSlotIndices()
{
if (!TheGameInfo)
return;

AsciiString playerName;

for (Int i = 0; i < MAX_SLOTS; ++i)
{
const GameSlot* slot = TheGameInfo->getSlot(i);
if (!slot || !slot->isOccupied())
continue;

playerName.format("player%d", i);

Player* player = findPlayerWithNameKey(TheNameKeyGenerator->nameToKey(playerName));
if (player)
{
setSlotIndex(player->getPlayerIndex(), i);
}
}
}


Comment thread
fbraz3 marked this conversation as resolved.
//-----------------------------------------------------------------------------
void PlayerList::reset()
{
Expand Down Expand Up @@ -226,13 +269,15 @@ void PlayerList::newGame()
p->setDefaultTeam();
}

resolveSlotIndices();
}

//-----------------------------------------------------------------------------
void PlayerList::init()
{
m_playerCount = 1;
m_players[0]->init(nullptr);
memset(m_slotIndices, -1, sizeof(m_slotIndices));
Comment thread
fbraz3 marked this conversation as resolved.

for (int i = 1; i < MAX_PLAYER_COUNT; i++)
m_players[i]->init(nullptr);
Expand Down
4 changes: 3 additions & 1 deletion Generals/Code/GameEngine/Source/GameLogic/System/GameLogic.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2345,9 +2345,11 @@ void GameLogic::processCommandList( CommandList *list )
{
// TheSuperHackers @bugfix Caball009 14/06/2026 Check if player is still connected,
// to avoid spurious mismatches at low CRC intervals, e.g. every frame.
if (!TheNetwork->isPlayerConnected(it->first))
const Int slotIndex = ThePlayerList->getSlotIndex(it->first);
if (slotIndex >= 0 && !TheNetwork->isPlayerConnected(slotIndex))
continue;


const UnsignedInt crc = it->second;

if (!hasReferenceCRC)
Expand Down
5 changes: 5 additions & 0 deletions GeneralsMD/Code/GameEngine/Include/Common/PlayerList.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ class PlayerList : public SubsystemInterface,
*/
Player *findPlayerWithNameKey(NameKeyType key);

void setSlotIndex(Int playerIndex, Byte slotIndex);
Comment thread
fbraz3 marked this conversation as resolved.
Byte getSlotIndex(Int playerIndex) const;
void resolveSlotIndices();
Comment thread
fbraz3 marked this conversation as resolved.

/**
Return the "local" player (ie, the human playing the game).
This will never return null.
Expand Down Expand Up @@ -162,6 +166,7 @@ class PlayerList : public SubsystemInterface,
Player *m_local;
Int m_playerCount;
Player *m_players[MAX_PLAYER_COUNT];
Byte m_slotIndices[MAX_PLAYER_COUNT];

@xezon xezon Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason why the PlayerList class owns the slot indices as opposed to the GameInfo class owning the player indices?

I am not sure right now which one is better, but my first instinct would have been to tie it to GameInfo class, because that is closer to the slots. Do we have any opinions on this?

@Caball009 Caball009 Jul 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think PlayerList is preferable because there are a couple of places where it's not clear to me if we could easily access GameInfo.

You can search the code base for player%d to find them; one example:

GeneralsGameCode/Core/GameEngine/Source/GameNetwork/NetCommandMsg.cpp

Lines 156 to 158 in 480a9a7

AsciiString name;
name.format("player%d", getPlayerID());
retval->friend_setPlayerIndex( ThePlayerList->findPlayerWithNameKey(TheNameKeyGenerator->nameToKey(name))->getPlayerIndex());


};

Expand Down
47 changes: 46 additions & 1 deletion GeneralsMD/Code/GameEngine/Source/Common/RTS/PlayerList.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
#endif
#include "GameLogic/SidesList.h"
#include "GameNetwork/NetworkDefs.h"

#include "GameNetwork/GameInfo.h"

//-----------------------------------------------------------------------------
/*extern*/ PlayerList *ThePlayerList = nullptr;
Expand Down Expand Up @@ -110,6 +110,49 @@ Player *PlayerList::findPlayerWithNameKey(NameKeyType key)
return nullptr;
}

//-----------------------------------------------------------------------------
void PlayerList::setSlotIndex(Int playerIndex, Byte slotIndex)
{
if (playerIndex >= 0 && playerIndex < ARRAY_SIZE(m_slotIndices))
{
m_slotIndices[playerIndex] = slotIndex;
}
}

Byte PlayerList::getSlotIndex(Int playerIndex) const
{
if (playerIndex >= 0 && playerIndex < ARRAY_SIZE(m_slotIndices))
{
return m_slotIndices[playerIndex];
}

return -1;
}

void PlayerList::resolveSlotIndices()
{
if (!TheGameInfo)
return;

AsciiString playerName;

for (Int i = 0; i < MAX_SLOTS; ++i)
{
const GameSlot* slot = TheGameInfo->getSlot(i);
if (!slot || !slot->isOccupied())
continue;

playerName.format("player%d", i);

Player* player = findPlayerWithNameKey(TheNameKeyGenerator->nameToKey(playerName));
if (player)
{
setSlotIndex(player->getPlayerIndex(), i);
}
}
}


//-----------------------------------------------------------------------------
void PlayerList::reset()
{
Expand Down Expand Up @@ -226,13 +269,15 @@ void PlayerList::newGame()
p->setDefaultTeam();
}

resolveSlotIndices();
}

//-----------------------------------------------------------------------------
void PlayerList::init()
{
m_playerCount = 1;
m_players[0]->init(nullptr);
memset(m_slotIndices, -1, sizeof(m_slotIndices));

for (int i = 1; i < MAX_PLAYER_COUNT; i++)
m_players[i]->init(nullptr);
Expand Down
4 changes: 3 additions & 1 deletion GeneralsMD/Code/GameEngine/Source/GameLogic/System/GameLogic.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2671,9 +2671,11 @@ void GameLogic::processCommandList( CommandList *list )
{
// TheSuperHackers @bugfix Caball009 14/06/2026 Check if player is still connected,
// to avoid spurious mismatches at low CRC intervals, e.g. every frame.
if (!TheNetwork->isPlayerConnected(it->first))
const Int slotIndex = ThePlayerList->getSlotIndex(it->first);
if (slotIndex >= 0 && !TheNetwork->isPlayerConnected(slotIndex))
continue;


Comment thread
fbraz3 marked this conversation as resolved.
const UnsignedInt crc = it->second;

if (!hasReferenceCRC)
Expand Down
Loading