GuiCreateEdit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
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 edit box.  This is a text box in which the user can input text.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element guiCreateWindow ( float x, float y, float width, float height, string text, bool relative, [element parent] )
element guiCreateEdit ( 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 edit box 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 edit box on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI edit box. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI edit box. 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 button 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 edit box 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 an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
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...
--setup our function to output the message to the chatbox
blabhalbalhb --abababa
function outputEditBox ()
--This line does this...
local text = guiGetText ( editBox )--get the text from the edit box
mooo
outputChatBox ( text ) --output that text
end
 
--create our button and attach it to the outputEditBox function
guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true, nil, outputEditBox )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
</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 13:21, 1 August 2007

This function is for creating a new GUI edit box. This is a text box in which the user can input text.

Syntax

element guiCreateEdit ( 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 edit box on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the GUI edit box on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the GUI edit box. This is affected by the relative argument.
  • height: A float of the height of the GUI edit box. 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 button 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 edit box if it was successfully created, false otherwise.

Example

This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box. 

--setup our function to output the message to the chatbox
function outputEditBox ()
	local text = guiGetText ( editBox )--get the text from the edit box
	outputChatBox ( text ) --output that text
end

--create our button and attach it to the outputEditBox function
guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true, nil, outputEditBox )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )

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/GuiCreateEdit?oldid=9530"