aboutsummaryrefslogtreecommitdiff
path: root/src/client/lua_api/gui/iguibutton.cpp
diff options
context:
space:
mode:
authorAlexander Pickering <alex@cogarr.net>2018-10-20 14:05:30 -0400
committerAlexander Pickering <alex@cogarr.net>2018-10-20 14:05:30 -0400
commit4a797a4226893b382ffc3c1f92e844f6743c7220 (patch)
tree5645ee6e58c0ac38e71230338901578ee572df2a /src/client/lua_api/gui/iguibutton.cpp
parent6543a9aa301a8ebc67ff50a880bcff2e496fa17e (diff)
downloadbrokengine-4a797a4226893b382ffc3c1f92e844f6743c7220.tar.gz
brokengine-4a797a4226893b382ffc3c1f92e844f6743c7220.tar.bz2
brokengine-4a797a4226893b382ffc3c1f92e844f6743c7220.zip
Added more documentation
Added documentation for several gui elements also moved documentation of generic iguielements to an iguielement class Also added a setvisible() function to iguielements
Diffstat (limited to 'src/client/lua_api/gui/iguibutton.cpp')
-rw-r--r--src/client/lua_api/gui/iguibutton.cpp8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/client/lua_api/gui/iguibutton.cpp b/src/client/lua_api/gui/iguibutton.cpp
index aabc992..42d2846 100644
--- a/src/client/lua_api/gui/iguibutton.cpp
+++ b/src/client/lua_api/gui/iguibutton.cpp
@@ -28,8 +28,14 @@ extern IrrlichtDevice* device;
char lhashkey[20];
/***
+Creates a new button.
+Buttons may have the following fields set for callbacks:
+`.onClick(self)`
+`.onFocus(self)`
+`.onUnfocus(self)`
+`.onHover(self)`
+`.onLeave(self)`
@function newbutton()
-Creates a new checkbox
@tparam rect dimensions The rectangle to place the button at. If the box has a parent,
it is offset from the upper-left of the parent element.
@tparam string default_text The default text to have in the button