- 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.
Caveats
CK Wiki - 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 Message.ResetHelpMessage(...).
Parameters
stringasEvent
CK Wiki Description
The event which both identifies and ends the help message.
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.
stringasContext=""
CK Wiki Description
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.
intaiPriority=0
CK Wiki Description
A relative priority value. Only active messages of the highest priority within a valid context will be shown.
- Default:0
Examples
No human-generated examples found for this function.
Auto-Generated Example
string myString__asEvent
float myFloat__afDuration
float myFloat__afInterval
int myInt__aiMaxTimes
string myString__asContext
int myInt__aiPriority
myMessage__toCallFunctionOn.ShowAsHelpMessage(myString__asEvent, myFloat__afDuration, myFloat__afInterval, myInt__aiMaxTimes, myString__asContext, myInt__aiPriority)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki