From ff7c89ebaf7303380dee8b9120093f20e35aa5cf Mon Sep 17 00:00:00 2001 From: Martin Chuckeles Date: Sun, 6 Mar 2016 10:34:07 +0100 Subject: [PATCH] Add more verbose build-in functions descriptions Add descriptions for some global constants --- doc/base/classes.xml | 171 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 143 insertions(+), 28 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index fe755d520ec..5eff28acabd 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -318,6 +318,7 @@ + Set seed for the random number generator. @@ -426,7 +427,7 @@ - Returns a reference to the specified function + Return a reference to the specified function. @@ -446,7 +447,7 @@ - Returns the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. + Return the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. @@ -521,7 +522,7 @@ - Converts a value to a string that can later be parsed using str2var. + Convert a value to a formatted string that can later be parsed using [method str2var]. @@ -530,7 +531,7 @@ - Converts a string that was returned by var2str to the original value. + Convert a formatted string that was returned by [method var2str] to the original value. @@ -539,7 +540,7 @@ - Encodes a variable to a byte array. + Encode a variable value to a byte array. @@ -548,7 +549,7 @@ - Decodes a byte array back to a variable. + Decode a byte array back to a value. @@ -557,7 +558,7 @@ - Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial,final-1,increment). + Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). @@ -590,10 +591,10 @@ - + - Hashes the variable passed and returns an integer. + Hash the variable passed and return an integer. @@ -608,7 +609,7 @@ - Makes a color from red, green, blue and alpha. Arguments can range from 0 to 255. + Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. @@ -633,18 +634,20 @@ - Preload and get a resource. The resource is loaded during script parsing. + Preload a resource from the filesystem. The resource is loaded during script parsing. - + - Stops function execution and return current state. Call resume on the state to resume execution. + Stop the function execution and return the current state. Call resume on the state to resume execution. This makes the state invalid. + Returns anything that was passed to the resume function call. + If passed an object and a signal, the execution is resumed when the object's signal is emmited. @@ -653,7 +656,7 @@ - If the condition is false, generates an error. + Assert that the condition is true. If the condition is false, generates an error. @@ -772,119 +775,172 @@ Tab Key - Shift-Tab key + Shift-Tab Key + Backspace Key + Return Key + Enter Key + Insert Key + Delete Key + Pause Key + Printscreen Key + Home Key + End Key + Left Arrow Key + Up Arrow Key + Right Arrow Key + Down Arrow Key + Pageup Key + Pagedown Key + Shift Key + Control Key + Alt Key + Capslock Key + Numlock Key + Scrolllock Key + F1 Key + F2 Key + F3 Key + F4 Key + F5 Key + F6 Key + F7 Key + F8 Key + F9 Key + F10 Key + F11 Key + F12 Key + F13 Key + F14 Key + F15 Key + F16 Key + Enter Key on Numpad + Multiply Key on Numpad + Divide Key on Numpad + Subtract Key on Numpad + Period Key on Numpad + Add Key on Numpad + Number 0 on Numpad + Number 1 on Numpad + Number 2 on Numpad + Number 3 on Numpad + Number 4 on Numpad + Number 5 on Numpad + Number 6 on Numpad + Number 7 on Numpad + Number 8 on Numpad + Number 9 on Numpad @@ -985,6 +1041,7 @@ + Space Key @@ -1017,24 +1074,34 @@ + Number 0 + Number 1 + Number 2 + Number 3 + Number 4 + Number 5 + Number 6 + Number 7 + Number 8 + Number 9 @@ -1051,56 +1118,82 @@ + A Key + B Key + C Key + D Key + E Key + F Key + G Key + H Key + I Key + J Key + K Key + L Key + M Key + N Key + O Key + P Key + Q Key + R Key + S Key + T Key + U Key + V Key + W Key + X Key + Y Key + Z Key @@ -1273,10 +1366,13 @@ + Left Mouse Button + Right Mouse Button + Middle Mouse Button @@ -1384,40 +1480,58 @@ + Joystick Button Select + Joystick Button Start + Joystick DPad Up + Joystick DPad Down + Joystick DPad Left + Joystick DPad Right + Joystick Left Shoulder Button + Joystick Left Trigger + Joystick Left Stick Click + Joystick Right Shoulder Button + Joystick Right Trigger + Joystick Right Stick Click + Joystick Left Stick Horizontal Axis + Joystick Left Stick Vertical Axis + Joystick Right Stick Horizontal Axis + Joystick Right Stick Vertical Axis + Joystick Left Trigger Analog Axis + Joystick Right Trigger Analog Axis @@ -1426,12 +1540,16 @@ + Joystick Left Stick Horizontal Axis + Joystick Left Stick Vertical Axis + Joystick Right Stick Horizontal Axis + Joystick Right Stick Vertical Axis @@ -1575,9 +1693,6 @@ Property will be used as storage (default). - - Property will be used as storage (default). - Property will be visible in editor (default). @@ -1639,34 +1754,34 @@ Variable is of type [AABB]. - Variable is fo type [Matrix3]. + Variable is of type [Matrix3]. - Variable is fo type [Transform]. + Variable is of type [Transform]. - Variable is fo type [Color]. + Variable is of type [Color]. - Variable is fo type [Image]. + Variable is of type [Image]. - Variable is fo type [NodePath]. + Variable is of type [NodePath]. - Variable is fo type [RID]. + Variable is of type [RID]. - Variable is fo type [Object]. + Variable is of type [Object]. - Variable is fo type [InputEvent]. + Variable is of type [InputEvent]. - Variable is fo type [Dictionary]. + Variable is of type [Dictionary]. - Variable is fo type [Array]. + Variable is of type [Array].