C4MessageBoard Class Reference

#include <C4MessageBoard.h>

Collaboration diagram for C4MessageBoard:

Public Member Functions
	C4MessageBoard ()
	~C4MessageBoard ()
void	Init (C4Facet &cgo, bool fStartup)
void	Execute ()
void	Draw (C4Facet &cgo)
void	AddLog (const char *szMessage)
void	ClearLog ()
void	LogNotify ()
void	EnsureLastMessage ()
bool	ControlScrollUp ()
bool	ControlScrollDown ()
C4Player *	GetMessagePlayer (const char *szMessage)

Public Attributes
C4Facet	Output

Friends
class	C4MessageInput

Detailed Description

Definition at line 29 of file C4MessageBoard.h.

Constructor & Destructor Documentation

C4MessageBoard()

C4MessageBoard::C4MessageBoard

(

)

Definition at line 37 of file C4MessageBoard.cpp.

                               : LogBuffer(C4LogSize, C4LogMaxLines, 0, "  ", false)
{
    Delay = -1;
    Fader = 0;
    Speed = 2;
    Output.Default();
    Startup = false;
    ScreenFader = 0;
    iBackScroll = -1;
    ScrollUpBinding = nullptr;
    ScrollDownBinding = nullptr;
    iLineHgt = 1; // Prevent unitialized access with USE_CONSOLE
}

References C4Facet::Default(), and Output.

Here is the call graph for this function:

~C4MessageBoard()

C4MessageBoard::~C4MessageBoard

(

)

Definition at line 51 of file C4MessageBoard.cpp.

{
    LogBuffer.Clear();
    LogBuffer.SetLBWidth(0);
}

References C4LogBuffer::Clear(), and C4LogBuffer::SetLBWidth().

Here is the call graph for this function:

Member Function Documentation

AddLog()

void C4MessageBoard::AddLog

(

const char *

szMessage

)

Definition at line 198 of file C4MessageBoard.cpp.

{
    // safety
    if (!szMessage || !*szMessage) return;
    // make sure new message will be drawn
    ++iBackScroll;
    // register message in standard messageboard font
    LogBuffer.AppendLines(szMessage, &::GraphicsResource.FontRegular, 0, nullptr);
}

References C4LogBuffer::AppendLines(), C4GraphicsResource::FontRegular, and GraphicsResource.

Here is the call graph for this function:

ClearLog()

void C4MessageBoard::ClearLog

(

)

Definition at line 208 of file C4MessageBoard.cpp.

{
    LogBuffer.Clear();
}

References C4LogBuffer::Clear().

Here is the call graph for this function:

ControlScrollDown()

bool C4MessageBoard::ControlScrollDown

(

)

Definition at line 253 of file C4MessageBoard.cpp.

{
    Delay=-1; Fader=0;
    if (iBackScroll > -1) iBackScroll--;
    return true;
}

Referenced by Init().

Here is the caller graph for this function:

ControlScrollUp()

bool C4MessageBoard::ControlScrollUp

(

)

Definition at line 246 of file C4MessageBoard.cpp.

{
    Delay=-1; Fader=0;
    iBackScroll++;
    return true;
}

Referenced by Init().

Here is the caller graph for this function:

Draw()

void C4MessageBoard::Draw

(

C4Facet &

cgo

)

Definition at line 131 of file C4MessageBoard.cpp.

{
    if (!Application.Active) return;
 
    // Startup: draw Loader
    if (Startup)
    {
        if (::GraphicsSystem.pLoaderScreen)
            ::GraphicsSystem.pLoaderScreen->Draw(cgo, C4LoaderScreen::Flag::ALL, Game.InitProgress, &LogBuffer);
        else
            // loader not yet loaded: black BG
            pDraw->DrawBoxDw(cgo.Surface, 0,0, cgo.Wdt, cgo.Hgt, 0x00000000);
        return;
    }
 
    // Game running: message fader
 
    // draw messages
    // how many "extra" messages should be shown?
    int iMsgFader = C4MSGB_MaxMsgFading;
    // check screenfader range
    if (ScreenFader >= 1.0f)
    {
        return;
    }
    ::GraphicsSystem.OverwriteBg();
    // show msgs
    for (int iMsg = -iMsgFader; iMsg < 0; iMsg++)
    {
        // get message at pos
        if (iMsg-iBackScroll >= 0) break;
        const char *Message = LogBuffer.GetLine(iMsg-iBackScroll, nullptr, nullptr, nullptr);
        if (!Message || !*Message) continue;
        // calc target position (y)
        int iMsgY = cgo.Y + cgo.Hgt + iMsg * iLineHgt + Fader;
 
        // player message color?
        C4Player *pPlr = GetMessagePlayer(Message);
 
        DWORD dwColor;
        if (pPlr)
            dwColor = PlrClr2TxtClr(pPlr->ColorDw) & 0xffffff;
        else
            dwColor = 0xffffff;
        // fade out (msg fade)
        float fade = std::max(ScreenFader, 0.0f) + ((iMsg + 2.0f + float(Fader) / iLineHgt) / std::min(2-iMsgFader, -1));
        DWORD dwFade = (0xff - Clamp(int(fade * 0xff), 0, 0xff)) << 24;
        dwColor |= dwFade;
        // Draw
        pDraw->StringOut(Message,::GraphicsResource.FontRegular,1.0,cgo.Surface,cgo.X,iMsgY,dwColor);
    }
}

References C4AbstractApp::Active, Application, C4MSGB_MaxMsgFading, Clamp(), C4Player::ColorDw, C4LoaderScreen::Draw(), C4Draw::DrawBoxDw(), C4GraphicsResource::FontRegular, Game, C4LogBuffer::GetLine(), GetMessagePlayer(), GraphicsResource, GraphicsSystem, C4Facet::Hgt, C4Game::InitProgress, C4GraphicsSystem::OverwriteBg(), pDraw, C4GraphicsSystem::pLoaderScreen, PlrClr2TxtClr(), C4Draw::StringOut(), C4Facet::Surface, C4Facet::Wdt, C4Facet::X, and C4Facet::Y.

Referenced by Execute(), and LogNotify().

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureLastMessage()

void C4MessageBoard::EnsureLastMessage

(

)

Definition at line 184 of file C4MessageBoard.cpp.

{
    // Ingore if startup or typein
    if (Startup) return;
    // scroll until end of log
    for (int i = 0; i < 100; i++)
    {
        ::GraphicsSystem.Execute();
        Execute();
        if (iBackScroll < 0) break;
        Delay=0;
    }
}

References C4GraphicsSystem::Execute(), Execute(), and GraphicsSystem.

Here is the call graph for this function:

Execute()

void C4MessageBoard::Execute

(

)

Definition at line 57 of file C4MessageBoard.cpp.

{
    // Startup? draw only
    if (Startup) { Draw(Output); return; }
 
    // typein or messages waiting? fade in
    if (::MessageInput.IsTypeIn() || iBackScroll >= 0)
        ScreenFader = std::max(ScreenFader - 0.20f, -1.0f);
 
    // no curr msg?
    if (iBackScroll<0)
    {
        // draw anyway
        Draw(Output);
        if (!::MessageInput.IsTypeIn())
            ScreenFader = std::min(ScreenFader + 0.05f, 1.0f);
        return;
    }
 
    // recalc fade/delay speed
    Speed = std::max(1, iBackScroll / 5);
    // fade msg in?
    if (Fader > 0)
        Fader = std::max(Fader - Speed, 0);
    // hold curr msg? (delay)
    if (Fader <= 0)
    {
        // no delay set yet?
        if (Delay == -1)
        {
            // set delay based on msg length
            const char *szCurrMsg = LogBuffer.GetLine(std::min(-iBackScroll, -1), nullptr, nullptr, nullptr);
            if (szCurrMsg) Delay = strlen(szCurrMsg); else Delay = 0;
        }
        // wait...
        if (Delay > 0) Delay = std::max(Delay - Speed, 0);
        // end of delay
        if (Delay == 0)
        {
            // set cursor to next msg (or at end of log)
            iBackScroll = std::max(iBackScroll - 1, -1);
            // reset fade
            Fader = iLineHgt;
            Delay = -1;
        }
    }
 
    // Draw
    Draw(Output);
}

References Draw(), C4LogBuffer::GetLine(), C4MessageInput::IsTypeIn(), MessageInput, and Output.

Referenced by EnsureLastMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

GetMessagePlayer()

C4Player * C4MessageBoard::GetMessagePlayer

(

const char *

szMessage

)

Definition at line 228 of file C4MessageBoard.cpp.

{
    // Scan message text for heading player name
    if (SEqual2(szMessage, "* "))
    {
        StdStrBuf str;
        str.CopyUntil(szMessage + 2,' ');
        return ::Players.GetByName(str.getData());
    }
    if (SCharCount(':',szMessage))
    {
        StdStrBuf str;
        str.CopyUntil(szMessage + 2,':');
        return ::Players.GetByName(str.getData());
    }
    return nullptr;
}

References StdStrBuf::CopyUntil(), C4PlayerList::GetByName(), StdStrBuf::getData(), Players, SCharCount(), and SEqual2().

Referenced by Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

void C4MessageBoard::Init	(	C4Facet &	cgo,
		bool	fStartup
	)

Definition at line 108 of file C4MessageBoard.cpp.

{
    Output=cgo;
    Startup=fStartup;
    iLineHgt=::GraphicsResource.FontRegular.GetLineHeight();
    LogBuffer.SetLBWidth(Output.Wdt);
 
    if (!Startup)
    {
        // set cursor to end of log
        iBackScroll = -1;
        Fader = 0;
        Speed = 2;
        ScreenFader = 1.0f; // msgs faded out
 
        LogBuffer.SetLBWidth(Output.Wdt);
    }
 
    // messageboard
    ScrollUpBinding = std::make_unique<C4KeyBinding>(C4KeyCodeEx(K_UP, KEYS_Shift), "MsgBoardScrollUp", KEYSCOPE_Fullscreen, new C4KeyCB  <C4MessageBoard>(*GraphicsSystem.MessageBoard, &C4MessageBoard::ControlScrollUp));
    ScrollDownBinding = std::make_unique<C4KeyBinding>(C4KeyCodeEx(K_DOWN, KEYS_Shift), "MsgBoardScrollDown", KEYSCOPE_Fullscreen, new C4KeyCB  <C4MessageBoard>(*GraphicsSystem.MessageBoard, &C4MessageBoard::ControlScrollDown));
}

References ControlScrollDown(), ControlScrollUp(), C4GraphicsResource::FontRegular, CStdFont::GetLineHeight(), GraphicsResource, GraphicsSystem, KEYS_Shift, KEYSCOPE_Fullscreen, C4GraphicsSystem::MessageBoard, Output, C4LogBuffer::SetLBWidth(), and C4Facet::Wdt.

Here is the call graph for this function:

LogNotify()

void C4MessageBoard::LogNotify

(

)

Definition at line 213 of file C4MessageBoard.cpp.

{
    // do not show startup board if GUI is active
    if (::pGUI->IsActive()) return;
    // Reset
    iBackScroll=0;
    // Draw
    if (pDraw)
    {
        Draw(Output);
        // startup: Draw message board only and do page flip
        if (Startup) FullScreen.pSurface->PageFlip();
    }
}

References Draw(), FullScreen, C4GUI::Screen::IsActive(), Output, C4Surface::PageFlip(), pDraw, pGUI, and C4Window::pSurface.

Here is the call graph for this function:

Friends And Related Function Documentation

C4MessageInput

friend class C4MessageInput

friend

Definition at line 62 of file C4MessageBoard.h.

Member Data Documentation

Output

C4Facet C4MessageBoard::Output

Definition at line 35 of file C4MessageBoard.h.

Referenced by C4MessageBoard(), Execute(), Init(), and LogNotify().

---

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

• C4MessageBoard.h
• C4MessageBoard.cpp