HideAreaNotification

HideAreaNotification

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.

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

• Upcoming 0.1.6; not included in public 0.1.5. 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.