View source for ShowAsHelpMessage - Message

[[Category:Scripting]]
[[Category:Papyrus]]
'''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 ==
<source lang="papyrus">
Function ShowAsHelpMessage(string asEvent, float afDuration, float afInterval, int aiMaxTimes) native
</source>

== Parameters ==
*asEvent: The event which both identifies and ends the help message.  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 - Message|ResetHelpMessage]]. [[Button Tag Replacement]].
*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.

== Example ==
<source lang="papyrus">
; 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)
</source>

== See Also ==
*[[Message Script]]
*[[ResetHelpMessage - Message|ResetHelpMessage]]
*[[Button Tag Replacement]]