WoW API: Frame SetClampedToScreen

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < Frame SetClampedToScreen

Set whether the frame is prohibited from being positioned or dragged off screen. This applies to any attempt of repositioning a frame partially or entirely off screen. If the frame is clamped to the screen boundaries then the frame points will be re-adjusted automatically so that the entire frame always stays on screen. Examples where this applies:

• calling SetPoint()
• dragging the frame after calling StartMoving()
• sizing the frame after calling StartSizing()

Parameters

clamped

Boolean - Whether to enable (true) or disable (false) the clamping of the frame to the screen boundaries

Returns

- unknown -

Example

The following sample code should cause the spell book frame to be places halfway outside the screen. Instead it stays fully inside of the screen.

SpellBookFrame:Show()
SpellBookFrame:SetClampedToScreen( true )
SpellBookFrame:SetPoint( "TOPLEFT", UIParent, "TOPLEFT", 1000, -100 )