HideAreaNotification: 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 29: | Line 29: | ||
== Notes == | == Notes == | ||
* | * Available since 0.1.6. Server-side only. Lower-camel alias: hideAreaNotification. | ||
* Requires exactly one argument. Does not hide another resource's newer replacement banner; resource identity is attached by the server, not supplied in Lua arguments. | * Requires exactly one argument. Does not hide another resource's newer replacement banner; resource identity is attached by the server, not supplied in Lua arguments. | ||
* Does not control automatic discovery notifications or chapter screens. Use [[ShowAreaNotification]] to show/replace an area banner. | * Does not control automatic discovery notifications or chapter screens. Use [[ShowAreaNotification]] to show/replace an area banner. | ||
Latest revision as of 21:55, 30 September 2026
HideAreaNotification
AVAILABLE FROM UPDATE 0.1.6
Available since G1R:MP 0.1.6. Use the matching client and server (Protocol 38).
Requests early removal of the caller resource's custom area notification for one player.
Syntax
HideAreaNotification(playerId)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | Connected numeric player ID; finite integer 1..4294967295. |
Returns
true when the owning resource's hide request is accepted for delivery; false for invalid/unavailable players, missing resource tracking or transport rejection. Not proof that a visible banner was removed.
Examples
-- Call later from the same resource that showed the banner:
local accepted = HideAreaNotification(playerId)
Notes
- Available since 0.1.6. Server-side only. Lower-camel alias: hideAreaNotification.
- Requires exactly one argument. Does not hide another resource's newer replacement banner; resource identity is attached by the server, not supplied in Lua arguments.
- Does not control automatic discovery notifications or chapter screens. Use ShowAreaNotification to show/replace an area banner.
- Visual expiry can occur before server-side tracking is cleared. Accepted hide is not a render acknowledgement. See Area notifications for lifecycle and cleanup.