GuiGetPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 6: Line 6:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float, float guiGetPosition ( element guiElement, bool relative )
float, float guiGetPosition ( element guiElement, bool relative )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]]:getPosition|position|guiSetPosition}}


===Required Arguments===  
===Required Arguments===  
*'''guiElement:''' The gui element of which you wish to retrieve the position.
*'''guiElement:''' The gui element of which you wish to retrieve the position.
*'''relative:''' A boolean representing whether the position should be relative to the element's parent width, or an absolute pixel offset from the parent's origin.
*'''relative:''' 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===
Line 41: Line 42:
==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
{{GUI_events}}

Latest revision as of 17:16, 21 November 2018

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

Syntax

float, float guiGetPosition ( element guiElement, bool relative )

OOP Syntax Help! I don't understand this!

Method: GuiElement:getPosition(...)
Variable: .position
Counterpart: guiSetPosition


Required Arguments

  • guiElement: The gui element of which you wish to retrieve the position.
  • relative: 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 floats representing the x and y position of the element, or false if the position could not be retrieved.

Example

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

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI