destiny-2-Sunrise/Sunrise/src/middleware/gameplay/external/actor_entity_registry.cpp

#include "actor_entity_registry.h"

#include "../../bap/activity_message/scriptable_auth_body.h"
#include "../../content/packages/tables/slot_descriptor_reader.h"
#include "composite_entity_codec.h"
#include "entity_identity_metadata.h"

namespace sunrise::middleware::gameplay::external {
namespace {

namespace format = state::activity_sdk::format;

/** @return True when the slot still holds the incarnation a token names. */
[[nodiscard]] bool same_token(const ActorEntitySlot& slot, const EntityToken& token) noexcept {
    return slot.occupied && slot.incarnation == token.incarnation;
}

/**
 * Resolves one RSAT tag to its single actor class.
 * A duplicate tag, or a row whose reverse definition tag disagrees, resolves to nothing.
 * @param catalog Pinned actor-class rows.
 * @param rsatTag Tag taken from a create baseline.
 * @param output Receives the class index.
 * @return True when exactly one consistent row owns that tag.
 */
[[nodiscard]] bool resolve_actor_class(const ActorEntityCatalog& catalog,
                                       std::uint32_t rsatTag,
                                       std::uint32_t& output) noexcept {
    const std::span<const format::ActorClass> actors = catalog.classes;
    std::uint32_t found = format::kAbsentIndex;
    for (std::size_t index = 0; index < actors.size(); ++index) {
        const format::ActorClass& actor = actors[index];
        if (actor.rsatTag != rsatTag) {
            continue;
        }
        if (found != format::kAbsentIndex || actor.definitionTag == 0
            || actor.definitionTag == format::kAbsentIndex
            || actor.rsatReverseDefinitionTag != actor.definitionTag) {
            return false;
        }
        found = static_cast<std::uint32_t>(index);
    }
    if (found == format::kAbsentIndex) {
        return false;
    }
    output = found;
    return true;
}

/** Pins one catalog view. Every slot is cleared when the rows change owner. */
void bind_catalog(ActorEntityRegistry& registry, const ActorEntityCatalog& catalog) noexcept {
    if (registry.catalog == catalog.owner && registry.classData == catalog.classes.data()
        && registry.classCount == catalog.classes.size()) {
        return;
    }
    registry.catalog = catalog.owner;
    registry.classData = catalog.classes.data();
    registry.classCount = catalog.classes.size();
    registry.slots.fill({});
}

} // namespace

/**
 * Applies one accepted allocation and its exact decoded actor-source relation.
 * @param registry Slot table to update.
 * @param catalog Pinned actor-class rows.
 * @param record Decoded record.
 * @return What the record did to the slot it names.
 */
ActorEntityApplyResult apply_actor_entity_record(ActorEntityRegistry& registry,
                                                 const ActorEntityCatalog& catalog,
                                                 const EntityRecord& record) noexcept {
    if (catalog.classes.empty() || !valid_token(record.token)) {
        return ActorEntityApplyResult::invalid;
    }
    const bool catalogChanged = registry.catalog != catalog.owner
                                || registry.classData != catalog.classes.data()
                                || registry.classCount != catalog.classes.size();
    const ActorEntitySlot previous =
        catalogChanged ? ActorEntitySlot{} : registry.slots[record.token.slot];
    ActorEntitySlot candidate = previous;
    const bool creating = (record.flags & entityCreate) != 0;
    const bool removing = (record.flags & entityRemove) != 0;
    if (removing && !creating) {
        if (!same_token(previous, record.token)) {
            return ActorEntityApplyResult::staleToken;
        }
        bind_catalog(registry, catalog);
        registry.slots[record.token.slot] = {};
        return ActorEntityApplyResult::actorRemoved;
    }
    bool fresh = false;
    if (creating) {
        if (record.type != EntityType::sobject) {
            bind_catalog(registry, catalog);
            registry.slots[record.token.slot] = {};
            return ActorEntityApplyResult::nonActor;
        }
        std::uint32_t rsatTag{};
        if (!composite_sobject_rsat(record.baseline, rsatTag)) {
            return ActorEntityApplyResult::invalid;
        }
        std::uint32_t actorClassIndex = format::kAbsentIndex;
        if (!resolve_actor_class(catalog, rsatTag, actorClassIndex)) {
            bind_catalog(registry, catalog);
            registry.slots[record.token.slot] = {};
            return ActorEntityApplyResult::nonActor;
        }
        fresh = !same_token(previous, record.token) || previous.rsatTag != rsatTag
                || previous.actorClassIndex != actorClassIndex
                || previous.allocationSequence != record.allocationSequence;
        if (fresh) {
            candidate = {};
        }
        candidate.actorClassIndex = actorClassIndex;
        candidate.rsatTag = rsatTag;
        candidate.incarnation = record.token.incarnation;
        candidate.allocationSequence = record.allocationSequence;
        candidate.occupied = true;
    } else if (!same_token(previous, record.token)) {
        return ActorEntityApplyResult::staleToken;
    }
    if (removing) {
        bind_catalog(registry, catalog);
        registry.slots[record.token.slot] = {};
        return ActorEntityApplyResult::actorRemoved;
    }
    state::gameplay::entity_identity::ActorSourceReference source{};
    if ((record.flags & entityUpdate) != 0 && record.update.actorSource.known) {
        if (!extract_actor_source_reference(record, source)) {
            return ActorEntityApplyResult::invalid;
        }
        candidate.authoredSource = source;
    }
    const bool membershipChanged = candidate.authoredSource != previous.authoredSource;
    bind_catalog(registry, catalog);
    registry.slots[record.token.slot] = candidate;
    return fresh ? ActorEntityApplyResult::actorCreated
                 : (membershipChanged ? ActorEntityApplyResult::membershipChanged
                                      : ActorEntityApplyResult::unchanged);
}

/** Catalog and source relations end with their exact peer view. */
void reset_actor_entity_registry(ActorEntityRegistry& registry) noexcept {
    registry.catalog.reset();
    registry.classData = nullptr;
    registry.classCount = 0;
    registry.slots.fill({});
}

} // namespace sunrise::middleware::gameplay::external