OpenTTD Source  20241108-master-g80f628063a
network_chat_gui.cpp File Reference

GUI for handling chat messages. More...

#include "../stdafx.h"
#include "../strings_func.h"
#include "../autocompletion.h"
#include "../blitter/factory.hpp"
#include "../console_func.h"
#include "../video/video_driver.hpp"
#include "../querystring_gui.h"
#include "../town.h"
#include "../window_func.h"
#include "../toolbar_gui.h"
#include "../core/geometry_func.hpp"
#include "../zoom_func.h"
#include "../timer/timer.h"
#include "../timer/timer_window.h"
#include "network.h"
#include "network_client.h"
#include "network_base.h"
#include "../widgets/network_chat_widget.h"
#include "table/strings.h"
#include "../safeguards.h"

Go to the source code of this file.

Data Structures

struct  ChatMessage
 Container for a message. More...
 
class  NetworkChatAutoCompletion
 
struct  NetworkChatWindow
 Window to enter the chat message in. More...
 

Functions

static bool HaveChatMessages (bool show_all)
 Test if there are any chat messages to display. More...
 
void CDECL NetworkAddChatMessage (TextColour colour, uint duration, const std::string &message)
 Add a text message to the 'chat window' to be shown. More...
 
void NetworkReInitChatBoxSize ()
 Initialize all font-dependent chat box sizes.
 
void NetworkInitChatMessage ()
 Initialize all buffers of the chat visualisation.
 
void NetworkUndrawChatMessage ()
 Hide the chatbox.
 
void NetworkDrawChatMessage ()
 Draw the chat message-box.
 
static void SendChat (const std::string &buf, DestType type, int dest)
 Send an actual chat message. More...
 
void ShowNetworkChatQueryWindow (DestType type, int dest)
 Show the chat window. More...
 

Variables

static const uint NETWORK_CHAT_LINE_SPACING = 3
 Spacing between chat lines.
 
static std::deque< ChatMessage_chatmsg_list
 The actual chat message list.
 
static bool _chatmessage_dirty = false
 Does the chat message need repainting?
 
static bool _chatmessage_visible = false
 Is a chat message visible.
 
static uint MAX_CHAT_MESSAGES = 0
 The limit of chat messages to show.
 
static std::chrono::steady_clock::time_point _chatmessage_dirty_time
 Time the chat history was marked dirty. More...
 
static PointDimension _chatmsg_box
 The chatbox grows from the bottom so the coordinates are pixels from the left and pixels from the bottom. More...
 
static ReusableBuffer< uint8_t > _chatmessage_backup
 Backup in case text is moved.
 
static IntervalTimer< TimerWindownetwork_message_expired_interval (std::chrono::seconds(1), [](auto) { auto now=std::chrono::steady_clock::now();for(auto &cmsg :_chatmsg_list) { if(now > cmsg.remove_time &&_chatmessage_dirty_time< cmsg.remove_time) { _chatmessage_dirty_time=now;_chatmessage_dirty=true;break;} } })
 Check if a message is expired on a regular interval.
 
static constexpr NWidgetPart _nested_chat_window_widgets []
 The widgets of the chat window. More...
 
static WindowDesc _chat_window_desc (WDP_MANUAL, nullptr, 0, 0, WC_SEND_NETWORK_MSG, WC_NONE, 0, _nested_chat_window_widgets)
 The description of the chat window.
 

Detailed Description

GUI for handling chat messages.

Definition in file network_chat_gui.cpp.

Function Documentation

◆ HaveChatMessages()

static bool HaveChatMessages ( bool  show_all)
inlinestatic

Test if there are any chat messages to display.

Parameters
show_allSet if all messages should be included, instead of unexpired only.
Returns
True iff there are chat messages to display.

Definition at line 68 of file network_chat_gui.cpp.

References _chatmsg_list.

◆ NetworkAddChatMessage()

void CDECL NetworkAddChatMessage ( TextColour  colour,
uint  duration,
const std::string &  message 
)

Add a text message to the 'chat window' to be shown.

Parameters
colourThe colour this message is to be shown in
durationThe duration of the chat message in seconds
messagemessage itself

Definition at line 86 of file network_chat_gui.cpp.

References _chatmessage_dirty, _chatmessage_dirty_time, _chatmsg_list, ChatMessage::colour, MAX_CHAT_MESSAGES, ChatMessage::message, and ChatMessage::remove_time.

◆ SendChat()

static void SendChat ( const std::string &  buf,
DestType  type,
int  dest 
)
static

Send an actual chat message.

Parameters
bufThe message to send.
typeThe type of destination.
destThe actual destination index.

Definition at line 255 of file network_chat_gui.cpp.

References _network_server, and ClientNetworkGameSocketHandler::SendChat().

◆ ShowNetworkChatQueryWindow()

void ShowNetworkChatQueryWindow ( DestType  type,
int  dest 
)

Show the chat window.

Parameters
typeThe type of destination.
destThe actual destination index.

Definition at line 445 of file network_chat_gui.cpp.

References _chat_window_desc, CloseWindowByClass(), and WC_SEND_NETWORK_MSG.

Referenced by NetworkClientListWindow::OnClickClientChat(), and NetworkClientListWindow::OnClickCompanyChat().

Variable Documentation

◆ _chatmessage_dirty_time

std::chrono::steady_clock::time_point _chatmessage_dirty_time
static

Time the chat history was marked dirty.

This is used to determine if expired messages have recently expired and should cause a redraw to hide them.

Definition at line 54 of file network_chat_gui.cpp.

Referenced by NetworkAddChatMessage().

◆ _chatmsg_box

PointDimension _chatmsg_box
static

The chatbox grows from the bottom so the coordinates are pixels from the left and pixels from the bottom.

The height is the maximum height.

Definition at line 60 of file network_chat_gui.cpp.

Referenced by NetworkInitChatMessage(), and NetworkReInitChatBoxSize().

◆ _nested_chat_window_widgets

constexpr NWidgetPart _nested_chat_window_widgets[]
staticconstexpr
Initial value:
= {
NWidget(WWT_TEXT, COLOUR_GREY, WID_NC_DESTINATION), SetMinimalSize(62, 12), SetPadding(1, 0, 1, 0), SetAlignment(SA_VERT_CENTER | SA_RIGHT), SetDataTip(STR_NULL, STR_NULL),
NWidget(WWT_EDITBOX, COLOUR_GREY, WID_NC_TEXTBOX), SetMinimalSize(100, 0), SetPadding(1, 0, 1, 0), SetResize(1, 0),
SetDataTip(STR_NETWORK_CHAT_OSKTITLE, STR_NULL),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_NC_SENDBUTTON), SetMinimalSize(62, 12), SetPadding(1, 0, 1, 0), SetDataTip(STR_NETWORK_CHAT_SEND, STR_NULL),
}
@ SA_RIGHT
Right align the text (must be a single bit).
Definition: gfx_type.h:345
@ SA_VERT_CENTER
Vertically center the text.
Definition: gfx_type.h:349
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1228
constexpr NWidgetPart SetDataTip(uint32_t data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1202
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1137
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1309
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1191
constexpr NWidgetPart SetAlignment(StringAlignment align)
Widget part function for setting the alignment of text/images.
Definition: widget_type.h:1170
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
Definition: widget_type.h:1126
@ WID_NC_SENDBUTTON
Send button.
@ WID_NC_BACKGROUND
Background of the window.
@ WID_NC_CLOSE
Close button.
@ WID_NC_TEXTBOX
Textbox.
@ WID_NC_DESTINATION
Destination.
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:112
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:71
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:75
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:50
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:69
@ WWT_TEXT
Pure simple text.
Definition: widget_type.h:58

The widgets of the chat window.

Definition at line 417 of file network_chat_gui.cpp.