guiGetPosition

Client-side

Server-side

Shared

This function allows retrieval of a GUI element's current position, relative to its parent.

OOP Syntax Help! I don't understand this!

Method:gui-element:getPosition(...)
Variable: .position

Syntax

float|false, float guiGetPosition ( gui-element guiElement, [ bool relative = false ] )

Required arguments

guiElement: The gui element of which you wish to retrieve the position.

Optional arguments

Note: when using optional arguments, you might need to supply all arguments before the one you wish to use.

relative (default: false): A boolean representing whether the position should be relative to the element's parent width, or the number of offset pixels from the parent's origin.

Returns

Returns two floats representing the x and y position of the element, or false if the position could not be retrieved.

float|false: x
float: y

Code Examples

client

This example checks which corner a gui element exists in.

function positionCheck(guiElement)
    local x, y = guiGetPosition(guiElement, true) -- get the position
    local position -- define the position
    if (x == 0.5) and (y == 0.5) then -- if its bang in the middle
        position = "middle" -- set position to middle
    elseif (x > 0.5) and (y > 0.5) then -- if its in the right bottom
        position = "right-bottom"
    elseif (x < 0.5) and (y < 0.5) then -- if its in the left top
        position = "left-top"
    elseif (x < 0.5) and (y > 0.5) then -- if its in the left bottom
        position = "left-bottom"
    elseif (x > 0.5) and (y < 0.5) then -- if its in the right top
        position = "right-top"
    else -- if it couldnt be retrieved
        position = "unknown"
    end
    -- announce this into the chatbox
    outputChatBox("The gui element's position is " .. position .. "!")
end

guiGetPosition

OOP Syntax Help! I don't understand this!

Syntax

Required arguments

Optional arguments

Returns

Code Examples

See Also

GUI Functions

GUI Elements

Reference