diff options
Diffstat (limited to 'doc')
30 files changed, 559 insertions, 220 deletions
diff --git a/doc/classes/@Global Scope.xml b/doc/classes/@Global Scope.xml index 0d509e6e51..20f323bb4f 100644 --- a/doc/classes/@Global Scope.xml +++ b/doc/classes/@Global Scope.xml @@ -30,6 +30,7 @@ [Geometry] singleton </member> <member name="GodotSharp" type="GodotSharp" setter="" getter=""> + [GodotSharp] singleton </member> <member name="IP" type="IP" setter="" getter=""> [IP] singleton @@ -41,6 +42,7 @@ [InputMap] singleton </member> <member name="JSON" type="JSON" setter="" getter=""> + [JSON] singleton </member> <member name="Marshalls" type="Reference" setter="" getter=""> [Marshalls] singleton @@ -144,8 +146,10 @@ Printscreen Key </constant> <constant name="KEY_SYSREQ" value="16777227"> + System Request Key </constant> <constant name="KEY_CLEAR" value="16777228"> + Clear Key </constant> <constant name="KEY_HOME" value="16777229"> Home Key @@ -178,6 +182,7 @@ Control Key </constant> <constant name="KEY_META" value="16777239"> + Meta Key </constant> <constant name="KEY_ALT" value="16777240"> Alt Key @@ -285,24 +290,28 @@ Number 9 on Numpad </constant> <constant name="KEY_SUPER_L" value="16777260"> - Super Left key (windows key) + Left Super Key (Windows Key) </constant> <constant name="KEY_SUPER_R" value="16777261"> - Super Left key (windows key) + Right Super Key (Windows Key) </constant> <constant name="KEY_MENU" value="16777262"> Context menu key </constant> <constant name="KEY_HYPER_L" value="16777263"> + Left Hyper Key </constant> <constant name="KEY_HYPER_R" value="16777264"> + Right Hyper Key </constant> <constant name="KEY_HELP" value="16777265"> Help key </constant> <constant name="KEY_DIRECTION_L" value="16777266"> + Left Direction Key </constant> <constant name="KEY_DIRECTION_R" value="16777267"> + Right Direction Key </constant> <constant name="KEY_BACK" value="16777280"> Back key @@ -326,14 +335,19 @@ Volume up key </constant> <constant name="KEY_BASSBOOST" value="16777287"> + Bass Boost Key </constant> <constant name="KEY_BASSUP" value="16777288"> + Bass Up Key </constant> <constant name="KEY_BASSDOWN" value="16777289"> + Bass Down Key </constant> <constant name="KEY_TREBLEUP" value="16777290"> + Treble Up Key </constant> <constant name="KEY_TREBLEDOWN" value="16777291"> + Treble Down Key </constant> <constant name="KEY_MEDIAPLAY" value="16777292"> Media play key @@ -360,46 +374,67 @@ Search key </constant> <constant name="KEY_STANDBY" value="16777300"> + Standby Key </constant> <constant name="KEY_OPENURL" value="16777301"> + Open URL / Launch Browser Key </constant> <constant name="KEY_LAUNCHMAIL" value="16777302"> + Launch Mail Key </constant> <constant name="KEY_LAUNCHMEDIA" value="16777303"> + Launch Media Key </constant> <constant name="KEY_LAUNCH0" value="16777304"> + Launch Shortcut 0 Key </constant> <constant name="KEY_LAUNCH1" value="16777305"> + Launch Shortcut 1 Key </constant> <constant name="KEY_LAUNCH2" value="16777306"> + Launch Shortcut 2 Key </constant> <constant name="KEY_LAUNCH3" value="16777307"> + Launch Shortcut 3 Key </constant> <constant name="KEY_LAUNCH4" value="16777308"> + Launch Shortcut 4 Key </constant> <constant name="KEY_LAUNCH5" value="16777309"> + Launch Shortcut 5 Key </constant> <constant name="KEY_LAUNCH6" value="16777310"> + Launch Shortcut 6 Key </constant> <constant name="KEY_LAUNCH7" value="16777311"> + Launch Shortcut 7 Key </constant> <constant name="KEY_LAUNCH8" value="16777312"> + Launch Shortcut 8 Key </constant> <constant name="KEY_LAUNCH9" value="16777313"> + Launch Shortcut 9 Key </constant> <constant name="KEY_LAUNCHA" value="16777314"> + Launch Shortcut A Key </constant> <constant name="KEY_LAUNCHB" value="16777315"> + Launch Shortcut B Key </constant> <constant name="KEY_LAUNCHC" value="16777316"> + Launch Shortcut C Key </constant> <constant name="KEY_LAUNCHD" value="16777317"> + Launch Shortcut D Key </constant> <constant name="KEY_LAUNCHE" value="16777318"> + Launch Shortcut E Key </constant> <constant name="KEY_LAUNCHF" value="16777319"> + Launch Shortcut F Key </constant> <constant name="KEY_UNKNOWN" value="33554431"> + Unknown Key </constant> <constant name="KEY_SPACE" value="32"> Space Key @@ -594,6 +629,7 @@ _ key </constant> <constant name="KEY_QUOTELEFT" value="96"> + Left Quote Key </constant> <constant name="KEY_BRACELEFT" value="123"> { key @@ -619,6 +655,7 @@ <constant name="KEY_CURRENCY" value="164"> </constant> <constant name="KEY_YEN" value="165"> + Yen Key </constant> <constant name="KEY_BROKENBAR" value="166"> ¦ key @@ -647,6 +684,7 @@ ® key </constant> <constant name="KEY_MACRON" value="175"> + Macron Key </constant> <constant name="KEY_DEGREE" value="176"> ° key @@ -667,6 +705,7 @@ µ key </constant> <constant name="KEY_PARAGRAPH" value="182"> + Paragraph Key </constant> <constant name="KEY_PERIODCENTERED" value="183"> · key @@ -675,377 +714,475 @@ ¬ key </constant> <constant name="KEY_ONESUPERIOR" value="185"> + ¹ key </constant> <constant name="KEY_MASCULINE" value="186"> + ♂ key </constant> <constant name="KEY_GUILLEMOTRIGHT" value="187"> + » key </constant> <constant name="KEY_ONEQUARTER" value="188"> + ¼ key </constant> <constant name="KEY_ONEHALF" value="189"> ½ key </constant> <constant name="KEY_THREEQUARTERS" value="190"> + ¾ key </constant> <constant name="KEY_QUESTIONDOWN" value="191"> + ¿ key </constant> <constant name="KEY_AGRAVE" value="192"> + à key </constant> <constant name="KEY_AACUTE" value="193"> + á key </constant> <constant name="KEY_ACIRCUMFLEX" value="194"> + â key </constant> <constant name="KEY_ATILDE" value="195"> + ã key </constant> <constant name="KEY_ADIAERESIS" value="196"> + ä key </constant> <constant name="KEY_ARING" value="197"> + å key </constant> <constant name="KEY_AE" value="198"> + æ key </constant> <constant name="KEY_CCEDILLA" value="199"> + ç key </constant> <constant name="KEY_EGRAVE" value="200"> + è key </constant> <constant name="KEY_EACUTE" value="201"> + é key </constant> <constant name="KEY_ECIRCUMFLEX" value="202"> + ê key </constant> <constant name="KEY_EDIAERESIS" value="203"> + ë key </constant> <constant name="KEY_IGRAVE" value="204"> + ì key </constant> <constant name="KEY_IACUTE" value="205"> + í key </constant> <constant name="KEY_ICIRCUMFLEX" value="206"> + î key </constant> <constant name="KEY_IDIAERESIS" value="207"> + ë key </constant> <constant name="KEY_ETH" value="208"> + ð key </constant> <constant name="KEY_NTILDE" value="209"> + ñ key </constant> <constant name="KEY_OGRAVE" value="210"> + ò key </constant> <constant name="KEY_OACUTE" value="211"> + ó key </constant> <constant name="KEY_OCIRCUMFLEX" value="212"> + ô key </constant> <constant name="KEY_OTILDE" value="213"> + õ key </constant> <constant name="KEY_ODIAERESIS" value="214"> + ö key </constant> <constant name="KEY_MULTIPLY" value="215"> + × key </constant> <constant name="KEY_OOBLIQUE" value="216"> + ø key </constant> <constant name="KEY_UGRAVE" value="217"> + ù key </constant> <constant name="KEY_UACUTE" value="218"> + ú key </constant> <constant name="KEY_UCIRCUMFLEX" value="219"> + û key </constant> <constant name="KEY_UDIAERESIS" value="220"> + ü key </constant> <constant name="KEY_YACUTE" value="221"> + ý key </constant> <constant name="KEY_THORN" value="222"> + þ key </constant> <constant name="KEY_SSHARP" value="223"> + ß key </constant> <constant name="KEY_DIVISION" value="247"> + ÷ key </constant> <constant name="KEY_YDIAERESIS" value="255"> + ÿ key </constant> <constant name="KEY_CODE_MASK" value="33554431"> + Key Code Mask </constant> <constant name="KEY_MODIFIER_MASK" value="-16777216"> + Modifier Key Mask </constant> <constant name="KEY_MASK_SHIFT" value="33554432"> + Shift Key Mask </constant> <constant name="KEY_MASK_ALT" value="67108864"> + Alt Key Mask </constant> <constant name="KEY_MASK_META" value="134217728"> + Meta Key Mask </constant> <constant name="KEY_MASK_CTRL" value="268435456"> + CTRL Key Mask </constant> <constant name="KEY_MASK_CMD" value="268435456"> + CMD Key Mask </constant> <constant name="KEY_MASK_KPAD" value="536870912"> + Keypad Key Mask </constant> <constant name="KEY_MASK_GROUP_SWITCH" value="1073741824"> + Group Switch Key Mask </constant> - <constant name="BUTTON_LEFT" value="1" enum=""> + <constant name="BUTTON_LEFT" value="1"> Left Mouse Button </constant> - <constant name="BUTTON_RIGHT" value="2" enum=""> + <constant name="BUTTON_RIGHT" value="2"> Right Mouse Button </constant> - <constant name="BUTTON_MIDDLE" value="3" enum=""> + <constant name="BUTTON_MIDDLE" value="3"> Middle Mouse Button </constant> - <constant name="BUTTON_WHEEL_UP" value="4" enum=""> + <constant name="BUTTON_WHEEL_UP" value="4"> Mouse wheel up </constant> - <constant name="BUTTON_WHEEL_DOWN" value="5" enum=""> + <constant name="BUTTON_WHEEL_DOWN" value="5"> Mouse wheel down </constant> - <constant name="BUTTON_WHEEL_LEFT" value="6" enum=""> + <constant name="BUTTON_WHEEL_LEFT" value="6"> Mouse wheel left button </constant> - <constant name="BUTTON_WHEEL_RIGHT" value="7" enum=""> + <constant name="BUTTON_WHEEL_RIGHT" value="7"> Mouse wheel right button </constant> - <constant name="BUTTON_MASK_LEFT" value="1" enum=""> + <constant name="BUTTON_MASK_LEFT" value="1"> + Left Mouse Button Mask </constant> - <constant name="BUTTON_MASK_RIGHT" value="2" enum=""> + <constant name="BUTTON_MASK_RIGHT" value="2"> + Right Mouse Button Mask </constant> - <constant name="BUTTON_MASK_MIDDLE" value="4" enum=""> + <constant name="BUTTON_MASK_MIDDLE" value="4"> + Middle Mouse Button Mask </constant> - <constant name="JOY_BUTTON_0" value="0" enum=""> + <constant name="JOY_BUTTON_0" value="0"> Joypad Button 0 </constant> - <constant name="JOY_BUTTON_1" value="1" enum=""> + <constant name="JOY_BUTTON_1" value="1"> Joypad Button 1 </constant> - <constant name="JOY_BUTTON_2" value="2" enum=""> + <constant name="JOY_BUTTON_2" value="2"> Joypad Button 2 </constant> - <constant name="JOY_BUTTON_3" value="3" enum=""> + <constant name="JOY_BUTTON_3" value="3"> Joypad Button 3 </constant> - <constant name="JOY_BUTTON_4" value="4" enum=""> + <constant name="JOY_BUTTON_4" value="4"> Joypad Button 4 </constant> - <constant name="JOY_BUTTON_5" value="5" enum=""> + <constant name="JOY_BUTTON_5" value="5"> Joypad Button 5 </constant> - <constant name="JOY_BUTTON_6" value="6" enum=""> + <constant name="JOY_BUTTON_6" value="6"> Joypad Button 6 </constant> - <constant name="JOY_BUTTON_7" value="7" enum=""> + <constant name="JOY_BUTTON_7" value="7"> Joypad Button 7 </constant> - <constant name="JOY_BUTTON_8" value="8" enum=""> + <constant name="JOY_BUTTON_8" value="8"> Joypad Button 8 </constant> - <constant name="JOY_BUTTON_9" value="9" enum=""> + <constant name="JOY_BUTTON_9" value="9"> Joypad Button 9 </constant> - <constant name="JOY_BUTTON_10" value="10" enum=""> + <constant name="JOY_BUTTON_10" value="10"> Joypad Button 10 </constant> - <constant name="JOY_BUTTON_11" value="11" enum=""> + <constant name="JOY_BUTTON_11" value="11"> Joypad Button 11 </constant> - <constant name="JOY_BUTTON_12" value="12" enum=""> + <constant name="JOY_BUTTON_12" value="12"> Joypad Button 12 </constant> - <constant name="JOY_BUTTON_13" value="13" enum=""> + <constant name="JOY_BUTTON_13" value="13"> Joypad Button 13 </constant> - <constant name="JOY_BUTTON_14" value="14" enum=""> + <constant name="JOY_BUTTON_14" value="14"> Joypad Button 14 </constant> - <constant name="JOY_BUTTON_15" value="15" enum=""> + <constant name="JOY_BUTTON_15" value="15"> Joypad Button 15 </constant> - <constant name="JOY_BUTTON_MAX" value="16" enum=""> + <constant name="JOY_BUTTON_MAX" value="16"> Joypad Button 16 </constant> - <constant name="JOY_SONY_CIRCLE" value="1" enum=""> + <constant name="JOY_SONY_CIRCLE" value="1"> DUALSHOCK circle button </constant> - <constant name="JOY_SONY_X" value="0" enum=""> + <constant name="JOY_SONY_X" value="0"> DUALSHOCK X button </constant> - <constant name="JOY_SONY_SQUARE" value="2" enum=""> + <constant name="JOY_SONY_SQUARE" value="2"> DUALSHOCK square button </constant> - <constant name="JOY_SONY_TRIANGLE" value="3" enum=""> + <constant name="JOY_SONY_TRIANGLE" value="3"> DUALSHOCK triangle button </constant> - <constant name="JOY_XBOX_B" value="1" enum=""> + <constant name="JOY_XBOX_B" value="1"> XBOX controller B button </constant> - <constant name="JOY_XBOX_A" value="0" enum=""> + <constant name="JOY_XBOX_A" value="0"> XBOX controller A button </constant> - <constant name="JOY_XBOX_X" value="2" enum=""> + <constant name="JOY_XBOX_X" value="2"> XBOX controller X button </constant> - <constant name="JOY_XBOX_Y" value="3" enum=""> + <constant name="JOY_XBOX_Y" value="3"> XBOX controller Y button </constant> - <constant name="JOY_DS_A" value="1" enum=""> + <constant name="JOY_DS_A" value="1"> + DualShock controller A button </constant> - <constant name="JOY_DS_B" value="0" enum=""> + <constant name="JOY_DS_B" value="0"> + DualShock controller B button </constant> - <constant name="JOY_DS_X" value="3" enum=""> + <constant name="JOY_DS_X" value="3"> + DualShock controller X button </constant> - <constant name="JOY_DS_Y" value="2" enum=""> + <constant name="JOY_DS_Y" value="2"> + DualShock controller Y button </constant> - <constant name="JOY_SELECT" value="10" enum=""> + <constant name="JOY_SELECT" value="10"> Joypad Button Select </constant> - <constant name="JOY_START" value="11" enum=""> + <constant name="JOY_START" value="11"> Joypad Button Start </constant> - <constant name="JOY_DPAD_UP" value="12" enum=""> + <constant name="JOY_DPAD_UP" value="12"> Joypad DPad Up </constant> - <constant name="JOY_DPAD_DOWN" value="13" enum=""> + <constant name="JOY_DPAD_DOWN" value="13"> Joypad DPad Down </constant> - <constant name="JOY_DPAD_LEFT" value="14" enum=""> + <constant name="JOY_DPAD_LEFT" value="14"> Joypad DPad Left </constant> - <constant name="JOY_DPAD_RIGHT" value="15" enum=""> + <constant name="JOY_DPAD_RIGHT" value="15"> Joypad DPad Right </constant> - <constant name="JOY_L" value="4" enum=""> + <constant name="JOY_L" value="4"> Joypad Left Shoulder Button </constant> - <constant name="JOY_L2" value="6" enum=""> + <constant name="JOY_L2" value="6"> Joypad Left Trigger </constant> - <constant name="JOY_L3" value="8" enum=""> + <constant name="JOY_L3" value="8"> Joypad Left Stick Click </constant> - <constant name="JOY_R" value="5" enum=""> + <constant name="JOY_R" value="5"> Joypad Right Shoulder Button </constant> - <constant name="JOY_R2" value="7" enum=""> + <constant name="JOY_R2" value="7"> Joypad Right Trigger </constant> - <constant name="JOY_R3" value="9" enum=""> + <constant name="JOY_R3" value="9"> Joypad Right Stick Click </constant> - <constant name="JOY_AXIS_0" value="0" enum=""> + <constant name="JOY_AXIS_0" value="0"> Joypad Left Stick Horizontal Axis </constant> - <constant name="JOY_AXIS_1" value="1" enum=""> + <constant name="JOY_AXIS_1" value="1"> Joypad Left Stick Vertical Axis </constant> - <constant name="JOY_AXIS_2" value="2" enum=""> + <constant name="JOY_AXIS_2" value="2"> Joypad Right Stick Horizontal Axis </constant> - <constant name="JOY_AXIS_3" value="3" enum=""> + <constant name="JOY_AXIS_3" value="3"> Joypad Right Stick Vertical Axis </constant> - <constant name="JOY_AXIS_4" value="4" enum=""> + <constant name="JOY_AXIS_4" value="4"> </constant> - <constant name="JOY_AXIS_5" value="5" enum=""> + <constant name="JOY_AXIS_5" value="5"> </constant> - <constant name="JOY_AXIS_6" value="6" enum=""> + <constant name="JOY_AXIS_6" value="6"> Joypad Left Trigger Analog Axis </constant> - <constant name="JOY_AXIS_7" value="7" enum=""> + <constant name="JOY_AXIS_7" value="7"> Joypad Right Trigger Analog Axis </constant> - <constant name="JOY_AXIS_MAX" value="8" enum=""> + <constant name="JOY_AXIS_MAX" value="8"> </constant> - <constant name="JOY_ANALOG_LX" value="0" enum=""> + <constant name="JOY_ANALOG_LX" value="0"> Joypad Left Stick Horizontal Axis </constant> - <constant name="JOY_ANALOG_LY" value="1" enum=""> + <constant name="JOY_ANALOG_LY" value="1"> Joypad Left Stick Vertical Axis </constant> - <constant name="JOY_ANALOG_RX" value="2" enum=""> + <constant name="JOY_ANALOG_RX" value="2"> Joypad Right Stick Horizontal Axis </constant> - <constant name="JOY_ANALOG_RY" value="3" enum=""> + <constant name="JOY_ANALOG_RY" value="3"> Joypad Right Stick Vertical Axis </constant> - <constant name="JOY_ANALOG_L2" value="6" enum=""> + <constant name="JOY_ANALOG_L2" value="6"> + Joypad Left Analog Trigger </constant> - <constant name="JOY_ANALOG_R2" value="7" enum=""> + <constant name="JOY_ANALOG_R2" value="7"> + Joypad Right Analog Trigger </constant> <constant name="OK" value="0"> - Functions that return Error return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout. + Functions that return Error return OK when no error occured. Most functions don't return errors and/or just print errors to STDOUT. </constant> <constant name="FAILED" value="1"> - Generic fail return error. + Generic error. </constant> <constant name="ERR_UNAVAILABLE" value="2"> + Unavailable error </constant> <constant name="ERR_UNCONFIGURED" value="3"> + Unconfigured error </constant> <constant name="ERR_UNAUTHORIZED" value="4"> + Unauthorized error </constant> <constant name="ERR_PARAMETER_RANGE_ERROR" value="5"> + Parameter range error </constant> <constant name="ERR_OUT_OF_MEMORY" value="6"> + Out of memory (OOM) error </constant> <constant name="ERR_FILE_NOT_FOUND" value="7"> + File: Not found error </constant> <constant name="ERR_FILE_BAD_DRIVE" value="8"> + File: Bad drive error </constant> <constant name="ERR_FILE_BAD_PATH" value="9"> + File: Bad path error </constant> <constant name="ERR_FILE_NO_PERMISSION" value="10"> + File: No permission error </constant> <constant name="ERR_FILE_ALREADY_IN_USE" value="11"> + File: Already in use error </constant> <constant name="ERR_FILE_CANT_OPEN" value="12"> + File: Can't open error </constant> <constant name="ERR_FILE_CANT_WRITE" value="13"> + File: Can't write error </constant> <constant name="ERR_FILE_CANT_READ" value="14"> + File: Can't read error </constant> <constant name="ERR_FILE_UNRECOGNIZED" value="15"> + File: Unrecognized error </constant> <constant name="ERR_FILE_CORRUPT" value="16"> + File: Corrupt error </constant> <constant name="ERR_FILE_MISSING_DEPENDENCIES" value="17"> + File: Missing dependencies error </constant> <constant name="ERR_FILE_EOF" value="18"> + File: End of file (EOF) error </constant> <constant name="ERR_CANT_OPEN" value="19"> + Can't open error </constant> <constant name="ERR_CANT_CREATE" value="20"> + Can't create error </constant> <constant name="ERR_PARSE_ERROR" value="43"> + Parse error </constant> <constant name="ERR_QUERY_FAILED" value="21"> + Query failed error </constant> <constant name="ERR_ALREADY_IN_USE" value="22"> + Already in use error </constant> <constant name="ERR_LOCKED" value="23"> + Locked error </constant> <constant name="ERR_TIMEOUT" value="24"> + Timeout error </constant> <constant name="ERR_CANT_ACQUIRE_RESOURCE" value="28"> + Can't acquire resource error </constant> <constant name="ERR_INVALID_DATA" value="30"> + Invalid data error </constant> <constant name="ERR_INVALID_PARAMETER" value="31"> + Invalid parameter error </constant> <constant name="ERR_ALREADY_EXISTS" value="32"> + Already exists error </constant> <constant name="ERR_DOES_NOT_EXIST" value="33"> + Does not exist error </constant> <constant name="ERR_DATABASE_CANT_READ" value="34"> + Database: Read error </constant> <constant name="ERR_DATABASE_CANT_WRITE" value="35"> + Database: Write error </constant> <constant name="ERR_COMPILATION_FAILED" value="36"> + Compilation failed error </constant> <constant name="ERR_METHOD_NOT_FOUND" value="37"> + Method not found error </constant> <constant name="ERR_LINK_FAILED" value="38"> + Linking failed error </constant> <constant name="ERR_SCRIPT_FAILED" value="39"> + Script failed error </constant> <constant name="ERR_CYCLIC_LINK" value="40"> + Cycling link (import cycle) error </constant> <constant name="ERR_BUSY" value="44"> + Busy error </constant> <constant name="ERR_HELP" value="46"> + Help error </constant> <constant name="ERR_BUG" value="47"> + Bug error </constant> <constant name="ERR_WTF" value="49"> + WTF error (something probably went really wrong) </constant> <constant name="PROPERTY_HINT_NONE" value="0"> No hint for edited property. @@ -1094,8 +1231,10 @@ <constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="19"> </constant> <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="20"> + Hints that the image is compressed using lossy compression. </constant> <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="21"> + Hints that the image is compressed using lossless compression. </constant> <constant name="PROPERTY_USAGE_STORAGE" value="1"> Property will be used as storage (default). @@ -1135,20 +1274,26 @@ <constant name="PROPERTY_USAGE_NOEDITOR" value="5"> </constant> <constant name="METHOD_FLAG_NORMAL" value="1"> + Flag for normal method </constant> <constant name="METHOD_FLAG_EDITOR" value="2"> + Flag for editor method </constant> <constant name="METHOD_FLAG_NOSCRIPT" value="4"> </constant> <constant name="METHOD_FLAG_CONST" value="8"> + Flag for constant method </constant> <constant name="METHOD_FLAG_REVERSE" value="16"> </constant> <constant name="METHOD_FLAG_VIRTUAL" value="32"> + Flag for virtual method </constant> <constant name="METHOD_FLAG_FROM_SCRIPT" value="64"> + Flag for method from script </constant> <constant name="METHOD_FLAGS_DEFAULT" value="1"> + Default method flags </constant> <constant name="TYPE_NIL" value="0"> Variable is of type nil (only applied for null). @@ -1232,6 +1377,7 @@ Variable is of type [PoolColorArray]. </constant> <constant name="TYPE_MAX" value="27"> + Marker for end of type constants. </constant> </constants> </class> diff --git a/doc/classes/ARVRAnchor.xml b/doc/classes/ARVRAnchor.xml index 6e11034073..ecd882cdb0 100644 --- a/doc/classes/ARVRAnchor.xml +++ b/doc/classes/ARVRAnchor.xml @@ -60,6 +60,7 @@ </methods> <members> <member name="anchor_id" type="int" setter="set_anchor_id" getter="get_anchor_id"> + The anchor's id. You can set this before the anchor itself exists. The first anchor gets an id of [code]1[/code], the second an id of [code]2[/code], etc. When anchors get removed, the engine can then assign the corresponding id to new anchors. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merges them. </member> </members> <constants> diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index 557f915c1d..af1deda2f0 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -31,6 +31,7 @@ <return type="int" enum="ARVRPositionalTracker.TrackerHand"> </return> <description> + Returns the hand holding this controller, if known. See TRACKER_* constants in [ARVRPositionalTracker]. </description> </method> <method name="get_is_active" qualifiers="const"> @@ -77,6 +78,7 @@ </methods> <members> <member name="controller_id" type="int" setter="set_controller_id" getter="get_controller_id"> + The controller's id. The first controller that the [ARVRServer] detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off, it's slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. </member> </members> <signals> diff --git a/doc/classes/ARVROrigin.xml b/doc/classes/ARVROrigin.xml index 28864bb3ae..226a69dea4 100644 --- a/doc/classes/ARVROrigin.xml +++ b/doc/classes/ARVROrigin.xml @@ -35,6 +35,8 @@ </methods> <members> <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale"> + Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. + Note that this method is a passthrough to the [ARVRServer] itself. </member> </members> <constants> diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml index 1379677344..686ac1db77 100644 --- a/doc/classes/ARVRPositionalTracker.xml +++ b/doc/classes/ARVRPositionalTracker.xml @@ -17,6 +17,7 @@ <return type="int" enum="ARVRPositionalTracker.TrackerHand"> </return> <description> + Returns the hand holding this tracker, if known. See TRACKER_* constants. </description> </method> <method name="get_joy_id" qualifiers="const"> @@ -80,10 +81,13 @@ </methods> <constants> <constant name="TRACKER_HAND_UNKNOWN" value="0"> + The hand this tracker is held in is unknown or not applicable. </constant> <constant name="TRACKER_LEFT_HAND" value="1"> + This tracker is the left hand controller. </constant> <constant name="TRACKER_RIGHT_HAND" value="2"> + This tracker is the right hand controller. </constant> </constants> </class> diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index 0693851203..bb7ac2c052 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -121,6 +121,7 @@ </methods> <members> <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale"> + Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. </member> </members> <signals> diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 9ce1a93121..82d572b81b 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -75,7 +75,7 @@ <member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB"> </member> <member name="gain" type="float" setter="set_gain" getter="get_gain"> - Gain amount of the frequences after the filter. + Gain amount of the frequencies after the filter. </member> <member name="resonance" type="float" setter="set_resonance" getter="get_resonance"> Amount of boost in the overtones near the cutoff frequency. diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 2ad46579b2..1b6583a834 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="BaseButton" inherits="Control" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Provides a base class for different kinds of buttons. + Base class for different kinds of buttons. </brief_description> <description> - BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesn't display anything). Other types of buttons inherit from it. + BaseButton is the abstract base class for buttons, so it shouldn't be used directly (it doesn't display anything). Other types of buttons inherit from it. </description> <tutorials> </tutorials> @@ -152,18 +152,25 @@ </methods> <members> <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode"> + Determines when the button is considered clicked, one of the ACTION_MODE_* constants. </member> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> + If [code]true[/code] the button is in disabled state and can't be clicked or toggled. </member> <member name="enabled_focus_mode" type="int" setter="set_enabled_focus_mode" getter="get_enabled_focus_mode" enum="Control.FocusMode"> + Focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [member disabled]). </member> <member name="group" type="ButtonGroup" setter="set_button_group" getter="get_button_group"> + [ButtonGroup] associated to the button. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> + If [code]true[/code] the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). </member> <member name="shortcut" type="ShortCut" setter="set_shortcut" getter="get_shortcut"> + [Shortcut] associated to the button. </member> <member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode"> + If [code]true[/code] the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. </member> </members> <signals> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 93140a0df6..352e270e77 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -348,10 +348,13 @@ If [code]true[/code] the camera only moves when reaching the vertical drag margins. If [code]false[/code] the camera moves vertically regardless of margins. Default value: [code]true[/code]. </member> <member name="editor_draw_drag_margin" type="bool" setter="set_margin_drawing_enabled" getter="is_margin_drawing_enabled"> + If [code]true[/code] draws the camera's drag margin rectangle in the editor. Default value: [code]false[/code] </member> <member name="editor_draw_limits" type="bool" setter="set_limit_drawing_enabled" getter="is_limit_drawing_enabled"> + If [code]true[/code] draws the camera's limits rectangle in the editor. Default value: [code]true[/code] </member> <member name="editor_draw_screen" type="bool" setter="set_screen_drawing_enabled" getter="is_screen_drawing_enabled"> + If [code]true[/code] draws the camera's screen rectangle in the editor. Default value: [code]false[/code] </member> <member name="limit_bottom" type="int" setter="set_limit" getter="get_limit"> Bottom scroll limit in pixels. The camera stops moving when reaching this value. @@ -363,6 +366,7 @@ Right scroll limit in pixels. The camera stops moving when reaching this value. </member> <member name="limit_smoothed" type="bool" setter="set_limit_smoothing_enabled" getter="is_limit_smoothing_enabled"> + If [code]true[/code] the camera smoothly stops when reaches its limits. Default value: [code]false[/code] </member> <member name="limit_top" type="int" setter="set_limit" getter="get_limit"> Top scroll limit in pixels. The camera stops moving when reaching this value. @@ -371,13 +375,13 @@ The camera's offset, useful for looking around or camera shake animations. </member> <member name="rotating" type="bool" setter="set_rotating" getter="is_rotating"> - If [code]true[/code] the camera can rotate during gameplay. Default value: [code]false[/code]. + If [code]true[/code] the camera rotates with the target. Default value: [code]false[/code] </member> <member name="smoothing_enabled" type="bool" setter="set_enable_follow_smoothing" getter="is_follow_smoothing_enabled"> - If [code]true[/code] the camera's velocity changes gradually, preventing sudden starts and stops. Default value: [code]false[/code]. + If [code]true[/code] the camera smoothly moves towards the target at [member smoothing_speed]. Default value: [code]false[/code] </member> <member name="smoothing_speed" type="float" setter="set_follow_smoothing" getter="get_follow_smoothing"> - How fast the camera's velocity changes if smoothing is enabled. + Speed in pixels per second of the camera's smoothing effect when [member smoothing_enabled] is [code]true[/code] </member> <member name="zoom" type="Vector2" setter="set_zoom" getter="get_zoom"> The camera's zoom relative to the viewport. Values larger than [code]Vector2(1, 1)[/code] zoom out and smaller values zoom in. For an example, use [code]Vector2(0.5, 0.5)[/code] for a 2x zoom in, and [code]Vector2(4, 4)[/code] for a 4x zoom out. diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index 5626554193..b173bba3c6 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CubeMap" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> <brief_description> + A CubeMap is a 6 sided 3D texture. </brief_description> <description> + A CubeMap is a 6 sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods. </description> <tutorials> </tutorials> @@ -19,6 +21,7 @@ <return type="int"> </return> <description> + Returns the CubeMap's height. </description> </method> <method name="get_lossy_storage_quality" qualifiers="const"> @@ -33,6 +36,7 @@ <argument index="0" name="side" type="int" enum="CubeMap.Side"> </argument> <description> + Returns an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5. </description> </method> <method name="get_storage" qualifiers="const"> @@ -45,6 +49,7 @@ <return type="int"> </return> <description> + Returns the CubeMap's width. </description> </method> <method name="set_flags"> @@ -71,6 +76,7 @@ <argument index="1" name="image" type="Image"> </argument> <description> + Sets an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5. </description> </method> <method name="set_storage"> @@ -84,8 +90,10 @@ </methods> <members> <member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality"> + The lossy storage quality of the CubeMap if the storage mode is set to STORAGE_COMPRESS_LOSSY. </member> <member name="storage_mode" type="int" setter="set_storage" getter="get_storage" enum="CubeMap.Storage"> + The CubeMap's storage mode. See [code]STORAGE_*[/code] constants. </member> </members> <constants> diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 4362887be3..99ec2b7d94 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -32,6 +32,7 @@ <return type="void"> </return> <description> + Removes all points from the curve. </description> </method> <method name="get_bake_interval" qualifiers="const"> @@ -191,8 +192,10 @@ </methods> <members> <member name="_data" type="Dictionary" setter="_set_data" getter="_get_data"> + The points describing the curve. Value is a [Dictionary] with the keys [code]in[/code], [code]out[/code], and [code]pos[/code]. The key pos is the position of a vertex of the curve, the key in is the vector from that position to the control point before this vertex, the key out is the vector from that position to the controlpoint after this vertex. </member> <member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval"> + The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. </member> </members> <constants> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index da8f0f235b..c276a8f661 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -39,8 +39,8 @@ return [{"name": "my_option", "default_value": false}] func load(src, dst, opts, r_platform_variants, r_gen_files): - var f = File.new() - if f.open(src, File.READ) != OK: + var file = File.new() + if file.open(src, File.READ) != OK: return FAILED var mesh = Mesh.new() diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 8856e3362a..245dbc078d 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -11,9 +11,9 @@ extends EditorScript func _run(): - print("Hello from the Godot Editor!") + print("Hello from the Godot Editor!") [/codeblock] - Note that the script is run in the Editor context, which means the output is visible in the console window started with the Editor (STDOUT) instead of the usual Godot *Output* dock. + Note that the script is run in the Editor context, which means the output is visible in the console window started with the Editor (STDOUT) instead of the usual Godot [i]Output[/i] dock. </description> <tutorials> </tutorials> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 2918200633..4d40d5af9a 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -238,6 +238,12 @@ <description> </description> </method> + <method name="get_ssao_blur" qualifiers="const"> + <return type="int" enum="Environment.SSAOBlur"> + </return> + <description> + </description> + </method> <method name="get_ssao_color" qualifiers="const"> <return type="Color"> </return> @@ -250,6 +256,12 @@ <description> </description> </method> + <method name="get_ssao_edge_sharpness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_ssao_intensity" qualifiers="const"> <return type="float"> </return> @@ -262,6 +274,12 @@ <description> </description> </method> + <method name="get_ssao_quality" qualifiers="const"> + <return type="int" enum="Environment.SSAOQuality"> + </return> + <description> + </description> + </method> <method name="get_ssao_radius" qualifiers="const"> <return type="float"> </return> @@ -408,12 +426,6 @@ <description> </description> </method> - <method name="is_ssao_blur_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_ssao_enabled" qualifiers="const"> <return type="bool"> </return> @@ -813,7 +825,7 @@ <method name="set_ssao_blur"> <return type="void"> </return> - <argument index="0" name="enabled" type="bool"> + <argument index="0" name="mode" type="int" enum="Environment.SSAOBlur"> </argument> <description> </description> @@ -834,6 +846,14 @@ <description> </description> </method> + <method name="set_ssao_edge_sharpness"> + <return type="void"> + </return> + <argument index="0" name="edge_sharpness" type="float"> + </argument> + <description> + </description> + </method> <method name="set_ssao_enabled"> <return type="void"> </return> @@ -858,6 +878,14 @@ <description> </description> </method> + <method name="set_ssao_quality"> + <return type="void"> + </return> + <argument index="0" name="quality" type="int" enum="Environment.SSAOQuality"> + </argument> + <description> + </description> + </method> <method name="set_ssao_radius"> <return type="void"> </return> @@ -1172,10 +1200,12 @@ </member> <member name="ssao_bias" type="float" setter="set_ssao_bias" getter="get_ssao_bias"> </member> - <member name="ssao_blur" type="bool" setter="set_ssao_blur" getter="is_ssao_blur_enabled"> + <member name="ssao_blur" type="int" setter="set_ssao_blur" getter="is_ssao_blur_enabled" enum="Environment.SSAOBlur"> </member> <member name="ssao_color" type="Color" setter="set_ssao_color" getter="get_ssao_color"> </member> + <member name="ssao_edge_sharpness" type="float" setter="set_ssao_edge_sharpness" getter="get_ssao_edge_sharpness"> + </member> <member name="ssao_enabled" type="bool" setter="set_ssao_enabled" getter="is_ssao_enabled"> </member> <member name="ssao_intensity" type="float" setter="set_ssao_intensity" getter="get_ssao_intensity"> @@ -1184,6 +1214,8 @@ </member> <member name="ssao_light_affect" type="float" setter="set_ssao_direct_light_affect" getter="get_ssao_direct_light_affect"> </member> + <member name="ssao_quality" type="int" setter="set_ssao_quality" getter="get_ssao_quality" enum="Environment.SSAOQuality"> + </member> <member name="ssao_radius" type="float" setter="set_ssao_radius" getter="get_ssao_radius"> </member> <member name="ssao_radius2" type="float" setter="set_ssao_radius2" getter="get_ssao_radius2"> @@ -1253,5 +1285,19 @@ <constant name="DOF_BLUR_QUALITY_HIGH" value="2"> High depth-of-field blur quality. </constant> + <constant name="SSAO_BLUR_DISABLED" value="0"> + </constant> + <constant name="SSAO_BLUR_1x1" value="1"> + </constant> + <constant name="SSAO_BLUR_2x2" value="2"> + </constant> + <constant name="SSAO_BLUR_3x3" value="3"> + </constant> + <constant name="SSAO_QUALITY_LOW" value="0"> + </constant> + <constant name="SSAO_QUALITY_MEDIUM" value="1"> + </constant> + <constant name="SSAO_QUALITY_HIGH" value="2"> + </constant> </constants> </class> diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 084bee92df..b00020b227 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -26,7 +26,7 @@ <argument index="0" name="pivot" type="Vector2"> </argument> <description> - Set the pivot position of the 2D node to 'pivot' value. Only some Node2Ds implement this method. + Sets the node's pivot position. </description> </method> <method name="get_angle_to" qualifiers="const"> @@ -143,7 +143,7 @@ <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> - Apply a local translation on the node's X axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement. + Applies a local translation on the node's X axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is false, normalizes the movement. </description> </method> <method name="move_local_y"> @@ -154,7 +154,7 @@ <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> - Apply a local translation on the node's Y axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement. + Applies a local translation on the node's Y axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is false, normalizes the movement. </description> </method> <method name="rotate"> @@ -163,7 +163,7 @@ <argument index="0" name="radians" type="float"> </argument> <description> - Apply a rotation to the node, in radians, starting from its current rotation. + Applies a rotation to the node, in radians, starting from its current rotation. </description> </method> <method name="set_global_position"> @@ -172,7 +172,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Set the node's global position. + Sets the node's global position. </description> </method> <method name="set_global_rotation"> @@ -181,7 +181,7 @@ <argument index="0" name="radians" type="float"> </argument> <description> - Set the node's global rotation in radians. + Sets the node's global rotation in radians. </description> </method> <method name="set_global_rotation_in_degrees"> @@ -190,7 +190,7 @@ <argument index="0" name="degrees" type="float"> </argument> <description> - Set the node's global rotation in degrees. + Sets the node's global rotation in degrees. </description> </method> <method name="set_global_scale"> @@ -199,7 +199,7 @@ <argument index="0" name="scale" type="Vector2"> </argument> <description> - Set the node's global scale. + Sets the node's global scale. </description> </method> <method name="set_global_transform"> @@ -208,7 +208,7 @@ <argument index="0" name="xform" type="Transform2D"> </argument> <description> - Set the node's global [Transform2D]. + Sets the node's global [Transform2D]. </description> </method> <method name="set_position"> @@ -217,7 +217,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Set the node's position. + Sets the node's position. </description> </method> <method name="set_rotation"> @@ -226,7 +226,7 @@ <argument index="0" name="radians" type="float"> </argument> <description> - Set the node's rotation in radians. + Sets the node's rotation in radians. </description> </method> <method name="set_rotation_in_degrees"> @@ -235,7 +235,7 @@ <argument index="0" name="degrees" type="float"> </argument> <description> - Set the node's rotation in degrees. + Sets the node's rotation in degrees. </description> </method> <method name="set_scale"> @@ -244,7 +244,7 @@ <argument index="0" name="scale" type="Vector2"> </argument> <description> - Set the node's scale. + Sets the node's scale. </description> </method> <method name="set_transform"> @@ -253,7 +253,7 @@ <argument index="0" name="xform" type="Transform2D"> </argument> <description> - Set the node's local [Transform2D]. + Sets the node's local [Transform2D]. </description> </method> <method name="set_z"> @@ -262,7 +262,7 @@ <argument index="0" name="z" type="int"> </argument> <description> - Set the node's Z-index. + Sets the node's Z-index. </description> </method> <method name="set_z_as_relative"> @@ -271,7 +271,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Make the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. + Makes the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. </description> </method> <method name="to_global" qualifiers="const"> @@ -280,6 +280,7 @@ <argument index="0" name="local_point" type="Vector2"> </argument> <description> + Converts a local point's coordinates to global coordinates. </description> </method> <method name="to_local" qualifiers="const"> @@ -288,6 +289,7 @@ <argument index="0" name="global_point" type="Vector2"> </argument> <description> + Converts a global point's coordinates to local coordinates. </description> </method> <method name="translate"> @@ -296,7 +298,7 @@ <argument index="0" name="offset" type="Vector2"> </argument> <description> - Translate the node locally by the 'offset' vector, starting from its current local position. + Translates the node by the given [code]offset[/code] in local coordinates. </description> </method> </methods> diff --git a/doc/classes/ParallaxBackground.xml b/doc/classes/ParallaxBackground.xml index a7d616129a..21b6150900 100644 --- a/doc/classes/ParallaxBackground.xml +++ b/doc/classes/ParallaxBackground.xml @@ -4,7 +4,7 @@ A node used to create a parallax scrolling background. </brief_description> <description> - A ParallaxBackground will use one or more [ParallaxLayer] nodes to create a parallax scrolling background. Each [ParallaxLayer] can be set to move at different speeds relative to the camera movement, this can be used to create an illusion of depth in a 2D game. + A ParallaxBackground uses one or more [ParallaxLayer] child nodes to create a parallax effect. Each [ParallaxLayer] can move at a different speed using [member ParallaxLayer.motion_offset]. This creates an illusion of depth in a 2D game. If not used with a [Camera2D], you must manually calculate the [member scroll_offset]. </description> <tutorials> </tutorials> @@ -108,16 +108,22 @@ </methods> <members> <member name="scroll_base_offset" type="Vector2" setter="set_scroll_base_offset" getter="get_scroll_base_offset"> + Base position offset of all [ParallaxLayer] children. </member> <member name="scroll_base_scale" type="Vector2" setter="set_scroll_base_scale" getter="get_scroll_base_scale"> + Base motion scale of all [ParallaxLayer] children. </member> <member name="scroll_ignore_camera_zoom" type="bool" setter="set_ignore_camera_zoom" getter="is_ignore_camera_zoom"> + If [code]true[/code] elements in [ParallaxLayer] child aren't affected by the zoom level of the camera. </member> <member name="scroll_limit_begin" type="Vector2" setter="set_limit_begin" getter="get_limit_begin"> + Top left limits for scrolling to begin. If the camera is outside of this limit the background will stop scrolling. Must be lower than [member scroll_limit_end] to work. </member> <member name="scroll_limit_end" type="Vector2" setter="set_limit_end" getter="get_limit_end"> + Right bottom limits for scrolling to end. If the camera is outside of this limit the background will stop scrolling. Must be higher than [member scroll_limit_begin] to work. </member> <member name="scroll_offset" type="Vector2" setter="set_scroll_offset" getter="get_scroll_offset"> + The ParallaxBackground's scroll value. Calculated automatically when using a [Camera2D], but can be used to manually manage scrolling when no camera is present. </member> </members> <constants> diff --git a/doc/classes/ParallaxLayer.xml b/doc/classes/ParallaxLayer.xml index 6cf5549c8f..f1e6f9e046 100644 --- a/doc/classes/ParallaxLayer.xml +++ b/doc/classes/ParallaxLayer.xml @@ -4,7 +4,8 @@ A parallax scrolling layer to be used with [ParallaxBackground]. </brief_description> <description> - A ParallaxLayer must be the child of a [ParallaxBackground] node. All child nodes will be affected by the parallax scrolling of this layer. + A ParallaxLayer must be the child of a [ParallaxBackground] node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the [member ParallaxBackground.scroll_offset] value. + This node's children will be affected by its scroll offset. </description> <tutorials> </tutorials> @@ -60,10 +61,13 @@ </methods> <members> <member name="motion_mirroring" type="Vector2" setter="set_mirroring" getter="get_mirroring"> + The ParallaxLayer's [Texture] mirroring. Useful for creating an infinite scrolling background. If an axis is set to [code]0[/code] the [Texture] will not be mirrored. Default value: [code](0, 0)[/code]. </member> <member name="motion_offset" type="Vector2" setter="set_motion_offset" getter="get_motion_offset"> + The ParallaxLayer's offset relative to the parent ParallaxBackground's [member ParallaxBackground.scroll_offset]. </member> <member name="motion_scale" type="Vector2" setter="set_motion_scale" getter="get_motion_scale"> + Multiplies the ParallaxLayer's motion. If an axis is set to [code]0[/code] it will not scroll. </member> </members> <constants> diff --git a/doc/classes/Path2D.xml b/doc/classes/Path2D.xml index 839e617375..722e0c1240 100644 --- a/doc/classes/Path2D.xml +++ b/doc/classes/Path2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Path2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Container for a [Curve2D]. + Contains a [Curve2D] path for [PathFollow2D] nodes to follow. </brief_description> <description> - This class is a container/Node-ification of a [Curve2D], so it can have [Node2D] properties and [Node] info. + Can have [PathFollow2D] child-nodes moving along the [Curve2D]. See [PathFollow2D] for more information on this usage. </description> <tutorials> </tutorials> @@ -30,6 +30,7 @@ </methods> <members> <member name="curve" type="Curve2D" setter="set_curve" getter="get_curve"> + A [Curve2D] describing the path. </member> </members> <constants> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index f07e143aa0..056d7d10fa 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -4,7 +4,10 @@ Quaternion. </brief_description> <description> - Quaternion is a 4 dimensional vector that is used to represent a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between two rotations. Multiplying quaternions also cheaply reproduces rotation sequences. However quaternions need to be often renormalized, or else they suffer from precision issues. + A 4-dimensional vector representing a rotation. + The vector represents a 4 dimensional complex number where multiplication of the basis elements is not commutative (multiplying i with j gives a different result than multiplying j with i). + Multiplying quaternions reproduces rotation sequences. However quaternions need to be often renormalized, or else they suffer from precision issues. + It can be used to perform SLERP (spherical-linear interpolation) between two rotations. </description> <tutorials> </tutorials> @@ -23,6 +26,7 @@ <argument index="3" name="w" type="float"> </argument> <description> + Returns a quaternion defined by these values. </description> </method> <method name="Quat"> @@ -57,6 +61,7 @@ <argument index="3" name="t" type="float"> </argument> <description> + Performs a cubic spherical-linear interpolation with another quaternion. </description> </method> <method name="dot"> @@ -111,7 +116,7 @@ <argument index="1" name="t" type="float"> </argument> <description> - Perform a spherical-linear interpolation with another quaternion. + Performs a spherical-linear interpolation with another quaternion. </description> </method> <method name="slerpni"> @@ -122,6 +127,7 @@ <argument index="1" name="t" type="float"> </argument> <description> + Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90°. </description> </method> <method name="xform"> @@ -130,17 +136,22 @@ <argument index="0" name="v" type="Vector3"> </argument> <description> + Transforms the vector [code]v[/code] by this quaternion. </description> </method> </methods> <members> <member name="w" type="float" setter="" getter=""> + W component of the quaternion. Default value: [code]1[/code] </member> <member name="x" type="float" setter="" getter=""> + X component of the quaternion. Default value: [code]0[/code] </member> <member name="y" type="float" setter="" getter=""> + Y component of the quaternion. Default value: [code]0[/code] </member> <member name="z" type="float" setter="" getter=""> + Z component of the quaternion. Default value: [code]0[/code] </member> </members> <constants> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index fc96a183eb..3f999f7fe2 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -85,6 +85,14 @@ Returns the collision mask for this ray. </description> </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector3"> </return> @@ -156,6 +164,16 @@ Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. </description> </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_enabled"> <return type="void"> </return> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 8fef07a859..45a83f7ded 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -84,6 +84,14 @@ Returns the collision mask for this ray. </description> </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector2"> </return> @@ -162,6 +170,16 @@ Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. </description> </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_enabled"> <return type="void"> </return> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 13b786908e..5af8c82a7b 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -4,7 +4,7 @@ 2D Axis-aligned bounding box. </brief_description> <description> - Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. </description> <tutorials> </tutorials> @@ -19,7 +19,7 @@ <argument index="1" name="size" type="Vector2"> </argument> <description> - Construct a [code]Rect2[/code] by position and size. + Constructs a [code]Rect2[/code] by position and size. </description> </method> <method name="Rect2"> @@ -34,7 +34,7 @@ <argument index="3" name="height" type="float"> </argument> <description> - Construct a [code]Rect2[/code] by x, y, width and height. + Constructs a [code]Rect2[/code] by x, y, width, and height. </description> </method> <method name="clip"> @@ -52,7 +52,7 @@ <argument index="0" name="b" type="Rect2"> </argument> <description> - Returns true if this [code]Rect2[/code] completely encloses another one. + Returns [code]true[/code] if this [code]Rect2[/code] completely encloses another one. </description> </method> <method name="expand"> @@ -61,14 +61,14 @@ <argument index="0" name="to" type="Vector2"> </argument> <description> - Return this [code]Rect2[/code] expanded to include a given point. + Returns this [code]Rect2[/code] expanded to include a given point. </description> </method> <method name="get_area"> <return type="float"> </return> <description> - Get the area of the [code]Rect2[/code]. + Returns the area of the [code]Rect2[/code]. </description> </method> <method name="grow"> @@ -77,7 +77,7 @@ <argument index="0" name="by" type="float"> </argument> <description> - Return a copy of the [code]Rect2[/code] grown a given amount of units towards all the sides. + Returns a copy of the [code]Rect2[/code] grown a given amount of units towards all the sides. </description> </method> <method name="grow_individual"> @@ -92,6 +92,7 @@ <argument index="3" name=" bottom" type="float"> </argument> <description> + Returns a copy of the [code]Rect2[/code] grown a given amount of units towards each direction individually. </description> </method> <method name="grow_margin"> @@ -102,13 +103,14 @@ <argument index="1" name="by" type="float"> </argument> <description> + Returns a copy of the [code]Rect2[/code] grown a given amount of units towards the [Margin] direction. </description> </method> <method name="has_no_area"> <return type="bool"> </return> <description> - Return true if the [code]Rect2[/code] is flat or empty. + Returns [code]true[/code] if the [code]Rect2[/code] is flat or empty. </description> </method> <method name="has_point"> @@ -117,7 +119,7 @@ <argument index="0" name="point" type="Vector2"> </argument> <description> - Return true if the [code]Rect2[/code] contains a point. + Returns [code]true[/code] if the [code]Rect2[/code] contains a point. </description> </method> <method name="intersects"> @@ -126,7 +128,7 @@ <argument index="0" name="b" type="Rect2"> </argument> <description> - Return true if the [code]Rect2[/code] overlaps with another. + Returns [code]true[/code] if the [code]Rect2[/code] overlaps with another. </description> </method> <method name="merge"> @@ -135,7 +137,7 @@ <argument index="0" name="b" type="Rect2"> </argument> <description> - Combine this [code]Rect2[/code] with another, a larger one is returned that contains both. + Returns a larger Rect2 that contains this Rect2 and [code]with[/code]. </description> </method> </methods> diff --git a/doc/classes/Rect3.xml b/doc/classes/Rect3.xml index 7adf4377aa..a56dac57c7 100644 --- a/doc/classes/Rect3.xml +++ b/doc/classes/Rect3.xml @@ -4,7 +4,7 @@ Axis-Aligned Bounding Box. </brief_description> <description> - Rect3 provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. + Rect3 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. </description> <tutorials> </tutorials> @@ -28,7 +28,7 @@ <argument index="0" name="with" type="Rect3"> </argument> <description> - Return true if this [code]Rect3[/code] completely encloses another one. + Returns [code]true[/code] if this [code]Rect3[/code] completely encloses another one. </description> </method> <method name="expand"> @@ -37,14 +37,14 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Return this [code]Rect3[/code] expanded to include a given point. + Returns this [code]Rect3[/code] expanded to include a given point. </description> </method> <method name="get_area"> <return type="float"> </return> <description> - Get the area of the [code]Rect3[/code]. + Gets the area of the [code]Rect3[/code]. </description> </method> <method name="get_endpoint"> @@ -53,49 +53,49 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the position of the 8 endpoints of the [code]Rect3[/code] in space. + Gets the position of the 8 endpoints of the [code]Rect3[/code] in space. </description> </method> <method name="get_longest_axis"> <return type="Vector3"> </return> <description> - Return the normalized longest axis of the [code]Rect3[/code]. + Returns the normalized longest axis of the [code]Rect3[/code]. </description> </method> <method name="get_longest_axis_index"> <return type="int"> </return> <description> - Return the index of the longest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum). + Returns the index of the longest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum). </description> </method> <method name="get_longest_axis_size"> <return type="float"> </return> <description> - Return the scalar length of the longest axis of the [code]Rect3[/code]. + Returns the scalar length of the longest axis of the [code]Rect3[/code]. </description> </method> <method name="get_shortest_axis"> <return type="Vector3"> </return> <description> - Return the normalized shortest axis of the [code]Rect3[/code]. + Returns the normalized shortest axis of the [code]Rect3[/code]. </description> </method> <method name="get_shortest_axis_index"> <return type="int"> </return> <description> - Return the index of the shortest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum). + Returns the index of the shortest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum). </description> </method> <method name="get_shortest_axis_size"> <return type="float"> </return> <description> - Return the scalar length of the shortest axis of the [code]Rect3[/code]. + Returns the scalar length of the shortest axis of the [code]Rect3[/code]. </description> </method> <method name="get_support"> @@ -104,7 +104,7 @@ <argument index="0" name="dir" type="Vector3"> </argument> <description> - Return the support point in a given direction. This is useful for collision detection algorithms. + Returns the support point in a given direction. This is useful for collision detection algorithms. </description> </method> <method name="grow"> @@ -113,21 +113,21 @@ <argument index="0" name="by" type="float"> </argument> <description> - Return a copy of the [code]Rect3[/code] grown a given amount of units towards all the sides. + Returns a copy of the [code]Rect3[/code] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> <return type="bool"> </return> <description> - Return true if the [code]Rect3[/code] is flat or empty. + Returns [code]true[/code] if the [code]Rect3[/code] is flat or empty. </description> </method> <method name="has_no_surface"> <return type="bool"> </return> <description> - Return true if the [code]Rect3[/code] is empty. + Returns [code]true[/code] if the [code]Rect3[/code] is empty. </description> </method> <method name="has_point"> @@ -136,7 +136,7 @@ <argument index="0" name="point" type="Vector3"> </argument> <description> - Return true if the [code]Rect3[/code] contains a point. + Returns [code]true[/code] if the [code]Rect3[/code] contains a point. </description> </method> <method name="intersection"> @@ -145,7 +145,7 @@ <argument index="0" name="with" type="Rect3"> </argument> <description> - Return the intersection between two [code]Rect3[/code]. An empty Rect3 (size 0,0,0) is returned on failure. + Returns the intersection between two [code]Rect3[/code]. An empty Rect3 (size 0,0,0) is returned on failure. </description> </method> <method name="intersects"> @@ -154,7 +154,7 @@ <argument index="0" name="with" type="Rect3"> </argument> <description> - Return true if the [code]Rect3[/code] overlaps with another. + Returns [code]true[/code] if the [code]Rect3[/code] overlaps with another. </description> </method> <method name="intersects_plane"> @@ -163,7 +163,7 @@ <argument index="0" name="plane" type="Plane"> </argument> <description> - Return true if the [code]Rect3[/code] is at both sides of a plane. + Returns [code]true[/code] if the [code]Rect3[/code] is on both sides of a plane. </description> </method> <method name="intersects_segment"> @@ -174,7 +174,7 @@ <argument index="1" name="to" type="Vector3"> </argument> <description> - Return true if the [code]Rect3[/code] intersects the line segment between from and to + Returns [code]true[/code] if the [code]Rect3[/code] intersects the line segment between [code]from[/code] and [code]to[/code]. </description> </method> <method name="merge"> @@ -183,7 +183,7 @@ <argument index="0" name="with" type="Rect3"> </argument> <description> - Combine this [code]Rect3[/code] with another, a larger one is returned that contains both. + Returns a larger Rect3 that contains this Rect3 and [code]with[/code]. </description> </method> </methods> @@ -192,6 +192,7 @@ Ending corner. </member> <member name="position" type="Vector3" setter="" getter=""> + Beginning corner. </member> <member name="size" type="Vector3" setter="" getter=""> Size from position to end. diff --git a/doc/classes/RemoteTransform.xml b/doc/classes/RemoteTransform.xml index ecc136055e..67679bc9df 100644 --- a/doc/classes/RemoteTransform.xml +++ b/doc/classes/RemoteTransform.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="RemoteTransform" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> <brief_description> + RemoteTransform mirrors the [Transform] of another [Spatial] derived Node in the scene. </brief_description> <description> + RemoteTransform mirrors the [Transform] of another [Spatial] derived Node (called the remote node) in the scene. + It can be set to track another Node's position, rotation and/or scale and update its own accordingly, using either global or local coordinates. </description> <tutorials> </tutorials> @@ -82,14 +85,19 @@ </methods> <members> <member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node"> + The remote node's [NodePath]. </member> <member name="update_position" type="bool" setter="set_update_position" getter="get_update_position"> + If [code]true[/code] the remote node's position is mirrored. </member> <member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation"> + If [code]true[/code] the remote node's rotation is mirrored. </member> <member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale"> + If [code]true[/code] the remote node's scale is mirrored. </member> <member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates"> + If [code]true[/code] global coordinates are used. If [code]false[/code] local coordinates are used. Default value: [code]true[/code]. </member> </members> <constants> diff --git a/doc/classes/RemoteTransform2D.xml b/doc/classes/RemoteTransform2D.xml index 346b8de621..eac7427f9f 100644 --- a/doc/classes/RemoteTransform2D.xml +++ b/doc/classes/RemoteTransform2D.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> <brief_description> + RemoteTransform2D mirrors the [Transform2D] of another [CanvasItem] derived Node in the scene. </brief_description> <description> + RemoteTransform2D mirrors the [Transform2D] of another [CanvasItem] derived Node (called the remote node) in the scene. + It can be set to track another Node's position, rotation and/or and update its own accordingly, using either global or local coordinates. </description> <tutorials> </tutorials> @@ -82,14 +85,19 @@ </methods> <members> <member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node"> + The remote node's [NodePath]. </member> <member name="update_position" type="bool" setter="set_update_position" getter="get_update_position"> + If [code]true[/code] the remote node's position is mirrored. </member> <member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation"> + If [code]true[/code] the remote node's rotation is mirrored. </member> <member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale"> + If [code]true[/code] the remote node's scale is mirrored. </member> <member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates"> + If [code]true[/code] global coordinates are used. If [code]false[/code] local coordinates are used. Default value: [code]true[/code]. </member> </members> <constants> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 307afba8a7..c13e009976 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -19,12 +19,6 @@ Returns true if the script can be instanced. </description> </method> - <method name="get_node_type" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> <method name="get_source_code" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index da89c37ff4..db47875050 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -1085,7 +1085,7 @@ </constant> <constant name="DIFFUSE_TOON" value="4"> </constant> - <constant name="SPECULAR_GGX" value="0"> + <constant name="SPECULAR_SCHLICK_GGX" value="0"> </constant> <constant name="SPECULAR_BLINN" value="1"> </constant> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index c7c19997b9..546712f223 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -17,6 +17,7 @@ <argument index="0" name="from" type="bool"> </argument> <description> + Constructs a new String from the given [bool]. </description> </method> <method name="String"> @@ -25,6 +26,7 @@ <argument index="0" name="from" type="int"> </argument> <description> + Constructs a new String from the given [int]. </description> </method> <method name="String"> @@ -33,6 +35,7 @@ <argument index="0" name="from" type="float"> </argument> <description> + Constructs a new String from the given [float]. </description> </method> <method name="String"> @@ -41,6 +44,7 @@ <argument index="0" name="from" type="Vector2"> </argument> <description> + Constructs a new String from the given [Vector2]. </description> </method> <method name="String"> @@ -49,6 +53,7 @@ <argument index="0" name="from" type="Rect2"> </argument> <description> + Constructs a new String from the given [Rect2]. </description> </method> <method name="String"> @@ -57,6 +62,7 @@ <argument index="0" name="from" type="Vector3"> </argument> <description> + Constructs a new String from the given [Vector3]. </description> </method> <method name="String"> @@ -65,6 +71,7 @@ <argument index="0" name="from" type="Transform2D"> </argument> <description> + Constructs a new String from the given [Transform2D]. </description> </method> <method name="String"> @@ -73,6 +80,7 @@ <argument index="0" name="from" type="Plane"> </argument> <description> + Constructs a new String from the given [Plane]. </description> </method> <method name="String"> @@ -81,6 +89,7 @@ <argument index="0" name="from" type="Quat"> </argument> <description> + Constructs a new String from the given [Quat]. </description> </method> <method name="String"> @@ -89,6 +98,7 @@ <argument index="0" name="from" type="Rect3"> </argument> <description> + Constructs a new String from the given [Rect3]. </description> </method> <method name="String"> @@ -97,6 +107,7 @@ <argument index="0" name="from" type="Basis"> </argument> <description> + Constructs a new String from the given [Basis]. </description> </method> <method name="String"> @@ -105,6 +116,7 @@ <argument index="0" name="from" type="Transform"> </argument> <description> + Constructs a new String from the given [Transform]. </description> </method> <method name="String"> @@ -113,6 +125,7 @@ <argument index="0" name="from" type="Color"> </argument> <description> + Constructs a new String from the given [Color]. </description> </method> <method name="String"> @@ -121,6 +134,7 @@ <argument index="0" name="from" type="NodePath"> </argument> <description> + Constructs a new String from the given [NodePath]. </description> </method> <method name="String"> @@ -129,6 +143,7 @@ <argument index="0" name="from" type="RID"> </argument> <description> + Constructs a new String from the given [RID]. </description> </method> <method name="String"> @@ -137,6 +152,7 @@ <argument index="0" name="from" type="Dictionary"> </argument> <description> + Constructs a new String from the given [Dictionary]. </description> </method> <method name="String"> @@ -145,6 +161,7 @@ <argument index="0" name="from" type="Array"> </argument> <description> + Constructs a new String from the given [Array]. </description> </method> <method name="String"> @@ -153,6 +170,7 @@ <argument index="0" name="from" type="PoolByteArray"> </argument> <description> + Constructs a new String from the given [PoolByteArray]. </description> </method> <method name="String"> @@ -161,6 +179,7 @@ <argument index="0" name="from" type="PoolIntArray"> </argument> <description> + Constructs a new String from the given [PoolIntArray]. </description> </method> <method name="String"> @@ -169,6 +188,7 @@ <argument index="0" name="from" type="PoolRealArray"> </argument> <description> + Constructs a new String from the given [PoolRealArray]. </description> </method> <method name="String"> @@ -177,6 +197,7 @@ <argument index="0" name="from" type="PoolStringArray"> </argument> <description> + Constructs a new String from the given [PoolStringArray]. </description> </method> <method name="String"> @@ -185,6 +206,7 @@ <argument index="0" name="from" type="PoolVector2Array"> </argument> <description> + Constructs a new String from the given [PoolVector2Array]. </description> </method> <method name="String"> @@ -193,6 +215,7 @@ <argument index="0" name="from" type="PoolVector3Array"> </argument> <description> + Constructs a new String from the given [PoolVector3Array]. </description> </method> <method name="String"> @@ -201,6 +224,7 @@ <argument index="0" name="from" type="PoolColorArray"> </argument> <description> + Constructs a new String from the given [PoolColorArray]. </description> </method> <method name="begins_with"> @@ -209,35 +233,35 @@ <argument index="0" name="text" type="String"> </argument> <description> - Return true if the strings begins with the given string. + Returns [code]true[/code] if the string begins with the given string. </description> </method> <method name="bigrams"> <return type="PoolStringArray"> </return> <description> - Return the bigrams (pairs of consecutive letters) of this string. + Returns the bigrams (pairs of consecutive letters) of this string. </description> </method> <method name="c_escape"> <return type="String"> </return> <description> - Return a copy of the string with special characters escaped using the C language standard. + Returns a copy of the string with special characters escaped using the C language standard. </description> </method> <method name="c_unescape"> <return type="String"> </return> <description> - Return a copy of the string with escaped characters replaced by their meanings according to the C language standard. + Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard. </description> </method> <method name="capitalize"> <return type="String"> </return> <description> - Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize first and every letter following the space character. For [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code]. + Changes the case of some letters. Replaces underscores with spaces, converts all letters to lowercase, then capitalizes first and every letter following the space character. For [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code]. </description> </method> <method name="casecmp_to"> @@ -246,14 +270,14 @@ <argument index="0" name="to" type="String"> </argument> <description> - Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. + Performs a case-sensitive comparison to another string. Returns [code]-1[/code] if less than, [code]+1[/code] if greater than, or [code]0[/code] if equal. </description> </method> <method name="empty"> <return type="bool"> </return> <description> - Return true if the string is empty. + Returns [code]true[/code] if the string is empty. </description> </method> <method name="ends_with"> @@ -262,7 +286,7 @@ <argument index="0" name="text" type="String"> </argument> <description> - Return true if the strings ends with the given string. + Returns [code]true[/code] if the string ends with the given string. </description> </method> <method name="erase"> @@ -271,7 +295,7 @@ <argument index="1" name="chars" type="int"> </argument> <description> - Erase [code]chars[/code] characters from the string starting from [code]position[/code]. + Erases [code]chars[/code] characters from the string starting from [code]position[/code]. </description> </method> <method name="find"> @@ -282,7 +306,7 @@ <argument index="1" name="from" type="int" default="0"> </argument> <description> - Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Finds the first occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="find_last"> @@ -291,7 +315,7 @@ <argument index="0" name="what" type="String"> </argument> <description> - Find the last occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="findn"> @@ -302,7 +326,7 @@ <argument index="1" name="from" type="int" default="0"> </argument> <description> - Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="format"> @@ -313,48 +337,49 @@ <argument index="1" name="placeholder" type="String" default="{_}"> </argument> <description> + Formats the string by replacing all occurences of [code]placeholder[/code] with [code]values[/code]. </description> </method> <method name="get_base_dir"> <return type="String"> </return> <description> - If the string is a path to a file, return the base directory. + If the string is a valid file path, returns the base directory name. </description> </method> <method name="get_basename"> <return type="String"> </return> <description> - If the string is a path to a file, return the path to the file without the extension. + If the string is a valid file path, returns the full file path without the extension. </description> </method> <method name="get_extension"> <return type="String"> </return> <description> - If the string is a path to a file, return the extension. + If the string is a valid file path, returns the extension. </description> </method> <method name="get_file"> <return type="String"> </return> <description> - If the string is a path to a file, return the file and ignore the base directory. + If the string is a valid file path, returns the filename. </description> </method> <method name="hash"> <return type="int"> </return> <description> - Hash the string and return a 32 bits integer. + Hashes the string and returns a 32-bit integer. </description> </method> <method name="hex_to_int"> <return type="int"> </return> <description> - Convert a string containing a hexadecimal number into an int. + Converts a string containing a hexadecimal number into an integer. </description> </method> <method name="insert"> @@ -365,21 +390,21 @@ <argument index="1" name="what" type="String"> </argument> <description> - Insert a substring at a given position. + Inserts a substring at a given position. </description> </method> <method name="is_abs_path"> <return type="bool"> </return> <description> - If the string is a path to a file or directory, return true if the path is absolute. + If the string is a path to a file or directory, returns [code]true[/code] if the path is absolute. </description> </method> <method name="is_rel_path"> <return type="bool"> </return> <description> - If the string is a path to a file or directory, return true if the path is relative. + If the string is a path to a file or directory, returns [code]true[/code] if the path is relative. </description> </method> <method name="is_subsequence_of"> @@ -388,7 +413,7 @@ <argument index="0" name="text" type="String"> </argument> <description> - Check whether this string is a subsequence of the given string. + Returns [code]true[/code] if this string is a subsequence of the given string. </description> </method> <method name="is_subsequence_ofi"> @@ -397,49 +422,49 @@ <argument index="0" name="text" type="String"> </argument> <description> - Check whether this string is a subsequence of the given string, without considering case. + Returns [code]true[/code] if this string is a subsequence of the given string, without considering case. </description> </method> <method name="is_valid_float"> <return type="bool"> </return> <description> - Check whether the string contains a valid float. + Returns [code]true[/code] if this string contains a valid float. </description> </method> <method name="is_valid_html_color"> <return type="bool"> </return> <description> - Check whether the string contains a valid color in HTML notation. + Returns [code]true[/code] if this string contains a valid color in HTML notation. </description> </method> <method name="is_valid_identifier"> <return type="bool"> </return> <description> - Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit. + Returns [code]true[/code] if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit. </description> </method> <method name="is_valid_integer"> <return type="bool"> </return> <description> - Check whether the string contains a valid integer. + Returns [code]true[/code] if this string contains a valid integer. </description> </method> <method name="is_valid_ip_address"> <return type="bool"> </return> <description> - Check whether the string contains a valid IP address. + Returns [code]true[/code] if this string contains a valid IP address. </description> </method> <method name="json_escape"> <return type="String"> </return> <description> - Return a copy of the string with special characters escaped using the JSON standard. + Returns a copy of the string with special characters escaped using the JSON standard. </description> </method> <method name="left"> @@ -448,14 +473,14 @@ <argument index="0" name="position" type="int"> </argument> <description> - Return an amount of characters from the left of the string. + Returns a number of characters from the left of the string. </description> </method> <method name="length"> <return type="int"> </return> <description> - Return the length of the string in characters. + Returns the string's amount of characters. </description> </method> <method name="match"> @@ -464,7 +489,7 @@ <argument index="0" name="expr" type="String"> </argument> <description> - Do a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'. + Does a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'. </description> </method> <method name="matchn"> @@ -473,21 +498,21 @@ <argument index="0" name="expr" type="String"> </argument> <description> - Do a simple case insensitive expression match, using ? and * wildcards (see [method match]). + Does a simple case insensitive expression match, using ? and * wildcards (see [method match]). </description> </method> <method name="md5_buffer"> <return type="PoolByteArray"> </return> <description> - Return the MD5 hash of the string as an array of bytes. + Returns the MD5 hash of the string as an array of bytes. </description> </method> <method name="md5_text"> <return type="String"> </return> <description> - Return the MD5 hash of the string as a string. + Returns the MD5 hash of the string as a string. </description> </method> <method name="nocasecmp_to"> @@ -496,7 +521,7 @@ <argument index="0" name="to" type="String"> </argument> <description> - Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. + Performs a case-insensitive comparison to another string. Returns [code]-1[/code] if less than, [code]+1[/code] if greater than, or [code]0[/code] if equal. </description> </method> <method name="ord_at"> @@ -505,7 +530,7 @@ <argument index="0" name="at" type="int"> </argument> <description> - Return the character code at position [code]at[/code]. + Returns the character code at position [code]at[/code]. </description> </method> <method name="pad_decimals"> @@ -514,7 +539,7 @@ <argument index="0" name="digits" type="int"> </argument> <description> - Format a number to have an exact number of [code]digits[/code] after the decimal point. + Formats a number to have an exact number of [code]digits[/code] after the decimal point. </description> </method> <method name="pad_zeros"> @@ -523,7 +548,7 @@ <argument index="0" name="digits" type="int"> </argument> <description> - Format a number to have an exact number of [code]digits[/code] before the decimal point. + Formats a number to have an exact number of [code]digits[/code] before the decimal point. </description> </method> <method name="percent_decode"> @@ -537,7 +562,7 @@ <return type="String"> </return> <description> - Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request. + Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests). </description> </method> <method name="plus_file"> @@ -557,7 +582,7 @@ <argument index="1" name="forwhat" type="String"> </argument> <description> - Replace occurrences of a substring for different ones inside the string. + Replaces occurrences of a substring with the given one inside the string. </description> </method> <method name="replacen"> @@ -568,7 +593,7 @@ <argument index="1" name="forwhat" type="String"> </argument> <description> - Replace occurrences of a substring for different ones inside the string, but search case-insensitive. + Replaces occurrences of a substring with the given one inside the string. Ignores case. </description> </method> <method name="rfind"> @@ -579,7 +604,7 @@ <argument index="1" name="from" type="int" default="-1"> </argument> <description> - Perform a search for a substring, but start from the end of the string instead of the beginning. + Performs a search for a substring, but starts from the end of the string instead of the beginning. </description> </method> <method name="rfindn"> @@ -590,7 +615,7 @@ <argument index="1" name="from" type="int" default="-1"> </argument> <description> - Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive. + Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case. </description> </method> <method name="right"> @@ -599,7 +624,7 @@ <argument index="0" name="position" type="int"> </argument> <description> - Return the right side of the string from a given position. + Returns the right side of the string from a given position. </description> </method> <method name="sha256_buffer"> @@ -612,7 +637,7 @@ <return type="String"> </return> <description> - Return the SHA-256 hash of the string as a string. + Returns the SHA-256 hash of the string as a string. </description> </method> <method name="similarity"> @@ -621,7 +646,7 @@ <argument index="0" name="text" type="String"> </argument> <description> - Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. + Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. </description> </method> <method name="split"> @@ -632,7 +657,7 @@ <argument index="1" name="allow_empty" type="bool" default="True"> </argument> <description> - Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". + Splits the string by a divisor string and returns an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". </description> </method> <method name="split_floats"> @@ -643,7 +668,7 @@ <argument index="1" name="allow_empty" type="bool" default="True"> </argument> <description> - Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". + Splits the string in floats by using a divisor string and returns an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". </description> </method> <method name="strip_edges"> @@ -654,7 +679,7 @@ <argument index="1" name="right" type="bool" default="True"> </argument> <description> - Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. + Returns a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. </description> </method> <method name="substr"> @@ -665,63 +690,63 @@ <argument index="1" name="len" type="int"> </argument> <description> - Return part of the string from the position [code]from[/code], with length [code]len[/code]. + Returns part of the string from the position [code]from[/code] with length [code]len[/code]. </description> </method> <method name="to_ascii"> <return type="PoolByteArray"> </return> <description> - Convert the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. + Converts the String (which is a character array) to [PoolByteArray] (which is an array of bytes). The conversion is sped up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. </description> </method> <method name="to_float"> <return type="float"> </return> <description> - Convert a string, containing a decimal number, into a [code]float[/code]. + Converts a string containing a decimal number into a [code]float[/code]. </description> </method> <method name="to_int"> <return type="int"> </return> <description> - Convert a string, containing an integer number, into an [code]int[/code]. + Converts a string containing an integer number into an [code]int[/code]. </description> </method> <method name="to_lower"> <return type="String"> </return> <description> - Return the string converted to lowercase. + Returns the string converted to lowercase. </description> </method> <method name="to_upper"> <return type="String"> </return> <description> - Return the string converted to uppercase. + Returns the string converted to uppercase. </description> </method> <method name="to_utf8"> <return type="PoolByteArray"> </return> <description> - Convert the String (which is an array of characters) to PoolByteArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). + Converts the String (which is an array of characters) to [PoolByteArray] (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). </description> </method> <method name="xml_escape"> <return type="String"> </return> <description> - Return a copy of the string with special characters escaped using the XML standard. + Returns a copy of the string with special characters escaped using the XML standard. </description> </method> <method name="xml_unescape"> <return type="String"> </return> <description> - Return a copy of the string with escaped characters replaced by their meanings according to the XML standard. + Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. </description> </method> </methods> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 9a500af347..43e5158515 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -239,6 +239,12 @@ Returns true if highlight all occurrences is enabled. </description> </method> + <method name="is_highlight_current_line_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_overriding_selected_font_color" qualifiers="const"> <return type="bool"> </return> @@ -340,6 +346,14 @@ Set to enable highlighting all occurrences of the current selection. </description> </method> + <method name="set_highlight_current_line"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_max_chars"> <return type="void"> </return> @@ -435,6 +449,8 @@ </member> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled"> </member> + <member name="highlight_current_line" type="bool" setter="set_highlight_current_line" getter="is_highlight_current_line_enabled"> + </member> <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color"> </member> <member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled"> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index fdbdabafd3..a05bc5db9a 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -37,6 +37,7 @@ <argument index="0" name="to" type="Vector3"> </argument> <description> + Returns the vector's minimum angle to the vector [code]to[/code]. </description> </method> <method name="bounce"> @@ -61,7 +62,7 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the cross product with b. + Returns the cross product with [code]b[/code]. </description> </method> <method name="cubic_interpolate"> @@ -76,7 +77,7 @@ <argument index="3" name="t" type="float"> </argument> <description> - Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t). + Performs a cubic interpolation between vectors [code]pre_a[/code], [code]a[/code], [code]b[/code], [code]post_b[/code] ([code]a[/code] is current), by the given amount (t). </description> </method> <method name="distance_squared_to"> @@ -85,7 +86,7 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. + Returns the squared distance to [code]b[/code]. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. </description> </method> <method name="distance_to"> @@ -94,7 +95,7 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the distance to b. + Returns the distance to b. </description> </method> <method name="dot"> @@ -103,7 +104,7 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the dot product with b. + Returns the dot product with b. </description> </method> <method name="floor"> @@ -131,14 +132,14 @@ <return type="float"> </return> <description> - Return the length of the vector. + Returns the length of the vector. </description> </method> <method name="length_squared"> <return type="float"> </return> <description> - Return the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. + Returns the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. </description> </method> <method name="linear_interpolate"> @@ -170,7 +171,7 @@ <return type="Vector3"> </return> <description> - Return a copy of the normalized vector to unit length. This is the same as v / v.length(). + Returns a copy of the normalized vector to unit length. This is the same as v / v.length(). </description> </method> <method name="outer"> @@ -179,7 +180,7 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the outer product with b. + Returns the outer product with b. </description> </method> <method name="reflect"> @@ -217,14 +218,14 @@ <argument index="0" name="by" type="float"> </argument> <description> - Return a copy of the vector, snapped to the lowest neared multiple. + Returns a copy of the vector, snapped to the lowest neared multiple. </description> </method> <method name="to_diagonal_matrix"> <return type="Basis"> </return> <description> - Return a diagonal matrix with the vector as main diagonal. + Returns a diagonal matrix with the vector as main diagonal. </description> </method> </methods> |