Interface IReadableNotes

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

Makes references readable notes whose pages a plugin writes at runtime.

public interface IReadableNotes

Remarks

The player's activation of a note opens the book menu on its pages and raises OnRead. A note written to be taken is an item, and shows its pages wherever the player reads it. The pages are stored in this plugin's saved state. Call members on the game's thread.

Properties

OnRead

Raised when the book menu opens on the pages of a note this plugin wrote.

IGameEvent<NoteReadEventArgs> OnRead { get; }

Property Value

IGameEvent<NoteReadEventArgs>

Remarks

It is raised on the game's thread.

Methods

SendByCourierAsync(string, IEnumerable<string>)

Sends the player a letter named name by the game's courier, whose pages are htmlPages.

Task<ObjectReference> SendByCourierAsync(string name, IEnumerable<string> htmlPages)

Parameters

name string

The name the letter shows.

htmlPages IEnumerable<string>

The pages as HTML, as ShowAsync(IEnumerable<string>, CancellationToken) receives them.

Returns

Task<ObjectReference>

The letter, a reference of dunLabyrinthianMazeClue that the player can take, once the courier has it.

Remarks

The letter is sent as SendAsync<TItem>(TItem) sends an item.

Exceptions

ArgumentNullException

name or htmlPages is null.

InvalidOperationException

The game created no letter.

Write<TNote>(TNote, string, IEnumerable<string>, bool)

Makes note a readable note named name, whose pages are htmlPages.

void Write<TNote>(TNote note, string name, IEnumerable<string> htmlPages, bool canBeTaken = false) where TNote : struct, IObjectReference

Parameters

note TNote

The reference, such as one of dunLabyrinthianMazeClue.

name string

The name the reference shows.

htmlPages IEnumerable<string>

The pages as HTML, as ShowAsync(IEnumerable<string>, CancellationToken) receives them. They replace the pages written before.

canBeTaken bool

Whether the player can take the note.

Type Parameters

TNote

Remarks

The reference's activation is blocked, or unblocked for a note that can be taken.

Exceptions

ArgumentNullException

name or htmlPages is null.