diff options
| author | Alexander M Pickering <alex@cogarr.net> | 2021-10-27 00:59:57 -0500 |
|---|---|---|
| committer | Alexander M Pickering <alex@cogarr.net> | 2021-10-27 00:59:57 -0500 |
| commit | b29ade63e3e6b4b3b163907e391f2968193ba7be (patch) | |
| tree | c70378e1e284c6fb4ad9eb81f5d8d12eb35883ce | |
| parent | c4f478522ac796476b16233b9606d4c37e916551 (diff) | |
| download | brokengine-b29ade63e3e6b4b3b163907e391f2968193ba7be.tar.gz brokengine-b29ade63e3e6b4b3b163907e391f2968193ba7be.tar.bz2 brokengine-b29ade63e3e6b4b3b163907e391f2968193ba7be.zip | |
Correct documentation
| -rw-r--r-- | src/client/lua_api/gui/iguiimage.cpp | 7 | ||||
| -rw-r--r-- | src/client/lua_api/gui/iguilabel.cpp | 3 | ||||
| -rw-r--r-- | src/client/lua_api/gui/iguitreeview.cpp | 6 |
3 files changed, 8 insertions, 8 deletions
diff --git a/src/client/lua_api/gui/iguiimage.cpp b/src/client/lua_api/gui/iguiimage.cpp index 81f6568..3251fff 100644 --- a/src/client/lua_api/gui/iguiimage.cpp +++ b/src/client/lua_api/gui/iguiimage.cpp @@ -25,11 +25,10 @@ extern IrrlichtDevice* device; extern IGUIEnvironment* env; /*** -@function gui.newiguiimage() Creates a new guielement with an image. -The size of the iguielement is the same as the itexture used for it's creation. -@tparam vector2d position The upper-left hand corner of the element. -it is offset from the upper-left of the parent element. +The size of the iguielement is the same as the itexture used for its creation. +@function gui.newiguiimage() +@tparam vector2d position The upper-left hand corner of the element. The element is offset from the upper-left of the parent element. @tparam number alpha The transparency of the element. @tparam itexture texture The texture to display on this element. @tparam? iguielement parent The parent element of the button. diff --git a/src/client/lua_api/gui/iguilabel.cpp b/src/client/lua_api/gui/iguilabel.cpp index bcb1778..1709d5e 100644 --- a/src/client/lua_api/gui/iguilabel.cpp +++ b/src/client/lua_api/gui/iguilabel.cpp @@ -23,8 +23,9 @@ using namespace gui; extern IrrlichtDevice* device; /*** -@function gui.newlabel() Creates a new label to display text. +Creates a label to display text with the front set in the engine. +@function gui.newlabel() @tparam rect pos The position of the label, reletive to the upper-left of it's parent element, or the root window if parent is nil. @tparam string text The text to display on this label. diff --git a/src/client/lua_api/gui/iguitreeview.cpp b/src/client/lua_api/gui/iguitreeview.cpp index 3778a50..ff4e655 100644 --- a/src/client/lua_api/gui/iguitreeview.cpp +++ b/src/client/lua_api/gui/iguitreeview.cpp @@ -18,10 +18,10 @@ using namespace gui; extern IrrlichtDevice* device; /*** +Creates a new tree view. +Creates a tree view where nodes can be expanded to show extra information, or more subtrees. @function gui.newtreeview() -Creates a new tree view -@tparam dimensions rect The rectangle to place the tree view at. -If the box has a parent, it is offset from the upper-left of the parent element. +@tparam dimensions rect The rectangle to place the tree view at. If the box has a parent, it is offset from the upper-left of the parent element. @tparam? iguielement parent The parent element of the button. @tparam? boolean draw_background Should we draw a background for the tree view? @tparam? boolean vertical_scroll Should there be a vertical scroll bar? |
