ShowAreaNotification

ShowAreaNotification

AVAILABLE FROM UPDATE 0.1.6

Upcoming 0.1.6: not yet publicly released and not included in public 0.1.5. This page documents the implemented API planned for that update.

Displays a passive, native-style area notification for one player, with independently customized heading and main title.

Syntax

ShowAreaNotification(playerId, heading, title [, durationMs])

Parameters

Name	Type	Required	Description
playerId	int	yes	Connected numeric player ID; finite integer 1..4294967295. Call after the player character is available.
heading	string	yes	Smaller heading, 0..256 UTF-8 bytes; may be empty.
title	string	yes	Main area name, 1..512 UTF-8 bytes.
durationMs	int	no	Finite integer 1000..30000 milliseconds, including fades. Omit for 5000 ms; explicit nil is invalid.

Returns

true when the server accepts the request for delivery; false for invalid arguments, unavailable players or rejected requests. Not a client rendering acknowledgement.

Examples

ShowAreaNotification(playerId, "Entering territory", "Bandit Camp", 5000)
ShowAreaNotification(playerId, "Wkraczasz na teren", "Stary Obóz — Старий табір", 7000)

Notes

• Upcoming 0.1.6; not included in public 0.1.5. Server-side only. Lower-camel alias: showAreaNotification.
• The latest show replaces the previous custom area banner and becomes its resource owner. One banner per player. Use HideAreaNotification from the same resource to hide early.
• Valid UTF-8 plain text only; no NUL, control characters or newlines. Polish characters and Cyrillic were confirmed in testing; font glyph coverage still applies.
• No input capture or changes to chapters, quests, discovery records, collision or streaming. No automatic database storage or late-join replay.
• See Area notifications for ownership, cleanup, duration semantics and bounded queues; see Update 0.1.6 for availability.