diff options
| author | Alexander <alex@cogarr.net> | 2020-06-29 15:29:03 -0400 |
|---|---|---|
| committer | Alexander <alex@cogarr.net> | 2020-06-29 15:29:03 -0400 |
| commit | 80789508b9655d25629223b9dcc84b4cfb77ce45 (patch) | |
| tree | 37e140e532af61c1ca4699c8b6254cf2cb07ed02 /src/client/lua_api/gui/iguielement.cpp | |
| parent | 44a1421c393632978d59c0698a93ae22243b97e9 (diff) | |
| download | brokengine-80789508b9655d25629223b9dcc84b4cfb77ce45.tar.gz brokengine-80789508b9655d25629223b9dcc84b4cfb77ce45.tar.bz2 brokengine-80789508b9655d25629223b9dcc84b4cfb77ce45.zip | |
Updates for mdoc
Also more tests
Diffstat (limited to 'src/client/lua_api/gui/iguielement.cpp')
| -rw-r--r-- | src/client/lua_api/gui/iguielement.cpp | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/client/lua_api/gui/iguielement.cpp b/src/client/lua_api/gui/iguielement.cpp index db7669a..17ec4a5 100644 --- a/src/client/lua_api/gui/iguielement.cpp +++ b/src/client/lua_api/gui/iguielement.cpp @@ -1,5 +1,5 @@ /*This file defines some things that all igui stuff can do*/ -/*** +/* All gui elements inherit from iguielement. Some functions (like settext()) do different things for different elements. All gui elements can call the following callbacks: @@ -9,7 +9,6 @@ All gui elements can call the following callbacks: onHover(self) onLeave(self) -@classmod iguielement */ extern "C" { #include <lua.h> @@ -28,9 +27,10 @@ using namespace core; using namespace gui; extern IrrlichtDevice *device; + /*** Move an element (by an offset) from it's current position -@function guielement:move() +@function iguielement:move() @tparam vector2d position The offset to move this element by */ //move({element},{x,y}) -> nil @@ -51,7 +51,7 @@ int moveiguielement(lua_State* L){ /*** Set the visibility of this element -@function guielement:setvisible() +@function iguielement:setvisible() @tparam boolean visible Should this element be visible? */ int setvisible(lua_State *L){ @@ -69,7 +69,7 @@ int setvisible(lua_State *L){ /*** Find the rectangle that an element occupies -@function guielement:getabsrect() +@function iguielement:getabsrect() @treturn rect The rectangle that this element occupies */ //getabsrect({element})-> {{sx,sy},{ex,ey}} @@ -91,7 +91,7 @@ int getiguiclippingrect(lua_State* L){ /*** Find the rectangle that an element occupies that is visible to the user -@function guielement:getabsclippingrect() +@function iguielement:getabsclippingrect() @treturn rect The rectangle that this element occupies that is visible to the user */ //getabsclippingrect({element}) :: {{sx,sy},{ex,ey}} @@ -112,7 +112,7 @@ int getiguiabsclippingrect(lua_State *L){ /*** Find the relative rectangle that this element occupies -@function guielement:getrelrect() +@function iguielement:getrelrect() @treturn rect The rectangle that this element occupies relative to it's parent */ int getiguirelrect(lua_State *L){ @@ -135,7 +135,7 @@ Sets the text of the element This function may do different things to different gui elements. For example, on a window, it sets the title. On a button, it sets the button's text. -@function guielement:settext() +@function iguielement:settext() @tparam string text The text to set on the element */ //setText({guielement},"text") :: nil @@ -168,7 +168,7 @@ int setrelrect(lua_State *L){ /*** -@function guielement:gettext() +@function iguielement:gettext() @treturn string The caption text of the element. For input element like editboxes, this returns the text that the edit box contains. */ @@ -189,7 +189,7 @@ int getiguitext(lua_State* L){ /*** Removes a gui element, and any child elements -@function guielement:remove() +@function iguielement:remove() */ //remove({self}) int removeiguielement(lua_State* L){ |
