API:GetAndClearPartyMemberDirtyFlag

UI Lua API · Group functions
Version: WAR 1.4.8

Returns whether a groupmate's status has changed since the last call, and resets that flag.

changed = GetAndClearPartyMemberDirtyFlag(memberIndex)

Arguments

memberIndex

number – Groupmate slot, 1 to 5 (the player is not counted). Only the low 8 bits are used.

Returns

changed

boolean – The slot's change flag before it was cleared. Nothing if memberIndex is out of range or there is no player object.

Details

• The flag is cleared on every successful call, so only the first caller after a change sees true. If several addons poll the same slot, they take the flag from each other.
• The stock UI uses the flag to decide when to re-read the member's values with GetGroupMemberStatusData.
• The function takes exactly one argument.

Errors

None besides the generic Invalid Parameters message when the argument is missing or not a number.

Example

From default/easystem_utils/source/partyutils.lua:

if( GetAndClearPartyMemberDirtyFlag( memberIndex ) )
then
    local memberData = GetGroupMemberStatusData( memberIndex )
    ...
end

See also

• GetGroupMemberStatusData
• GetAndClearWarbandMemberDirtyFlag