API:ActionButtonGroupSetTimeFormat

UI Lua API · ActionButtonGroup functions
Version: WAR 1.4.8

Stores a time format setting on an ActionButtonGroup.

ActionButtonGroupSetTimeFormat(groupName, format)

Arguments

groupName

string – Name of an ActionButtonGroup window.

format

number – One of the Window.TimeFormat constants the client defines:

Constant	Value
Window.TimeFormat.SECONDS	0
Window.TimeFormat.LARGEST_UNIT_ROUNDUP	1
Window.TimeFormat.LARGEST_UNIT_TRUNCATE	2
Window.TimeFormat.NUM_FORMATS	3

Returns

Nothing.

Details

• Values 0 to 3 are stored on the group. Any other value (after dropping fractions) is ignored without an error, and in that case the window name is not even checked.
• In this client the stored value is not used by the button countdown code: the text of ActionButtonGroupSetTimer is formatted the same way whatever format is set.

Errors

• Error in function call 'ActionButtonGroupSetTimeFormat': Window %s does not exist
• Error in function call 'ActionButtonGroupSetTimeFormat': Window %s is not a ActionButtonGroup

Example

From ea_backpackwindow/source/backpackiconview.lua:

ActionButtonGroupSetTimeFormat( pocketName.."Buttons", Window.TimeFormat.LARGEST_UNIT_TRUNCATE )

See also

• ActionButtonGroupSetTimeAbbreviations
• ActionButtonGroupSetTimer