ShowAsHelpMessage - Message

Member of: 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

; 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."
Message.ShowAsHelpMessage("Jump", 5, 30, 3)

Notes

There can be only one message per event and once the event occurs, the message will not display again. To redisplay a message or display a new message for an event, use ResetHelpMessage.

See Also

• Message Script
• UnshowAsHelpMessage
• ClearHelpMessages
• ResetHelpMessage
• Button Tag Replacement
• OnMenuOpenCloseEvent
• OnTutorialEvent