Table of Contents

Class MessageScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from Message.psc.

public static class MessageScript
Inheritance
MessageScript
Inherited Members

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

ResetHelpMessage(string)

Resets help message status for an input event so a new message can be displayed for that event.

public static Task ResetHelpMessage(string asEvent)

Parameters

asEvent string

Returns

Task

Show(PapyrusScript<Message>, float, float, float, float, float, float, float, float, float)

Show this message on the screen, substituting the values as appropriate. If a message box, it will wait until the user closes the box before returning - returning the button the user hit. If not a message box, or something went wrong, it will return -1

public static Task<int> Show(this PapyrusScript<Message> self, float afArg1 = 0, float afArg2 = 0, float afArg3 = 0, float afArg4 = 0, float afArg5 = 0, float afArg6 = 0, float afArg7 = 0, float afArg8 = 0, float afArg9 = 0)

Parameters

self PapyrusScript<Message>
afArg1 float
afArg2 float
afArg3 float
afArg4 float
afArg5 float
afArg6 float
afArg7 float
afArg8 float
afArg9 float

Returns

Task<int>

ShowAsHelpMessage(PapyrusScript<Message>, string, float, float, int)

Shows help message for a user action on screen.

public static Task ShowAsHelpMessage(this PapyrusScript<Message> self, string asEvent, float afDuration, float afInterval, int aiMaxTimes)

Parameters

self PapyrusScript<Message>
asEvent string
afDuration float
afInterval float
aiMaxTimes int

Returns

Task