GuiCheckBoxGetSelected: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Undo revision 27628 by Alsa7er2011 (talk) Your example makes absolutely no sense, please learn to script before submitting an example)
No edit summary
Line 15: Line 15:


==Example==
==Example==
This page lacks an example
This example makes a different beep based on the state when any checkbox has been clicked.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--add an example here
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)
</syntaxhighlight>
</syntaxhighlight>


Revision as of 16:39, 10 November 2011

This function gets a checkbox's selection state.

Syntax

bool guiCheckBoxGetSelected ( element 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.

Example

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)

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/GuiCheckBoxGetSelected?oldid=27632"