C4ControlVote Class Reference

#include <C4Control.h>

Inheritance diagram for C4ControlVote:

Collaboration diagram for C4ControlVote:

Public Member Functions
	C4ControlVote (C4ControlVoteType eType=VT_None, bool fApprove=true, int iData=0)
C4ControlVoteType	getType () const
bool	isApprove () const
int32_t	getData () const
StdStrBuf	getDesc () const
StdStrBuf	getDescWarning () const
bool	Sync () const override
int32_t	getByClient () const
bool	LocalControl () const
bool	HostControl () const
void	SetByClient (int32_t iByClient)
virtual bool	PreExecute () const
virtual void	Execute () const =0
virtual void	PreRec (C4Record *pRecord)
virtual bool	Lobby () const
void	CompileFunc (StdCompiler *pComp) override
C4NetIOPacket	pack (const C4NetIO::addr_t &addr=C4NetIO::addr_t()) const
C4NetIOPacket	pack (uint8_t cStatus, const C4NetIO::addr_t &addr=C4NetIO::addr_t()) const
void	unpack (const C4NetIOPacket &Pkt, char *pStatus=nullptr)

Protected Attributes
int32_t	iByClient

Detailed Description

Definition at line 567 of file C4Control.h.

Constructor & Destructor Documentation

C4ControlVote()

C4ControlVote::C4ControlVote ( C4ControlVoteType  eType = VT_None, bool  fApprove = true, int  iData = 0  )

inline

Definition at line 570 of file C4Control.h.

            : eType(eType), fApprove(fApprove), iData(iData)
    { }

Member Function Documentation

CompileFunc()

void C4ControlPacket::CompileFunc ( StdCompiler *  pComp )

overridevirtualinherited

Implements C4PacketBase.

Definition at line 70 of file C4Control.cpp.

{
    // Section must be set by caller
    pComp->Value(mkNamingAdapt(mkIntPackAdapt(iByClient), "ByClient", -1));
}

References C4ControlPacket::iByClient, mkIntPackAdapt(), mkNamingAdapt(), and StdCompiler::Value().

Here is the call graph for this function:

Execute()

virtual void C4ControlPacket::Execute ( ) const

pure virtualinherited

Referenced by C4GameControl::DoSyncCheck(), C4GameControl::ExecControlPacket(), and C4Control::Execute().

Here is the caller graph for this function:

getByClient()

int32_t C4ControlPacket::getByClient ( ) const

inlineinherited

Definition at line 42 of file C4Control.h.

{ return iByClient; }

References C4ControlPacket::iByClient.

Referenced by C4Network2::GetVote(), C4GameControlNetwork::HandlePacket(), and C4Network2::OpenVoteDialog().

Here is the caller graph for this function:

getData()

int32_t C4ControlVote::getData ( ) const

inline

Definition at line 582 of file C4Control.h.

{ return iData; }

Referenced by C4Network2::Execute(), C4Network2::GetVote(), and C4Network2::OpenVoteDialog().

Here is the caller graph for this function:

getDesc()

StdStrBuf C4ControlVote::getDesc

(

)

const

Definition at line 1675 of file C4Control.cpp.

{
    // Describe action
    StdStrBuf Action;
    switch (eType)
    {
    case VT_Cancel:
        Action = LoadResStr("IDS_VOTE_CANCELTHEROUND"); break;
    case VT_Kick:
        if (iData == iByClient)
            Action = LoadResStr("IDS_VOTE_LEAVETHEGAME");
        else
        {
            C4Client *pTargetClient = Game.Clients.getClientByID(iData);
            Action.Format(LoadResStr("IDS_VOTE_KICKCLIENT"), pTargetClient ? pTargetClient->getName() : "???");
        }
        break;
    case VT_Pause:
        if (iData)
            Action = LoadResStr("IDS_TEXT_PAUSETHEGAME");
        else
            Action = LoadResStr("IDS_TEXT_UNPAUSETHEGAME");
        break;
    default:
        Action = "perform some mysterious action"; break;
    }
    return Action;
}

References C4Game::Clients, StdStrBuf::Format(), Game, C4ClientList::getClientByID(), C4Client::getName(), C4ControlPacket::iByClient, LoadResStr(), VT_Cancel, VT_Kick, and VT_Pause.

Referenced by C4Network2::OpenVoteDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

getDescWarning()

StdStrBuf C4ControlVote::getDescWarning

(

)

const

Definition at line 1704 of file C4Control.cpp.

{
    StdStrBuf Warning;
    switch (eType)
    {
    case VT_Cancel:
        Warning = LoadResStr("IDS_TEXT_WARNINGIFTHEGAMEISCANCELL"); break;
    case VT_Kick:
        Warning = LoadResStr("IDS_TEXT_WARNINGNOLEAGUEPOINTSWILL"); break;
    default:
        Warning = ""; break;
    }
    return Warning;
}

References LoadResStr(), VT_Cancel, and VT_Kick.

Referenced by C4Network2::OpenVoteDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

getType()

C4ControlVoteType C4ControlVote::getType ( ) const

inline

Definition at line 580 of file C4Control.h.

{ return eType; }

Referenced by C4Network2::Execute(), C4Network2::GetVote(), and C4Network2::OpenVoteDialog().

Here is the caller graph for this function:

HostControl()

bool C4ControlPacket::HostControl ( ) const

inlineinherited

Definition at line 44 of file C4Control.h.

{ return iByClient == C4ClientIDHost; }

References C4ClientIDHost, and C4ControlPacket::iByClient.

isApprove()

bool C4ControlVote::isApprove ( ) const

inline

Definition at line 581 of file C4Control.h.

{ return fApprove; }

Lobby()

virtual bool C4ControlPacket::Lobby ( ) const

inlinevirtualinherited

Reimplemented in C4ControlMessage, C4ControlPlayerInfo, C4ControlClientRemove, C4ControlClientUpdate, C4ControlClientJoin, and C4ControlSet.

Definition at line 53 of file C4Control.h.

{ return false; }

Referenced by C4GameControl::DoInput().

Here is the caller graph for this function:

LocalControl()

bool C4ControlPacket::LocalControl ( ) const

inherited

Definition at line 60 of file C4Control.cpp.

{
    return iByClient == ::Control.ClientID();
}

References C4GameControl::ClientID(), Control, and C4ControlPacket::iByClient.

Here is the call graph for this function:

pack() [1/2]

C4NetIOPacket C4PacketBase::pack ( const C4NetIO::addr_t &  addr = C4NetIO::addr_t() ) const

inherited

Definition at line 150 of file C4Packet2.cpp.

{
    return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(*this), addr);
}

Referenced by MkC4NetIOPacket().

Here is the caller graph for this function:

pack() [2/2]

C4NetIOPacket C4PacketBase::pack ( uint8_t  cStatus, const C4NetIO::addr_t &  addr = C4NetIO::addr_t()  ) const

inherited

Definition at line 155 of file C4Packet2.cpp.

{
    return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(mkInsertAdapt(mkDecompileAdapt(*this), cStatus)), addr);
}

References mkDecompileAdapt(), and mkInsertAdapt().

Here is the call graph for this function:

PreExecute()

virtual bool C4ControlPacket::PreExecute ( ) const

inlinevirtualinherited

Reimplemented in C4ControlJoinPlayer.

Definition at line 48 of file C4Control.h.

{ return true; }

Referenced by C4GameControl::ExecControlPacket(), and C4Control::PreExecute().

Here is the caller graph for this function:

PreRec()

virtual void C4ControlPacket::PreRec ( C4Record *  pRecord )

inlinevirtualinherited

Reimplemented in C4ControlJoinPlayer.

Definition at line 50 of file C4Control.h.

{ }

Referenced by C4Control::PreRec(), and C4Record::Rec().

Here is the caller graph for this function:

SetByClient()

void C4ControlPacket::SetByClient ( int32_t  iByClient )

inherited

Definition at line 65 of file C4Control.cpp.

{
    iByClient = inByClient;
}

References C4ControlPacket::iByClient.

Sync()

bool C4ControlVote::Sync ( ) const

inlineoverridevirtual

Reimplemented from C4ControlPacket.

Reimplemented in C4ControlVoteEnd.

Definition at line 587 of file C4Control.h.

{ return false; }

unpack()

void C4PacketBase::unpack ( const C4NetIOPacket &  Pkt, char *  pStatus = nullptr  )

inherited

Definition at line 160 of file C4Packet2.cpp.

{
    if (pStatus) *pStatus = Pkt.getStatus();
    CompileFromBuf<StdCompilerBinRead>(*this, pStatus ? Pkt.getPBuf() : Pkt.getRef());
}

References C4NetIOPacket::getPBuf(), C4NetIOPacket::getRef(), and C4NetIOPacket::getStatus().

Referenced by C4IDPacket::C4IDPacket(), and C4Network2IO::HandlePacket().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

iByClient

int32_t C4ControlPacket::iByClient

protectedinherited

Definition at line 39 of file C4Control.h.

Referenced by C4ControlPacket::CompileFunc(), C4ControlPacket::getByClient(), getDesc(), C4ControlPacket::HostControl(), C4ControlPacket::LocalControl(), and C4ControlPacket::SetByClient().

---

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

• C4Control.h
• C4Control.cpp