QCherry: Document ShowChapterScreen/HideChapterScreen available from update 0.1.3

2026-09-12T18:33:03Z

Document ShowChapterScreen/HideChapterScreen available from update 0.1.3

New page

= hideChapterScreen =
<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.3</div>
<div style="color:#111111; margin-top:0.25rem;">This function is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.</div>
</div>

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

== Syntax ==
<syntaxhighlight lang="lua">
bool HideChapterScreen(int playerId)
bool hideChapterScreen(int playerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|}

== Returns ==
Returns <code>true</code> when an owned hide request is accepted for delivery. Returns <code>false</code> 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:
<syntaxhighlight lang="lua" line>
HideChapterScreen(playerId)
</syntaxhighlight>

== 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.

[[Category:Lua Functions]]
[[Category:Server Functions]]
[[Category:Player Functions]]

HideChapterScreen - Revision history

QCherry: Document ShowChapterScreen/HideChapterScreen available from update 0.1.3