GuiCheckBoxGetSelected: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (changed category)
(OOP syntax)
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Client function}}
__NOTOC__  
__NOTOC__  
This function gets a checkbox's selection state.
This function gets a checkbox's selection state.
Line 5: Line 6:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiCheckBoxGetSelected ( element theCheckbox )
bool guiCheckBoxGetSelected ( element theCheckbox )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Checkbox|GuiCheckBox]]:getSelected|selected|guiCheckBoxSetSelected}}


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''theCheckbox :''' The checkbox you wish to retrieve the selection state of.
 
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns ''true'' if the checkbox is selected, ''false'' if it is not.


==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>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[Category:Needs_Example]]
{{GUI_events}}

Latest revision as of 20:34, 7 November 2018

This function gets a checkbox's selection state.

Syntax

bool guiCheckBoxGetSelected ( element theCheckbox )

OOP Syntax Help! I don't understand this!

Method: GuiCheckBox:getSelected(...)
Variable: .selected
Counterpart: guiCheckBoxSetSelected


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

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCheckBoxGetSelected?oldid=60481"