Planeshift
PendingInvite Class Reference

This class is the superclass for all player-to-player invitations, such as inviting into a group, a guild, a duel, an alliance, a guild war, a tourney, etc. More...

#include <invitemanager.h>

Public Member Functions

virtual void HandleAnswer (const csString &answer)
 This is called when user sends answer to this question, or when the question times out (because the user didn't respond in time) More...
 
virtual void HandleTimeout ()
 
 PendingInvite (Client *inviter, Client *invitee, bool penalize, const char *question_str, const char *accept_button, const char *reject_button, const char *inviter_explanation, const char *invitee_explanation, const char *inviter_acceptance, const char *invitee_acceptance, const char *inviter_rejection, const char *invitee_rejection, psQuestionMessage::questionType_t invType)
 if the user cannot accept this invitation (used when inviting member of secret guild) More...
 
- Public Member Functions inherited from PendingQuestion
 PendingQuestion ()
 
 PendingQuestion (int clientnum, const csString &question, psQuestionMessage::questionType_t type)
 
virtual ~PendingQuestion ()
 

Public Attributes

csString accept
 the text on buttons used to either accept or reject invitation More...
 
bool cannotAccept
 
csString inviteeAcceptance
 
csString inviteeName
 
csString inviteeRejection
 
csString inviterAcceptance
 text sent via chat when invitation has been accepted More...
 
int inviterClientNum
 
csString inviterName
 names of the two players More...
 
csString inviterRejection
 text sent via chat when invitation has been rejected More...
 
csString reject
 
- Public Attributes inherited from PendingQuestion
int clientnum
 
psQuestionCancelEvent * event
 
unsigned id
 
bool ok
 
csString question
 Holds data that will be somehow displayed to user. More...
 
psQuestionMessage::questionType_t type
 type of question - clients handles each question type differently More...
 

Protected Member Functions

bool CheckForSpam (Client *inviter, psQuestionMessage::questionType_t type)
 
void HandleSpamPoints (bool accepted)
 

Additional Inherited Members

- Static Public Attributes inherited from PendingQuestion
static unsigned nextID
 

Detailed Description

This class is the superclass for all player-to-player invitations, such as inviting into a group, a guild, a duel, an alliance, a guild war, a tourney, etc.

Subclass this and then hand over to QuestionManager

Definition at line 55 of file invitemanager.h.

Constructor & Destructor Documentation

PendingInvite::PendingInvite ( Client inviter,
Client invitee,
bool  penalize,
const char *  question_str,
const char *  accept_button,
const char *  reject_button,
const char *  inviter_explanation,
const char *  invitee_explanation,
const char *  inviter_acceptance,
const char *  invitee_acceptance,
const char *  inviter_rejection,
const char *  invitee_rejection,
psQuestionMessage::questionType_t  invType 
)

if the user cannot accept this invitation (used when inviting member of secret guild)

Member Function Documentation

bool PendingInvite::CheckForSpam ( Client inviter,
psQuestionMessage::questionType_t  type 
)
protected
virtual void PendingInvite::HandleAnswer ( const csString &  answer)
virtual

This is called when user sends answer to this question, or when the question times out (because the user didn't respond in time)

Override this method to react to the answers sent by questioned users

Reimplemented from PendingQuestion.

void PendingInvite::HandleSpamPoints ( bool  accepted)
protected
virtual void PendingInvite::HandleTimeout ( )
virtual

Reimplemented from PendingQuestion.

Member Data Documentation

csString PendingInvite::accept

the text on buttons used to either accept or reject invitation

Definition at line 62 of file invitemanager.h.

bool PendingInvite::cannotAccept

Definition at line 73 of file invitemanager.h.

csString PendingInvite::inviteeAcceptance

Definition at line 65 of file invitemanager.h.

csString PendingInvite::inviteeName

Definition at line 71 of file invitemanager.h.

csString PendingInvite::inviteeRejection

Definition at line 68 of file invitemanager.h.

csString PendingInvite::inviterAcceptance

text sent via chat when invitation has been accepted

Definition at line 65 of file invitemanager.h.

int PendingInvite::inviterClientNum

Definition at line 59 of file invitemanager.h.

csString PendingInvite::inviterName

names of the two players

Definition at line 71 of file invitemanager.h.

csString PendingInvite::inviterRejection

text sent via chat when invitation has been rejected

Definition at line 68 of file invitemanager.h.

csString PendingInvite::reject

Definition at line 62 of file invitemanager.h.


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