ShowAreaNotification: Difference between revisions
Jump to navigation
Jump to search
Document upcoming 0.1.6: area notification Lua API, door and pickup improvements; not a release |
Release G1R:MP 0.1.6 BUILD174 / Protocol 38; availability and upgrade guidance |
||
| Line 2: | Line 2: | ||
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"> | <div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"> | ||
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.6</div> | <div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.6</div> | ||
<div style="color:#111111; margin-top:0.25rem;"> | <div style="color:#111111; margin-top:0.25rem;">Available since G1R:MP 0.1.6. Use the matching client and server (Protocol 38).</div> | ||
</div> | </div> | ||
| Line 35: | Line 35: | ||
== Notes == | == Notes == | ||
* | * Available since 0.1.6. 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. | * 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. | * 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. | ||
Latest revision as of 21:56, 30 September 2026
ShowAreaNotification
AVAILABLE FROM UPDATE 0.1.6
Available since G1R:MP 0.1.6. Use the matching client and server (Protocol 38).
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
- Available since 0.1.6. 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.