guiCheckBoxGetSelected

Client-side

Server-side

Shared

This function gets a checkbox's selection state.

OOP Syntax Help! I don't understand this!

Method:gui-checkbox:getSelected(...)
Variable: .selected

Syntax

bool guiCheckBoxGetSelected ( gui-checkbox theCheckbox )

Required arguments

theCheckbox: The checkbox you wish to retrieve the selection state of.

Returns

Returns true if the checkbox is selected, false if it is not.

bool: result

Code Examples

client

This example makes a different beep based on the state when any checkbox has been clicked.

function checkboxBleepWhenClicked()
    if (getElementType(source) == "gui-checkbox") then -- Is the element clicked a checkbox?
        if (guiCheckBoxGetSelected(source)) then
            playSoundFrontEnd(1) -- If the checkbox is selected play sound 1.
        else
            playSoundFrontEnd(2) -- If the checkbox isn't selected play sound 2.
        end
    end
end
addEventHandler("onClientGUIClick", root, checkboxBleepWhenClicked, false)

guiCheckBoxGetSelected

OOP Syntax Help! I don't understand this!

Syntax

Required arguments

Returns

Code Examples

See Also

GUI Functions

GUI Elements

Reference