GuiCreateRadioButton: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(6 intermediate revisions by 6 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element guiCreateRadioButton ( float x, float y, float width, float height, string text, bool relative, [element parent = nil] )
element guiCreateRadioButton ( float x, float y, float width, float height, string text, [ bool relative = false, gui-element parent = nil ] )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[Element/GUI/Radio button|GuiRadioButton]]}}


===Required Arguments===  
===Required Arguments===  
[[Image:gui-radiobutton.png|frame|Example GUI radio buttons.]]
*'''x:''' A float of the 2D x position of the radio button on a player's screen. This is affected by the ''relative'' argument.
*'''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.
*'''y:''' A float of the 2D y position of the radio button on a player's screen. This is affected by the ''relative'' argument.
Line 14: Line 16:
*'''height:''' A float of the height 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.
*'''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}}  
*'''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.
*'''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.
*'''parent:''' This is the parent that the radio button is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
''NOTE:'' All radio buttons become grouped together with their parent item.  Only ONE radio button per group/parent will be able to be selected at the same time.
''NOTE:'' All radio buttons become grouped together with their parent item.  Only ONE radio button per group/parent will be able to be selected at the same time.


Line 25: Line 27:


==Example==
==Example==
This example
This example creates a radio button then checks if one is selected and if it is, then it's output the title and sets the next radio button selected. (TESTED!)
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">hi = guiCreateRadioButton(243,204,36,16,"Hi",false)
guiRadioButtonSetSelected(hi,true)
bye = guiCreateRadioButton(243,224,41,16,"Bye",false)
 
if(guiRadioButtonGetSelected(hi))then
outputChatBox("Hi "..getPlayerName(localPlayer))
guiRadioButtonSetSelected(bye,true)
else
outputChatBox("Bye "..getPlayerName(localPlayer))
guiRadioButtonSetSelected(hi,true)
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[Category:Needs Example]]
{{GUI_events}}

Latest revision as of 08:10, 30 October 2023

This function creates a radio button.

Syntax

element guiCreateRadioButton ( float x, float y, float width, float height, string text, [ bool relative = false, gui-element parent = nil ] )

OOP Syntax Help! I don't understand this!

Method: GuiRadioButton(...)


Required Arguments

Example GUI radio buttons.
  • 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.

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.

  • 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.
  • parent: This is the parent that the radio button is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

NOTE: All radio buttons become grouped together with their parent item. Only ONE radio button per group/parent will be able to be selected at the same time.

Returns

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

Example

This example creates a radio button then checks if one is selected and if it is, then it's output the title and sets the next radio button selected. (TESTED!) 

hi = guiCreateRadioButton(243,204,36,16,"Hi",false)
guiRadioButtonSetSelected(hi,true)
bye = guiCreateRadioButton(243,224,41,16,"Bye",false)

if(guiRadioButtonGetSelected(hi))then
	outputChatBox("Hi "..getPlayerName(localPlayer))
	guiRadioButtonSetSelected(bye,true)
else
	outputChatBox("Bye "..getPlayerName(localPlayer))
	guiRadioButtonSetSelected(hi,true)
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


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCreateRadioButton?oldid=78483"