resonance 1.0.1
Loading...
Searching...
No Matches
GenericCatcher Class Referenceabstract

Interface every gem catcher presents. More...

#include <genericcatcher.h>

Inheritance diagram for GenericCatcher:
Collaboration diagram for GenericCatcher:

Public Member Functions

 GenericCatcher ()
virtual ~GenericCatcher ()
virtual void Start ()
 Start catching.
virtual void Stop ()
 Stop catching.
virtual int IsPhraseRunEmpty ()=0
 Report whether no phrase run is in progress.
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the tagged heap under the tag "MsgSink".
void operator delete (void *pBlock)
 Release a sink to the tagged heap.
virtual ~MsgSink ()
virtual void Dispatch (Message *pMsg)
 Accept a message.
virtual void DispatchPriv (Message *pMsg)=0
 Act on a message.
Public Member Functions inherited from MsgSource
virtual ~MsgSource ()
virtual void AddSink (MsgSink *pSink)
 Register a sink, ignoring a sink that is already registered.
virtual void RemoveSink (MsgSink *pSink)
 Unregister the first occurrence of a sink.
void Send (Message *pMsg) const
 Deliver a message to every registered sink, in registration order.
void ClearSinks ()
 Unregister every sink.

Additional Inherited Members

Public Attributes inherited from MsgSource
int mGraphBuilt
 A word no member of this class reads.

Detailed Description

Interface every gem catcher presents.

Its RTTI descriptor is at 0x008ef7c0. It is built over MsgSink at offset 0 and MsgSource at offset 4. Its primary table is at 0x007e0c98 with seven entries and its MsgSource subobject table at 0x007e1098 with four and a -4 adjustment on every entry.

The class is abstract twice over. Slot 3, MsgSink::DispatchPriv(), still addresses the shared pure-virtual stub at 0x005381a8, and so does slot 6, the first virtual this class introduces that it does not default. Catcher supplies both.

The constructor writes the two table pointers and nothing else, so the class declares no data member. The destructor's whole body is the implicit teardown of the MsgSource base's vector and the tagged release behind the deleting flag, which is why the definition below is empty.

No literal attests a verb for slots 4, 5, and 6. Their titles follow what Catcher's overrides do. Slots 4 and 5 have empty default bodies here and Catcher overrides all three.

Constructor & Destructor Documentation

◆ GenericCatcher()

GenericCatcher::GenericCatcher ( )
Ghidra address:
NTSC-U/C: 0x001b0a98
Ghidra address:
PAL: 0x001b6848

◆ ~GenericCatcher()

virtual GenericCatcher::~GenericCatcher ( )
virtual
Ghidra address:
NTSC-U/C: 0x001b0b88
Ghidra address:
PAL: 0x001b6938

Member Function Documentation

◆ Start()

virtual void GenericCatcher::Start ( )
virtual

Start catching.

Slot 4. The default body is empty and Catcher overrides it with a body that schedules two commands on the tick clock.

Ghidra address:
NTSC-U/C: 0x001b0c58
Ghidra address:
PAL: 0x001b6a08

Reimplemented in Catcher.

◆ Stop()

virtual void GenericCatcher::Stop ( )
virtual

Stop catching.

Slot 5. The default body is empty and Catcher overrides it with a body that withdraws the two scheduled commands.

Ghidra address:
NTSC-U/C: 0x001b0c60
Ghidra address:
PAL: 0x001b6a10

Reimplemented in Catcher.

◆ IsPhraseRunEmpty()

virtual int GenericCatcher::IsPhraseRunEmpty ( )
pure virtual

Report whether no phrase run is in progress.

Slot 6, pure. Catcher reports whether Catcher::mPhraseRunBars is zero.

Returns
Non-zero when the catcher has nothing outstanding.

Implemented in Catcher.


The documentation for this class was generated from the following file: