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

Step that bans a player from the game of the host on the lobby server. More...

#include <banplayertask.h>

Inheritance diagram for BanPlayerTask:
Collaboration diagram for BanPlayerTask:

Public Member Functions

 ~BanPlayerTask () override=default
 Destroy the object.
 BanPlayerTask (int nWorldId, int nAccountId)
 Construct a step for a player.
Public Member Functions inherited from NetTask
 NetTask ()
 Construct a task outside any NetMultiTask.
void Finish (bool bSucceeded, int nResult)
 End the task, and record a failure in the result of the NetMultiTask that runs it.
NetMultiTask * GetParent () const
void SetParent (NetMultiTask *pParent)
 Set the NetMultiTask that runs the task.
Public Member Functions inherited from Task
 Task ()
 Construct an idle task.
virtual ~Task ()
 Release the task.
int Poll ()
 Report the state after giving a running task one poll.
void Start ()
 Enter the running state and call OnStart(), unless the task is already running.
void Stop ()
 Call OnStop() when the task is running, and return to the idle state.
void Finish (bool bSucceeded)
 End the task from outside its poll, and call OnStop() when it was running.
int GetState () const
 Report mState.

Static Public Member Functions

static void OnResponse (int nConnection, int nType, int nSize, const rtMediusResponse *pResponse)
 Ignore the response of the lobby server.
Static Public Member Functions inherited from NetTask
static void MakeTag (NetTask *pTask, char *pszTag)
 Create the next tag of a task and copy its text.
static void RemoveTag (NetTask *pTask)
 Remove the first tag of a task.
static NetTask * FindTag (const char *pszTag)
 Find the task of a tag.

Static Public Attributes

static constexpr int kBanDuration = 60
 The length of a ban the request gives.
Static Public Attributes inherited from NetTask
static std::list< NetTaskTag > sTags
 The tags MakeTag() created and RemoveTag() has not removed.
static int sNextTag
 The number the next tag takes.

Protected Member Functions

void OnStart () override
 Send the request and finish.
Protected Member Functions inherited from NetTask
void OnStop () override
 Remove the tag of the task.
Protected Member Functions inherited from Task
virtual void OnPoll ()
 Advance the work, and set mState to kStateDone when it finishes.

Additional Inherited Members

Public Types inherited from Task
enum  State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 }
 Values of mState. More...

Detailed Description

Step that bans a player from the game of the host on the lobby server.

The RTTI includes the name and records NetTask as the base. The vtable is at 0x003d49c8, and the object is 0x14 bytes. HostpadRT::Kick() runs the step on the stack.

Constructor & Destructor Documentation

◆ ~BanPlayerTask()

BanPlayerTask::~BanPlayerTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0039a438
Ghidra address:
PAL: 0x00408cc0

◆ BanPlayerTask()

BanPlayerTask::BanPlayerTask ( int nWorldId,
int nAccountId )
inline

Construct a step for a player.

Inline.

Parameters
nWorldIdThe game.
nAccountIdThe account of the player.

Member Function Documentation

◆ OnResponse()

void BanPlayerTask::OnResponse ( int nConnection,
int nType,
int nSize,
const rtMediusResponse * pResponse )
static

Ignore the response of the lobby server.

Parameters
nConnectionThe connection.
nTypeThe kind of response.
nSizeThe size of the response.
pResponseThe response.
Ghidra address:
NTSC-U/C: 0x0025c6e0
Ghidra address:
PAL: 0x00265740

◆ OnStart()

void BanPlayerTask::OnStart ( )
overrideprotectedvirtual

Send the request and finish.

Ghidra address:
NTSC-U/C: 0x0025c660
Ghidra address:
PAL: 0x002656c0

Reimplemented from Task.

Member Data Documentation

◆ kBanDuration

int BanPlayerTask::kBanDuration = 60
staticconstexpr

The length of a ban the request gives.


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