C4GameMessage Class Reference

#include <C4GameMessage.h>

Collaboration diagram for C4GameMessage:

Public Member Functions
void	Draw (C4TargetFacet &cgo, int32_t iPlayer)
	C4GameMessage ()
	~C4GameMessage ()
int32_t	GetPositioningFlags () const

Protected Member Functions
void	Init (int32_t iType, const StdStrBuf &Text, C4Object *pTarget, int32_t iPlayer, int32_t iX, int32_t iY, uint32_t dwCol, C4ID idDecoID, C4PropList *pSrc, uint32_t dwFlags, int width)
void	Append (const char *szText, bool fNoDuplicates=false)
bool	Execute ()
const char *	WordWrap (int32_t iMaxWidth)
void	UpdateDef (C4ID idUpdDef)

Protected Attributes
int32_t	X
int32_t	Y
int32_t	Wdt
int32_t	Hgt
int32_t	Delay
DWORD	ColorDw
int32_t	Player
int32_t	Type
C4Object *	Target
StdCopyStrBuf	Text
C4GameMessage *	Next
C4ID	DecoID
C4PropList *	PictureDef
C4Value	PictureDefVal
C4GUI::FrameDecoration *	pFrameDeco {nullptr}
uint32_t	dwFlags

Friends
class	C4GameMessageList

Detailed Description

Definition at line 50 of file C4GameMessage.h.

Constructor & Destructor Documentation

C4GameMessage::C4GameMessage ( )

default

C4GameMessage::~C4GameMessage

(

)

Definition at line 34 of file C4GameMessage.cpp.

References pFrameDeco.

{
    delete pFrameDeco;
}

Member Function Documentation

void C4GameMessage::Append ( const char *  szText, bool  fNoDuplicates = false  )

protected

Definition at line 96 of file C4GameMessage.cpp.

References StdStrBuf::AppendFormat(), Delay, StdStrBuf::getData(), GlobalMsgDelayFactor, ObjectMsgDelayFactor, SAdvancePast(), SEqual2(), SLen(), Target, and Text.

Referenced by C4GameMessageList::Append().

{
    // Check for duplicates
    if (fNoDuplicates)
        for (const char *pPos = Text.getData(); *pPos; pPos = SAdvancePast(pPos, '|'))
            if (SEqual2(pPos, szText))
                return;
    // Append new line
    Text.AppendFormat("|%s", szText);
    Delay += SLen(szText) * (Target ? ObjectMsgDelayFactor : GlobalMsgDelayFactor);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameMessage::Draw	(	C4TargetFacet &	cgo,
		int32_t	iPlayer
	)

Definition at line 121 of file C4GameMessage.cpp.

References ACenter, ALeft, ARight, CStdFont::BreakMessage(), C4GM_Bottom, C4GM_Global, C4GM_GlobalPlayer, C4GM_HCenter, C4GM_Left, C4GM_NoBreak, C4GM_Right, C4GM_Target, C4GM_TargetPlayer, C4GM_Top, C4GM_VCenter, C4GM_WidthRel, C4GM_XRel, C4GM_YRel, C4GM_Zoom, ColorDw, C4Object::Def, C4Def::Draw(), C4GUI::FrameDecoration::Draw(), DrawMessageOffset, C4Object::DrawPicture(), C4Game::DrawPropListSpecImage(), dwFlags, C4GraphicsResource::FontRegular, Game, StdStrBuf::getData(), C4PropList::GetDef(), C4Object::GetDrawPosition(), C4PropList::GetObject(), CStdFont::GetTextExtent(), CStdFont::GetTextWidth(), GraphicsResource, C4Rect::Hgt, Hgt, C4Facet::Hgt, C4GUI::FrameDecoration::iBorderBottom, C4GUI::FrameDecoration::iBorderLeft, C4GUI::FrameDecoration::iBorderRight, C4GUI::FrameDecoration::iBorderTop, C4Object::IsVisible(), pDraw, pFrameDeco, PictureDef, PictureIndent, PictureWidth, Player, StdStrBuf::Ref(), C4Def::Shape, C4Facet::Surface, Target, C4TargetFacet::TargetX, C4TargetFacet::TargetY, Text, C4Draw::TextOut(), Type, C4Rect::Wdt, Wdt, C4Facet::Wdt, C4Rect::x, X, C4Facet::X, C4Rect::y, Y, C4Facet::Y, and C4TargetFacet::Zoom.

Referenced by C4GameMessageList::Draw().

{
    // Globals or player
    if (Type == C4GM_Global || ((Type == C4GM_GlobalPlayer) && (iPlayer == Player)))
    {
        int32_t iTextWdt,iTextHgt;
        StdStrBuf sText;
        int32_t x,y,wdt;
        if (dwFlags & C4GM_XRel) x = X * cgo.Wdt / 100; else x = X;
        if (dwFlags & C4GM_YRel) y = Y * cgo.Hgt / 100; else y = Y;
        if (dwFlags & C4GM_WidthRel) wdt = Wdt * cgo.Wdt / 100; else wdt = Wdt;
        if (~dwFlags & C4GM_NoBreak)
        {
            // Word wrap to cgo width
            if (PictureDef)
            {
                if (!wdt) wdt = Clamp<int32_t>(cgo.Wdt/2, 50, std::min<int32_t>(500, cgo.Wdt-10));
                int32_t iUnbrokenTextWidth = ::GraphicsResource.FontRegular.GetTextWidth(Text.getData(), true);
                wdt = std::min<int32_t>(wdt, iUnbrokenTextWidth+10);
            }
            else
            {
                if (!wdt)
                    wdt = Clamp<int32_t>(cgo.Wdt-50, 50, 500);
                else
                    wdt = Clamp<int32_t>(wdt, 10, cgo.Wdt-10);
            }
            iTextWdt = wdt * cgo.Zoom;
            iTextHgt = ::GraphicsResource.FontRegular.BreakMessage(Text.getData(), iTextWdt, &sText, true);
        }
        else
        {
            ::GraphicsResource.FontRegular.GetTextExtent(Text.getData(), iTextWdt, iTextHgt, true);
            sText.Ref(Text);
        }
        int32_t iDrawX = cgo.X+x;
        int32_t iDrawY = cgo.Y+y;
        // draw message
        if (PictureDef)
        {
            // message with portrait
            // bottom-placed portrait message: Y-Positioning 0 refers to bottom of viewport
            if (dwFlags & C4GM_Bottom) iDrawY += cgo.Hgt;
            else if (dwFlags & C4GM_VCenter) iDrawY += cgo.Hgt/2;
            if (dwFlags & C4GM_Right) iDrawX += cgo.Wdt;
            else if (dwFlags & C4GM_HCenter) iDrawX += cgo.Wdt/2;
            // draw decoration
            if (pFrameDeco)
            {
                iDrawX *= cgo.Zoom; iDrawY *= cgo.Zoom;
                C4Rect rect(iDrawX-cgo.TargetX, iDrawY-cgo.TargetY, iTextWdt + PictureWidth + PictureIndent + pFrameDeco->iBorderLeft + pFrameDeco->iBorderRight, std::max(iTextHgt, PictureWidth) + pFrameDeco->iBorderTop + pFrameDeco->iBorderBottom);
                if (dwFlags & C4GM_Bottom) { rect.y -= rect.Hgt; iDrawY -= rect.Hgt; }
                else if (dwFlags & C4GM_VCenter) { rect.y -= rect.Hgt/2; iDrawY -= rect.Hgt/2; }
                if (dwFlags & C4GM_Right) { rect.x -= rect.Wdt; iDrawX -= rect.Wdt; }
                else if (dwFlags & C4GM_HCenter) { rect.x -= rect.Wdt/2; iDrawX -= rect.Wdt/2; }
                pFrameDeco->Draw(cgo, rect);
                iDrawX += pFrameDeco->iBorderLeft;
                iDrawY += pFrameDeco->iBorderTop;
            }
            else
                iDrawY -= iTextHgt;
            // draw picture
            // can only be def or object because has been checked on assignment

            C4Facet facet(cgo.Surface, iDrawX, iDrawY, PictureWidth, PictureWidth);
            if(PictureDef->GetObject())
                PictureDef->GetObject()->DrawPicture(facet);
            else if (PictureDef->GetDef())
                PictureDef->GetDef()->Draw(facet);
            else
                Game.DrawPropListSpecImage(facet, PictureDef);

            // draw message
            pDraw->TextOut(sText.getData(),::GraphicsResource.FontRegular,1.0,cgo.Surface,iDrawX+PictureWidth+PictureIndent,iDrawY,ColorDw,ALeft);
        }
        else
        {
            // message without picture
            iDrawX += (cgo.Wdt/2) * cgo.Zoom;
            iDrawY += (2 * cgo.Hgt / 3 + 50) * cgo.Zoom;
            if (!(dwFlags & C4GM_Bottom)) iDrawY += DrawMessageOffset;
            pDraw->TextOut(sText.getData(),::GraphicsResource.FontRegular,1.0,cgo.Surface,iDrawX,iDrawY,ColorDw,ACenter);
        }
    }
    // Positioned
    else if (Type == C4GM_Target || ((Type == C4GM_TargetPlayer) && (iPlayer == Player)))
    {
        // adjust position by object; care about parallaxity
        float iMsgX, iMsgY, newzoom;
        Target->GetDrawPosition(cgo, iMsgX, iMsgY, newzoom);
        if(~dwFlags & C4GM_YRel)
            iMsgY -= Target->Def->Shape.Hgt/2+5;
        iMsgX+=X; iMsgY+=Y;
        // check output bounds
        if (Inside<float>((iMsgX - cgo.X) * newzoom, 0, cgo.Wdt * cgo.Zoom - 1) || (dwFlags & C4GM_XRel))
            if (Inside<float>((iMsgY - cgo.Y) * newzoom, 0, cgo.Hgt * cgo.Zoom - 1) || (dwFlags & C4GM_YRel))
            {
                // if the message is attached to an object and the object
                // is invisible for that player, the message won't be drawn
                if (Type == C4GM_Target)
                    if (!Target->IsVisible(iPlayer, false))
                        return;
                // Word wrap to cgo width
                StdStrBuf sText;
                if (~dwFlags & C4GM_NoBreak)
                {
                    // standard break width
                    int breakWdt = Clamp<int32_t>(cgo.Wdt * cgo.Zoom, 50, 200);

                    // user supplied width?
                    if (Wdt)
                        breakWdt = Wdt;

                    ::GraphicsResource.FontRegular.BreakMessage(Text.getData(), breakWdt, &sText, true);
                }
                else
                    sText.Ref(Text);

                // vertical placement
                if (dwFlags & C4GM_Bottom)
                    iMsgY += Hgt; // iTHgt will be substracted below
                else if (dwFlags & C4GM_Top)
                    ;
                else if (dwFlags & C4GM_VCenter)
                    iMsgY += Hgt / 2;

                // horizontal placement
                int alignment = ACenter;

                if (dwFlags & C4GM_Left)
                    alignment = ALeft;
                else if (dwFlags & C4GM_Right)
                {
                    alignment = ARight;
                    iMsgX += Wdt;
                }
                else if (dwFlags & C4GM_HCenter)
                    iMsgX += Wdt / 2;

                // calculate display position and adjust position by output boundaries
                float iTX, iTY;
                iTX = (iMsgX - cgo.X) * newzoom;
                iTY = (iMsgY - cgo.Y) * newzoom;
                int iTWdt, iTHgt;
                ::GraphicsResource.FontRegular.GetTextExtent(sText.getData(),iTWdt,iTHgt,true);

                // adjust zoom if needed
                float zoom = 1.0;
                if(dwFlags & C4GM_Zoom)
                    zoom = cgo.Zoom;

                if (dwFlags & C4GM_Bottom)
                    iTY -= zoom * float(iTHgt);
                else if (dwFlags & C4GM_VCenter)
                    iTY -= zoom * float(iTHgt/2);
                else if (~dwFlags & C4GM_Top)
                    iTY -= zoom * float(iTHgt); // above object is standard

                if (dwFlags & C4GM_Right)
                    iTX += 0.25f * float(iTWdt) * (1.0f - zoom);

                // adjustment for objects at border of screen?
                // +0.5f for proper rounding; avoids oscillations near pixel border:
                if (~dwFlags & C4GM_XRel) iTX = Clamp<float>(iTX, iTWdt/2, cgo.Wdt * cgo.Zoom - iTWdt / 2) + 0.5f;
                if (~dwFlags & C4GM_YRel) iTY = Clamp<float>(iTY, 0, cgo.Hgt * cgo.Zoom - iTHgt) + 0.5f;

                // Draw
                pDraw->TextOut(sText.getData(), ::GraphicsResource.FontRegular, zoom,
                                           cgo.Surface,
                                           cgo.X + iTX,
                                           cgo.Y + iTY,
                                           ColorDw, alignment);
                return;
            }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4GameMessage::Execute ( )

protected

Definition at line 108 of file C4GameMessage.cpp.

References Delay.

Referenced by C4GameMessageList::Execute().

{
    // Delay / removal
    if (Delay>0) Delay--;
    if (Delay==0) return false;
    // Done
    return true;
}

Here is the caller graph for this function:

int32_t C4GameMessage::GetPositioningFlags ( ) const

inline

Definition at line 79 of file C4GameMessage.h.

References C4GM_PositioningFlags.

Referenced by C4GameMessageList::ClearPlayers().

{ return dwFlags & C4GM_PositioningFlags; }

Here is the caller graph for this function:

void C4GameMessage::Init ( int32_t  iType, const StdStrBuf &  Text, C4Object *  pTarget, int32_t  iPlayer, int32_t  iX, int32_t  iY, uint32_t  dwCol, C4ID  idDecoID, C4PropList *  pSrc, uint32_t  dwFlags, int  width  )

protected

Definition at line 39 of file C4GameMessage.cpp.

References C4GM_MinDelay, ColorDw, StdStrBuf::Copy(), DecoID, Delay, dwFlags, C4PropList::GetDef(), C4Value::getInt(), StdStrBuf::getLength(), C4PropList::GetObject(), C4PropList::GetProperty(), C4PropList::GetPropertyPropList(), GlobalMsgDelayFactor, Hgt, StdStrBuf::Move(), ObjectMsgDelayFactor, P_Hgt, P_Source, P_Wdt, pFrameDeco, PictureDef, PictureDefVal, Player, C4Value::Set0(), C4GUI::FrameDecoration::SetByDef(), C4Value::SetPropList(), StdStrBuf::Shrink(), C4PropList::Status, Target, Text, Type, Wdt, X, and Y.

Referenced by C4GameMessageList::New().

{
    // safety!
    if (pTarget && !pTarget->Status) pTarget = nullptr;
    // Set data
    Text.Copy(sText);
    Target=pTarget;
    X=iX; Y=iY; Wdt=width; Hgt=0;
    Player=iPlayer;
    ColorDw=dwClr;
    Type=iType;
    Delay=std::max<int32_t>(C4GM_MinDelay, Text.getLength() * (Target ? ObjectMsgDelayFactor : GlobalMsgDelayFactor));
    DecoID=idDecoID;
    this->dwFlags=dwFlags;
    PictureDef=nullptr;
    PictureDefVal.Set0();
    if (pSrc)
    {
        // retain special width/height properties when using a message box on an object-local message
        if (Target)
        {
            C4Value val;
            if (pSrc->GetProperty(P_Wdt, &val))
                Wdt = val.getInt();
            if (pSrc->GetProperty(P_Hgt, &val))
                Hgt = val.getInt();
        }

        // retain object or definition from the proplist
        PictureDef = pSrc->GetObject();
        if (!PictureDef) PictureDef = pSrc->GetDef();
        if (!PictureDef && pSrc->GetPropertyPropList(P_Source))
        {
            PictureDef = pSrc;
            PictureDefVal.SetPropList(pSrc);
        }
    }
    // Permanent message
    if ('@' == Text[0])
    {
        Delay=-1;
        Text.Move(1, Text.getLength());
        Text.Shrink(1);
    }
    // frame decoration
    delete pFrameDeco; pFrameDeco = nullptr;
    if (DecoID)
    {
        pFrameDeco = new C4GUI::FrameDecoration();
        if (!pFrameDeco->SetByDef(DecoID))
        {
            delete pFrameDeco;
            pFrameDeco = nullptr;
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameMessage::UpdateDef ( C4ID  idUpdDef )

protected

Definition at line 298 of file C4GameMessage.cpp.

References pFrameDeco, and C4GUI::FrameDecoration::UpdateGfx().

Referenced by C4GameMessageList::UpdateDef().

{
    // frame deco might be using updated/deleted def
    if (pFrameDeco)
    {
        if (!pFrameDeco->UpdateGfx())
        {
            delete pFrameDeco;
            pFrameDeco = nullptr;
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

const char* C4GameMessage::WordWrap ( int32_t  iMaxWidth )

protected

Friends And Related Function Documentation

friend class C4GameMessageList

friend

Definition at line 52 of file C4GameMessage.h.

Member Data Documentation

DWORD C4GameMessage::ColorDw

protected

Definition at line 60 of file C4GameMessage.h.

Referenced by Draw(), and Init().

C4ID C4GameMessage::DecoID

protected

Definition at line 66 of file C4GameMessage.h.

Referenced by Init().

int32_t C4GameMessage::Delay

protected

Definition at line 59 of file C4GameMessage.h.

Referenced by Append(), Execute(), and Init().

uint32_t C4GameMessage::dwFlags

protected

Definition at line 70 of file C4GameMessage.h.

Referenced by Draw(), and Init().

int32_t C4GameMessage::Hgt

protected

Definition at line 58 of file C4GameMessage.h.

Referenced by Draw(), and Init().

C4GameMessage* C4GameMessage::Next

protected

Definition at line 65 of file C4GameMessage.h.

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

C4GUI::FrameDecoration* C4GameMessage::pFrameDeco {nullptr}

protected

Definition at line 69 of file C4GameMessage.h.

Referenced by Draw(), Init(), UpdateDef(), and ~C4GameMessage().

C4PropList* C4GameMessage::PictureDef

protected

Definition at line 67 of file C4GameMessage.h.

Referenced by Draw(), and Init().

C4Value C4GameMessage::PictureDefVal

protected

Definition at line 68 of file C4GameMessage.h.

Referenced by Init().

int32_t C4GameMessage::Player

protected

Definition at line 61 of file C4GameMessage.h.

Referenced by C4GameMessageList::Append(), C4GameMessageList::ClearPlayers(), Draw(), and Init().

C4Object* C4GameMessage::Target

protected

Definition at line 63 of file C4GameMessage.h.

Referenced by Append(), C4GameMessageList::Append(), C4GameMessageList::ClearPointers(), Draw(), C4GameMessageList::Draw(), and Init().

StdCopyStrBuf C4GameMessage::Text

protected

Definition at line 64 of file C4GameMessage.h.

Referenced by Append(), Draw(), and Init().

int32_t C4GameMessage::Type

protected

Definition at line 62 of file C4GameMessage.h.

Referenced by C4GameMessageList::ClearPlayers(), Draw(), C4GameMessageList::Draw(), and Init().

int32_t C4GameMessage::Wdt

protected

Definition at line 58 of file C4GameMessage.h.

Referenced by Draw(), and Init().

int32_t C4GameMessage::X

protected

Definition at line 58 of file C4GameMessage.h.

Referenced by Draw(), and Init().

int32_t C4GameMessage::Y

protected

Definition at line 58 of file C4GameMessage.h.

Referenced by Draw(), and Init().

---

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

• C4GameMessage.h
• C4GameMessage.cpp