🔨 EntityId tracking structure

[zach2good]

I affirm:

• I understand that if I do not agree to the following points by completing the checkboxes my issue will be ignored.
• I have read and understood the Contributing Guide and the Code of Conduct.
• I have searched existing issues to see if the issue has already been opened, and I have checked the commit log to see if the issue has been resolved since my server was last updated.

Describe the feature

A recurring theme of the server is the caching/looking up of pointers to invalid/gone entities. As much as I like to harp on about the abuse of DEs, invalid pointers to Pets and Trusts are still possible, so it is a legitimate problem. We need a mechanism to safely hold references to entities that might no longer exist when you try to look them up.

struct EntityId
{
    u64 hash; // Incremental is enough here. A process will never be up long enough for this to overflow. If it does we've won the stability game.
    u16 zoneId;
    u16 index;
};

TODO: A global (per process) tracker of entities.

TODO: Lookup mechanism.

TODO: On entity destruction, look up your own lookup entry and invalidate it.

[zach2good]

I'm not sure if it's even possible to stop people from taking references/pointers to objects. We wouldn't even want std::optional. We'd need:

auto entityToken = PEntity->getToken();

// later

if (auto PEntity = entityToken.resolve())
{
    // Successfully looked-up
}

// later

if (!entityToken.valid())
{
    // Log
    return;
}

[zach2good]

Does this mean we'll move all entities out of Zone->ZoneEntities? Unknown.

[zach2good]

Creation/lookup/removal of these tokens needs to be constant time. It needs to proliferate into Lua

[zach2good]

Partially related to: #5065

[zach2good]

A small place we could road-test this is PChar->PWideScanTarget. It's only used in 10 lines or so. I was thinking about whether or not we need a spawntime or creationtime stored, but the u64 incremental id serves the same purpose.

[zach2good]

We also already have someone's attempt at this:

// TODO:it is possible to make this structure part of the class, instead of the current ID and Targid, but without the Clean method

struct EntityID_t
{
    void clean()
    {
        id     = 0;
        targid = 0;
    }

    uint32 id;
    uint16 targid;
};

[zach2good]

Partially here: #6392