API
:AreMovablesLocked()(key)
Check whether all frames are locked or not.
Parameters
- key
Return value
(boolean) True if all frame are locked, false if at least one frame is unlocked.
:IsMovable(target)(key, target)
Check whether a given frame can be unlocked.
Parameters
- key
- target
- (frame) The frame to check.
Return value
(boolean) True if the frame can be unlocked.
:IterateMovableOverlays()(key, A)
Return an iterator on frame overlays.
Parameters
- key
- A
- (iter, data, index) triplet suitable for for .. in .. do loops.
:LockMovables()(key)
Lock all frames.
Parameters
- key
:RegisterMovable(target, db, label, anchor)(key, target, db, label, anchor)
Register a frame.
Parameters
- key
- target
- (frame) The frame that should become movable.
- db
- (table/function) The table to save position into, or a callback that returns such table.
- label
- (string) The overlay label.
- anchor
- (frame) Optional frame to use in place of target for overlay anchor.
:ResetMovableLayout()(key)
Reset all frames to their default position and scale.
Parameters
- key
:SetMovable(target)(key, target, flag, update)
Enable/disable the movable behavior of a frame.
This is used to disable all the overlays frames of a disabled addon.
Parameters
- key
- target
- (frame) The target frame.
- flag
- (boolean) True to enable the frame.
- update
- (boolean) True to apply the settings (if enabled), or reset the frame to its default position (if disable).
:UnlockMovables()(key)
Unlock all frames.
Parameters
- key
:UpdateMovableLayout()(key)
Refresh the layout of all frames.
Force every frames to re-read and to apply theirs settings.
Useful after a profile switch or reset.
Parameters
- key
Comments