- Found in:
- Vanilla
Description
Wiki Description
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.
Documentation Comment
Shows help message for a user action on screen.
Parameters
stringasEvent
CK Wiki Description
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 Message.ResetHelpMessage(...). Button Tag Replacement.
floatafDuration
CK Wiki Description
How long should the message appear before going away? A value <= 0 means no time limit.
floatafInterval
CK Wiki Description
How much time should elapse in between showings of the message.
intaiMaxTimes
CK Wiki Description
After this many times being shown, the message will stop appearing. A value <= 0 means no occurrence limit.
Examples
; 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)Auto-Generated Example
string myString__asEvent
float myFloat__afDuration
float myFloat__afInterval
int myInt__aiMaxTimes
myMessage__toCallFunctionOn.ShowAsHelpMessage(myString__asEvent, myFloat__afDuration, myFloat__afInterval, myInt__aiMaxTimes)