guiCreateRadioButton

Client-side

Server-side

Shared

This function creates a radio button.

OOP Syntax Help! I don't understand this!

Constructor: GuiRadioButton (...)

Syntax

gui-radiobutton|false guiCreateRadioButton ( float x, float y, float width, float height, string text, [ bool relative = false, gui-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.

Optional arguments

Note: when using optional arguments, you might need to supply all arguments before the one you wish to use.

relative (default: false): 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 (default: nil): 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.

Returns

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

gui-radiobutton|false: result

Code Examples

client

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.

local hi = guiCreateRadioButton(243, 204, 36, 16, "Hi", false)
guiRadioButtonSetSelected(hi, true)

local bye = guiCreateRadioButton(243, 224, 41, 16, "Bye", false)

addEventHandler('onClientGUIClick', resourceRoot, function()
  if (guiRadioButtonGetSelected(hi)) then
    outputChatBox("Hi " .. getPlayerName(localPlayer))
    guiRadioButtonSetSelected(bye, true)
  else
    outputChatBox("Bye " .. getPlayerName(localPlayer))
    guiRadioButtonSetSelected(hi, true)
  end
end)

Gallery

Click on the image to view the full preview along with the description.

guiCreateRadioButton

OOP Syntax Help! I don't understand this!

Syntax

Required arguments

Optional arguments

Returns

Code Examples

Gallery

See Also

GUI Functions

GUI Elements

Reference