Skip to content

Fix discrepancy between CLEO and native subtitles behavior #547

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

Merged
x87 merged 10 commits into from
Mar 10, 2026
Merged

Fix discrepancy between CLEO and native subtitles behavior #547

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6d48a40
CLEO print commands match native commands and added to the brief
x87 Mar 8, 2026
e2808fb
Help messages are not queued
x87 Mar 8, 2026
c13ae0c
update
x87 Mar 8, 2026
cb4e3bb
Properly handle message queue
x87 Mar 9, 2026
f9a1c5c
Refactoring
x87 Mar 9, 2026
6e0adbf
Fix print_big off-by-one error
x87 Mar 10, 2026
167e8ce
more tests
x87 Mar 10, 2026
399bd93
Refactor
x87 Mar 10, 2026
172ecd6
Refactor
x87 Mar 10, 2026
794734a
suppress subtitles
x87 Mar 10, 2026
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
137 changes: 108 additions & 29 deletions cleo_plugins/Text/Text.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,17 @@ class Text
static ScriptDrawing scriptDrawing;
static CTextManager textManager;

static char msgBuffLow[400]; // same as in CMessages' text processing functions
static char msgBuffHigh[400];
static const size_t MsgBigStyleCount = 7;
static char msgBuffBig[MsgBigStyleCount][MAX_STR_LEN + 1];
static const size_t MessageQueueSize = 8; // matches CMessages::BriefMessages queue size
static const size_t BriefSize = 20; // matches CMessages::PreviousBriefs count
static const size_t BigStylesCount = 7; // matches CMessages::BIGMessages count

static size_t queueIdx;
static size_t briefIdx;

static char messageQueue[MessageQueueSize][400];
static char bigMessages[BigStylesCount][MAX_STR_LEN + 1];
static char messageNow[400];
static char briefs[BriefSize][400];

static WORD genericLabelCounter;

Expand Down Expand Up @@ -145,6 +152,66 @@ class Text
return result;
}

static bool CanTextInThisSlotBeAddedToBrief(const char* slot)
{
// content dedup: exits early if another entry already holds the same text.
for (size_t i = 0; i < BriefSize; i++)
{
const auto pText = CMessages::PreviousBriefs[i].m_pText;
if (pText == nullptr) break; // end of used entries
if (pText == slot) continue; // stale self-reference, skip to avoid a false positive duplicate
if (strcmp(pText, slot) == 0) return false; // content duplicate, exit
}

// stale pointer eviction: prevents the game's pointer-based dedup from rejecting the insertion
for (size_t i = 0; i < BriefSize; i++)
{
auto& pText = CMessages::PreviousBriefs[i].m_pText;
if (pText == slot)
{
pText = nullptr;
break;
}
}
return true;
}

static void AddToBriefHistory(const char* text)
{
if (CTheScripts::bAddNextMessageToPreviousBriefs)
{
briefIdx = (briefIdx + 1) % BriefSize;
auto& briefSlot = briefs[briefIdx];

strncpy_s(briefSlot, text, sizeof(briefSlot) - 1);

if (CanTextInThisSlotBeAddedToBrief(briefSlot))
{
CMessages::AddToPreviousBriefArray(briefSlot, -1, -1, -1, -1, -1, -1, 0);
}
}

CTheScripts::bAddNextMessageToPreviousBriefs = true;
}

static void AddToMessageQueue(CLEO::CRunningScript* pScript, const char* text, int time)
{
queueIdx = (queueIdx + 1) % MessageQueueSize;
auto& messageSlot = messageQueue[queueIdx];
strncpy_s(messageSlot, text, sizeof(messageSlot) - 1);

bool addToBrief = false;
if (!IsLegacyScript(pScript))
{
if (CTheScripts::bAddNextMessageToPreviousBriefs)
{
addToBrief = CanTextInThisSlotBeAddedToBrief(messageSlot);
}
CTheScripts::bAddNextMessageToPreviousBriefs = true;
}
CMessages::AddMessage(messageSlot, time, false, addToBrief);
}

// 0390=1,load_texture_dictionary %1s%
static OpcodeResult __stdcall opcode_0390(CLEO::CRunningScript* thread)
{
Expand Down Expand Up @@ -189,12 +256,13 @@ class Text
return CLEO_CallNativeOpcode(thread, 0x0391);
}

// 0ACA=1,show_text_box %1d%
// 0ACA=1,print_help_string %1d%
static OpcodeResult __stdcall opcode_0ACA(CLEO::CRunningScript* thread)
{
OPCODE_READ_PARAM_STRING(text);

CHud::SetHelpMessage(text, true, false, false);
if (!IsLegacyScript(thread)) AddToBriefHistory(text);
return OR_CONTINUE;
}

Expand All @@ -205,78 +273,83 @@ class Text
auto time = OPCODE_READ_PARAM_INT();
auto style = OPCODE_READ_PARAM_INT();

auto styleIdx = std::clamp(style, 0, (int)MsgBigStyleCount - 1);
strncpy_s(msgBuffBig[styleIdx], text, sizeof(msgBuffBig[styleIdx]) - 1);
CMessages::AddBigMessage(msgBuffBig[styleIdx], time, style - 1);
auto styleIdx = std::clamp(style, 0, (int)BigStylesCount - 1);
auto& bigMessage = bigMessages[styleIdx];

strncpy_s(bigMessage, text, sizeof(bigMessage) - 1);
CMessages::AddBigMessage(bigMessage, time, style - 1);
Copy link
Copy Markdown
Collaborator

@MiranDMC MiranDMC Mar 9, 2026

Choose a reason for hiding this comment

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

Not using styleIdx here?

Copy link
Copy Markdown
Author

@x87 x87 Mar 9, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

no idea, looks like a hidden one-off bug here?

Copy link
Copy Markdown
Collaborator

@MiranDMC MiranDMC Mar 9, 2026

Choose a reason for hiding this comment

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

Style is clamped to valid range above, then raw value is used here.

Copy link
Copy Markdown
Author

@x87 x87 Mar 9, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

problem is that styleIdx is incorrect. It clamps valid style id 7 into 6. It means you can't display both style 6 and 7 on screen at the same time

Copy link
Copy Markdown
Author

@x87 x87 Mar 10, 2026

Choose a reason for hiding this comment

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

Fixed

return OR_CONTINUE;
}

// 0ACC=2,show_text_lowpriority %1d% time %2d%
// 0ACC=2,print_string %1d% time %2d%
static OpcodeResult __stdcall opcode_0ACC(CLEO::CRunningScript* thread)
{
OPCODE_READ_PARAM_STRING(text);
auto time = OPCODE_READ_PARAM_INT();

strncpy_s(msgBuffLow, text, sizeof(msgBuffLow) - 1);
CMessages::AddMessage(msgBuffLow, time, false, false);
AddToMessageQueue(thread, text, time);
return OR_CONTINUE;
}

// 0ACD=2,show_text_highpriority %1d% time %2d%
// 0ACD=2,print_string_now %1d% time %2d%
static OpcodeResult __stdcall opcode_0ACD(CLEO::CRunningScript* thread)
{
OPCODE_READ_PARAM_STRING(text);
auto time = OPCODE_READ_PARAM_INT();

strncpy_s(msgBuffHigh, text, sizeof(msgBuffHigh) - 1);
CMessages::AddMessageJumpQ(msgBuffHigh, time, false, false);
strncpy_s(messageNow, text, sizeof(messageNow) - 1);
CMessages::AddMessageJumpQ(messageNow, time, false, false);
if (!IsLegacyScript(thread)) AddToBriefHistory(messageNow);
return OR_CONTINUE;
}

// 0ACE=-1,show_formatted_text_box %1d%
// 0ACE=-1,print_help_formatted %1d%
static OpcodeResult __stdcall opcode_0ACE(CLEO::CRunningScript* thread)
{
OPCODE_READ_PARAM_STRING_FORMATTED(text);

CHud::SetHelpMessage(text, true, false, false);
if (!IsLegacyScript(thread)) AddToBriefHistory(text);
return OR_CONTINUE;
}

// 0ACF=-1,show_formatted_styled_text %1d% time %2d% style %3d%
// 0ACF=-1,print_big_formatted %1d% time %2d% style %3d%
static OpcodeResult __stdcall opcode_0ACF(CLEO::CRunningScript* thread)
{
OPCODE_READ_PARAM_STRING(format);
auto time = OPCODE_READ_PARAM_INT();
auto style = OPCODE_READ_PARAM_INT();
OPCODE_READ_PARAMS_FORMATTED(format, text);

auto styleIdx = std::clamp(style, 0, (int)MsgBigStyleCount - 1);
strncpy_s(msgBuffBig[styleIdx], text, sizeof(msgBuffBig[styleIdx]) - 1);
CMessages::AddBigMessage(msgBuffBig[styleIdx], time, style - 1);
auto styleIdx = std::clamp(style, 0, (int)BigStylesCount - 1);
auto& bigMessage = bigMessages[styleIdx];

strncpy_s(bigMessage, text, sizeof(bigMessage) - 1);
CMessages::AddBigMessage(bigMessage, time, style - 1);
return OR_CONTINUE;
}

// 0AD0=-1,show_formatted_text_lowpriority %1d% time %2d%
// 0AD0=-1,print_formatted %1d% time %2d%
static OpcodeResult __stdcall opcode_0AD0(CLEO::CRunningScript* thread)
{
OPCODE_READ_PARAM_STRING(format);
auto time = OPCODE_READ_PARAM_INT();
OPCODE_READ_PARAMS_FORMATTED(format, text);

strncpy_s(msgBuffLow, text, sizeof(msgBuffLow) - 1);
CMessages::AddMessage(msgBuffLow, time, false, false);
AddToMessageQueue(thread, text, time);
return OR_CONTINUE;
}

// 0AD1=-1,show_formatted_text_highpriority %1d% time %2d%
// 0AD1=-1,print_formatted_now %1d% time %2d%
static OpcodeResult __stdcall opcode_0AD1(CLEO::CRunningScript* thread)
{
OPCODE_READ_PARAM_STRING(format);
auto time = OPCODE_READ_PARAM_INT();
OPCODE_READ_PARAMS_FORMATTED(format, text);

strncpy_s(msgBuffHigh, text, sizeof(msgBuffHigh) - 1);
CMessages::AddMessageJumpQ(msgBuffHigh, time, false, false);
strncpy_s(messageNow, text, sizeof(messageNow) - 1);
CMessages::AddMessageJumpQ(messageNow, time, false, false);
if (!IsLegacyScript(thread)) AddToBriefHistory(messageNow);
return OR_CONTINUE;
}

Expand Down Expand Up @@ -434,7 +507,7 @@ class Text
auto modelIndex = OPCODE_READ_PARAM_UINT();

CVehicleModelInfo* model;
// if 1.0 US, prefer GetModelInfo function — makes it compatible with fastman92's limit adjuster
// if 1.0 US, prefer GetModelInfo function - makes it compatible with fastman92's limit adjuster
if (CLEO_GetGameVersion() == CLEO::GV_US10)
model = plugin::CallAndReturn<CVehicleModelInfo*, 0x403DA0, int>(modelIndex);
else
Expand Down Expand Up @@ -671,9 +744,15 @@ class Text

ScriptDrawing Text::scriptDrawing;
CTextManager Text::textManager;
char Text::msgBuffLow[400];
char Text::msgBuffHigh[400];
char Text::msgBuffBig[MsgBigStyleCount][MAX_STR_LEN + 1];

size_t Text::queueIdx = 0;
size_t Text::briefIdx = 0;

char Text::messageQueue[Text::MessageQueueSize][400];
char Text::briefs[Text::BriefSize][400];
char Text::bigMessages[Text::BigStylesCount][MAX_STR_LEN + 1];
char Text::messageNow[400];

WORD Text::genericLabelCounter;

// exports
Expand Down
6 changes: 3 additions & 3 deletions tests/cleo_tests/Math/2707.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ function tests
end
end

assert_range(aCount, 80, 120)
assert_range(bCount, 80, 120)
assert_range(cCount, 80, 120)
assert_range(aCount, 80, 130) // flaky
assert_range(bCount, 80, 130)
assert_range(cCount, 80, 130)
end
end
Loading
Loading