Packet that reports a phrase of a track captured by a player on another console.
More...
#include <capturepacket.h>
|
| static Message * | New () |
| | Produce a default-constructed packet on the heap.
|
| static Message * | NewMessage (int nType) |
| | Produce a message of the identified class through the factory list.
|
Packet that reports a phrase of a track captured by a player on another console.
The RTTI records the class as deriving from ExternalPacket. Delivery is guaranteed. The members Clone(), Type(), and GetName() are inline. The member names are inferred.
◆ ~CapturePacket()
| CapturePacket::~CapturePacket |
( |
| ) |
|
|
overridedefault |
Destroy the object.
- Ghidra address:
- NTSC-U/C: 0x00349e60
- Ghidra address:
- PAL: 0x003b7290
◆ CapturePacket() [1/2]
| CapturePacket::CapturePacket |
( |
| ) |
|
|
inline |
Construct a packet with no track and no bar.
Inline. New() expands it.
◆ CapturePacket() [2/2]
| CapturePacket::CapturePacket |
( |
int | nTrack, |
|
|
int | nBar, |
|
|
bool | bAutocatch ) |
|
inline |
Construct a packet with every field set.
Inline. MultiGameLogic::OnPhraseCaptured() expands it on its stack.
- Parameters
-
| nTrack | The index of the track. |
| nBar | The bar. |
| bAutocatch | Whether an autocatcher captured the phrase. |
◆ New()
Produce a default-constructed packet on the heap.
- Returns
- The packet.
- Ghidra address:
- NTSC-U/C: 0x00122f78
- Ghidra address:
- PAL: 0x001246f8
◆ operator new()
| void * CapturePacket::operator new |
( |
size_t | nSize | ) |
|
|
inline |
Allocate a packet, billed to the class name.
- Parameters
-
| nSize | The object size the compiler supplies. |
- Returns
- The block.
◆ operator delete()
| void CapturePacket::operator delete |
( |
void * | pBlock | ) |
|
|
inline |
Release a packet.
- Parameters
-
◆ Clone()
Produce a heap copy of this packet.
- Returns
- The copy.
- Ghidra address:
- NTSC-U/C: 0x00349f00
- Ghidra address:
- PAL: 0x003b7330
Implements Message.
◆ Type()
| int CapturePacket::Type |
( |
| ) |
|
|
inlineoverridevirtual |
Report this packet's registered identity.
- Returns
- g_nCapturePacketType.
- Ghidra address:
- NTSC-U/C: 0x00349f88
- Ghidra address:
- PAL: 0x003b73b8
Implements Message.
◆ GetName()
| const char * CapturePacket::GetName |
( |
| ) |
const |
|
inlineoverridevirtual |
Report this packet's class name.
- Returns
- The literal CapturePacket.
- Ghidra address:
- NTSC-U/C: 0x00349f98
- Ghidra address:
- PAL: 0x003b73c8
Implements Message.
◆ saveGuts()
| void CapturePacket::saveGuts |
( |
BinStream & | stream | ) |
const |
|
overridevirtual |
Write the fields packed into one half-word.
- Parameters
-
| stream | The stream to write to. |
- Ghidra address:
- NTSC-U/C: 0x0014b208
- Ghidra address:
- PAL: 0x0014cba8
Reimplemented from Message.
◆ restoreGuts()
| void CapturePacket::restoreGuts |
( |
BinStream & | stream | ) |
|
|
overridevirtual |
Read the half-word saveGuts() writes back into the fields.
- Parameters
-
| stream | The stream to read from. |
- Ghidra address:
- NTSC-U/C: 0x0014b2a0
- Ghidra address:
- PAL: 0x0014cc40
Reimplemented from Message.
◆ GetAutocatch()
| int CapturePacket::GetAutocatch |
( |
| ) |
const |
|
inline |
- Returns
- Whether an autocatcher captured the phrase.
◆ GetBar()
| int CapturePacket::GetBar |
( |
| ) |
const |
|
inline |
- Returns
- The bar of the capture.
◆ GetTrack()
| int CapturePacket::GetTrack |
( |
| ) |
const |
|
inline |
- Returns
- The index of the track.
◆ GetValid()
| int CapturePacket::GetValid |
( |
| ) |
const |
|
inline |
- Returns
- Whether a sender filled the packet.
◆ SetValid()
| void CapturePacket::SetValid |
( |
int | nValid | ) |
|
|
inline |
- Parameters
-
| nValid | Whether a sender filled the packet. |
The documentation for this class was generated from the following file: