GuiCreateRadioButton: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Needs_Checking|The size specifications do not resize the radio buttons, yet they influence their positions on the GUI window. If the radio buttons are not going to be resizable, the sizing options should be turned off to avoid confusion --[[User:Ransom|Ransom]] 16:25, 14 September 2007 (CDT)}}
{{Needs_Checking|The size specifications do not resize the radio buttons, yet they influence their positions on the GUI window. If the radio buttons are not going to be resizable, the sizing options should be turned off to avoid confusion --[[User:Ransom|Ransom]] 16:25, 14 September 2007 (CDT)}}


__NOTOC__  
__NOTOC__
This function creates a radio button.
{{Client function}}
This function creates a [[Element/GUI/Radio button|radio button]].


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


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''x:''' A float of the 2D x position of the radio button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the radio button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the text field next to the radio button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the text field next to the radio button. This is affected by the ''relative'' argument.
*'''text:''' The text to be displayed next to the radio button.
*'''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 measures relative to the parent.


===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''argumentName2:''' description
*'''parent:''' This is the parent that the radio button is attached to. The ''relative'' argument must be true to use this. Sizes and positioning will be made relative to this parent. If ''nil'' parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns [[element]] of the radio button if it was created succesfully, ''false'' otherwise.


==Example==
==Example==
Line 26: Line 32:
==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]]
[[Category:Needs Example]]

Revision as of 16:46, 20 March 2008

Dialog-information.png This article needs checking.
Reason(s): The size specifications do not resize the radio buttons, yet they influence their positions on the GUI window. If the radio buttons are not going to be resizable, the sizing options should be turned off to avoid confusion --Ransom 16:25, 14 September 2007 (CDT)


This function creates a radio button.

Syntax

element guiCreateRadioButton ( 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 radio button on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the radio button on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the text field next to the radio button. This is affected by the relative argument.
  • height: A float of the height of the text field next to the radio button. This is affected by the relative argument.
  • text: The text to be displayed next to the radio button.
  • 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 measures 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 radio button is attached to. The relative argument must be true to use this. Sizes and positioning will be made relative to this parent. If nil parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

Returns

Returns element of the radio button if it was created succesfully, false otherwise.

Example

This example 



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/GuiCreateRadioButton?oldid=16242"