https://g1r-mp.com/wiki/index.php?action=history&feed=atom&title=ShowAreaNotificationShowAreaNotification - Revision history2026-09-30T01:20:56ZRevision history for this page on the wikiMediaWiki 1.46.0https://g1r-mp.com/wiki/index.php?title=ShowAreaNotification&diff=1121&oldid=prevQCherry: Document upcoming 0.1.6: area notification Lua API, door and pickup improvements; not a release2026-09-26T22:22:28Z<p>Document upcoming 0.1.6: area notification Lua API, door and pickup improvements; not a release</p>
<p><b>New page</b></p><div>= ShowAreaNotification =<br />
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"><br />
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.6</div><br />
<div style="color:#111111; margin-top:0.25rem;">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.</div><br />
</div><br />
<br />
Displays a passive, native-style area notification for one player, with independently customized heading and main title.<br />
<br />
== Syntax ==<br />
<syntaxhighlight lang="lua"><br />
ShowAreaNotification(playerId, heading, title [, durationMs])<br />
</syntaxhighlight><br />
<br />
== Parameters ==<br />
{| class="wikitable"<br />
! Name !! Type !! Required !! Description<br />
|-<br />
| <code>playerId</code> || <code>int</code> || yes || Connected numeric player ID; finite integer 1..4294967295. Call after the player character is available.<br />
|-<br />
| <code>heading</code> || <code>string</code> || yes || Smaller heading, 0..256 UTF-8 bytes; may be empty.<br />
|-<br />
| <code>title</code> || <code>string</code> || yes || Main area name, 1..512 UTF-8 bytes.<br />
|-<br />
| <code>durationMs</code> || <code>int</code> || no || Finite integer 1000..30000 milliseconds, including fades. Omit for 5000 ms; explicit nil is invalid.<br />
|}<br />
<br />
== Returns ==<br />
true when the server accepts the request for delivery; false for invalid arguments, unavailable players or rejected requests. Not a client rendering acknowledgement.<br />
<br />
== Examples ==<br />
<syntaxhighlight lang="lua" line><br />
ShowAreaNotification(playerId, "Entering territory", "Bandit Camp", 5000)<br />
ShowAreaNotification(playerId, "Wkraczasz na teren", "Stary Obóz — Старий табір", 7000)<br />
</syntaxhighlight><br />
<br />
== Notes ==<br />
* Upcoming 0.1.6; not included in public 0.1.5. Server-side only. Lower-camel alias: showAreaNotification.<br />
* 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.<br />
* 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.<br />
* No input capture or changes to chapters, quests, discovery records, collision or streaming. No automatic database storage or late-join replay.<br />
* See [[Area notifications]] for ownership, cleanup, duration semantics and bounded queues; see [[Update 0.1.6]] for availability.<br />
<br />
[[Category:Lua Functions]]<br />
[[Category:Server Functions]]<br />
[[Category:GUI Functions]]<br />
[[Category:Player Functions]]</div>QCherry