HideChapterScreen

hideChapterScreen

AVAILABLE FROM UPDATE 0.1.3

This function is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.

Request early removal of the calling resource's custom chapter title card for one player. See showChapterScreen and Chapter screens.

Syntax

bool HideChapterScreen(int playerId)
bool hideChapterScreen(int playerId)

Parameters

Name	Type	Required	Description
playerId	int	yes	The connected player identifier.

Returns

Returns true when an owned hide request is accepted for delivery. Returns false for invalid arguments, a disconnected player, no tracked chapter ownership for this resource/player, or a rejected runtime action. This is not a client-render acknowledgement.

Examples

Hide a title card previously requested by this same resource:

HideChapterScreen(playerId)

Notes

• Available only in server-side resource scripts.
• Available from update 0.1.3 (introduced in BUILD85), with matching client support.
• Both spellings in Syntax are aliases. Exactly one argument is accepted.
• Only the current owner can remove the displayed custom card. If another resource replaced it, an older resource's accepted hide is ignored by the client and does not hide the new card.
• The server ownership record is not a visibility query: automatic client expiry does not acknowledge an early hide to Lua. Do not use the return value to determine whether a card was visible.
• The custom card also expires automatically; resource cleanup, disconnect and player-pawn replacement clear the corresponding presentation. This function does not change the story or cancel arbitrary native cutscenes.