C4Client Class Reference

#include <C4Client.h>

Public Member Functions
	C4Client ()
	C4Client (const C4ClientCore &Core)
	~C4Client ()
const C4ClientCore &	getCore () const
int32_t	getID () const
bool	isHost () const
const char *	getName () const
const char *	getCUID () const
const char *	getNick () const
bool	isActivated () const
bool	isObserver () const
bool	isLobbyReady () const
bool	isRegistered () const
bool	IsIgnored () const
bool	isLocal () const
C4Network2Client *	getNetClient () const
void	SetCore (const C4ClientCore &NewCore)
void	SetID (int32_t iID)
void	SetActivated (bool fnActivated)
void	SetObserver ()
void	SetLobbyReady (bool fnLobbyReady, time_t *time_since_last_change=nullptr)
void	SetLocal ()
void	ToggleIgnore ()
void	UnlinkNetClient ()
void	Remove ()
void	CompileFunc (StdCompiler *pComp)

Friends
class	C4ClientList

Detailed Description

Definition at line 84 of file C4Client.h.

Constructor & Destructor Documentation

C4Client() [1/2]

C4Client::C4Client ( )

default

C4Client() [2/2]

C4Client::C4Client

(

const C4ClientCore &

Core

)

Definition at line 108 of file C4Client.cpp.

        : Core(Core), pNext(nullptr)
{
 
}

~C4Client()

C4Client::~C4Client

(

)

Definition at line 114 of file C4Client.cpp.

{
    // network client bind must be removed before
    assert(!pNetClient);
}

Member Function Documentation

CompileFunc()

void C4Client::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 153 of file C4Client.cpp.

{
    pComp->Value(Core);
    // Assume this is a non-local client
    if (pComp->isDeserializer())
        fLocal = false;
}

References StdCompiler::isDeserializer(), and StdCompiler::Value().

Here is the call graph for this function:

getCore()

const C4ClientCore& C4Client::getCore ( ) const

inline

Definition at line 104 of file C4Client.h.

{ return Core; }

Referenced by C4Network2Client::DoConnectAttempt(), C4Network2Client::DoTCPSimultaneousOpen(), C4Network2Client::getCore(), C4ClientList::getLocalCore(), C4Network2::HandleJoinData(), C4ClientList::operator=(), and C4Network2ClientList::RegClient().

Here is the caller graph for this function:

getCUID()

const char* C4Client::getCUID ( ) const

inline

Definition at line 108 of file C4Client.h.

{ return Core.getCUID(); }

References C4ClientCore::getCUID().

Referenced by C4StartupNetListEntry::IsSameHost().

Here is the call graph for this function:

Here is the caller graph for this function:

getID()

int32_t C4Client::getID ( ) const

inline

Definition at line 105 of file C4Client.h.

{ return Core.getID(); }

References C4ClientCore::getID().

Referenced by C4ClientList::Add(), C4GameControlNetwork::CopyClientList(), C4ClientList::CtrlRemove(), C4GameControl::InitLocal(), C4GameControl::InitNetwork(), C4Network2Players::OnClientPart(), C4GameLobby::MainDlg::OnClientSound(), C4GameLobby::MainDlg::OnMessage(), C4Network2ClientListDlg::OnSound(), C4ClientList::operator=(), C4MessageInput::ProcessCommand(), C4Network2ClientList::RegClient(), Remove(), and C4Network2ClientListBox::Update().

Here is the call graph for this function:

Here is the caller graph for this function:

getName()

const char* C4Client::getName ( ) const

inline

Definition at line 107 of file C4Client.h.

{ return Core.getName(); }

References C4ClientCore::getName().

Referenced by C4GameControlNetwork::CopyClientList(), C4ControlVote::getDesc(), C4Game::InitNetworkFromReference(), C4StartupNetListEntry::IsSameHost(), C4StartupNetListEntry::KeywordMatch(), C4Network2::OpenVoteDialog(), C4PlayerInfoList::RecreatePlayers(), C4PlayerInfoList::SetAsRestoreInfos(), C4StartupNetListEntry::SetReference(), and C4Network2ClientDlg::UpdateText().

Here is the call graph for this function:

Here is the caller graph for this function:

getNetClient()

C4Network2Client* C4Client::getNetClient ( ) const

inline

Definition at line 117 of file C4Client.h.

{ return pNetClient; }

Referenced by C4ClientList::CtrlRemove(), C4Network2ClientList::RegClient(), C4ClientList::Remove(), C4Network2ClientListBox::Update(), and C4Network2ClientDlg::UpdateText().

Here is the caller graph for this function:

getNick()

const char* C4Client::getNick ( ) const

inline

Definition at line 109 of file C4Client.h.

{ return Core.getNick(); }

References C4ClientCore::getNick().

Here is the call graph for this function:

isActivated()

bool C4Client::isActivated ( ) const

inline

Definition at line 110 of file C4Client.h.

{ return Core.isActivated(); }

References C4ClientCore::isActivated().

Referenced by C4GameControlNetwork::CopyClientList(), C4GameControlNetwork::DecideControlDelivery(), C4Network2Players::GetClientChatColor(), C4Network2::HandleJoinData(), C4Network2Players::HandlePlayerInfo(), C4Network2Players::JoinLocalPlayer(), C4Network2Players::OnStatusGoReached(), C4GameControl::Prepare(), C4Network2::RequestActivate(), and C4Network2ClientDlg::UpdateText().

Here is the call graph for this function:

Here is the caller graph for this function:

isHost()

bool C4Client::isHost ( ) const

inline

Definition at line 106 of file C4Client.h.

{ return Core.isHost(); }

References C4ClientCore::isHost().

Referenced by C4ClientList::CtrlRemove(), C4GameControl::InitNetwork(), C4Network2ClientListBox::Update(), and C4Network2ClientDlg::UpdateText().

Here is the call graph for this function:

Here is the caller graph for this function:

IsIgnored()

bool C4Client::IsIgnored ( ) const

inline

Definition at line 114 of file C4Client.h.

{ return fIsIgnored; }

Referenced by C4GameLobby::MainDlg::OnMessage().

Here is the caller graph for this function:

isLobbyReady()

bool C4Client::isLobbyReady ( ) const

inline

Definition at line 112 of file C4Client.h.

{ return Core.isLobbyReady(); }

References C4ClientCore::isLobbyReady().

Here is the call graph for this function:

isLocal()

bool C4Client::isLocal ( ) const

inline

Definition at line 116 of file C4Client.h.

{ return fLocal; }

Referenced by C4ClientList::Add(), C4Network2Client::isLocal(), C4Network2ClientList::RegClient(), and C4Network2ClientDlg::UpdateText().

Here is the caller graph for this function:

isObserver()

bool C4Client::isObserver ( ) const

inline

Definition at line 111 of file C4Client.h.

{ return Core.isObserver(); }

References C4ClientCore::isObserver().

Referenced by C4Network2Players::JoinLocalPlayer(), and C4Network2::RequestActivate().

Here is the call graph for this function:

Here is the caller graph for this function:

isRegistered()

bool C4Client::isRegistered ( ) const

inline

Definition at line 113 of file C4Client.h.

{ return Core.isRegistered(); }

References C4ClientCore::isRegistered().

Here is the call graph for this function:

Remove()

void C4Client::Remove

(

)

Definition at line 147 of file C4Client.cpp.

{
    // remove players for this client
    ::Players.RemoveAtClient(getID(), true);
}

References getID(), Players, and C4PlayerList::RemoveAtClient().

Referenced by C4ClientList::Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

SetActivated()

void C4Client::SetActivated

(

bool

fnActivated

)

Definition at line 120 of file C4Client.cpp.

{
    Core.SetActivated(fnActivated);
    // activity
    if (fnActivated && pNetClient)
        pNetClient->SetLastActivity(Game.FrameCounter);
}

References C4Game::FrameCounter, Game, C4ClientCore::SetActivated(), and C4Network2Client::SetLastActivity().

Referenced by C4GameControl::ChangeToLocal().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCore()

void C4Client::SetCore ( const C4ClientCore &  NewCore )

inline

Definition at line 119 of file C4Client.h.

{ Core = NewCore; }

Referenced by C4ClientList::operator=().

Here is the caller graph for this function:

SetID()

void C4Client::SetID ( int32_t  iID )

inline

Definition at line 120 of file C4Client.h.

{ Core.SetID(iID); }

References C4ClientCore::SetID().

Referenced by C4ClientList::SetLocalID().

Here is the call graph for this function:

Here is the caller graph for this function:

SetLobbyReady()

void C4Client::SetLobbyReady	(	bool	fnLobbyReady,
		time_t *	time_since_last_change = nullptr
	)

Definition at line 128 of file C4Client.cpp.

{
    // Change state
    Core.SetLobbyReady(fnLobbyReady);
    // Keep track of times
    if (time_since_last_change)
    {
        time_t now = time(nullptr);
        *time_since_last_change = now - last_lobby_ready_change;
        last_lobby_ready_change = now;
    }
}

References C4ClientCore::SetLobbyReady().

Here is the call graph for this function:

SetLocal()

void C4Client::SetLocal

(

)

Definition at line 141 of file C4Client.cpp.

{
    // set flag
    fLocal = true;
}

Referenced by C4ClientList::AddLocal().

Here is the caller graph for this function:

SetObserver()

void C4Client::SetObserver ( )

inline

Definition at line 123 of file C4Client.h.

{ Core.SetObserver(true); }

References C4ClientCore::SetObserver().

Here is the call graph for this function:

ToggleIgnore()

void C4Client::ToggleIgnore ( )

inline

Definition at line 127 of file C4Client.h.

{ fIsIgnored = !fIsIgnored; }

UnlinkNetClient()

void C4Client::UnlinkNetClient ( )

inline

Definition at line 129 of file C4Client.h.

{ pNetClient = nullptr; }

Referenced by C4Network2Client::~C4Network2Client().

Here is the caller graph for this function:

Friends And Related Function Documentation

C4ClientList

friend class C4ClientList

friend

Definition at line 86 of file C4Client.h.

---

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

• C4Client.h
• C4Client.cpp