hud_player_combo_add(display_time, max_wait_time, display_text, display_value[, show_value[, hud_type[, priority[, symbol[, skin[, sync_flag[, play_anim]]]]]]])

Parameters:
display_time		(float) The time, in seconds, the message should show for. If 0, the message will stay visible until hud_player_combo_remove is called.
max_wait_time		(float) The time, in seconds, the message can be queued for. If this time is exceeded, the message will be removed without being shown.
display_text		(string) The name of the text string to get localized text for.
display_value		(float) The value to show.
show_value		(bool, optional) If a value should be shown. If false only the text is. Defaults to true.
hud_type		(int, optional) The type of hud to show. Defaults to HPT_NONE.
priority		(int, optional) The priority of the hud. Defaults to HUD_MESSAGE_PRIORITY_NORMAL.
symbol		(int, optional) The symbol to show in front of the display value. Defaults to HPS_NONE.
skin		(int, optional) The skin for the hud. Defaults to HP_SKIN_DEFAULT.
sync_flag		(int, optional) How the hud should be sync'd in co-op. Defaults to MULTI_SYNC_LOCAL.
play_anim		(bool, optional) If animations should be played with the hu. Defaults to true.

Returns:
(uint) The message handle for the added hud (Could be INVALID_HANDLE if the message was not added).

Description:
This adds a player combo hud given the specified values. NOTE: The defines for the hud_type, symbol, and skin, are located in hud_mayhem.lua. hud_types: HPT_NONE HPT_POINTS HPT_DISTANCE HPT_TIME HPT_MONEY HPT_DEGREES hud_priorities: HUD_MESSAGE_PRIORITY_LOW HUD_MESSAGE_PRIORITY_NORMAL HUD_MESSAGE_PRIORITY_HIGH HUD_MESSAGE_PRIORITY_CRITICAL HUD_MESSAGE_PRIORITY_SUPER_CRITICAL hud_symbols: HPS_NONE HPS_MINUS HPS_PLUS HPS_MULTIPLIER hud_skins: HP_SKIN_DEFAULT


back to index	SR3 Script Action Documentation Last updated: Tue, 09 Aug 2011 11:32:15