ShowTextMessage

ISettlers4Api::ShowTextMessage method

Show a text message in the notification window in the bottom left corner of the game window.

Syntax

BOOL ISettlers4Api::ShowTextMessage(
	LPCSTR message, 
	DWORD icon, 
	DWORD reserved
);

Parameters

message

A null terminated c-string that contains the message to show.

icon

An icon identifier that specifies what icon will be shown left to the text. This can be one of the following values.

Value	Description
0	Red player icon.
1	Blue player icon.
2	Green player icon.
3	Yellow player icon.
4	Purple player icon.
5	Orange player icon.
6	Cyan player icon.
7	White player icon.
9	Exclamation mark icon.

reserved

This argument is reserved for future use. You must pass 0 (zero).

Return value

If this method could execute successfully it will return TRUE. If an error occurred it will return FALSE.

Remarks

none

Requirements

Minimum API Level	1
Target Edition	HistoryEdition MD5: C13883CBD796C614365AB2D670EAD561
Header	S4ModApi.h
Library	S4ModApi.lib
DLL	S4ModApi.dll

See also

ISettlers4Api

dbg.stm (s4.muffinmar.io)