resonance 1.0.1
Loading...
Searching...
No Matches
JuiceAmountMsg Class Reference

Event the game passes between a MsgSource and a MsgSink. More...

#include <juiceamountmsg.h>

Inheritance diagram for JuiceAmountMsg:
Collaboration diagram for JuiceAmountMsg:

Public Member Functions

virtual Message * Clone ()
 Produce a heap copy of this message.
virtual int Type ()
 Report this message's registered identity.
virtual const char * GetName () const
 Report this message's class name.
virtual void PrintExtra (std::ostream &stream) const
 Write the player to a diagnostic stream through Player::Print().
int GetJuice ()
 Report the player's juice.
float GetJuiceFraction ()
 Report the player's juice as a fraction of mMaxJuice.
Public Member Functions inherited from Message
void * operator new (size_t nSize)
 Allocate a message from the tagged heap under the tag MSG.
void operator delete (void *pBlock)
 Release a message to the tagged heap under the tag MSG.
virtual ~Message ()
 Vtable slot 1.
virtual void saveGuts (OBStream &stream) const
 Write this message's payload to an output stream.
virtual void restoreGuts (IBStream &stream)
 Read this message's payload from an input stream.
std::ostream & Print (std::ostream &stream) const
 Write this message to a diagnostic stream as {GetName() PrintExtra()}.

Static Public Member Functions

static Message * New ()
 Produce a default-constructed message on the heap.
Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Public Attributes

Player * mPlayer
 Player the message is about.
int mMaxJuice
 The player's mMaxJuice, clamped by the same site to a maximum of 800.

Detailed Description

Event the game passes between a MsgSource and a MsgSink.

Its RTTI descriptor is at 0x008ef840. It has Message as its one base. The object is 0xc bytes and its vtable is at 0x008121e0. The members below are the whole of the class. No other routine in the image refers to this type by anything but its vtable.

The payload layout comes from the run of field copies in Clone(), so the offsets and widths are recovered but the purpose of each field is not. Readers of the fields have not been traced, so they are private by default.

The destructor at 0x003e07b8 is compiler-generated and has no declaration here.

Member Function Documentation

◆ New()

Message * JuiceAmountMsg::New ( )
static

Produce a default-constructed message on the heap.

The translation unit at 0x003d9818 registers this factory. The payload is left unset.

Returns
The message.
Ghidra address:
NTSC-U/C: 0x003d7818
Ghidra address:
PAL: 0x0040f718

◆ Clone()

virtual Message * JuiceAmountMsg::Clone ( )
virtual

Produce a heap copy of this message.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003e08a8
Ghidra address:
PAL: 0x00418d00

Implements Message.

◆ Type()

virtual int JuiceAmountMsg::Type ( )
virtual

Report this message's registered identity.

Returns
g_nJuiceAmountMsgType.
Ghidra address:
NTSC-U/C: 0x003e08f8
Ghidra address:
PAL: 0x00418d50

Implements Message.

◆ GetName()

virtual const char * JuiceAmountMsg::GetName ( ) const
virtual

Report this message's class name.

Returns
The literal JuiceAmountMsg.
Ghidra address:
NTSC-U/C: 0x003e0908
Ghidra address:
PAL: 0x00418d60

Implements Message.

◆ PrintExtra()

virtual void JuiceAmountMsg::PrintExtra ( std::ostream & stream) const
virtual

Write the player to a diagnostic stream through Player::Print().

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x003e41d8
Ghidra address:
PAL: 0x0041c408

Reimplemented from Message.

◆ GetJuice()

int JuiceAmountMsg::GetJuice ( )

Report the player's juice.

Forwards to Player::GetJuice(). Overlay::OnJuiceAmount() calls it at 0x0041f3ac. The name is inferred from the accessor it forwards to.

Returns
The juice.
Ghidra address:
NTSC-U/C: 0x003e4178
Ghidra address:
PAL: 0x0041c3a8

◆ GetJuiceFraction()

float JuiceAmountMsg::GetJuiceFraction ( )

Report the player's juice as a fraction of mMaxJuice.

Both values are converted to float before the division. Six sites call it, among them Overlay::OnJuiceAmount() twice, TnlArena::DispatchPriv(), and AppTunnel::DispatchPriv(). The name is inferred.

Returns
The juice divided by mMaxJuice.
Ghidra address:
NTSC-U/C: 0x003e4198
Ghidra address:
PAL: 0x0041c3c8

Member Data Documentation

◆ mPlayer

Player* JuiceAmountMsg::mPlayer

Player the message is about.

Player::AnnounceState() at 0x0012f788 writes the player here before sending. That write types this member as a player rather than as a payload word.

+0x04

◆ mMaxJuice

int JuiceAmountMsg::mMaxJuice

The player's mMaxJuice, clamped by the same site to a maximum of 800.

+0x08


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