GuiCreateRadioButton: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| (4 intermediate revisions by 4 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 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=== | ||
| Line 15: | 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. | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''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. | *'''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 26: | 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}} | ||
{{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
- guiBringToFront
- getChatboxLayout
- getChatboxCharacterLimit
- guiCreateFont
- guiBlur
- guiFocus
- guiGetAlpha
- guiGetCursorType
- guiGetEnabled
- guiGetFont
- guiGetInputEnabled
- guiGetInputMode
- guiGetPosition
- guiGetProperties
- guiGetProperty
- guiGetScreenSize
- guiGetSize
- guiGetText
- guiGetVisible
- guiMoveToBack
- guiSetAlpha
- guiSetEnabled
- guiSetFont
- guiSetInputEnabled
- guiSetInputMode
- guiSetPosition
- guiSetProperty
- guiSetSize
- guiSetText
- guiSetVisible
- isChatBoxInputActive
- isConsoleActive
- isDebugViewActive
- isMainMenuActive
- isMTAWindowActive
- isTransferBoxActive
- setChatboxCharacterLimit
- setDebugViewActive
Browsers
Buttons
Checkboxes
Comboboxes
- guiCreateComboBox
- guiComboBoxAddItem
- guiComboBoxClear
- guiComboBoxGetItemCount
- guiComboBoxGetItemText
- guiComboBoxGetSelected
- guiComboBoxIsOpen
- guiComboBoxRemoveItem
- guiComboBoxSetItemText
- guiComboBoxSetOpen
- guiComboBoxSetSelected
Edit Boxes
- guiCreateEdit
- guiEditGetCaretIndex
- guiEditGetMaxLength
- guiEditIsMasked
- guiEditIsReadOnly
- guiEditSetCaretIndex
- guiEditSetMasked
- guiEditSetMaxLength
- guiEditSetReadOnly
Gridlists
- guiCreateGridList
- guiGridListAddColumn
- guiGridListAddRow
- guiGridListAutoSizeColumn
- guiGridListClear
- guiGridListGetColumnCount
- guiGridListGetColumnTitle
- guiGridListGetColumnWidth
- guiGridListGetHorizontalScrollPosition
- guiGridListGetItemColor
- guiGridListGetItemData
- guiGridListGetItemText
- guiGridListGetRowCount
- guiGridListGetSelectedCount
- guiGridListGetSelectedItem
- guiGridListGetSelectedItems
- guiGridListGetSelectionMode
- guiGridListIsSortingEnabled
- guiGridListGetVerticalScrollPosition
- guiGridListInsertRowAfter
- guiGridListRemoveColumn
- guiGridListRemoveRow
- guiGridListSetColumnTitle
- guiGridListSetColumnWidth
- guiGridListSetHorizontalScrollPosition
- guiGridListSetItemColor
- guiGridListSetItemData
- guiGridListSetItemText
- guiGridListSetScrollBars
- guiGridListSetSelectedItem
- guiGridListSetSelectionMode
- guiGridListSetSortingEnabled
- guiGridListSetVerticalScrollPosition
Memos
- guiCreateMemo
- guiMemoGetCaretIndex
- guiMemoGetVerticalScrollPosition
- guiMemoSetVerticalScrollPosition
- guiMemoIsReadOnly
- guiMemoSetCaretIndex
- guiMemoSetReadOnly
Progressbars
Radio Buttons
Scrollbars
Scrollpanes
- guiCreateScrollPane
- guiScrollPaneGetHorizontalScrollPosition
- guiScrollPaneGetVerticalScrollPosition
- guiScrollPaneSetHorizontalScrollPosition
- guiScrollPaneSetScrollBars
- guiScrollPaneSetVerticalScrollPosition
Static Images
Tab Panels
Tabs
Text Labels
- guiCreateLabel
- guiLabelGetColor
- guiLabelGetFontHeight
- guiLabelGetTextExtent
- guiLabelSetColor
- guiLabelSetHorizontalAlign
- guiLabelSetVerticalAlign
Windows
Input
GUI
- onClientGUIAccepted
- onClientGUIBlur
- onClientGUIChanged
- onClientGUIClick
- onClientGUIComboBoxAccepted
- onClientGUIDoubleClick
- onClientGUIFocus
- onClientGUIMouseDown
- onClientGUIMouseUp
- onClientGUIMove
- onClientGUIScroll
- onClientGUISize
- onClientGUITabSwitched
- onClientMouseEnter
- onClientMouseLeave
- onClientMouseMove
- onClientMouseWheel