Interface IDebug

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

The game's debug functions, which surface information while it runs.

public interface IDebug

Remarks

Both reach the game on the calling thread and return once it has finished with them, and both end at the interface: a notification is drawn by the heads-up display and a box is a menu.

Methods

MessageBox(string)

Shows a message box the player must dismiss, which Papyrus calls Debug.MessageBox.

[Obsolete("Use IMessageBoxPrompter.ShowAsync.")]
void MessageBox(string message)

Parameters

message string

Exceptions

ArgumentNullException

message is null.

Notification(string, string?, bool)

Shows a notification the way the game shows its own, in the corner of the screen.

void Notification(string message, string? sound = null, bool dropIfQueued = true)

Parameters

message string

The text shown.

sound string

The editor ID of a sound record or a sound descriptor to play with it, or null for none.

dropIfQueued bool

Whether the notification is dropped where the same text is already waiting to be shown.

Exceptions

ArgumentNullException

message is null.