From f558b4003b010a81884b95eea37470da1cffa38c Mon Sep 17 00:00:00 2001 From: "Daniel J. Ramirez" Date: Tue, 3 May 2016 17:09:42 -0500 Subject: Documented LinkButton --- doc/base/classes.xml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index cba5425d3f..affe73c222 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -17963,39 +17963,47 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Simple button used to represent a link to some resource + This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page). + Sets the text of the button. + Returns the text of the button. + Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section). + Returns the underline mode for this button. + The LinkButton will always show an underline at the bottom of its text + The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it. -- cgit v1.2.3 From ed7c0a6caf35838efbf8799bdae7b591f5332ec9 Mon Sep 17 00:00:00 2001 From: "Daniel J. Ramirez" Date: Thu, 5 May 2016 12:42:42 -0500 Subject: Partial documentation for OS methods --- doc/base/classes.xml | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index affe73c222..529601c741 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -20971,12 +20971,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Returns the number of displays attached to the host machine + Returns the current screen index (0 padded). @@ -20999,54 +21001,63 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Returns the dimensions in pixels of the specified screen. + Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. + Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen). + Returns the size of the window (without counting window manager decorations). + Sets the window size to the specified size. + Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode. + Returns whether the window is in fullscreen mode or not. + Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings. + Returns whether the window is resizable or not. @@ -21089,12 +21100,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. + Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. @@ -21108,6 +21121,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Returns whether the screen is being kept on or not. @@ -21159,6 +21173,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Sets the window title to the specified string. @@ -21179,6 +21194,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Returns the number of cores available in the host machine. @@ -21209,7 +21225,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) - Kill a process ID. + Kill a process ID (this method can be used to kill processes that were not spawned by the game). @@ -21224,6 +21240,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Returns the game process ID @@ -21490,6 +21507,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Returns the frames per second of the running game. -- cgit v1.2.3