| objective_text(goal_index, tag[, string1[, string2[, sync_type[, icon_index]]]]) |
|
| Parameters: |
| goal_index | | (integer) index of the objective text to display/modify in the HUD |
| tag | | (string) message text to display (from mission_help.xtbl) |
| string1 | | (string, optional) string to insert into the message text, replaces the first %s occurrence (defaults to "") |
| string2 | | (string, optional) string to insert into the message text, replaces the second %s occurrence (defaults to "") |
| sync_type | | (enumeration, optional) synchronization type (MULTI_SYNC_LOCAL = affects local player, MULTI_SYNC_REMOTE = affects remote player, or MULTI_SYNC_ALL = affects both players; defaults to MULTI_SYNC_ALL) |
| icon_index | | (integer, optional) index of the icon to display next to the message. This will also be shown briefly on minimap. |
| |
| Returns: |
| none |
|
| Description: |
| Display an objective message for the current mission. The objective text will continue to display until changed by another call to objective_text or cleared with a call to objective_text_clear. |
| |
|
| back to index | SR3 Script Action Documentation
Last updated: Tue, 09 Aug 2011 11:32:16 |