Skip to content

New Engine Feature: Concealment #17

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
4Luke4 wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

New Engine Feature: Concealment #17

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 EEex-Core-Shared-Files/headers/EEex/EEex.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ namespace EEex {
// New op409
int Opcode_Hook_EnableActionListener_ApplyEffect(CGameEffect* pEffect, CGameSprite* pSprite);
void Opcode_Hook_EnableActionListener_OnRemove(CGameEffect* pEffect, CGameSprite* pSprite);
// New op419
int Opcode_Hook_Concealment_ApplyEffect(CGameEffect* pEffect, CGameSprite* pSprite);

int Opcode_Hook_ApplySpell_ShouldFlipSplprotSourceAndTarget(CGameEffect* pEffect);
int Opcode_Hook_OnCheckAdd(CGameEffect* pEffect, CGameSprite* pSprite);
Expand All @@ -130,6 +132,9 @@ namespace EEex {
void Sprite_Hook_OnAfterEffectListUnmarshalled(CGameSprite* pSprite);
void Sprite_Hook_OnBeforeEffectListMarshalled(CGameSprite* pSprite);
byte Sprite_Hook_OnGetAttackFrameType(CGameSprite* pSprite, byte numAttacks);
void Sprite_Hook_BeginConcealmentRender(CGameSprite* pSprite);
void Sprite_Hook_EndConcealmentRender(CGameSprite* pSprite);
bool Sprite_Hook_ResolveConcealment(CGameSprite* pAttacker, CGameSprite* pTarget);

////////////
// Action //
Expand Down
238 changes: 223 additions & 15 deletions EEex-Core-Shared-Files/source/EEex.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,24 @@ struct ExStatInfo {

std::unordered_map<int, ExStatInfo> exStatInfoMap{};

constexpr int CONCEALMENT_STAT_ID = 211;
constexpr int CONCEALMENT_MAX_TRANSLUCENCY = 191;
constexpr const char* CONCEALMENT_STAT_NAME = "B3_CONCEALMENT";
constexpr const char* CONCEALMENT_ENGINEST_ROW = "STRREF_TARGET_CONCEALED";

constexpr short scaleConcealmentToTranslucency(int concealment) {
return static_cast<short>((concealment * CONCEALMENT_MAX_TRANSLUCENCY + 50) / 100);
}

static_assert(scaleConcealmentToTranslucency(0) == 0);
static_assert(scaleConcealmentToTranslucency(50) == 96);
static_assert(scaleConcealmentToTranslucency(100) == CONCEALMENT_MAX_TRANSLUCENCY);

int concealmentStatId = -1;
int concealmentFeedbackStrRef = -1;
bool concealmentMissingMetadataLogged = false;
bool concealmentMissingRuntimeStatLogged = false;

struct ExScriptData {
bool bPlayerScript;
};
Expand Down Expand Up @@ -147,6 +165,9 @@ struct ExSpriteData {

EngineVal<CVidBitmap> combatRoundsOverride[5]{};
Array<int, 3> oldDisabledSpellTypes;
CGameAnimationType* concealmentRenderAnimation = nullptr;
int concealmentRenderDepth = 0;
bool concealmentRenderUseSpriteShader = false;
bool deferredAfterListsResolvedPending = false;
int oldDisableSpells = 0;
uint64_t uuid = 0;
Expand Down Expand Up @@ -3738,21 +3759,13 @@ void EEex::Opcode_Hook_SetTemporaryAIScript_OnRemove(CGameEffect* pEffect, CGame
STUTTER_LOG_END
}

//-----------//
// New op401 //
//-----------//

int EEex::Opcode_Hook_SetExtendedStat_ApplyEffect(CGameEffect* pEffect, CGameSprite* pSprite) {

STUTTER_LOG_START(int, "EEex::Opcode_Hook_SetExtendedStat_ApplyEffect")

int applyExtendedStatModifier(CGameEffect* pEffect, CGameSprite* pSprite, int exStatId, const char* opcodeName) {
int param1 = pEffect->m_effectAmount;
int modType = pEffect->m_dWFlags;
int exStatId = pEffect->m_special;

ExStatInfo* exStatInfo;
if (auto exStatInfoPair = exStatInfoMap.find(exStatId); exStatInfoPair == exStatInfoMap.end()) {
FPrint("[!][EEex.dll] op401 (SetExtendedStat) - Invalid special (extended stat id) value: %d\n", exStatId);
FPrint("[!][EEex.dll] %s - Invalid extended stat id: %d\n", opcodeName, exStatId);
return 1;
}
else {
Expand All @@ -3773,12 +3786,23 @@ int EEex::Opcode_Hook_SetExtendedStat_ApplyEffect(CGameEffect* pEffect, CGameSpr
newVal = clampedPercent(exStatValues[exStatId], param1);
break;
default:
FPrint("[!][EEex.dll] op401 (SetExtendedStat) - Invalid param2 (modification type) value: %d\n", modType);
FPrint("[!][EEex.dll] %s - Invalid param2 (modification type) value: %d\n", opcodeName, modType);
return 1;
}

exStatValues[exStatId] = clamp(newVal, exStatInfo->min, exStatInfo->max);
return 1;
}

//-----------//
// New op401 //
//-----------//

int EEex::Opcode_Hook_SetExtendedStat_ApplyEffect(CGameEffect* pEffect, CGameSprite* pSprite) {

STUTTER_LOG_START(int, "EEex::Opcode_Hook_SetExtendedStat_ApplyEffect")

return applyExtendedStatModifier(pEffect, pSprite, pEffect->m_special, "op401 (SetExtendedStat)");

STUTTER_LOG_END
}
Expand Down Expand Up @@ -3835,9 +3859,9 @@ void EEex::Opcode_Hook_ProjectileMutator_OnRemove(CGameEffect* pEffect, CGameSpr
STUTTER_LOG_END
}

//-----------------//
// START New op409 //
//-----------------//
//-----------//
// New op409 //
//-----------//

int EEex::Opcode_Hook_EnableActionListener_ApplyEffect(CGameEffect* pEffect, CGameSprite* pSprite) {

Expand All @@ -3864,8 +3888,154 @@ void EEex::Opcode_Hook_EnableActionListener_OnRemove(CGameEffect* pEffect, CGame
STUTTER_LOG_END
}

//-----------------//
// START New op419 //
//-----------------//

int EEex::Opcode_Hook_Concealment_ApplyEffect(CGameEffect* pEffect, CGameSprite* pSprite) {

STUTTER_LOG_START(int, "EEex::Opcode_Hook_Concealment_ApplyEffect")

if (concealmentStatId == -1) {
return 1;
}
return applyExtendedStatModifier(pEffect, pSprite, concealmentStatId, "op419 (Concealment)");

STUTTER_LOG_END
}

static void applyConcealmentTranslucency(CDerivedStats& stats) {

if (concealmentStatId == -1) {
return;
}

auto& exStatValues = exStatDataMap[&stats].exStatValues;
const auto concealmentPair = exStatValues.find(concealmentStatId);
if (concealmentPair == exStatValues.end()) {
return;
}

// Reload initializes this field from the CRE base value on every derived-stat
// pass. Applying concealment last keeps stronger native translucency intact.
const short concealmentTranslucency = scaleConcealmentToTranslucency(
clamp(concealmentPair->second, 0, 100)
);
if (concealmentTranslucency > stats.m_nTranslucent) {
stats.m_nTranslucent = concealmentTranslucency;
}
}

static bool shouldUseLegacyConcealmentRenderer(CGameSprite* pSprite) {

if (concealmentStatId == -1) {
return false;
}

CDerivedStats* const pStats = pSprite->GetActiveStats();
const auto statsPair = exStatDataMap.find(pStats);
if (statsPair == exStatDataMap.end()) {
return false;
}

const auto& exStatValues = statsPair->second.exStatValues;
const auto concealmentPair = exStatValues.find(concealmentStatId);
if (concealmentPair == exStatValues.end()) {
return false;
}

return clamp(concealmentPair->second, 0, 100) > 0;
}

void EEex::Sprite_Hook_BeginConcealmentRender(CGameSprite* pSprite) {

auto exDataPair = exSpriteDataMap.find(pSprite);
if (exDataPair == exSpriteDataMap.end()) {
return;
}

ExSpriteData& exData = exDataPair->second;
if (exData.concealmentRenderDepth > 0) {
++exData.concealmentRenderDepth;
return;
}

if (!shouldUseLegacyConcealmentRenderer(pSprite)) {
return;
}

CGameAnimationType* const pAnimation = pSprite->m_animation.m_animation;
if (pAnimation == nullptr || !pAnimation->m_bUseSpriteShader) {
return;
}

// The sprite shader ignores low-range translucency when outlines are enabled.
// Select the legacy alpha path only for this sprite's render interval.
exData.concealmentRenderAnimation = pAnimation;
exData.concealmentRenderUseSpriteShader = pAnimation->m_bUseSpriteShader;
exData.concealmentRenderDepth = 1;
pAnimation->m_bUseSpriteShader = false;
}

void EEex::Sprite_Hook_EndConcealmentRender(CGameSprite* pSprite) {

auto exDataPair = exSpriteDataMap.find(pSprite);
if (exDataPair == exSpriteDataMap.end()) {
return;
}

ExSpriteData& exData = exDataPair->second;
if (exData.concealmentRenderDepth <= 0 || --exData.concealmentRenderDepth > 0) {
return;
}

if (exData.concealmentRenderAnimation != nullptr) {
exData.concealmentRenderAnimation->m_bUseSpriteShader = exData.concealmentRenderUseSpriteShader;
}
exData.concealmentRenderAnimation = nullptr;
exData.concealmentRenderUseSpriteShader = false;
}

bool EEex::Sprite_Hook_ResolveConcealment(CGameSprite* pAttacker, CGameSprite* pTarget) {

STUTTER_LOG_START(bool, "EEex::Sprite_Hook_ResolveConcealment")

(void)pAttacker;
if (concealmentStatId == -1) {
if (!concealmentMissingMetadataLogged) {
FPrint("[!][EEex.dll] op419 (Concealment) - B3_CONCEALMENT metadata is missing; allowing hit\n");
concealmentMissingMetadataLogged = true;
}
return true;
}

auto& exStatValues = exStatDataMap[pTarget->GetActiveStats()].exStatValues;
const auto concealmentPair = exStatValues.find(concealmentStatId);
if (concealmentPair == exStatValues.end()) {
if (!concealmentMissingRuntimeStatLogged) {
FPrint("[!][EEex.dll] op419 (Concealment) - Target is missing the B3_CONCEALMENT derived stat; allowing hit\n");
concealmentMissingRuntimeStatLogged = true;
}
return true;
}

const int concealment = clamp(concealmentPair->second, 0, 100);
const int roll = p_rand() % 100 + 1;
if (roll > concealment) {
return true;
}

CInfGame& game = *(*p_g_pBaldurChitin)->m_pObjectGame;
if ((game.m_options.m_nEffectTextLevel & 1) != 0 && concealmentFeedbackStrRef != -1) {
displaySpriteMessage(pTarget, std::format("{}{}", fetchStrRef(concealmentFeedbackStrRef)->m_pchData, concealment).c_str());
}
return false;

STUTTER_LOG_END
}

//---------------//
// END New op409 //
// END New op419 //
//---------------//

int EEex::Opcode_Hook_ApplySpell_ShouldFlipSplprotSourceAndTarget(CGameEffect* pEffect) {
Expand Down Expand Up @@ -3965,6 +4135,8 @@ void EEex::Opcode_Hook_AfterListsResolved(CGameSprite* pSprite) {
CDerivedStats& stats = *pSprite->GetActiveStats();
lua_State *const L = luaState();

applyConcealmentTranslucency(stats);

if (EEex::Opcode_LuaHook_DeferredAfterListsResolved_Enabled) {
// The engine can resolve the same sprite's effect lists many times in a
// tick. Defer opt-in Lua listeners to the sprite's real AI pass, where
Expand Down Expand Up @@ -5491,6 +5663,10 @@ int getExtendedStatField(C2DArray* pXStats2DA, const char* name, int id, const c
}

void initStats() {
concealmentStatId = -1;
concealmentFeedbackStrRef = -1;
concealmentMissingMetadataLogged = false;
concealmentMissingRuntimeStatLogged = false;

EngineVal<CAIIdList> pStatsIDS{};
pStatsIDS->LoadList("STATS", false);
Expand Down Expand Up @@ -5528,6 +5704,38 @@ void initStats() {
}

exStatInfoMap.try_emplace(id, min, max, def);

if (strcmp(name, CONCEALMENT_STAT_NAME) == 0) {
if (id == CONCEALMENT_STAT_ID) {
concealmentStatId = id;
}
else {
FPrint("[!][EEex.dll] %s must use stat id %d, found %d; concealment disabled\n",
CONCEALMENT_STAT_NAME, CONCEALMENT_STAT_ID, id);
}
}
}

if (concealmentStatId != -1) {
EngineVal<C2DArray> pEngineStrings2DA{};
{
const CResRef resref{"ENGINEST"};
pEngineStrings2DA->Load(&resref);
}

const int rowIndex = pEngineStrings2DA->FindRowLabel(CONCEALMENT_ENGINEST_ROW);
const int columnIndex = pEngineStrings2DA->FindColumnLabel("StrRef");
if (rowIndex == -1 || columnIndex == -1) {
FPrint("[!][EEex.dll] ENGINEST.2DA - Missing %s row or StrRef column; concealment feedback disabled\n",
CONCEALMENT_ENGINEST_ROW);
}
else if (!parseInt(pEngineStrings2DA->GetAt(columnIndex, rowIndex)->m_pchData, concealmentFeedbackStrRef)
|| concealmentFeedbackStrRef < 0)
{
FPrint("[!][EEex.dll] ENGINEST.2DA - Invalid StrRef for %s; concealment feedback disabled\n",
CONCEALMENT_ENGINEST_ROW);
concealmentFeedbackStrRef = -1;
}
}
}

Expand Down
5 changes: 5 additions & 0 deletions EEex-Core-Shared-Files/source/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ static void exportPatterns() {
// New op409
exportPattern(TEXT("EEex::Opcode_Hook_EnableActionListener_ApplyEffect"), EEex::Opcode_Hook_EnableActionListener_ApplyEffect);
exportPattern(TEXT("EEex::Opcode_Hook_EnableActionListener_OnRemove"), EEex::Opcode_Hook_EnableActionListener_OnRemove);
// New op419
exportPattern(TEXT("EEex::Opcode_Hook_Concealment_ApplyEffect"), EEex::Opcode_Hook_Concealment_ApplyEffect);

exportPattern(TEXT("EEex::Opcode_Hook_OnCopy"), EEex::Opcode_Hook_OnCopy);
exportPattern(TEXT("EEex::Opcode_Hook_OnDestruct"), EEex::Opcode_Hook_OnDestruct);
Expand All @@ -153,6 +155,9 @@ static void exportPatterns() {
exportPattern(TEXT("EEex::Sprite_Hook_OnAfterEffectListUnmarshalled"), EEex::Sprite_Hook_OnAfterEffectListUnmarshalled);
exportPattern(TEXT("EEex::Sprite_Hook_OnBeforeEffectListMarshalled"), EEex::Sprite_Hook_OnBeforeEffectListMarshalled);
exportPattern(TEXT("EEex::Sprite_Hook_OnGetAttackFrameType"), EEex::Sprite_Hook_OnGetAttackFrameType);
exportPattern(TEXT("EEex::Sprite_Hook_BeginConcealmentRender"), EEex::Sprite_Hook_BeginConcealmentRender);
exportPattern(TEXT("EEex::Sprite_Hook_EndConcealmentRender"), EEex::Sprite_Hook_EndConcealmentRender);
exportPattern(TEXT("EEex::Sprite_Hook_ResolveConcealment"), EEex::Sprite_Hook_ResolveConcealment);

////////////
// Action //
Expand Down