wavelength 1.0.0
Loading...
Searching...
No Matches
JoinChatroomResultMsg Class Reference

Message that reports the result of joining a chat room of the online lobby. More...

#include <joinchatroomresultmsg.h>

Inheritance diagram for JoinChatroomResultMsg:
Collaboration diagram for JoinChatroomResultMsg:

Public Types

enum  Result { kResultVulgarName = -76 , kResultFailed = -75 , kResultNameExists = -74 , kResultSuccess = 0 }
 Values of mResult. More...

Public Member Functions

 JoinChatroomResultMsg (int nResult)
 Construct a failure, whose room has the identifier -1.
 JoinChatroomResultMsg (int nResult, const NetChatroomInfo &chatroom)
 Construct a result with the room joined.
void * operator new (size_t nSize)
 Allocate a message, billed to the class name.
void operator delete (void *pBlock)
 Release a message.
Message * Clone () override
 Produce a heap copy of this message.
int Type () override
 Report this message's registered identity.
const char * GetName () const override
 Report this message's class name.
void PrintExtra (PrnStream &stream) const override
 Write the result, and the room after a success.
const NetChatroomInfo & GetChatroom () const
int GetResult () const
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual void saveGuts (BinStream &stream) const
 Write this message's payload to a stream.
virtual void restoreGuts (BinStream &stream)
 Read this message's payload from a stream.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Additional Inherited Members

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

Detailed Description

Message that reports the result of joining a chat room of the online lobby.

The RTTI records the class as deriving from Message. The vtable is at 0x003d60d8. The members Clone(), Type(), and GetName() are inline.

Member Enumeration Documentation

◆ Result

Values of mResult.

Enumerator
kResultVulgarName 

The chatroom name is not acceptable.

kResultFailed 

The server refused the request.

kResultNameExists 

A chatroom of the name exists.

kResultSuccess 

The player is in the chatroom.

Constructor & Destructor Documentation

◆ JoinChatroomResultMsg() [1/2]

JoinChatroomResultMsg::JoinChatroomResultMsg ( int nResult)
inlineexplicit

Construct a failure, whose room has the identifier -1.

Inline. The counts of the room are not set.

Parameters
nResultThe error.

◆ JoinChatroomResultMsg() [2/2]

JoinChatroomResultMsg::JoinChatroomResultMsg ( int nResult,
const NetChatroomInfo & chatroom )
inline

Construct a result with the room joined.

Inline.

Parameters
nResultOne of Result.
chatroomThe room.

Member Function Documentation

◆ operator new()

void * JoinChatroomResultMsg::operator new ( size_t nSize)
inline

Allocate a message, billed to the class name.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete()

void JoinChatroomResultMsg::operator delete ( void * pBlock)
inline

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * JoinChatroomResultMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message.

Returns
The copy.

Implements Message.

◆ Type()

int JoinChatroomResultMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nJoinChatroomResultMsgType.

Implements Message.

◆ GetName()

const char * JoinChatroomResultMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal JoinChatroomResultMsg.

Implements Message.

◆ PrintExtra()

void JoinChatroomResultMsg::PrintExtra ( PrnStream & stream) const
overridevirtual

Write the result, and the room after a success.

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

Reimplemented from Message.

◆ GetChatroom()

const NetChatroomInfo & JoinChatroomResultMsg::GetChatroom ( ) const
inline
Returns
The room joined.

◆ GetResult()

int JoinChatroomResultMsg::GetResult ( ) const
inline
Returns
Zero on success, otherwise an error code.

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