GuiSetPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Client function}}
This function is for setting the position of a GUI element.
__NOTOC__
This function sets the position of a GUI element.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiSetPosition ( element gui, float x, float y, bool relative )
bool guiSetPosition ( element theElement, float x, float y, bool relative )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]]:setPosition|position|guiGetPosition}}


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''argumentName:''' description
*'''theElement:''' The GUI element to change position for
 
*'''x:''' Position over the X axis
<!-- Only include this section below if there are optional arguments -->
*'''y:''' Position over the Y axis
===Optional Arguments===
*'''relative:''' Bool that indicates if the x/y positions are relative to the elements parent element.
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if blah, ''false'' otherwise.
Returns ''true'' if the position has been successfully set, ''false'' otherwise.


==Example==  
==Example==  
Line 35: Line 34:
guiSetText ( myLabel, elementType )
guiSetText ( myLabel, elementType )
--and place it in the position of where the element is
--and place it in the position of where the element is
guiSetPosition ( myLabel, absoluteX, absoluteY, true )
guiSetPosition ( myLabel, absoluteX, absoluteY, false )
--hide the text by passing an empty string 5 seconds later
--hide the text by passing an empty string 5 seconds later
setTimer ( guiSetText, 5000, 1, myLabel, "" )
setTimer ( guiSetText, 5000, 1, myLabel, "" )
Line 46: Line 45:
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function
{{GUI_events}}

Latest revision as of 17:20, 21 November 2018

This function sets the position of a GUI element.

Syntax

bool guiSetPosition ( element theElement, float x, float y, bool relative )

OOP Syntax Help! I don't understand this!

Method: GuiElement:setPosition(...)
Variable: .position
Counterpart: guiGetPosition


Required Arguments

  • theElement: The GUI element to change position for
  • x: Position over the X axis
  • y: Position over the Y axis
  • relative: Bool that indicates if the x/y positions are relative to the elements parent element.

Returns

Returns true if the position has been successfully set, false otherwise.

Example

This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 5 seconds. 

--create an empty label
local myLabel = guiCreateLabel  ( 0, 0, 1, 1, "", true )

function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
	--if an element was clicked on screen
	if ( clickedElement ) then
		--retreive the element type
		local elementType = getElementType ( clickedElement )
		--change the label text to that element type
		guiSetText ( myLabel, elementType )
		--and place it in the position of where the element is
		guiSetPosition ( myLabel, absoluteX, absoluteY, false )
		--hide the text by passing an empty string 5 seconds later
		setTimer ( guiSetText, 5000, 1, myLabel, "" )
	end
end
addEventHandler ( "onClientClick", getRootElement(), addLabelOnClick )

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


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiSetPosition?oldid=60861"