C4GameMessageList Class Reference

#include <C4GameMessage.h>

Collaboration diagram for C4GameMessageList:

Public Member Functions
	C4GameMessageList ()
	~C4GameMessageList ()
void	Default ()
void	Clear ()
void	Execute ()
void	Draw (C4TargetFacet &gui_cgo, C4TargetFacet &cgo, int32_t iPlayer)
void	ClearPlayers (int32_t iPlayer, int32_t dwPositioningFlags)
void	ClearPointers (C4Object *pObj)
void	UpdateDef (C4ID idUpdDef)
bool	New (int32_t iType, const StdStrBuf &Text, C4Object *pTarget, int32_t iPlayer, int32_t iX=-1, int32_t iY=-1, uint32_t dwClr=0xffFFFFFF, C4ID idDecoID=C4ID::None, C4PropList *pSrc=nullptr, uint32_t dwFlags=0u, int32_t width=0)
bool	New (int32_t iType, const char *szText, C4Object *pTarget, int32_t iPlayer, int32_t iX, int32_t iY, uint32_t dwClr, C4ID idDecoID=C4ID::None, C4PropList *pSrc=nullptr, uint32_t dwFlags=0u, int32_t width=0)
bool	Append (int32_t iType, const char *szText, C4Object *pTarget, int32_t iPlayer, int32_t iX, int32_t iY, uint32_t bCol, bool fNoDuplicates=false)

Protected Attributes
C4GameMessage *	First

Detailed Description

Definition at line 82 of file C4GameMessage.h.

Constructor & Destructor Documentation

C4GameMessageList()

C4GameMessageList::C4GameMessageList

(

)

Definition at line 311 of file C4GameMessage.cpp.

{
    Default();
}

References Default().

Here is the call graph for this function:

~C4GameMessageList()

C4GameMessageList::~C4GameMessageList

(

)

Definition at line 316 of file C4GameMessage.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Append()

bool C4GameMessageList::Append	(	int32_t	iType,
		const char *	szText,
		C4Object *	pTarget,
		int32_t	iPlayer,
		int32_t	iX,
		int32_t	iY,
		uint32_t	bCol,
		bool	fNoDuplicates = false
	)

Definition at line 394 of file C4GameMessage.cpp.

{
    C4GameMessage *cmsg = nullptr;
    if (iType == C4GM_Target)
    {
        for (cmsg=::Messages.First; cmsg; cmsg=cmsg->Next)
            if (pTarget == cmsg->Target)
                break;
    }
    if (iType == C4GM_Global || iType == C4GM_GlobalPlayer)
    {
        for (cmsg=::Messages.First; cmsg; cmsg=cmsg->Next)
            if (iPlayer == cmsg->Player)
                break;
    }
    if (!cmsg || pTarget!=cmsg->Target)
    {
        New(iType, szText, pTarget, iPlayer, iX, iY, bCol);
    }
    else
    {
        cmsg->Append(szText, fNoDuplicates);
    }
    return true;
}

References C4GameMessage::Append(), C4GM_Global, C4GM_GlobalPlayer, C4GM_Target, First, Messages, New(), C4GameMessage::Next, C4GameMessage::Player, and C4GameMessage::Target.

Referenced by C4Command::Fail().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void C4GameMessageList::Clear

(

)

Definition at line 339 of file C4GameMessage.cpp.

{
    C4GameMessage *cmsg,*next;
    for (cmsg=First; cmsg; cmsg=next)
    {
        next=cmsg->Next;
        delete cmsg;
    }
    First=nullptr;
}

References First, and C4GameMessage::Next.

Referenced by C4Game::Clear(), and ~C4GameMessageList().

Here is the caller graph for this function:

ClearPlayers()

void C4GameMessageList::ClearPlayers	(	int32_t	iPlayer,
		int32_t	dwPositioningFlags
	)

Definition at line 420 of file C4GameMessage.cpp.

{
    C4GameMessage *cmsg,*next,*prev=nullptr;
    for (cmsg=First; cmsg; cmsg=next)
    {
        next=cmsg->Next;
        if ( (cmsg->Type == C4GM_Global || cmsg->Type == C4GM_GlobalPlayer) && cmsg->Player==iPlayer && cmsg->GetPositioningFlags() == dwPositioningFlags)
            { delete cmsg; if (prev) prev->Next=next; else First=next; }
        else
            prev=cmsg;
    }
}

References C4GM_Global, C4GM_GlobalPlayer, First, C4GameMessage::GetPositioningFlags(), C4GameMessage::Next, C4GameMessage::Player, and C4GameMessage::Type.

Referenced by New().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearPointers()

void C4GameMessageList::ClearPointers

(

C4Object *

pObj

)

Definition at line 326 of file C4GameMessage.cpp.

{
    C4GameMessage *cmsg,*next,*prev=nullptr;
    for (cmsg=First; cmsg; cmsg=next)
    {
        next=cmsg->Next;
        if (cmsg->Target==pObj)
            { delete cmsg; if (prev) prev->Next=next; else First=next; }
        else
            prev=cmsg;
    }
}

References First, C4GameMessage::Next, and C4GameMessage::Target.

Referenced by C4Game::ClearPointers(), and New().

Here is the caller graph for this function:

Default()

void C4GameMessageList::Default

(

)

Definition at line 321 of file C4GameMessage.cpp.

{
    First=nullptr;
}

References First.

Referenced by C4GameMessageList(), and C4Game::Default().

Here is the caller graph for this function:

Draw()

void C4GameMessageList::Draw	(	C4TargetFacet &	gui_cgo,
		C4TargetFacet &	cgo,
		int32_t	iPlayer
	)

Definition at line 439 of file C4GameMessage.cpp.

{
    C4GameMessage *cmsg;
    for (cmsg=First; cmsg; cmsg=cmsg->Next)
    {
        if ((cmsg->Target && (cmsg->Target->Category & C4D_Foreground)) || cmsg->Type == C4GM_Global || cmsg->Type == C4GM_GlobalPlayer)
            cmsg->Draw(gui_cgo,iPlayer);
        else
            cmsg->Draw(cgo,iPlayer);
    }
}

References C4D_Foreground, C4GM_Global, C4GM_GlobalPlayer, C4Object::Category, C4GameMessage::Draw(), First, C4GameMessage::Next, C4GameMessage::Target, and C4GameMessage::Type.

Referenced by C4Viewport::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

Execute()

void C4GameMessageList::Execute

(

)

Definition at line 350 of file C4GameMessage.cpp.

{
    C4GameMessage *cmsg,*next,*prev=nullptr;
    for (cmsg=First; cmsg; cmsg=next)
    {
        next=cmsg->Next;
        if (!cmsg->Execute())
            { delete cmsg; if (prev) prev->Next=next; else First=next; }
        else
            prev=cmsg;
    }
}

References C4GameMessage::Execute(), First, and C4GameMessage::Next.

Referenced by C4Game::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

New() [1/2]

bool C4GameMessageList::New	(	int32_t	iType,
		const char *	szText,
		C4Object *	pTarget,
		int32_t	iPlayer,
		int32_t	iX,
		int32_t	iY,
		uint32_t	dwClr,
		C4ID	idDecoID = C4ID::None,
		C4PropList *	pSrc = nullptr,
		uint32_t	dwFlags = 0u,
		int32_t	width = 0
	)

Definition at line 363 of file C4GameMessage.cpp.

{
    return New(iType, StdStrBuf(szText), pTarget, iPlayer, iX, iY, dwClr, idDecoID, pSrc, dwFlags, width);
}

References New().

Here is the call graph for this function:

New() [2/2]

bool C4GameMessageList::New	(	int32_t	iType,
		const StdStrBuf &	Text,
		C4Object *	pTarget,
		int32_t	iPlayer,
		int32_t	iX = -1,
		int32_t	iY = -1,
		uint32_t	dwClr = 0xffFFFFFF,
		C4ID	idDecoID = C4ID::None,
		C4PropList *	pSrc = nullptr,
		uint32_t	dwFlags = 0u,
		int32_t	width = 0
	)

Definition at line 368 of file C4GameMessage.cpp.

{
    if (!(dwFlags & C4GM_Multiple))
    {
        // Clear messages with same target
        if (pTarget) ClearPointers(pTarget);
 
        // Clear other global messages for the given player
        if (iType == C4GM_Global || iType == C4GM_GlobalPlayer) ClearPlayers(iPlayer, dwFlags & C4GM_PositioningFlags);
    }
 
    // Object deleted?
    if (pTarget && !pTarget->Status) return false;
 
    // Empty message? (only deleting old message)
    if (!sText.getLength()) return true;
 
    // Add new message
    C4GameMessage *msgNew = new C4GameMessage;
    msgNew->Init(iType, sText,pTarget,iPlayer,iX,iY,dwClr, idDecoID, pSrc, dwFlags, width);
    msgNew->Next=First;
    First=msgNew;
 
    return true;
}

References C4GM_Global, C4GM_GlobalPlayer, C4GM_Multiple, C4GM_PositioningFlags, ClearPlayers(), ClearPointers(), First, StdStrBuf::getLength(), C4GameMessage::Init(), C4GameMessage::Next, and C4PropList::Status.

Referenced by Append(), GameMsgObject(), GameMsgObjectDw(), GameMsgObjectError(), GameMsgObjectPlayer(), and New().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateDef()

void C4GameMessageList::UpdateDef

(

C4ID

idUpdDef

)

Definition at line 433 of file C4GameMessage.cpp.

{
    C4GameMessage *cmsg;
    for (cmsg=First; cmsg; cmsg=cmsg->Next) cmsg->UpdateDef(idUpdDef);
}

References First, C4GameMessage::Next, and C4GameMessage::UpdateDef().

Referenced by C4Game::ReloadDef().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

First

C4GameMessage* C4GameMessageList::First

protected

Definition at line 88 of file C4GameMessage.h.

Referenced by Append(), Clear(), ClearPlayers(), ClearPointers(), Default(), Draw(), Execute(), New(), and UpdateDef().

---

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

• C4GameMessage.h
• C4GameMessage.cpp