Mod:Creation Kit/ShowAsHelpMessage - Message

Member of: Mod:Creation Kit/Message Script

Displays a help message on screen for a specified duration at specified intervals until a specified number of showings occurs or until a user event takes place.

Syntax
Function ShowAsHelpMessage(string asEvent, float afDuration, float afInterval, int aiMaxTimes, string asContext="", \ int aiPriority=0) native

Parameters

 * asEvent: The event which both identifies and ends the help message.
 * afDuration: How long should the message appear before going away? A value <= 0 means no time limit.
 * afInterval: How much time should elapse in between showings of the message.
 * aiMaxTimes: After this many times being shown, the message will stop appearing. A value <= 0 means no occurrence limit.
 * asContext: A string identifying the context in which this message is shown.
 * Default: ""
 * Pass a menu name for this message only to show when the given menu is open. (For a list of valid menu names, see OnMenuOpenCloseEvent)
 * Pass "NoMenu" for this message only to appear when the game is not in menu mode.
 * Leave off for no contextual restrictions.
 * aiPriority: A relative priority value. Only active messages of the highest priority within a valid context will be shown.
 * Default: 0

Example
Message.ShowAsHelpMessage("Jump", 5, 30, 3)
 * Display a message telling the player to press the jump button.
 * In this example, the message's text would be something like "Press [Jump] to jump."