GuiCreateLabel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
This function is for creating a new GUI label
This function is for creating a new GUI label.  A label is simply a piece of text that cannot be edited by the user.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element guiCreateLabel ( float x, float y, float width, float height, string text, bool relative, element [parent] )
element guiCreateLabel ( float x, float y, float width, float height, string text, bool relative, [element parent = nil] )
</syntaxhighlight>  
</syntaxhighlight>  


===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 -->
*'''x:''' A float of the 2D x position of the GUI label on a player's screen.  This is affected by the ''relative'' argument.
*'''argumentName:''' description
*'''y:''' A float of the 2D y position of the GUI label on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI label. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI label. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed by default in the edit box.
*'''relative:''' This is whether sizes and positioning are relative.  If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.
 


<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''argumentName2:''' description
*'''parent:''' This is the parent that the gui label is attached to.  The ''relative'' argument must be true to use this. Sizes and positioning will be made relative to this parent.  If no parent is passed, the parent will become the screen - causing relative positioning and sizing according to screen positioning.
*'''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 -->
Returns an element of the created label if it was successfully created, false otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
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.
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
--create an empty label
blabhalbalhb --abababa
local myLabel = guiCreateLabel  ( 0, 0, 1, 1, "", true )
--This line does this...
 
mooo
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, true )
--hide the text by passing an empty string 5 seconds later
setTimer ( guiSetText, 5000, 1, myLabel, "" )
end
end
addEventHandler ( "onClientClick", getRootElement(), addLabelOnClick )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- 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

Revision as of 14:27, 1 August 2007

This function is for creating a new GUI label. A label is simply a piece of text that cannot be edited by the user.

Syntax

element guiCreateLabel ( float x, float y, float width, float height, string text, bool relative, [element parent = nil] )

Required Arguments

  • x: A float of the 2D x position of the GUI label on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the GUI label on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the GUI label. This is affected by the relative argument.
  • height: A float of the height of the GUI label. This is affected by the relative argument.
  • text: A string of the text that will be displayed by default in the edit box.
  • relative: This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.


Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • parent: This is the parent that the gui label is attached to. The relative argument must be true to use this. Sizes and positioning will be made relative to this parent. If no parent is passed, the parent will become the screen - causing relative positioning and sizing according to screen positioning.

Returns

Returns an element of the created label if it was successfully created, 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, true )
		--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

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCreateLabel?oldid=9550"