Files
BT411/game/reconstructed/searchlight.hpp
T
arcattackandClaude Opus 5 f3bdb3b85a Searchlight + ThermalSight ToggleLamp WIRED (#61) -- and a swapped table attribution ROOT-CAUSED, retracting a false "1995 latent bug"
Both classes' Receiver::MessageHandlerSet were default-constructed blackholes
(input-path audit systemic cause #1): entryCount 0, no parent chain, Find()
returns NullHandler for every id, Receive drops silently.  The new unhandled-
message trace printed it on the first press:

    [btntest] PRESS 0x14 at poll 400
    [msg] UNHANDLED: Searchlight has no handler for message id 3

Each class now has a GetMessageHandlers() function-local static chained to
PowerWatcher's (which name-resolves through HeatWatcher/MechSubsystem to
Receiver's empty ROOT set, so id 3 does NOT collide with HeatSink's
ToggleCooling), plus a correctly-typed forwarder -- Receiver::Handler is
void(const Message*) while the decomp shape is Logical(Message&), so a cast
would be UB that merely happens to work on x86 __thiscall.  DefaultData
re-pointed off the dead empty sets.  MessageArg now reads the NAMED
ReceiverDataMessageOf<int>::dataContents with a static_assert locking it to the
binary's message+0xC (was a raw offset read -- databinding rule).

ROOT CAUSE of a long-standing misattribution: @004b860c is **ThermalSight's**
ToggleLamp (table @0x51120C), NOT Searchlight's.  The two TUs emit parallel
shared-data blocks with identical stride (msg entry, +0x5C attrs, +0x84
Performance triple); what pins each entry to its TU is that "ToggleLamp" is NOT
pooled across them -- two copies exist, each emitted immediately before its own
class-name string ("Searchlight"@0x51144B, "ThermalSight"@0x511475).
[T1: reference/decomp/section_dump.txt:69661-69711]

Searchlight's own handler is @004b838c, which sits in a Ghidra EXPORT GAP (#60).
RECOVERED by raw disassembly of content/BTL4OPT.EXE (scratchpad/dis838c.py, the
EjectAmmo technique) -- and it corrected two things I had inferred wrong:
  * NO ControlsAllowLights/+0x25C novice gate.  Searchlight tests the press
    alone; that lock is ThermalSight-only.  A NOVICE pilot CAN work the lamp.
  * `or word ptr [this+0x18],1` sits AT the jle target -> the graphics-dirty bit
    (updateModel == ForceUpdate(), per #59) is raised UNCONDITIONALLY.

Consequence: the "ORIGINAL 1995 LATENT BUG -- the searchlight can never light"
claim is RETRACTED.  It compared Searchlight's Performance (@004b841c, reads
requestedOn@0x1E0) against ThermalSight's toggle (0x1DC) -- two different
classes -- and so invented a missing 0x1DC->0x1E0 bridge.  Every sibling toggles
the field its own Performance reads.  The searchlight DID light in the arcade,
the searchlight->fog swap was NOT inert there, and building PullFogRenderable is
FAITHFUL rather than a designer-intent deviation (the 2026-07-13 "left as-is"
decision is void; the sim needs no repair).

Verified live, real click seam (BT_BTNTEST):
  0x14 -> [light] requested ON -> reported lightState 0 -> 1     (lamp lights)
  0x12 -> [light] thermal sight requested ON -> thermalActive 0 -> 1
UNHANDLED lines for both classes gone; 40 LNK2019 unchanged (the pre-existing
CreateStreamedSubsystem + Entity__SharedData::DefaultData families only).

Swept the misattribution out of searchlight.cpp/.hpp, thermalsight.cpp/.hpp,
hud.cpp:282 (it had claimed @00511180/@004b838c as HUD's), btplayer.cpp's +0x25C
consumer list, context/{decomp-reference,subsystems,rendering,open-questions,
pod-hardware,experience-levels}.md, docs/{GLASS_COCKPIT,INPUT_PATH_AUDIT}.md.
checkctx.py CLEAN.

Still open (documented, not fixed): ThermalSight has no visible IR effect
(ToggleGlobalThermalVision is a marked no-op, pvision unported, IsLocallyViewed
returns False); ThermalSight publishes "LightState"->0x1D8 where the binary has
"LightOn"->0x1D8 and "LightState"->0x1E0; Searchlight's commandedOn@0x1DC has no
identified role and measured 21 live, hinting our SubsystemResource +0x28 differs
from the binary's.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-25 10:46:59 -05:00

301 lines
13 KiB
C++

//===========================================================================//
// File: searchlight.hpp //
// Project: BattleTech //
// Contents: Searchlight (illumination) subsystem //
//---------------------------------------------------------------------------//
// Copyright (C) 1995, Virtual World Entertainment, Inc. All Rights reserved //
// PROPRIETARY AND CONFIDENTIAL //
//===========================================================================//
//
// RECONSTRUCTED from the shipped binary (Ghidra pseudo-C, recovered shard
// part_013.c). NO SEARCHLIGHT.HPP survived; the class body is inferred from
// usage and the embedded string pool. Each method cites its @ADDR.
//
// IDENTIFICATION:
// * mech3.cpp factory map: Searchlight::CreateStreamedSubsystem @004b85a8,
// DefaultData &DAT_00511198.
// * vtable @005114d4 (slot0 dtor @004b8568), ctor @004b84dc.
// * CreateStreamedSubsystem @004b85a8 stamps classID 0x0BD8 and streamed
// model size 0xF4; it parses NO searchlight-specific model fields (empty
// resource extension).
// * String pool @00511440 ("ToggleLamp", "Searchlight", "LightOn",
// "LightState"). ClassDerivations name "Searchlight" @005111a8.
// * A message-handler record @00511210 binds "ToggleLamp" -> FUN_004b860c.
//
// BASE CLASS:
// Searchlight IS-A PowerWatcher (powersub.hpp): ctor @004b84dc chains to the
// PowerWatcher ctor FUN_004b18a4 with &DAT_00511198, and
// CreateStreamedSubsystem chains to PowerWatcher::CreateStreamedSubsystem
// FUN_004b198c. The shared base occupies bytes 0..0x1D8; Searchlight's own
// members begin at 0x1D8. It exposes one queryable attribute "LightState".
//
#if !defined(SEARCHLIGHT_HPP)
# define SEARCHLIGHT_HPP
#if !defined(POWERSUB_HPP)
#include "powersub.hpp"
#endif
//##########################################################################
//##################### Local multi-level alarm shim #################
//##########################################################################
//
// CROSS-FAMILY: heat.hpp does `typedef GaugeAlarm AlarmIndicator;` but the
// engine GaugeAlarm (GAUGALRM.h) has a PROTECTED ctor/dtor and no
// Initialize/Finalize/SetLevel; the mech.hpp/mechrecon.hpp alias resolves
// AlarmIndicator to ReconAlarm, which also lacks Initialize/Finalize. Until
// the heat family provides a real multi-level AlarmIndicator, this module owns
// a tiny faithful stand-in for ITS OWN alarm member (it does NOT redefine the
// AlarmIndicator typedef).
//
#if !defined(BT_LOCAL_ALARM_SHIM)
# define BT_LOCAL_ALARM_SHIM
struct BtAlarm
{
int level;
BtAlarm() : level(0) {}
void Initialize(int /*levels*/) { level = 0; } // FUN_0041b9ec
void Finalize() {} // FUN_0041baa4
void SetLevel(int n) { level = n; } // FUN_0041bbd8
int GetLevel() const { return level; }
};
#endif
//##########################################################################
//##################### Searchlight::SubsystemResource ###############
//##########################################################################
//
// Empty extension of the PowerWatcher resource (CreateStreamedSubsystem
// @004b85a8 reads no light-specific fields; it only stamps classID/model
// size). The ctor seeds commandedOn from the inherited segment field (+0x28).
//
struct Searchlight__SubsystemResource:
public PowerWatcher::SubsystemResource
{
// RESOURCE_AUDIT.md: Searchlight adds NO resource field. The ctor seeds
// commandedOn from the INHERITED segmentIndex (resource +0x28); the old
// `int segmentDefault;` was appended after the base (compiled at ~0xF4, OOB)
// and read garbage. Empty extension = correct 0xF4 model size.
};
//##########################################################################
//########################## Searchlight #############################
//##########################################################################
class Searchlight:
public PowerWatcher
{
friend struct SearchlightLayoutCheck; // compile-time offset locks (searchlight.cpp)
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Shared Data Support
//
// DefaultData @00511198, ClassDerivations @005111a8 ("Searchlight").
//
public:
static Derivation ClassDerivations; // @005111a8
static SharedData DefaultData; // @00511198
static Receiver::MessageHandlerSet MessageHandlers; // @00511210 ("ToggleLamp")
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Attribute Support
//
// AttributePointers IndexEntry table @005111e0:
// id 5 "LightState" -> @0x1D8 (offset encoded 0x1D9 == 0x1D8|1)
//
public:
enum {
// The cockpit button-5 lamp binds "Searchlight/LightOn" (L4GAUGE.CFG:5017);
// the published NAME must be "LightOn" for Find() to hit, bound to the
// reported on/off member lightState@0x1D8.
LightOnAttributeID = PowerWatcher::NextAttributeID, // 5
NextAttributeID
};
private:
static const IndexEntry AttributePointers[]; // @005111e0
protected:
static AttributeIndexSet AttributeIndex;
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Local data.
//
protected:
int lightState; // @0x1D8 reported on/off (gated by power + heat each frame); "LightState"
int commandedOn; // @0x1DC ctor-seeded from the subsystem resource +0x28 (@004b84dc).
// NOT the toggle target and NOT read by @004b841c; it measured
// 21 live, so it is not a boolean -- role still unidentified.
int requestedOn; // @0x1E0 init 0; THE on/off input consumed by SearchlightSimulation
// (@004b841c reads +0x1E0) and toggled by ToggleLamp @004b838c
BtAlarm stateAlarm; // @0x1E4 2-level light indicator (size 0x54)
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// BT segment / base-state compatibility shims (CROSS-FAMILY).
//
// These accessors / mutators logically belong on the shared bases
// (Subsystem::GetSegmentFlags / SetInstanceFlag / SetGraphicsDirty,
// PowerWatcher::HostShutDown / WatchedVoltageLevel, HeatSink::HeatStateLevel,
// Mech controls-mapper lightsEnabled). Until those families expose them they
// are backed by local members so this module compiles; see report.
//
public:
// De-shimmed (WAVE 4 un-stub): the 7 CROSS-FAMILY backing fields
// (segmentFlags/hostShutDown/watchedVoltageLevel/heatStateLevel/
// controlsAllowLights/graphicsDirty/instanceFlags) are DELETED. They
// duplicated engine-base state AND -- via the old shadow `segmentFlags`
// (seeded 0) -- made the ctor gate ((0&0xC)==0 && (0&0x100)!=0) FALSE, so
// SearchlightSimulation was NEVER installed. Accessors now read the REAL
// inherited base members (mirrors torso.hpp/torso.cpp):
// HostShutDown <- MechSubsystem::simulationState == Destroyed (this+0x40)
// WatchedVoltageLevel <- PowerWatcher::watchdogAlarm level (this+0x198)
// HeatStateLevel <- HeatWatcher::heatAlarm level (this+0x140)
// SetGraphicsDirty -> engine Simulation::ForceUpdate() (this+0x18)
// SetInstanceFlag -> engine Simulation::simulationFlags |= bits (this+0x28)
// GetSegmentFlags() removed (the ctor gate now reads owner->simulationFlags).
// ControlsAllowLights(): ⚠ NOT USED BY Searchlight::ToggleLamp. Raw
// disassembly of @004b838c (#61 -- it is a Ghidra export gap, see
// searchlight.cpp) shows Searchlight gates on the PRESS ALONE and never
// reads mech+0xD0 -> +0x190 -> player+0x25C. The +0x25C novice lock
// belongs to the SIBLING ThermalSight (@004b860c), whose handler had been
// mis-transcribed into this file -- which is where this accessor came
// from. Kept because the bridge itself is correct and callers elsewhere
// document the flag; see thermalsight.hpp for the real consumer.
// [T1: player+0x25c is the "sim live" experience flag, 0 only for NOVICE;
// routed through the complete-type bridge in btplayer.cpp per the
// databinding rule.]
Logical HostShutDown() const { return simulationState == 1; /* Destroyed */ }
int WatchedVoltageLevel() const { return watchdogAlarm.GetLevel(); } // @0x198
int HeatStateLevel() const { return heatAlarm.GetLevel(); } // @0x140
Logical ControlsAllowLights() const
{
extern int BTPlayerExperienceSimLive(void *owner_mech); // btplayer.cpp (player+0x25c)
return BTPlayerExperienceSimLive(owner) ? True : False;
}
void SetGraphicsDirty() { ForceUpdate(); } // this[0x18] |= 1
void SetInstanceFlag(int bits) { simulationFlags |= bits; } // this[10] |= bits
// The "ToggleLamp" command arg is carried at message+0xC (decomp). That
// is exactly ReceiverDataMessageOf<int>::dataContents -- the first member
// added to Receiver::Message -- so read the NAMED member instead of the
// raw offset (databinding rule). searchlight.cpp static_asserts the
// 0xC equivalence so the binary citation above stays honest.
static int MessageArg(Message &m)
{
return Cast_Object(const ReceiverDataMessageOf<int>*, &m)->dataContents;
}
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Simulation Support
//
public:
typedef void
(Searchlight::*Performance)(Scalar time_slice);
void
SetPerformance(Performance performance)
{
Check(this);
activePerformance = (Simulation::Performance)performance;
}
void
SearchlightSimulation(Scalar time_slice); // @004b841c (Performance, PTR @00511200)
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Message handling
//
public:
Logical
ToggleLamp(Message &message); // @004b838c (bound to "ToggleLamp" @0051117c)
//
// Gitea #61 (input-path audit systemic cause #1). The bare
// `MessageHandlers` above is DEFAULT-CONSTRUCTED -- entryCount 0, no
// parent chain -- so Receiver::MessageHandlerSet::Find() returned
// NullHandler for EVERY id and Receiver::Receive dropped every message
// the searchlight was ever sent, in silence. Proved live by the new
// unhandled-message trace:
// [btntest] PRESS 0x14 at poll 400
// [msg] UNHANDLED: Searchlight has no handler for message id 3
// The binary's table @0051117c holds exactly ONE entry --
// { 3, "ToggleLamp" @00511440, @004b838c } -- with this class's attribute
// index ("LightOn" -> 0x1D9, "LightState" -> 0x1E5) at @005111d8 and its
// Performance triple (@004b841c) at @00511200. [T1: section_dump.txt]
//
// NOT @004b860c / table @0051120c -- that pair is ThermalSight's (this
// file mis-cited it for a long time). The two TUs emit parallel blocks
// and each keeps its OWN un-pooled "ToggleLamp" string next to its own
// class name: @00511440+"Searchlight"@0051144b here,
// @0051146a+"ThermalSight"@00511475 there.
//
// ToggleLamp's own signature is Logical(Message&) while
// Receiver::Handler is void(const Message*), so the table binds a
// correctly-typed forwarder rather than a cast (a cast would be UB that
// merely happens to work on x86 __thiscall).
//
// No id collision with HeatSink's id 3 (ToggleCooling): PowerWatcher
// declares no set of its own, so `PowerWatcher::GetMessageHandlers()`
// name-resolves up through HeatWatcher and MechSubsystem to Receiver's
// empty ROOT set -- HeatSink is not on this chain. Confirmed live: the
// id-3 press produced the UNHANDLED line and NO coolant toggle.
//
enum { ToggleLampMessageID = 3 }; // table @0051120c, fn @004b860c
static Receiver::MessageHandlerSet& GetMessageHandlers();
void
ToggleLampMessageHandler(ReceiverDataMessageOf<int> *message);
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Subsystem virtual overrides (vtable @005114d4)
//
// Only slots 6 and 7 (network state replication) are HUD-specific; slot 9
// (HandleMessage) and slot 10 (ResetToInitialState) inherit PowerWatcher's
// @004b179c / @004b1804.
//
// The decomp named these ReadUpdate/WriteUpdate over a fictional
// NetworkPacket.value / NetworkRecord{kind,value}. The real engine
// network-state-replication virtuals (SIMULATE.h) are
// ReadUpdateRecord(UpdateRecord*) / WriteUpdateRecord(UpdateRecord*,int);
// the replicated on/off and the 0x14 record tag map to the real
// UpdateRecord::simulationState / ::recordID fields.
//
public:
void
ReadUpdateRecord(UpdateRecord *message); // slot 6, @004b83b8
void
WriteUpdateRecord(UpdateRecord *message, int update_model); // slot 7, @004b83f0 (record tag 0x14)
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Test Class Support
//
public:
static Logical TestClass(Mech&);
Logical TestInstance() const; // @004b85f0
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Construction and Destruction
//
public:
typedef Searchlight__SubsystemResource SubsystemResource;
Searchlight(
Mech *owner,
int subsystem_ID,
SubsystemResource *subsystem_resource,
SharedData &shared_data = DefaultData
); // @004b84dc
~Searchlight(); // @004b8568
static int
CreateStreamedSubsystem( // @004b85a8
NotationFile *model_file,
const char *model_name,
const char *subsystem_name,
SubsystemResource *subsystem_resource,
NotationFile *subsystem_file,
const ResourceDirectories *directories,
int passes = 1
);
};
#endif