C_PingSecure.GetTargetPingReceiver

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

Returns the first suitable frame that may intercept a ping that can be found at the given screen position.

frame = C_PingSecure.GetTargetPingReceiver(mousePosX, mousePosY)

Arguments

mousePosX

number

mousePosY

number

Returns

frame

ScriptRegion

Details

• This function will typically be supplied the return values of GetCursorPosition.
• This function will return the first frame in the frame stack that meet either of the following criteria:
  • Any frame that is both marked as top level (Frame:SetToplevel) and does not have the ping-top-level-pass-through attribute set.
  • Any frame that has the ping-receiver attribute set.
• When determining if an attribute is set, this function only checks if the attribute has a non-nil value. Notably, this means that setting either of these attributes to false will still result in the attribute being considered as set.
• The behavior of this function if it encounters a frame that meets a mutually exclusive set of criteria should be considered undefined. However, currently if a frame is both marked as top level and has the ping-top-level-pass-through attribute set then the ping-receiver attribute will be ignored and the frame will not be returned.

Patch changes

Patch 10.1.7 (2023-09-05): Added.