 |
The API is no longer being updated here until further notice. |
Returns the distance from the bottom/left edge of the screen to the requested edge of an object, scaled with the objects's effective scale.
offset = MyObject:GetBottom(); offset = MyObject:GetTop(); offset = MyObject:GetLeft(); offset = MyObject:GetRight();
Returns
- offset
- Number - distance between the bottom or left side of screen, respectively, to the requested edge of the object, in pixels, scaled according to effective scale. Or nil if the object has not been positioned, or :ClearAllPoints() has been called on it.
Notes
As an object moves towards the top of the screen, the return values for GetTop/GetBottom increase. As an object moves toward the right, the return values for GetLeft/GetRight increase. This function works for all objects including UIParent and WorldFrame.
This function is only guaranteed to work after the PLAYER_LOGIN event and then, only if the object in question is being Shown. Also, currently if you re-anchor an object or Show it, you will need to wait until after the next OnUpdate event before this function will return the correct new value.
The values returned by this function are generally not nice whole numbers but are often close. Example: 767.99994277954. Use floor(bottom + 0.5) to make integer.
Example
local playerFrameBottom = PlayerFrame:GetBottom(); local playerFrameTop = PlayerFrame:GetTop(); local playerFrameLeft = PlayerFrame:GetLeft(); local playerFrameRight = PlayerFrame:GetRight(); playerFrameBottom: 650 playerFrameTop: 780 playerFrameLeft: 20 playerFrameRight: 180