| mission_help_table(tag[, string1[, string2[, sync]]]) |
|
| Parameters: |
| tag | | (string) name of help text to display (from mission_help.xtbl) |
| string1 | | (string, optional) first replacement string |
| string2 | | (string, optional) second replacement string |
| sync | | (enumeration, optional) synchronization type (SYNC_LOCAL = affects local player, SYNC_REMOTE = affects remote player, or SYNC_ALL = affects both players; defaults to SYNC_ALL) |
| |
| Returns: |
| none |
|
| Description: |
| Generates a mission help message and updates the Objectives screen. Displays a localized help string in the help text area of the HUD. There are two replacement strings available which will replace up to instances of %s in the table text. The duration of the text is specified in the mission_help.xtbl file. If a value of 0.0 is specified, the default duration is 5 seconds. Example: Entry in the mission_help.xtbl file has name of "KillGangsta" and text of "Kill %s more %s members!" Executing the lua statement 'mission_help_table("KillGangsta", 5, "Vice King")' results in the help output "Kill 5 more Vice King members!" |
| |
|
| back to index | SR3 Script Action Documentation
Last updated: Tue, 09 Aug 2011 11:32:16 |