Table of Contents

Interface IBookMenuPresenter

Namespace
SkyrimForge
Assembly
SkyrimForge.dll

Shows runtime text in the book menu.

public interface IBookMenuPresenter

Remarks

The menu opens on dunLabyrinthianMazeClue, showing the supplied pages in place of its text. Opened during a conversation, it shows above the dialogue menu, which stays open beneath it, so the conversation continues once it closes. Call members on the game's thread.

Methods

ShowAsync(IEnumerable<string>, CancellationToken)

Opens the book menu on htmlPages.

Task ShowAsync(IEnumerable<string> htmlPages, CancellationToken cancellationToken = default)

Parameters

htmlPages IEnumerable<string>

The pages as HTML. Encode text with HtmlEncode(string). BookFonts lists the font faces.

cancellationToken CancellationToken

Stops the wait. The menu, requested from the game before the wait begins, still opens.

Returns

Task

A task that completes in work queued through ITaskQueue when the menu closes. It is canceled by cancellationToken, and does not complete if the game opens no menu.

Exceptions

ArgumentNullException

htmlPages is null.