Squirrel/Client/Events/GUI/onClientClickCheckbox

Latest revision as of 02:50, 2 August 2011

This event is called when the local player clicks a checkbox.

function onClientClickCheckbox( int checkID, bool down )

1 - Let the checkbox be checked/unchecked normally
0 - Returning 0 locks the status of the checkbox (if the mouse button is released)

This code will tell a player they pressed a checkbox.

 
function onClientClickCheckbox( checkID, down )
{
    Message("You just clicked on a checkbox.");
    return 1;
}

This code will stop a player from enabling (or disabling) a checkbox.

 
function onClientClickCheckbox( checkID, down )
{
    Message("I'm afraid I can't let you do that.");
    return 0;
}

The function Message was used in both examples and has more information on the corresponding page.

@@ Line 19: / Line 19: @@
 == Example ==
-Some explanation here
+This code will tell a player they pressed a checkbox.
-{{Squirrel/NeedsExample}}
 <code lang="squirrel">
- -- todo
+function onClientClickCheckbox( checkID, down )
+{
+    Message("You just clicked on a checkbox.");
+    return 1;
+}
+</code>
+This code will stop a player from enabling (or disabling) a checkbox.
+<code lang="squirrel">
+function onClientClickCheckbox( checkID, down )
+{
+    Message("I'm afraid I can't let you do that.");
+    return 0;
+}
 </code>
 === Notes ===
--- List of used functions and other notes here.
+The function [[Squirrel/Client/Functions/Messages/Message|Message]] was used in both examples and has more information on the corresponding page.
 == Related Events ==
 {{Squirrel/Client/Events/GUI}}