ObjectPoolMixin:GetNextActive()

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

→ FrameXML Funcs

→ FrameXML Docs

These functions are implemented in :GetNextActive FrameXML/Pools.lua.

Stateless iterator to cycle through the active and inactive widgets in an object pool.

widget = pool:NextActive([current])
widget = pool:NextInactive([current])

Arguments

current

UIObject?Optional. Could be nil. - Current widget in the list, or nil to start at the beginning.

Returns

widget

UIObject?Optional. Could be nil. - Next widget in the list, or nil when the last widget has been reached.

Details

• There are no assurances the widgets will be accessed in any particular order.

Example

local widget = pool:NextActive()
while (widget) do
  -- do something
  widget = pool:NextActive()
end

See also

• ObjectPoolMixin:EnumerateActive()
• ObjectPoolMixin:EnumerateInactive()
• next() - Generic stateless iterator.

Patch changes

• Patch 9.0.1 (2020-10-13): GetNextInactive() added.
  
• Patch 7.2.0 (2017-03-28): GetNextActive() added.