mirror of
https://github.com/brues-code/ClassicAPI.git
synced 2026-11-16 16:10:36 +00:00
Addons can now choose the countdown text and its color for each range of time left. Cooldown:SetCountdownFormatter(formatter) and GetCountdownFormatter() take a NumericRuleFormatter from C_StringUtil.CreateNumericRuleFormatter(). Its breakpoints each give a threshold, an optional step, rounding (Enum.NumericRuleFormatRounding), min and max, a format string, and optional div/mod/step components, one for each format argument. Color codes in the format string pass through. The formatter is a full Lua userdata, the first in the DLL. Its block holds a pointer to a reference-counted native object. Every Lua object and every frame that uses it hold one reference, so the GC finalizer (__gc) and the frame's deleting destructor can run in any order. lua_newuserdata (0x6F4560, __fastcall, block at Udata + 0x10, read from the disassembly) is new in Offsets.h. lua_touserdata reuses FUN_FRAMESCRIPT_GET_OBJECT, which is that function. One metatable per Lua state lives in the registry. Its __metatable is false, and the identity check compares a value's metatable with it. 1.12 has no newproxy, so the only finalizer an allocation can run is ours. Thus no addon code can change a formatter while it formats. The text goes through 1.12's own str_format (0x7FD3D0). Its closure is made once per state and kept in the registry, because FormatNumber runs from addon timers and lua_pushcclosure allocates on each push. The rounding is x - fmod(x, step), plus a step away from zero when the rounding needs it. Only that arithmetic matches retail to the last bit: Up of 0.7 by 0.1 gives 0.7000000000000001 and of 0.6 gives 0.6, but ceil(x / step) * step gives 0.6000000000000001. The cooldown shares the formatter and gives it the unrounded seconds left. The formatter replaces the built-in text and both thresholds, and every gate stays. The cached countdown text is now a heap std::string, because a formatter's text has no length limit. The frame frees it, and its reference, in DeletingDestructor. A probe addon recorded 229 results in retail 12.1.5. The same probe on 1.18.1 matched 197 of them. The other results come from 1.12's own str_format (%e exponent digits, %q, %d past the int range, its error wording), from field storage on the object (not ported), and from addresses and times.
43 lines
1.7 KiB
C++
43 lines
1.7 KiB
C++
// This file is part of ClassicAPI.
|
|
//
|
|
// ClassicAPI is free software: you can redistribute it and/or modify it under the terms
|
|
// of the GNU General Public License as published by the Free Software Foundation, either
|
|
// version 3 of the License, or (at your option) any later version.
|
|
//
|
|
// ClassicAPI is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
// PURPOSE. See the GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License along with
|
|
// ClassicAPI. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
#pragma once
|
|
|
|
// Retail's NumericFormatter objects, as the engine-side users take them
|
|
// (Cooldown:SetCountdownFormatter). The one kind ported is
|
|
// C_StringUtil.CreateNumericRuleFormatter's. A formatter is shared, not
|
|
// copied: retail's cooldown shows a SetBreakpoints made after it was handed
|
|
// the formatter, and each getter call returns a new Lua object for it
|
|
// (retail probe 2026-10-31). So the formatter is reference-counted, and every
|
|
// Lua object and every holder owns one reference.
|
|
namespace Text::NumericFormatter {
|
|
|
|
struct Formatter;
|
|
|
|
void Retain(Formatter *f);
|
|
// Null-safe.
|
|
void Release(Formatter *f);
|
|
|
|
// The formatter of the NumericFormatter object at `idx`, or null when the
|
|
// value is not one.
|
|
Formatter *ToFormatter(void *L, int idx);
|
|
|
|
// Pushes a new Lua object for `f`.
|
|
void Push(void *L, Formatter *f);
|
|
|
|
// Pushes `f`'s text for `value` and returns it. On a format error, pushes
|
|
// str_format's message and returns null. Either way one value is pushed.
|
|
const char *Format(void *L, Formatter *f, double value);
|
|
|
|
} // namespace Text::NumericFormatter
|