diff options
Diffstat (limited to 'doc')
125 files changed, 2934 insertions, 509 deletions
diff --git a/doc/classes/@Global Scope.xml b/doc/classes/@Global Scope.xml index d8c9a57a88..9d0133faf4 100644 --- a/doc/classes/@Global Scope.xml +++ b/doc/classes/@Global Scope.xml @@ -29,6 +29,9 @@ <member name="Geometry" type="Geometry" setter="" getter=""> [Geometry] singleton </member> + <member name="GodotSharp" type="GodotSharp" setter="" getter=""> + [GodotSharp] singleton + </member> <member name="IP" type="IP" setter="" getter=""> [IP] singleton </member> @@ -39,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 @@ -142,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 @@ -176,6 +182,7 @@ Control Key </constant> <constant name="KEY_META" value="16777239"> + Meta Key </constant> <constant name="KEY_ALT" value="16777240"> Alt Key @@ -283,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 @@ -324,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 @@ -358,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 @@ -592,6 +629,7 @@ _ key </constant> <constant name="KEY_QUOTELEFT" value="96"> + Left Quote Key </constant> <constant name="KEY_BRACELEFT" value="123"> { key @@ -617,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 @@ -645,6 +684,7 @@ ® key </constant> <constant name="KEY_MACRON" value="175"> + Macron Key </constant> <constant name="KEY_DEGREE" value="176"> ° key @@ -665,6 +705,7 @@ µ key </constant> <constant name="KEY_PARAGRAPH" value="182"> + Paragraph Key </constant> <constant name="KEY_PERIODCENTERED" value="183"> · key @@ -673,105 +714,154 @@ ¬ 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=""> Left Mouse Button @@ -795,10 +885,13 @@ Mouse wheel right button </constant> <constant name="BUTTON_MASK_LEFT" value="1" enum=""> + Left Mouse Button Mask </constant> <constant name="BUTTON_MASK_RIGHT" value="2" enum=""> + Right Mouse Button Mask </constant> <constant name="BUTTON_MASK_MIDDLE" value="4" enum=""> + Middle Mouse Button Mask </constant> <constant name="JOY_BUTTON_0" value="0" enum=""> Joypad Button 0 @@ -876,12 +969,16 @@ XBOX controller Y button </constant> <constant name="JOY_DS_A" value="1" enum=""> + DualShock controller A button </constant> <constant name="JOY_DS_B" value="0" enum=""> + DualShock controller B button </constant> <constant name="JOY_DS_X" value="3" enum=""> + DualShock controller X button </constant> <constant name="JOY_DS_Y" value="2" enum=""> + DualShock controller Y button </constant> <constant name="JOY_SELECT" value="10" enum=""> Joypad Button Select @@ -956,94 +1053,136 @@ Joypad Right Stick Vertical Axis </constant> <constant name="JOY_ANALOG_L2" value="6" enum=""> + Joypad Left Analog Trigger </constant> <constant name="JOY_ANALOG_R2" value="7" enum=""> + 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. @@ -1092,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). @@ -1133,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). @@ -1231,5 +1378,6 @@ </constant> <constant name="TYPE_MAX" value="27"> </constant> + Marker for end of type constants. </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 5e1055d568..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> @@ -171,12 +172,12 @@ <constant name="TRACKER_ANCHOR" value="4"> Our tracker tracks the location and size of an AR anchor. </constant> - <constant name="TRACKER_UNKNOWN" value="128"> - Used internally if we haven't set the tracker type yet. - </constant> <constant name="TRACKER_ANY_KNOWN" value="127"> Used internally to filter trackers of any known type. </constant> + <constant name="TRACKER_UNKNOWN" value="128"> + Used internally if we haven't set the tracker type yet. + </constant> <constant name="TRACKER_ANY" value="255"> Used internally to select all trackers. </constant> diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index 8797575038..febced0a8e 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -88,14 +88,14 @@ <return type="Array"> </return> <description> - Returns a list of intersecting [Area]\ s. + Returns a list of intersecting [code]Area[/code]s. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Returns a list of intersecting [PhysicsBody]\ s. + Returns a list of intersecting [PhysicsBody]s. </description> </method> <method name="get_priority" qualifiers="const"> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 0cbc079962..6bc6e36dfc 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -88,14 +88,14 @@ <return type="Array"> </return> <description> - Returns a list of intersecting [Area2D]\ s. + Returns a list of intersecting [code]Area2D[/code]s. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Returns a list of intersecting [PhysicsBody2D]\ s. + Returns a list of intersecting [PhysicsBody2D]s. </description> </method> <method name="get_priority" qualifiers="const"> diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 36f8494c44..c9996c1a0f 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -75,7 +75,7 @@ <return type="int"> </return> <description> - Return the amount of surfaces that the [ArrayMesh] holds. + Return the amount of surfaces that the [code]ArrayMesh[/code] holds. </description> </method> <method name="regen_normalmaps"> diff --git a/doc/classes/AudioEffectBandLimitFilter.xml b/doc/classes/AudioEffectBandLimitFilter.xml index 96f95fbffd..d4b251fc8e 100644 --- a/doc/classes/AudioEffectBandLimitFilter.xml +++ b/doc/classes/AudioEffectBandLimitFilter.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Adds a band limit filter to the Audio Bus. </brief_description> <description> + Limits the frequencies in a range around the [member cutoff_hz] and allows frequencies outside of this range to pass. </description> <tutorials> </tutorials> diff --git a/doc/classes/AudioEffectBandPassFilter.xml b/doc/classes/AudioEffectBandPassFilter.xml index 4437961cc6..b5c6ae3c20 100644 --- a/doc/classes/AudioEffectBandPassFilter.xml +++ b/doc/classes/AudioEffectBandPassFilter.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Adds a band pass filter to the Audio Bus. </brief_description> <description> + Attenuates the frequencies inside of a range around the [member cutoff_hz] and cuts frequencies outside of this band. </description> <tutorials> </tutorials> diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 17aa01d60a..9ce1a93121 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Adds a filter to the Audio Bus. </brief_description> <description> + Allows frequencies other than the [member cutoff_hz] to pass. </description> <tutorials> </tutorials> @@ -68,12 +70,15 @@ </methods> <members> <member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff"> + Threshold frequency for the filter. </member> - <member name="dB" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB"> + <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. </member> <member name="resonance" type="float" setter="set_resonance" getter="get_resonance"> + Amount of boost in the overtones near the cutoff frequency. </member> </members> <constants> diff --git a/doc/classes/AudioEffectHighPassFilter.xml b/doc/classes/AudioEffectHighPassFilter.xml index 641f7cfee2..c5e24af510 100644 --- a/doc/classes/AudioEffectHighPassFilter.xml +++ b/doc/classes/AudioEffectHighPassFilter.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Adds a high pass filter to the Audio Bus. </brief_description> <description> + Cuts frequencies lower than the [member cutoff_hz] and allows higher frequencies to pass. </description> <tutorials> </tutorials> diff --git a/doc/classes/AudioEffectLowPassFilter.xml b/doc/classes/AudioEffectLowPassFilter.xml index fcaf32d761..f102dda03e 100644 --- a/doc/classes/AudioEffectLowPassFilter.xml +++ b/doc/classes/AudioEffectLowPassFilter.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Adds a low pass filter to the Audio Bus. </brief_description> <description> + Cuts frequencies higher than the [member cutoff_hz] and allows lower frequencies to pass. </description> <tutorials> </tutorials> diff --git a/doc/classes/AudioEffectNotchFilter.xml b/doc/classes/AudioEffectNotchFilter.xml index f90577fa5a..8ec9a4bc7c 100644 --- a/doc/classes/AudioEffectNotchFilter.xml +++ b/doc/classes/AudioEffectNotchFilter.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Adds a notch filter to the Audio Bus. </brief_description> <description> + Attenuates frequencies in a narrow band around the [member cutoff_hz] and cuts frequencies outside of this range. </description> <tutorials> </tutorials> 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/BitmapFont.xml b/doc/classes/BitmapFont.xml index 07027c4b42..43ce40562f 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -38,7 +38,7 @@ <argument index="2" name="kerning" type="int"> </argument> <description> - Adds a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. + Adds a kerning pair to the [code]BitmapFont[/code] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. </description> </method> <method name="add_texture"> @@ -47,7 +47,7 @@ <argument index="0" name="texture" type="Texture"> </argument> <description> - Adds a texture to the [BitmapFont]. + Adds a texture to the [code]BitmapFont[/code]. </description> </method> <method name="clear"> @@ -168,7 +168,7 @@ The font's kernings as [PoolIntArray]. </member> <member name="textures" type="Array" setter="_set_textures" getter="_get_textures"> - The font's [Texture]\ s. + The font's [Texture]s. </member> </members> <constants> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index c627112af5..93140a0df6 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -327,12 +327,13 @@ The Camera2D's anchor point. See [code]ANCHOR_MODE_*[/code] constants. </member> <member name="current" type="bool" setter="_set_current" getter="is_current"> - If [code]true[/code] this camera is the active camera for the current scene. Only one camera can be current, so setting a different camera [code]current[/code] will disable this one. + If [code]true[/code] the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera [code]current[/code] will disable this one. </member> <member name="drag_margin_bottom" type="float" setter="set_drag_margin" getter="get_drag_margin"> Bottom margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen. </member> <member name="drag_margin_h_enabled" type="bool" setter="set_h_drag_enabled" getter="is_h_drag_enabled"> + If [code]true[/code] the camera only moves when reaching the horizontal drag margins. If [code]false[/code] the camera moves horizontally regardless of margins. Default value: [code]true[/code]. </member> <member name="drag_margin_left" type="float" setter="set_drag_margin" getter="get_drag_margin"> Left margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen. @@ -344,6 +345,7 @@ Top margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen. </member> <member name="drag_margin_v_enabled" type="bool" setter="set_v_drag_enabled" getter="is_v_drag_enabled"> + 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"> </member> @@ -369,19 +371,22 @@ 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]. </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]. </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. </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. </member> </members> <constants> - <constant name="ANCHOR_MODE_DRAG_CENTER" value="1"> - </constant> <constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0"> </constant> + <constant name="ANCHOR_MODE_DRAG_CENTER" value="1"> + </constant> </constants> </class> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 4a9890ea18..3682cc6d8f 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -652,6 +652,9 @@ <constant name="BLEND_MODE_PREMULT_ALPHA" value="4"> Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. </constant> + <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum=""> + Canvas item transform has changed. Only received if requested. + </constant> <constant name="NOTIFICATION_DRAW" value="30" enum=""> CanvasItem is requested to draw. </constant> @@ -664,8 +667,5 @@ <constant name="NOTIFICATION_EXIT_CANVAS" value="33" enum=""> Canvas item has exited the canvas. </constant> - <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum=""> - Canvas item transform has changed. Only received if requested. - </constant> </constants> </class> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 3ee1f10536..c3f2e43892 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -4,7 +4,7 @@ Canvas drawing layer. </brief_description> <description> - Canvas drawing layer. [CanvasItem] nodes that are direct or indirect children of a [CanvasLayer] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). + Canvas drawing layer. [CanvasItem] nodes that are direct or indirect children of a [code]CanvasLayer[/code] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [code]CanvasLayer[/code] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). </description> <tutorials> </tutorials> diff --git a/doc/classes/CapsuleShape2D.xml b/doc/classes/CapsuleShape2D.xml index df833e0582..4fb5579436 100644 --- a/doc/classes/CapsuleShape2D.xml +++ b/doc/classes/CapsuleShape2D.xml @@ -15,14 +15,14 @@ <return type="float"> </return> <description> - Return the height of the [CapsuleShape2D]. + Return the height of the [code]CapsuleShape2D[/code]. </description> </method> <method name="get_radius" qualifiers="const"> <return type="float"> </return> <description> - Return the radius of the [CapsuleShape2D]. + Return the radius of the [code]CapsuleShape2D[/code]. </description> </method> <method name="set_height"> @@ -31,7 +31,7 @@ <argument index="0" name="height" type="float"> </argument> <description> - Set the height of the [CapsuleShape2D]. + Set the height of the [code]CapsuleShape2D[/code]. </description> </method> <method name="set_radius"> @@ -40,7 +40,7 @@ <argument index="0" name="radius" type="float"> </argument> <description> - Set the radius of the [CapsuleShape2D]. + Set the radius of the [code]CapsuleShape2D[/code]. </description> </method> </methods> diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index 64e9e07925..71b0c5fa7c 100644 --- a/doc/classes/CollisionObject.xml +++ b/doc/classes/CollisionObject.xml @@ -4,7 +4,7 @@ Base node for collision objects. </brief_description> <description> - CollisionObject is the base class for physics objects. It can hold any number of collision [Shape]\ s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. + CollisionObject is the base class for physics objects. It can hold any number of collision [Shape]s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. </description> <tutorials> </tutorials> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index 52743bd37d..ec0554d51f 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -4,7 +4,7 @@ Base node for 2D collision objects. </brief_description> <description> - CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision [Shape2D]\ s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. + CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision [Shape2D]s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. </description> <tutorials> </tutorials> diff --git a/doc/classes/ConcavePolygonShape2D.xml b/doc/classes/ConcavePolygonShape2D.xml index 018d64b643..be884fd08d 100644 --- a/doc/classes/ConcavePolygonShape2D.xml +++ b/doc/classes/ConcavePolygonShape2D.xml @@ -5,7 +5,7 @@ </brief_description> <description> Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for [RigidBody2D] nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. - The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. + The main difference between a [ConvexPolygonShape2D] and a [code]ConcavePolygonShape2D[/code] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. </description> <tutorials> </tutorials> diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index 78655c496d..baf28c5a74 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -46,7 +46,7 @@ <member name="swing_span" type="float" setter="_set_swing_span" getter="_get_swing_span"> Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected allong the swing axis. - Could be defined as looseness in the [ConeTwistJoint]. + Could be defined as looseness in the [code]ConeTwistJoint[/code]. If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code]. </member> <member name="twist_span" type="float" setter="_set_twist_span" getter="_get_twist_span"> @@ -58,7 +58,7 @@ <constant name="PARAM_SWING_SPAN" value="0"> Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected allong the swing axis. - Could be defined as looseness in the [ConeTwistJoint]. + Could be defined as looseness in the [code]ConeTwistJoint[/code]. If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code]. </constant> <constant name="PARAM_TWIST_SPAN" value="1"> diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml index 844c17a1d9..f8555def37 100644 --- a/doc/classes/Container.xml +++ b/doc/classes/Container.xml @@ -4,7 +4,7 @@ Base node for containers. </brief_description> <description> - Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way. + Base node for containers. A [code]Container[/code] contains other controls and automatically arranges them in a certain way. A Control can inherit this to create custom container classes. </description> <tutorials> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 77bbfa186b..e3d29c2e93 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -1113,18 +1113,18 @@ </constant> <constant name="PRESET_MODE_MINSIZE" value="0"> </constant> - <constant name="PRESET_MODE_KEEP_HEIGHT" value="2"> - </constant> <constant name="PRESET_MODE_KEEP_WIDTH" value="1"> </constant> - <constant name="PRESET_MODE_KEEP_SIZE" value="3"> + <constant name="PRESET_MODE_KEEP_HEIGHT" value="2"> </constant> - <constant name="SIZE_EXPAND" value="2"> - Tells the parent [Container] to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See [member size_flags_stretch_ratio]. Use with [member size_flags_horizontal] and [member size_flags_vertical]. + <constant name="PRESET_MODE_KEEP_SIZE" value="3"> </constant> <constant name="SIZE_FILL" value="1"> Tells the parent [Container] to expand the bounds of this node to fill all the available space without pushing any other node. Use with [member size_flags_horizontal] and [member size_flags_vertical]. </constant> + <constant name="SIZE_EXPAND" value="2"> + Tells the parent [Container] to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See [member size_flags_stretch_ratio]. Use with [member size_flags_horizontal] and [member size_flags_vertical]. + </constant> <constant name="SIZE_EXPAND_FILL" value="3"> Sets the node's size flags to both fill and expand. See the 2 constants above for more information. </constant> diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index 0cb4f4045b..cf1fdccc26 100644 --- a/doc/classes/ConvexPolygonShape2D.xml +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -5,7 +5,7 @@ </brief_description> <description> Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check). - The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. + The main difference between a [code]ConvexPolygonShape2D[/code] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. </description> <tutorials> </tutorials> diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index ac2ff3fc57..5626554193 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -82,6 +82,12 @@ </description> </method> </methods> + <members> + <member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality"> + </member> + <member name="storage_mode" type="int" setter="set_storage" getter="get_storage" enum="CubeMap.Storage"> + </member> + </members> <constants> <constant name="STORAGE_RAW" value="0"> </constant> 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/DampedSpringJoint2D.xml b/doc/classes/DampedSpringJoint2D.xml index 18554820fa..36c5564513 100644 --- a/doc/classes/DampedSpringJoint2D.xml +++ b/doc/classes/DampedSpringJoint2D.xml @@ -78,12 +78,16 @@ </methods> <members> <member name="damping" type="float" setter="set_damping" getter="get_damping"> + The spring joint's damping ratio. A value between [code]0[/code] and [code]1[/code]. When the two bodies move into different directions the system tries to align them to the spring axis again. A high [code]damping[/code] value forces the attached bodies to align faster. Default value: [code]1[/code] </member> <member name="length" type="float" setter="set_length" getter="get_length"> + The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: [code]50[/code] </member> <member name="rest_length" type="float" setter="set_rest_length" getter="get_rest_length"> + When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: [code]0[/code] </member> <member name="stiffness" type="float" setter="set_stiffness" getter="get_stiffness"> + The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: [code]20[/code] </member> </members> <constants> diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index 447c0d7ed3..4b37061af2 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -59,7 +59,7 @@ <return type="Array"> </return> <description> - Return the list of keys in the [Dictionary]. + Return the list of keys in the [code]Dictionary[/code]. </description> </method> <method name="size"> @@ -73,7 +73,7 @@ <return type="Array"> </return> <description> - Return the list of values in the [Dictionary]. + Return the list of values in the [code]Dictionary[/code]. </description> </method> </methods> diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index c130add523..d7f08c85a1 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -4,7 +4,7 @@ DynamicFont renders vector font files at runtime. </brief_description> <description> - DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]\ s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths. + DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths. </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 203c96516b..3a3fd43b15 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorInterface" inherits="Node" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Editor interface and main components. </brief_description> <description> + Editor interface. Allows saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects and provides access to [EditorSettings], [EditorFileSystem], [EditorResourcePreview]\ er, [ScriptEditor], the editor viewport, as well as information about scenes. Also see [EditorPlugin] and [EditorScript]. </description> <tutorials> </tutorials> @@ -15,60 +17,70 @@ <argument index="0" name="resource" type="Resource"> </argument> <description> + Edits the given [Resource]. </description> </method> <method name="get_base_control"> <return type="Control"> </return> <description> + Returns the base [Control]. </description> </method> <method name="get_edited_scene_root"> <return type="Node"> </return> <description> + Returns the edited scene's root [Node]. </description> </method> <method name="get_editor_settings"> <return type="EditorSettings"> </return> <description> + Returns the [EditorSettings]. </description> </method> <method name="get_editor_viewport"> <return type="Control"> </return> <description> + Returns the editor [Viewport]. </description> </method> <method name="get_open_scenes" qualifiers="const"> <return type="Array"> </return> <description> + Returns an [Array] of the currently opened scenes. </description> </method> <method name="get_resource_filesystem"> <return type="EditorFileSystem"> </return> <description> + Returns the [EditorFileSystem]. </description> </method> <method name="get_resource_previewer"> <return type="EditorResourcePreview"> </return> <description> + Returns the [EditorResourcePreview]\ er. </description> </method> <method name="get_script_editor"> <return type="ScriptEditor"> </return> <description> + Returns the [ScriptEditor]. </description> </method> <method name="get_selection"> <return type="EditorSelection"> </return> <description> + Returns the [EditorSelection]. </description> </method> <method name="inspect_object"> @@ -79,6 +91,7 @@ <argument index="1" name="for_property" type="String" default=""""> </argument> <description> + Shows the given property on the given [code]object[/code] in the Editor's Inspector dock. </description> </method> <method name="make_mesh_previews"> @@ -89,6 +102,7 @@ <argument index="1" name="preview_size" type="int"> </argument> <description> + Returns mesh previews rendered at the given size as an [Array] of [Texture]s. </description> </method> <method name="open_scene_from_path"> @@ -97,6 +111,7 @@ <argument index="0" name="scene_filepath" type="String"> </argument> <description> + Opens the scene at the given path. </description> </method> <method name="reload_scene_from_path"> @@ -105,12 +120,14 @@ <argument index="0" name="scene_filepath" type="String"> </argument> <description> + Reloads the scene at the given path. </description> </method> <method name="save_scene"> <return type="int" enum="Error"> </return> <description> + Saves the scene. Returns either OK or ERR_CANT_CREATE. See [@Global Scope] constants. </description> </method> <method name="save_scene_as"> @@ -121,6 +138,7 @@ <argument index="1" name="with_preview" type="bool" default="true"> </argument> <description> + Saves the scene as a file at [code]path[/code]. </description> </method> </methods> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 2831555d41..de79c3c85c 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -366,6 +366,8 @@ </constant> <constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5"> </constant> + <constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="6"> + </constant> <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7"> </constant> <constant name="DOCK_SLOT_LEFT_UL" value="0"> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 48cf3e9843..245dbc078d 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -1,10 +1,19 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorScript" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Simple script to perform changes in the currently edited scene. + Base script that can be used to add extension functions to the editor. </brief_description> <description> - This script can be run from the Scene -> Run Script menu option. + Scripts extending this class and implementing its [code]_run()[/code] method can be executed from the Script Editor's [code]File -> Run[/code] menu option (or by pressing [code]CTRL+Shift+X[/code]) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using [EditorPlugin]s instead. Note that extending scripts need to have [code]tool mode[/code] enabled. + Example script: + [codeblock] + tool + extends EditorScript + + func _run(): + 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 [i]Output[/i] dock. </description> <tutorials> </tutorials> @@ -15,6 +24,7 @@ <return type="void"> </return> <description> + This method is executed by the Editor when [code]File -> Run[/code] is used. </description> </method> <method name="add_root_node"> @@ -29,12 +39,14 @@ <return type="EditorInterface"> </return> <description> + Returns the [EditorInterface] singleton instance. </description> </method> <method name="get_scene"> <return type="Node"> </return> <description> + Returns the Editor's currently active scene. </description> </method> </methods> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 5bb0810296..083688b416 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -4,7 +4,7 @@ Access to basic engine properties. </brief_description> <description> - The [Engine] class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others. + The [code]Engine[/code] class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others. </description> <tutorials> </tutorials> diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml index 1277cef77d..987d750ced 100644 --- a/doc/classes/FuncRef.xml +++ b/doc/classes/FuncRef.xml @@ -5,7 +5,7 @@ </brief_description> <description> In GDScript, functions are not [i]first-class objects[/i]. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments. - However, by creating a [FuncRef] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called. + However, by creating a [code]FuncRef[/code] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called. </description> <tutorials> </tutorials> diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml index 9df0b80b35..3f3d24aaaa 100644 --- a/doc/classes/GIProbe.xml +++ b/doc/classes/GIProbe.xml @@ -195,6 +195,8 @@ </constant> <constant name="SUBDIV_256" value="2"> </constant> + <constant name="SUBDIV_512" value="3"> + </constant> <constant name="SUBDIV_MAX" value="4"> </constant> </constants> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index f064029a01..01d578be5e 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -228,8 +228,6 @@ <constants> </constants> <theme_items> - <theme_item name="SnapGrid" type="Texture"> - </theme_item> <theme_item name="bezier_len_neg" type="int"> </theme_item> <theme_item name="bezier_len_pos" type="int"> @@ -246,5 +244,7 @@ </theme_item> <theme_item name="reset" type="Texture"> </theme_item> + <theme_item name="snap" type="Texture"> + </theme_item> </theme_items> </class> diff --git a/doc/classes/GrooveJoint2D.xml b/doc/classes/GrooveJoint2D.xml index 3db2d9aee9..412a4504c3 100644 --- a/doc/classes/GrooveJoint2D.xml +++ b/doc/classes/GrooveJoint2D.xml @@ -46,8 +46,10 @@ </methods> <members> <member name="initial_offset" type="float" setter="set_initial_offset" getter="get_initial_offset"> + The body B's initial anchor position defined by the joint's origin and a local offset [member initial_offset] along the joint's y axis (along the groove). Default value: [code]25[/code] </member> <member name="length" type="float" setter="set_length" getter="get_length"> + The groove's length. The groove is from the joint's origin towards [member length] along the joint's local y axis. Default value: [code]50[/code] </member> </members> <constants> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index cf48ec84f6..e75aee0126 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -16,7 +16,7 @@ <return type="void"> </return> <description> - Cloces the current connection, allows for reusal of [HTTPClient]. + Cloces the current connection, allows for reusal of [code]HTTPClient[/code]. </description> </method> <method name="connect_to_host"> @@ -84,7 +84,7 @@ <return type="bool"> </return> <description> - Return whether this [HTTPClient] has a response available. + Return whether this [code]HTTPClient[/code] has a response available. </description> </method> <method name="is_blocking_mode_enabled" qualifiers="const"> @@ -98,7 +98,7 @@ <return type="bool"> </return> <description> - Return whether this [HTTPClient] has a response that is chunked. + Return whether this [code]HTTPClient[/code] has a response that is chunked. </description> </method> <method name="poll"> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index f4ea9d00ce..2e76eb6d0b 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -21,7 +21,7 @@ <argument index="2" name="dst" type="Vector2"> </argument> <description> - Alpha-blends a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest". + Alpha-blends a "src_rect" [Rect2] from "src" [code]Image[/code] to this [code]Image[/code] on coordinates "dest". </description> </method> <method name="blend_rect_mask"> @@ -36,7 +36,7 @@ <argument index="3" name="dst" type="Vector2"> </argument> <description> - Alpha-blends a "src_rect" [Rect2] from "src" [Image] to this [Image] using a "mask" [Image] on coordinates "dest". Alpha channels are required for both "src" and "mask", dest pixels and src pixels will blend if the corresponding mask pixel's alpha value is not 0. "src" [Image] and "mask" [Image] *must* have the same size (width and height) but they can have different formats + Alpha-blends a "src_rect" [Rect2] from "src" [code]Image[/code] to this [code]Image[/code] using a "mask" [code]Image[/code] on coordinates "dest". Alpha channels are required for both "src" and "mask", dest pixels and src pixels will blend if the corresponding mask pixel's alpha value is not 0. "src" [code]Image[/code] and "mask" [code]Image[/code] *must* have the same size (width and height) but they can have different formats </description> </method> <method name="blit_rect"> @@ -49,7 +49,7 @@ <argument index="2" name="dst" type="Vector2"> </argument> <description> - Copy a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest". + Copy a "src_rect" [Rect2] from "src" [code]Image[/code] to this [code]Image[/code] on coordinates "dest". </description> </method> <method name="blit_rect_mask"> @@ -64,7 +64,7 @@ <argument index="3" name="dst" type="Vector2"> </argument> <description> - Blits a "src_rect" [Rect2] from "src" [Image] to this [Image] using a "mask" [Image] on coordinates "dest". Alpha channel is required for "mask", will copy src pixel onto dest if the corresponding mask pixel's alpha value is not 0. "src" [Image] and "mask" [Image] *must* have the same size (width and height) but they can have different formats + Blits a "src_rect" [Rect2] from "src" [code]Image[/code] to this [code]Image[/code] using a "mask" [code]Image[/code] on coordinates "dest". Alpha channel is required for "mask", will copy src pixel onto dest if the corresponding mask pixel's alpha value is not 0. "src" [code]Image[/code] and "mask" [code]Image[/code] *must* have the same size (width and height) but they can have different formats </description> </method> <method name="clear_mipmaps"> @@ -166,7 +166,7 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Fills an [Image] with a specified [Color] + Fills an [code]Image[/code] with a specified [Color] </description> </method> <method name="fix_alpha_edges"> @@ -197,21 +197,21 @@ <return type="PoolByteArray"> </return> <description> - Return the raw data of the [Image]. + Return the raw data of the [code]Image[/code]. </description> </method> <method name="get_format" qualifiers="const"> <return type="int" enum="Image.Format"> </return> <description> - Return the format of the [Image], one of [Image].FORMAT_*. + Return the format of the [code]Image[/code], one of [code]Image[/code].FORMAT_*. </description> </method> <method name="get_height" qualifiers="const"> <return type="int"> </return> <description> - Return the height of the [Image]. + Return the height of the [code]Image[/code]. </description> </method> <method name="get_mipmap_offset" qualifiers="const"> @@ -238,7 +238,7 @@ <argument index="0" name="rect" type="Rect2"> </argument> <description> - Return a new [Image] that is a copy of "area" in this [Image]. + Return a new [code]Image[/code] that is a copy of "area" in this [code]Image[/code]. </description> </method> <method name="get_size" qualifiers="const"> @@ -251,14 +251,14 @@ <return type="Rect2"> </return> <description> - Return the area of this [Image] that is used/visibly colored/opaque. + Return the area of this [code]Image[/code] that is used/visibly colored/opaque. </description> </method> <method name="get_width" qualifiers="const"> <return type="int"> </return> <description> - Return the width of the [Image]. + Return the width of the [code]Image[/code]. </description> </method> <method name="has_mipmaps" qualifiers="const"> @@ -291,7 +291,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Load an [Image]. + Load an [code]Image[/code]. </description> </method> <method name="lock"> @@ -338,7 +338,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Save this [Image] as a png. + Save this [code]Image[/code] as a png. </description> </method> <method name="set_pixel"> diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index fdaee798db..b392252399 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -23,7 +23,7 @@ <argument index="3" name="flags" type="int" default="7"> </argument> <description> - Create a new [ImageTexture] with "width" and "height". + Create a new [code]ImageTexture[/code] with "width" and "height". "format" one of [Image].FORMAT_*. "flags" one or more of [Texture].FLAG_*. </description> @@ -36,28 +36,28 @@ <argument index="1" name="flags" type="int" default="7"> </argument> <description> - Create a new [ImageTexture] from an [Image] with "flags" from [Texture].FLAG_*. + Create a new [code]ImageTexture[/code] from an [Image] with "flags" from [Texture].FLAG_*. </description> </method> <method name="get_format" qualifiers="const"> <return type="int" enum="Image.Format"> </return> <description> - Return the format of the [ImageTexture], one of [Image].FORMAT_*. + Return the format of the [code]ImageTexture[/code], one of [Image].FORMAT_*. </description> </method> <method name="get_lossy_storage_quality" qualifiers="const"> <return type="float"> </return> <description> - Return the storage quality for [ImageTexture].STORAGE_COMPRESS_LOSSY. + Return the storage quality for [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY. </description> </method> <method name="get_storage" qualifiers="const"> <return type="int" enum="ImageTexture.Storage"> </return> <description> - Return the storage type. One of [ImageTexture].STORAGE_*. + Return the storage type. One of [code]ImageTexture[/code].STORAGE_*. </description> </method> <method name="load"> @@ -66,7 +66,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Load an [ImageTexture]. + Load an [code]ImageTexture[/code]. </description> </method> <method name="set_data"> @@ -75,7 +75,7 @@ <argument index="0" name="image" type="Image"> </argument> <description> - Set the [Image] of this [ImageTexture]. + Set the [Image] of this [code]ImageTexture[/code]. </description> </method> <method name="set_lossy_storage_quality"> @@ -84,7 +84,7 @@ <argument index="0" name="quality" type="float"> </argument> <description> - Set the storage quality in case of [ImageTexture].STORAGE_COMPRESS_LOSSY. + Set the storage quality in case of [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY. </description> </method> <method name="set_size_override"> @@ -102,7 +102,7 @@ <argument index="0" name="mode" type="int" enum="ImageTexture.Storage"> </argument> <description> - Set the storage type. One of [ImageTexture].STORAGE_*. + Set the storage type. One of [code]ImageTexture[/code].STORAGE_*. </description> </method> </methods> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 392ee25ad6..c6abf2fee5 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -4,8 +4,10 @@ Generic input event </brief_description> <description> + Base class of all sort of input event. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -16,7 +18,7 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Returns true if this input event matches the event passed. + Returns [code]true[/code] if this event matches [code]event[event]. </description> </method> <method name="as_text" qualifiers="const"> @@ -30,14 +32,14 @@ <return type="int"> </return> <description> - Returns the id of the device that generated the event. + Returns the device's id that generated the event. </description> </method> <method name="get_id" qualifiers="const"> <return type="int"> </return> <description> - Returns the id of the event. + Returns the event's ID. </description> </method> <method name="is_action" qualifiers="const"> @@ -46,7 +48,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns true if this input event matches a pre-defined action, no matter the type. + Returns [code]true[/code] if this input event matches a pre-defined action of any type. </description> </method> <method name="is_action_pressed" qualifiers="const"> @@ -55,7 +57,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns true if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns [code]true[/code] if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. </description> </method> <method name="is_action_released" qualifiers="const"> @@ -64,27 +66,28 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns true if the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. </description> </method> <method name="is_action_type" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if this input event's type is one of the [code]InputEvent[/code] constants. </description> </method> <method name="is_echo" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if this input event is an echo event (only for events of type KEY, it will return false for other types). + Returns [code]true[/code] if this input event is an echo event (only for events of type KEY). </description> </method> <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns [code]true[/code] if this input event is pressed. Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. </description> </method> <method name="set_device"> @@ -124,6 +127,7 @@ </methods> <members> <member name="device" type="int" setter="set_device" getter="get_device"> + The event's device ID. </member> </members> <constants> diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index 2617ea4dfa..d97f1d4a2e 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -4,8 +4,10 @@ Input event type for actions. </brief_description> <description> + Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu [code]Project > Project Settings > Input Map[/Code]. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#actions </tutorials> <demos> </demos> @@ -35,8 +37,10 @@ </methods> <members> <member name="action" type="String" setter="set_action" getter="get_action"> + The action's name. Actions are accessed via this [String]. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> + If [code]true[/code] the action's state is pressed. If [code]false[/code] the action's state is released. </member> </members> <constants> diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index 2784b06442..f13a1102b7 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Input event type for joypad button events. + Input event for gamepad buttons. </brief_description> <description> + Input event type for gamepad buttons. For joysticks see [InputEventJoypadMotion]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -49,13 +51,13 @@ </methods> <members> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index"> - Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. + Button identifier. One of the [code]JOY_BUTTON_*[/code] constants from [@global Scope]. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> - Pressed state of the joypad button. + If [code]true[/code] the button's state is pressed. If [code]false[/code] the button's state is released. </member> <member name="pressure" type="float" setter="set_pressure" getter="get_pressure"> - Intensity of the button pressure, ranges from 0 to 1.0. + Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from [code]0[/code] to [code]1[/code]. </member> </members> <constants> diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index 8a26007fc1..a7c585a55d 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Input event type for joypad motion/axis events. + Input event type for gamepad joysticks and other motions. For buttons see [code]InputEventJoypadMotion[/code]. </brief_description> <description> + Stores information about joystick motions. One [code]InputEventJoypadMotion[/code] represents one axis at a time. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -41,10 +43,10 @@ </methods> <members> <member name="axis" type="int" setter="set_axis" getter="get_axis"> - Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. + Axis identifier. Use one of the [code]JOY_AXIS_*[/code] constants in [@global Scope]. </member> <member name="axis_value" type="float" setter="set_axis_value" getter="get_axis_value"> - Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position. + Current position of the joystick on the given axis. The value ranges from [code]-1.0[/code] to [code]1.0[/code]. A value of [code]0[/code] means the axis is in its resting position. </member> </members> <constants> diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 151e19d25d..9565584a4f 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -4,8 +4,10 @@ Input event type for keyboard events. </brief_description> <description> + Stores key presses on the keyboard. Supports key presses, key releases and [member echo] events. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -63,16 +65,16 @@ </methods> <members> <member name="echo" type="bool" setter="set_echo" getter="is_echo"> - Echo state of the key, i.e. whether it's a repeat event or not. + If [code]true[/code] the key was already pressed before this event. It means the user is holding the key down. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> - Pressed state of the key. + If [code]true[/code] the key's state is pressed. If [code]false[/code] the key's state is released. </member> <member name="scancode" type="int" setter="set_scancode" getter="get_scancode"> - Scancode of the key, one of the KEY_* constants in [@Global Scope]. + Key scancode, one of the [code]KEY_*[/code] constants in [@global Scope]. </member> <member name="unicode" type="int" setter="set_unicode" getter="get_unicode"> - Unicode identifier of the key (when relevant). + Key unicode identifier when relevant. </member> </members> <constants> diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 57f0acbf30..38eec74ffa 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -4,8 +4,10 @@ Base input event type for mouse events. </brief_description> <description> + Stores general mouse events informations. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -58,10 +60,10 @@ Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. </member> <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position"> - Global position of the mouse click. + Mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position"> - Local position of the mouse click. + Mouse local position relative to the [Viewport]. If used in [method Control._gui_input] the position is relative to the current [Control] wich is under the mouse. </member> </members> <constants> diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index 63e31eb61c..afc0c331c8 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -4,8 +4,10 @@ Input event type for mouse button events. </brief_description> <description> + Contains mouse click informations. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -66,12 +68,13 @@ Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope]. </member> <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick"> - Whether the event is a double-click. + If [code]true[/code] the mouse button's state is a double-click. If [code]false[/code] the mouse button's state is released. </member> <member name="factor" type="float" setter="set_factor" getter="get_factor"> + TO TALK in PR, reduz said : i think it's used for apple touch but i don't remember what it does </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> - Pressed state of the mouse button. + If [code]true[/code] the mouse button's state is pressed. If [code]false[/code] the mouse button's state is released. </member> </members> <constants> diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 59fe8d2e58..5be82e1ffa 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -4,8 +4,10 @@ Input event type for mouse motion events. </brief_description> <description> + Contains mouse motion informations. Supports relative, absolute positions and speed. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -41,10 +43,10 @@ </methods> <members> <member name="relative" type="Vector2" setter="set_relative" getter="get_relative"> - Position of the mouse pointer relative to the previous mouse position. + Mouse position relative to the previous position (position at the last frame). </member> <member name="speed" type="Vector2" setter="set_speed" getter="get_speed"> - Speed of the mouse pointer. + Mouse speed. </member> </members> <constants> diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index 0b0ecc17bc..0c92ad5f70 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -2,10 +2,13 @@ <class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> Input event type for screen drag events. + (only available on mobile devices) </brief_description> <description> + Contains screen drag informations. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -72,13 +75,13 @@ Drag event index in the case of a multi-drag event. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position"> - Position of the drag event. + Drag position. </member> <member name="relative" type="Vector2" setter="set_relative" getter="get_relative"> - Position of the drag event relative to its start position. + Drag position relative to its start position. </member> <member name="speed" type="Vector2" setter="set_speed" getter="get_speed"> - Speed of the drag event. + Drag speed. </member> </members> <constants> diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index 48c5626f14..01ba9f1285 100644 --- a/doc/classes/InputEventScreenTouch.xml +++ b/doc/classes/InputEventScreenTouch.xml @@ -2,10 +2,13 @@ <class name="InputEventScreenTouch" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> Input event type for screen touch events. + (only available on mobile devices) </brief_description> <description> + Stores multi-touch press/release information. Supports touch press, touch release and [member index] for multi-touch count and order. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -49,13 +52,13 @@ </methods> <members> <member name="index" type="int" setter="set_index" getter="get_index"> - Touch event index in the case of a multi-touch event. + Touch index in the case of a multi-touch event. One index = one finger. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position"> - Position of the touch event. + Touch position. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> - Pressed state of the touch event. + If [code]true[/code] the touch's state is pressed. If [code]false[/code] the touch's state is released. </member> </members> <constants> diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index 7bbdf0a441..46107a4ab8 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Base class for input events with modifiers. + Base class for keys events with modifiers. </brief_description> <description> + Contains keys events informations with modifiers support like [code]SHIFT[/code] or [code]ALT[/code]. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index bf72ba05e7..99b77dab36 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputMap" inherits="Object" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Singleton that manages actions. + Singleton that manages [InputEventAction]. </brief_description> <description> + Manages all [InputEventAction] which can be created/modified from the project settings menu [code]Project > Project Settings > Input Map[/Code] or in code with [method add_action] and [method action_add_event]. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#inputmap </tutorials> <demos> </demos> @@ -18,7 +20,7 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Add an [InputEvent] to an action. This [InputEvent] will trigger the action. + Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. </description> </method> <method name="action_erase_event"> @@ -29,7 +31,7 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Remove an [InputEvent] from an action. + Removes an [InputEvent] from an action. </description> </method> <method name="action_has_event"> @@ -40,7 +42,7 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Whether an action has an [InputEvent] associated with it. + Returns [true] if an action has an [InputEvent] associated with it. </description> </method> <method name="add_action"> @@ -49,7 +51,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Add an (empty) action to the [InputMap]. An [InputEvent] can then be added to this action with [method action_add_event]. + Adds an (empty) action to the [code]InputMap[/code]. An [InputEvent] can then be added to this action with [method action_add_event]. </description> </method> <method name="erase_action"> @@ -58,7 +60,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Remove an action from the [InputMap]. + Removes an action from the [code]InputMap[/code]. </description> </method> <method name="event_is_action" qualifiers="const"> @@ -69,7 +71,7 @@ <argument index="1" name="action" type="String"> </argument> <description> - Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. + Returns [true] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. </description> </method> <method name="get_action_list"> @@ -78,14 +80,14 @@ <argument index="0" name="action" type="String"> </argument> <description> - Return an array of InputEvents associated with a given action. + Returns an array of [InputEvent]s associated with a given action. </description> </method> <method name="get_actions"> <return type="Array"> </return> <description> - Return an array of all actions in the [InputMap]. + Returns an array of all actions in the [code]InputMap[/code]. </description> </method> <method name="has_action" qualifiers="const"> @@ -94,14 +96,14 @@ <argument index="0" name="action" type="String"> </argument> <description> - Whether this InputMap has a registered action with the given name. + Returns [code]true[/code] if the [code]InputMap[/code] has a registered action with the given name. </description> </method> <method name="load_from_globals"> <return type="void"> </return> <description> - Clear the [InputMap] and load it anew from [ProjectSettings]. + Clears all [InputEventAction] in the [code]InputMap[/code] and load it anew from [ProjectSettings]. </description> </method> </methods> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index db9a681896..2d163c4a80 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -4,7 +4,7 @@ Data class wrapper for decoded JSON. </brief_description> <description> - Returned by [method JSON.parse], [JSONParseResult] contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with [code]if json_result.error == 0[/code]. + Returned by [method JSON.parse], [code]JSONParseResult[/code] contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with [code]if json_result.error == 0[/code]. </description> <tutorials> </tutorials> diff --git a/doc/classes/Joint2D.xml b/doc/classes/Joint2D.xml index e6c2f6d157..b9caa7ef4b 100644 --- a/doc/classes/Joint2D.xml +++ b/doc/classes/Joint2D.xml @@ -74,12 +74,16 @@ </methods> <members> <member name="bias" type="float" setter="set_bias" getter="get_bias"> + When [member node_a] and [member node_b] move in different directions the [code]bias[/code] controls how fast the joint pulls them back to their original position. The lower the [code]bias[/code] the more the two bodies can pull on the joint. Default value: [code]0[/code] </member> <member name="disable_collision" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision"> + If [code]true[/code] [member node_a] and [member node_b] can collide. Default value: [code]false[/code]. </member> <member name="node_a" type="NodePath" setter="set_node_a" getter="get_node_a"> + The first body attached to the joint. Must derive from [PhysicsBody2D]. </member> <member name="node_b" type="NodePath" setter="set_node_b" getter="get_node_b"> + The second body attached to the joint. Must derive from [PhysicsBody2D]. </member> </members> <constants> diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 86354548cd..f80c00ed6d 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -86,7 +86,7 @@ <argument index="4" name="floor_max_angle" type="float" default="0.785398"> </argument> <description> - Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [KinematicBody] or [RigidBody], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. + Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [code]KinematicBody[/code] or [RigidBody], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [code]linear_velocity[/code] is a value in pixels per second. Unlike in for example [method move_and_collide], you should [i]not[/i] multiply it with [code]delta[/code] — this is done by the method. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector2(0, 0)[/code], everything is considered a wall. This is useful for topdown games. If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index badc098494..798fc4153c 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -86,7 +86,7 @@ <argument index="4" name="floor_max_angle" type="float" default="0.785398"> </argument> <description> - Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [KinematicBody2D] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. + Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [code]KinematicBody2D[/code] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [code]linear_velocity[/code] is a value in pixels per second. Unlike in for example [method move_and_collide], you should [i]not[/i] multiply it with [code]delta[/code] — this is done by the method. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector2(0, 0)[/code], everything is considered a wall. This is useful for topdown games. If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index 11eee135cb..fd3ecc7365 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -179,6 +179,8 @@ </constant> <constant name="PARAM_SHADOW_BIAS" value="12"> </constant> + <constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="13"> + </constant> <constant name="PARAM_MAX" value="14"> </constant> </constants> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index e6c26e3248..50bff87a80 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -17,14 +17,14 @@ <argument index="0" name="text" type="String"> </argument> <description> - Append text at cursor, scrolling the [LineEdit] when needed. + Append text at cursor, scrolling the [code]LineEdit[/code] when needed. </description> </method> <method name="clear"> <return type="void"> </return> <description> - Clear the [LineEdit] text. + Clear the [code]LineEdit[/code] text. </description> </method> <method name="cursor_get_blink_enabled" qualifiers="const"> @@ -63,14 +63,14 @@ <return type="int" enum="LineEdit.Align"> </return> <description> - Return the align mode of the [LineEdit]. + Return the align mode of the [code]LineEdit[/code]. </description> </method> <method name="get_cursor_position" qualifiers="const"> <return type="int"> </return> <description> - Return the cursor position inside the [LineEdit]. + Return the cursor position inside the [code]LineEdit[/code]. </description> </method> <method name="get_expand_to_text_length" qualifiers="const"> @@ -83,14 +83,14 @@ <return type="int"> </return> <description> - Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists. + Return the maximum amount of characters the [code]LineEdit[/code] can edit. If 0 is returned, no limit exists. </description> </method> <method name="get_menu" qualifiers="const"> <return type="PopupMenu"> </return> <description> - Return the [PopupMenu] of this [LineEdit]. + Return the [PopupMenu] of this [code]LineEdit[/code]. </description> </method> <method name="get_placeholder" qualifiers="const"> @@ -111,21 +111,21 @@ <return type="String"> </return> <description> - Return the text in the [LineEdit]. + Return the text in the [code]LineEdit[/code]. </description> </method> <method name="is_editable" qualifiers="const"> <return type="bool"> </return> <description> - Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]). + Return the [i]editable[/i] status of the [code]LineEdit[/code] (see [method set_editable]). </description> </method> <method name="is_secret" qualifiers="const"> <return type="bool"> </return> <description> - Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]). + Return the [i]secret[/i] status of the [code]LineEdit[/code] (see [method set_secret]). </description> </method> <method name="menu_option"> @@ -145,7 +145,7 @@ <argument index="1" name="to" type="int" default="-1"> </argument> <description> - Select the text inside [LineEdit] by the given character positions. [code]from[/code] is default to the beginning. [code]to[/code] is default to the end. + Select the text inside [code]LineEdit[/code] by the given character positions. [code]from[/code] is default to the beginning. [code]to[/code] is default to the end. [codeblock] select() # select all select(5) # select from the fifth character to the end. @@ -166,7 +166,7 @@ <argument index="0" name="align" type="int" enum="LineEdit.Align"> </argument> <description> - Set text alignment of the [LineEdit]. + Set text alignment of the [code]LineEdit[/code]. </description> </method> <method name="set_cursor_position"> @@ -175,7 +175,7 @@ <argument index="0" name="position" type="int"> </argument> <description> - Set the cursor position inside the [LineEdit], causing it to scroll if needed. + Set the cursor position inside the [code]LineEdit[/code], causing it to scroll if needed. </description> </method> <method name="set_editable"> @@ -184,7 +184,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added. + Set the [i]editable[/i] status of the [code]LineEdit[/code]. When disabled, existing text can't be modified and new text can't be added. </description> </method> <method name="set_expand_to_text_length"> @@ -201,7 +201,7 @@ <argument index="0" name="chars" type="int"> </argument> <description> - Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. + Set the maximum amount of characters the [code]LineEdit[/code] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. </description> </method> <method name="set_placeholder"> @@ -228,7 +228,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*". + Set the [i]secret[/i] status of the [code]LineEdit[/code]. When enabled, every character is displayed as "*". </description> </method> <method name="set_text"> @@ -237,7 +237,7 @@ <argument index="0" name="text" type="String"> </argument> <description> - Set the text in the [LineEdit], clearing the existing one and the selection. + Set the text in the [code]LineEdit[/code], clearing the existing one and the selection. </description> </method> </methods> @@ -277,7 +277,7 @@ <argument index="0" name="text" type="String"> </argument> <description> - This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs. + This signal is emitted when the user presses KEY_ENTER on the [code]LineEdit[/code]. This signal is often used as an alternate confirmation mechanism in dialogs. </description> </signal> </signals> diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index d9598daf16..5e7f467684 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -40,7 +40,7 @@ <argument index="0" name="underline_mode" type="int" enum="LinkButton.UnderlineMode"> </argument> <description> - Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section). + Sets the underline mode for this button, the argument must be one of the [code]LinkButton[/code] constants (see constants section). </description> </method> </methods> diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index e6f9e40dfe..f8343467af 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -4,7 +4,7 @@ Main loop is the abstract main loop base class. </brief_description> <description> - Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [MainLoop] has to be provided to OS, else the application will exit. This happens automatically (and a [SceneTree] is created), unless a main [Script] is supplied, which may or not create and return a [MainLoop]. + Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [code]MainLoop[/code] has to be provided to OS, else the application will exit. This happens automatically (and a [SceneTree] is created), unless a main [Script] is supplied, which may or not create and return a [code]MainLoop[/code]. </description> <tutorials> </tutorials> @@ -124,6 +124,8 @@ </constant> <constant name="NOTIFICATION_WM_QUIT_REQUEST" value="6" enum=""> </constant> + <constant name="NOTIFICATION_WM_GO_BACK_REQUEST" value="7" enum=""> + </constant> <constant name="NOTIFICATION_WM_UNFOCUS_REQUEST" value="8" enum=""> </constant> <constant name="NOTIFICATION_OS_MEMORY_WARNING" value="9" enum=""> diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index ef3aeb9e07..3d0c8eb1df 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -15,21 +15,21 @@ <return type="void"> </return> <description> - Lock this [Mutex], blocks until it is unlocked by the current owner. + Lock this [code]Mutex[/code], blocks until it is unlocked by the current owner. </description> </method> <method name="try_lock"> <return type="int" enum="Error"> </return> <description> - Try locking this [Mutex], does not block. Returns [OK] on success else [ERR_BUSY]. + Try locking this [code]Mutex[/code], does not block. Returns [OK] on success else [ERR_BUSY]. </description> </method> <method name="unlock"> <return type="void"> </return> <description> - Unlock this [Mutex], leaving it to others threads. + Unlock this [code]Mutex[/code], leaving it to others threads. </description> </method> </methods> diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index c1d8c5ad91..3ac3895df2 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -31,7 +31,7 @@ <return type="bool"> </return> <description> - Return whether this [NetworkedMultiplayerPeer] is refusing new connections. + Return whether this [code]NetworkedMultiplayerPeer[/code] is refusing new connections. </description> </method> <method name="poll"> @@ -46,7 +46,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - If [code]endable[/code] is true, this [NetworkedMultiplayerPeer] will refuse new connections. + If [code]endable[/code] is true, this [code]NetworkedMultiplayerPeer[/code] will refuse new connections. </description> </method> <method name="set_target_peer"> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index a484556e69..7ec4bbb8b5 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -13,7 +13,7 @@ Nodes can also process input events. When set, the [method _input] function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the [method _unhandled_input] function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI [Control] nodes), ensuring that the node only receives the events that were meant for it. To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with [method set_owner]. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed with [method free] or [method queue_free], it will also free all its children. - [b]Networking with nodes:[/b] After connecting to a server (or making one, see [NetworkedMultiplayerENet]) it is possible to use the built-in RPC (remote procedure call) system to easily communicate over the network. By calling [method rpc] with a method name, it will be called locally, and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode ([method set_network_mode]) on the receiving peer. To identify which [Node] receives the RPC call Godot will use its [NodePath] (make sure node names are the same on all peers). + [b]Networking with nodes:[/b] After connecting to a server (or making one, see [NetworkedMultiplayerENet]) it is possible to use the built-in RPC (remote procedure call) system to easily communicate over the network. By calling [method rpc] with a method name, it will be called locally, and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode ([method set_network_mode]) on the receiving peer. To identify which [code]Node[/code] receives the RPC call Godot will use its [NodePath] (make sure node names are the same on all peers). </description> <tutorials> </tutorials> @@ -100,7 +100,7 @@ <argument index="1" name="legible_unique_name" type="bool" default="false"> </argument> <description> - Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. + Add a child [code]Node[/code]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. The optional boolean argument enforces creating child nodes with human-readable names, based on the name of the node being instanced instead of its type only. </description> </method> @@ -124,7 +124,7 @@ <argument index="1" name="persistent" type="bool" default="false"> </argument> <description> - Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example "enemies" or "collectables". A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]). + Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example "enemies" or "collectables". A [code]Node[/code] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]). </description> </method> <method name="can_process" qualifiers="const"> @@ -140,7 +140,7 @@ <argument index="0" name="flags" type="int" default="15"> </argument> <description> - Duplicate the node, returning a new [Node]. + Duplicate the node, returning a new [code]Node[/code]. You can fine-tune the behavior using the [code]flags[/code], which are based on the DUPLICATE_* constants. </description> </method> @@ -177,7 +177,7 @@ <return type="Array"> </return> <description> - Return an array of references ([Node]) to the child nodes. + Return an array of references ([code]Node[/code]) to the child nodes. </description> </method> <method name="get_filename" qualifiers="const"> @@ -261,7 +261,7 @@ <return type="Node"> </return> <description> - Return the parent node of the current node, or an empty [Node] if the node lacks a parent. + Return the parent node of the current node, or an empty [code]Node[/code] if the node lacks a parent. </description> </method> <method name="get_path" qualifiers="const"> @@ -470,7 +470,7 @@ <argument index="2" name="parent_first" type="bool" default="false"> </argument> <description> - Calls the method (if present) with the arguments given in "args" on this Node and recursively on all children. If the parent_first argument is true then the method will be called on the current [Node] first, then on all children. If it is false then the children will get called first. + Calls the method (if present) with the arguments given in "args" on this Node and recursively on all children. If the parent_first argument is true then the method will be called on the current [code]Node[/code] first, then on all children. If it is false then the children will get called first. </description> </method> <method name="propagate_notification"> @@ -509,7 +509,7 @@ <argument index="0" name="node" type="Node"> </argument> <description> - Remove a child [Node]. Node is NOT deleted and will have to be deleted manually. + Remove a child [code]Node[/code]. Node is NOT deleted and will have to be deleted manually. </description> </method> <method name="remove_from_group"> @@ -672,7 +672,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Set the name of the [Node]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. + Set the name of the [code]Node[/code]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. </description> </method> <method name="set_network_master"> @@ -806,6 +806,10 @@ </constant> <constant name="NOTIFICATION_READY" value="13" enum=""> </constant> + <constant name="NOTIFICATION_PAUSED" value="14" enum=""> + </constant> + <constant name="NOTIFICATION_UNPAUSED" value="15" enum=""> + </constant> <constant name="NOTIFICATION_PHYSICS_PROCESS" value="16" enum=""> Notification received every frame when the physics process flag is set (see [method set_physics_process]). </constant> @@ -818,10 +822,6 @@ <constant name="NOTIFICATION_UNPARENTED" value="19" enum=""> Notification received when a node is unparented (parent removed it from the list of children). </constant> - <constant name="NOTIFICATION_PAUSED" value="14" enum=""> - </constant> - <constant name="NOTIFICATION_UNPAUSED" value="15" enum=""> - </constant> <constant name="NOTIFICATION_INSTANCED" value="20" enum=""> </constant> <constant name="NOTIFICATION_DRAG_BEGIN" value="21" enum=""> 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/NodePath.xml b/doc/classes/NodePath.xml index 9aa9572b80..ba2145482f 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -5,8 +5,8 @@ </brief_description> <description> A pre-parsed relative or absolute path in a scene tree, for use with [method Node.get_node] and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, [code]"Path2D/PathFollow2D/Sprite:texture:size"[/code] would refer to the size property of the texture resource on the node named "Sprite" which is a child of the other named nodes in the path. Note that if you want to get a resource, you must end the path with a colon, otherwise the last element will be used as a property name. - You will usually just pass a string to [method Node.get_node] and it will be automatically converted, but you may occasionally want to parse a path ahead of time with [NodePath] or the literal syntax [code]@"path"[/code]. Exporting a [NodePath] variable will give you a node selection widget in the properties panel of the editor, which can often be useful. - A [NodePath] is made up of a list of node names, a list of "subnode" (resource) names, and the name of a property in the final node or resource. + You will usually just pass a string to [method Node.get_node] and it will be automatically converted, but you may occasionally want to parse a path ahead of time with [code]NodePath[/code] or the literal syntax [code]@"path"[/code]. Exporting a [code]NodePath[/code] variable will give you a node selection widget in the properties panel of the editor, which can often be useful. + A [code]NodePath[/code] is made up of a list of node names, a list of "subnode" (resource) names, and the name of a property in the final node or resource. </description> <tutorials> </tutorials> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index abb0dc4f2d..08ea23f05a 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -46,7 +46,7 @@ <return type="void"> </return> <description> - Clear all the items in the [OptionButton]. + Clear all the items in the [code]OptionButton[/code]. </description> </method> <method name="get_item_count" qualifiers="const"> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 9bff0c9b5e..1d2241b580 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -4,7 +4,7 @@ UDP packet peer. </brief_description> <description> - UDP packet peer. Can be used to send raw UDP packets as well as [Variant]\ s. + UDP packet peer. Can be used to send raw UDP packets as well as [Variant]s. </description> <tutorials> </tutorials> @@ -15,7 +15,7 @@ <return type="void"> </return> <description> - Close the UDP socket the [PacketPeerUDP] is currently listening on. + Close the UDP socket the [code]PacketPeerUDP[/code] is currently listening on. </description> </method> <method name="get_packet_ip" qualifiers="const"> @@ -36,7 +36,7 @@ <return type="bool"> </return> <description> - Return whether this [PacketPeerUDP] is listening. + Return whether this [code]PacketPeerUDP[/code] is listening. </description> </method> <method name="listen"> @@ -49,7 +49,7 @@ <argument index="2" name="recv_buf_size" type="int" default="65536"> </argument> <description> - Make this [PacketPeerUDP] listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". + Make this [code]PacketPeerUDP[/code] listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". If "bind_address" is set as "*" (default), the peer will listen on all available addresses (both IPv4 and IPv6). If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the peer will listen on all available addresses matching that IP type. If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). 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..8de7e05578 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/Performance.xml b/doc/classes/Performance.xml index 2dc3aa239b..82ee3531f1 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -77,8 +77,6 @@ <constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16"> Draw calls per frame. 3D only. </constant> - <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20"> - </constant> <constant name="RENDER_VIDEO_MEM_USED" value="17"> Video memory used. Includes both texture and vertex memory. </constant> @@ -88,6 +86,8 @@ <constant name="RENDER_VERTEX_MEM_USED" value="19"> Vertex memory used. </constant> + <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20"> + </constant> <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21"> Number of active [RigidBody2D] nodes in the game. </constant> diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml index 9399227d27..b15d4dfd54 100644 --- a/doc/classes/Physics2DDirectSpaceState.xml +++ b/doc/classes/Physics2DDirectSpaceState.xml @@ -70,7 +70,7 @@ collider_id: Id of the object the point is in. collider: Object the point is inside of. rid: [RID] of the object the point is in. - Additionally, the method can take an array of objects or [RID]\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). </description> </method> <method name="intersect_ray"> @@ -96,7 +96,7 @@ collider: Object against which the ray was stopped. rid: [RID] of the object against which the ray was stopped. If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. - Additionally, the method can take an array of objects or [RID]\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). </description> </method> <method name="intersect_shape"> @@ -130,11 +130,11 @@ <constant name="TYPE_MASK_CHARACTER_BODY" value="8"> Check for collisions with rigid bodies in character mode. </constant> - <constant name="TYPE_MASK_AREA" value="16"> - Check for collisions with areas. - </constant> <constant name="TYPE_MASK_COLLISION" value="15"> Check for collisions with any kind of bodies (but not areas). </constant> + <constant name="TYPE_MASK_AREA" value="16"> + Check for collisions with areas. + </constant> </constants> </class> diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index edc46a53d0..6e3381c200 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -978,6 +978,8 @@ <constant name="SHAPE_LINE" value="0"> This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks. </constant> + <constant name="SHAPE_RAY" value="1"> + </constant> <constant name="SHAPE_SEGMENT" value="2"> This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections. </constant> diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index d838ff2317..04fe12cc07 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -22,7 +22,7 @@ <return type="Array"> </return> <description> - Return the list of objects, or object [RID]\ s, that will be excluded from collisions. + Return the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> <method name="get_margin" qualifiers="const"> @@ -75,7 +75,7 @@ <argument index="0" name="exclude" type="Array"> </argument> <description> - Set the list of objects, or object [RID]\ s, that will be excluded from collisions. + Set the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> <method name="set_margin"> diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml index 1e4354fa7e..01307b92c7 100644 --- a/doc/classes/PhysicsDirectSpaceState.xml +++ b/doc/classes/PhysicsDirectSpaceState.xml @@ -73,9 +73,9 @@ </constant> <constant name="TYPE_MASK_CHARACTER_BODY" value="8"> </constant> - <constant name="TYPE_MASK_AREA" value="16"> - </constant> <constant name="TYPE_MASK_COLLISION" value="15"> </constant> + <constant name="TYPE_MASK_AREA" value="16"> + </constant> </constants> </class> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 12c1abccc6..b0f42b83a3 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -376,14 +376,15 @@ </argument> <description> Returns the physics layer or layers a body can collide with. -- </description> -- </method> -- <method name="body_get_direct_state"> -- <return type="PhysicsDirectBodyState"> -- </return> -- <argument index="0" name="body" type="RID"> -- </argument> -- <description> +- + </description> + </method> + <method name="body_get_direct_state"> + <return type="PhysicsDirectBodyState"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> Returns the [PhysicsDirectBodyState] of the body. </description> </method> @@ -534,7 +535,7 @@ <argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxisLock"> </argument> <description> - Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. + Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. </description> </method> <method name="body_set_axis_velocity"> @@ -746,7 +747,7 @@ </argument> <argument index="2" name="flag" type="int" enum="PhysicsServer.G6DOFJointAxisFlag"> </argument> - <description> + <description> Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants). </description> </method> @@ -1436,12 +1437,12 @@ <constant name="BODY_PARAM_GRAVITY_SCALE" value="3"> Constant to set/get a body's gravity multiplier. </constant> - <constant name="BODY_PARAM_ANGULAR_DAMP" value="5"> - Constant to set/get a body's angular dampening factor. - </constant> <constant name="BODY_PARAM_LINEAR_DAMP" value="4"> Constant to set/get a body's linear dampening factor. </constant> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="5"> + Constant to set/get a body's angular dampening factor. + </constant> <constant name="BODY_PARAM_MAX" value="6"> This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. </constant> diff --git a/doc/classes/PluginScript.xml b/doc/classes/PluginScript.xml new file mode 100644 index 0000000000..334921016b --- /dev/null +++ b/doc/classes/PluginScript.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PluginScript" inherits="Script" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 2640b5118f..9ef5390c5e 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -31,7 +31,7 @@ <argument index="0" name="array" type="PoolByteArray"> </argument> <description> - Append a [PoolByteArray] at the end of this array. + Append a [code]PoolByteArray[/code] at the end of this array. </description> </method> <method name="compress"> @@ -40,7 +40,7 @@ <argument index="0" name="compression_mode" type="int" default="0"> </argument> <description> - Returns a new [PoolByteArray] with the data compressed. Set the compression mode using one of [File]'s COMPRESS_* constants. + Returns a new [code]PoolByteArray[/code] with the data compressed. Set the compression mode using one of [File]'s COMPRESS_* constants. </description> </method> <method name="decompress"> @@ -51,7 +51,7 @@ <argument index="1" name="compression_mode" type="int" default="0"> </argument> <description> - Returns a new [PoolByteArray] with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of [File]'s COMPRESS_* constants. + Returns a new [code]PoolByteArray[/code] with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of [File]'s COMPRESS_* constants. </description> </method> <method name="get_string_from_ascii"> @@ -129,7 +129,7 @@ <argument index="1" name="to" type="int"> </argument> <description> - Returns the slice of the [PoolByteArray] between indices (inclusive) as a new [PoolByteArray]. Any negative index is considered to be from the end of the array. + Returns the slice of the [code]PoolByteArray[/code] between indices (inclusive) as a new [code]PoolByteArray[/code]. Any negative index is considered to be from the end of the array. </description> </method> </methods> diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index 644256e765..70503a67b9 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -31,7 +31,7 @@ <argument index="0" name="array" type="PoolColorArray"> </argument> <description> - Append a [PoolColorArray] at the end of this array. + Append a [code]PoolColorArray[/code] at the end of this array. </description> </method> <method name="insert"> diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index 17772b6e2a..5caa8add1e 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -31,7 +31,7 @@ <argument index="0" name="array" type="PoolIntArray"> </argument> <description> - Append an [PoolIntArray] at the end of this array. + Append an [code]PoolIntArray[/code] at the end of this array. </description> </method> <method name="insert"> diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index e5df38483a..fbfdb11825 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -17,7 +17,7 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new [PoolVector2Array]. Optionally, you can pass in an Array that will be converted. + Construct a new [code]PoolVector2Array[/code]. Optionally, you can pass in an Array that will be converted. </description> </method> <method name="append"> @@ -31,7 +31,7 @@ <argument index="0" name="array" type="PoolVector2Array"> </argument> <description> - Append an [PoolVector2Array] at the end of this array. + Append an [code]PoolVector2Array[/code] at the end of this array. </description> </method> <method name="insert"> diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index 13a8290531..e5e2924273 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -31,7 +31,7 @@ <argument index="0" name="array" type="PoolVector3Array"> </argument> <description> - Append an [PoolVector3Array] at the end of this array. + Append an [code]PoolVector3Array[/code] at the end of this array. </description> </method> <method name="insert"> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index f07e143aa0..d351cdfbc0 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 3782a98e3e..fc96a183eb 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -78,11 +78,11 @@ [/codeblock] </description> </method> - <method name="get_collision_layer" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Returns the collision layer for this ray. + Returns the collision mask for this ray. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -147,13 +147,13 @@ Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]. </description> </method> - <method name="set_collision_layer"> + <method name="set_collision_mask"> <return type="void"> </return> - <argument index="0" name="layer" type="int"> + <argument index="0" name="mask" type="int"> </argument> <description> - Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + 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_enabled"> @@ -179,8 +179,8 @@ <member name="cast_to" type="Vector3" setter="set_cast_to" getter="get_cast_to"> The ray's destination point, relative to the RayCast's [code]position[/code]. </member> - <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> - The RayCast's collision layer(s). Only bodies in the same collision layer(s) will be detected. + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 74ee0a8911..8fef07a859 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -77,11 +77,11 @@ [/codeblock] </description> </method> - <method name="get_collision_layer" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Returns the collision layer for this ray. + Returns the collision mask for this ray. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -153,13 +153,13 @@ Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] </description> </method> - <method name="set_collision_layer"> + <method name="set_collision_mask"> <return type="void"> </return> - <argument index="0" name="layer" type="int"> + <argument index="0" name="mask" type="int"> </argument> <description> - Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + 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_enabled"> @@ -194,8 +194,8 @@ <member name="cast_to" type="Vector2" setter="set_cast_to" getter="get_cast_to"> The ray's destination point, relative to the RayCast's [code]position[/code]. </member> - <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> - The RayCast2D's collision layer(s). Only bodies in the same collision layer(s) will be detected. + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 80f7830a16..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 [Rect2] 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 [Rect2] by x, y, width and height. + Constructs a [code]Rect2[/code] by x, y, width, and height. </description> </method> <method name="clip"> @@ -43,7 +43,7 @@ <argument index="0" name="b" type="Rect2"> </argument> <description> - Returns the intersection of this [Rect2] and b. + Returns the intersection of this [code]Rect2[/code] and b. </description> </method> <method name="encloses"> @@ -52,7 +52,7 @@ <argument index="0" name="b" type="Rect2"> </argument> <description> - Returns true if this [Rect2] 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 [Rect2] 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 [Rect2]. + 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 [Rect2] 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 [Rect2] 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 [Rect2] 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 [Rect2] 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 [Rect2] 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 f41665db34..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 [Rect3] 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 [Rect3] 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 [Rect3]. + 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 [Rect3] 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 [Rect3]. + 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 [Rect3] (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 [Rect3]. + 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 [Rect3]. + 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 [Rect3] (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 [Rect3]. + 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 [Rect3] 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 [Rect3] 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 [Rect3] 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 [Rect3] 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 [Rect3]. 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 [Rect3] 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 [Rect3] 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 [Rect3] 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 [Rect3] 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/Resource.xml b/doc/classes/Resource.xml index 57497f5d78..7767b26988 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -81,7 +81,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [Resource] already has path "path". + Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [code]Resource[/code] already has path "path". </description> </method> <method name="setup_local_to_scene"> @@ -96,7 +96,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing. + Set the path of the resource. Differs from set_path(), if another [code]Resource[/code] exists with "path" it over-takes it, instead of failing. </description> </method> </methods> diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 6558a388c8..9fb3c71a5b 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -4,7 +4,7 @@ Resource Loader. </brief_description> <description> - Resource Loader. This is a static object accessible as [ResourceLoader]. GDScript has a simplified load() function, though. + Resource Loader. This is a static object accessible as [code]ResourceLoader[/code]. GDScript has a simplified load() function, though. </description> <tutorials> </tutorials> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 9f8cdcce6d..c28a2b26b4 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -102,6 +102,12 @@ <description> </description> </method> + <method name="is_overriding_selected_font_color" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_scroll_active" qualifiers="const"> <return type="bool"> </return> @@ -247,6 +253,14 @@ <description> </description> </method> + <method name="set_override_selected_font_color"> + <return type="void"> + </return> + <argument index="0" name="override" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_percent_visible"> <return type="void"> </return> @@ -330,6 +344,8 @@ </member> <member name="bbcode_text" type="String" setter="set_bbcode" getter="get_bbcode"> </member> + <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color"> + </member> <member name="percent_visible" type="float" setter="set_percent_visible" getter="get_percent_visible"> </member> <member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters"> @@ -378,6 +394,8 @@ </constant> <constant name="ITEM_LIST" value="9"> </constant> + <constant name="ITEM_TABLE" value="10"> + </constant> <constant name="ITEM_META" value="11"> </constant> </constants> diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index 76a93248fb..f9488d2f7f 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -430,18 +430,18 @@ </signal> </signals> <constants> - <constant name="MODE_STATIC" value="1"> - Static mode. The body behaves like a [StaticBody], and can only move by user code. - </constant> - <constant name="MODE_KINEMATIC" value="3"> - Kinematic body. The body behaves like a [KinematicBody], and can only move by user code. - </constant> <constant name="MODE_RIGID" value="0"> Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. </constant> + <constant name="MODE_STATIC" value="1"> + Static mode. The body behaves like a [StaticBody], and can only move by user code. + </constant> <constant name="MODE_CHARACTER" value="2"> Character body. This behaves like a rigid body, but can not rotate. </constant> + <constant name="MODE_KINEMATIC" value="3"> + Kinematic body. The body behaves like a [KinematicBody], and can only move by user code. + </constant> <constant name="AXIS_LOCK_DISABLED" value="0"> </constant> <constant name="AXIS_LOCK_X" value="1"> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index a4faa697de..e0ca6084e6 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -1,14 +1,17 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="RigidBody2D" inherits="PhysicsBody2D" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Physics Body whose position is determined through physics simulation in 2D space. + A body that is controlled by the 2D physics engine. </brief_description> <description> - This is the node that implements full 2D physics. This means that you do not control a RigidBody2D directly. Instead you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. - This node can use custom force integration, for writing complex physics motion behavior per node. - This node can shift state between regular Rigid body, Kinematic, Character or Static. - Character mode forbids this node from being rotated. - As a warning, don't change RigidBody2D's position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. + This node implements simulated 2D physics. You do not control a RigidBody2D directly. Instead you apply forces to it (gravity, impulses, etc.) and the physics simulation calculates the resulting movement based on its mass, friction, and other physical properties. + A RigidBody2D has 4 behavior modes (see [member mode]): + - [b]Rigid[/b]: The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode. + - [b]Static[/b]: The body behaves like a [StaticBody2D] and does not move. + - [b]Character[/b]: Similar to [code]Rigid[/code] mode, but the body can not rotate. + - [b]Kinematic[/b]: The body behaves like a [KinematicBody2D], and must be moved by code. + [b]Note:[/b] You should not change a RigidBody2D's [code]position[/code] or [code]linear_velocity[/code] every frame or even very often. If you need to directly affect the body's state, use [method _integrate_forces], which allows you to directly access the physics state. + If you need to override the default physics behavior, you can write a custom force integration. See [member custom_integrator]. </description> <tutorials> </tutorials> @@ -21,7 +24,7 @@ <argument index="0" name="state" type="Physics2DDirectBodyState"> </argument> <description> - Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. + Allows you to read and safely modify the simulation state for the object. Use this instead of [Node._physics_process] if you need to directly change the body's [code]position[/code] or other physics properties. By default it works in addition to the usual physics behavior, but [member custom_integrator] allows you to disable the default behavior and write custom force integration for a body. </description> </method> <method name="add_force"> @@ -32,7 +35,7 @@ <argument index="1" name="force" type="Vector2"> </argument> <description> - Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates. + Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. </description> </method> <method name="apply_impulse"> @@ -43,7 +46,7 @@ <argument index="1" name="impulse" type="Vector2"> </argument> <description> - Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. + Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates. </description> </method> <method name="get_angular_damp" qualifiers="const"> @@ -64,14 +67,14 @@ <return type="Vector2"> </return> <description> - Return the applied force vector. + Returns the body's total applied force. </description> </method> <method name="get_applied_torque" qualifiers="const"> <return type="float"> </return> <description> - Return the torque which is being applied to this body. + Returns the body's total applied torque. </description> </method> <method name="get_bounce" qualifiers="const"> @@ -85,7 +88,7 @@ <return type="Array"> </return> <description> - Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. You must also enable contact monitor, see [method set_contact_monitor] + Returns a list of the bodies colliding with this one. Use [member contacts_reported] to set the maximum number reported. You must also set [member contact_monitor] to [code]true[/code]. </description> </method> <method name="get_continuous_collision_detection_mode" qualifiers="const"> @@ -113,7 +116,7 @@ <return type="float"> </return> <description> - Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet. + Returns the body's moment of inertia, which is computed automatically from the body's mass and assigned [Shape2D]s during the physics frame. Note that it will not yet have a value in the [code]_ready()[/code] function. </description> </method> <method name="get_linear_damp" qualifiers="const"> @@ -127,7 +130,7 @@ <return type="Vector2"> </return> <description> - Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity]. + Returns the body's linear velocity. This changes when a physics frame has passed, not during a normal update. See [method set_linear_velocity]. </description> </method> <method name="get_mass" qualifiers="const"> @@ -210,7 +213,7 @@ <argument index="0" name="force" type="Vector2"> </argument> <description> - Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly. + Sets the applied force vector. This is the equivalent of firing a rocket: the force is applied constantly. </description> </method> <method name="set_applied_torque"> @@ -219,7 +222,7 @@ <argument index="0" name="torque" type="float"> </argument> <description> - Set a constant torque which will be applied to this body. + Sets the applied torque. </description> </method> <method name="set_axis_velocity"> @@ -228,7 +231,7 @@ <argument index="0" name="axis_velocity" type="Vector2"> </argument> <description> - Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. + Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="set_bounce"> @@ -378,59 +381,59 @@ <argument index="2" name="result" type="Physics2DTestMotionResult" default="null"> </argument> <description> - Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one). + Returns [code]true[/code] if a collision would result from moving in the given vector. [code]margin[/code] increases the size of the shapes involved in the collision detection, and [code]result[/code] is an object of type [Physics2DTestMotionResult], which contains additional information about the collision (should there be one). </description> </method> </methods> <members> <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp"> - Damps RigidBody2D's rotational forces. + Damps the body's [member angular_velocity]. If [code]-1[/code] the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: [code]-1[/code]. </member> <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity"> - RigidBody2D's rotational velocity. + The body's rotational velocity. </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> - RigidBody2D's bounciness. + The body's bounciness. Default value: [code]0[/code]. </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep"> - If [code]true[/code] RigidBody2D will not calculate forces and will act as a static body while there is no movement. It will wake up when other forces are applied through other collisions or when the [code]apply_impulse[/code] method is used. Default value: [code]true[/code] + If [code]true[/code] the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using [method apply_impulse] or [method add_force]. Default value: [code]true[/code]. </member> <member name="contact_monitor" type="bool" setter="set_contact_monitor" getter="is_contact_monitor_enabled"> - If [code]true[/code] RigidBody2D will emit signals when it collides with another RigidBody2D. + If [code]true[/code] the body will emit signals when it collides with another RigidBody2D. See also [member contacts_reported]. Default value: [code]false[/code]. </member> <member name="contacts_reported" type="int" setter="set_max_contacts_reported" getter="get_max_contacts_reported"> - The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. + The maximum number of contacts to report. Default value: [code]0[/code]. </member> <member name="continuous_cd" type="int" setter="set_continuous_collision_detection_mode" getter="get_continuous_collision_detection_mode" enum="RigidBody2D.CCDMode"> - If [code]true[/code] continuous collision detection is used. Default value: [code]false[/code] - Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses less impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. + Continuous collision detection mode. Default value: [code]CCD_MODE_DISABLED[/code]. + Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See [code]CCD_MODE_[/code] constants for details. </member> <member name="custom_integrator" type="bool" setter="set_use_custom_integrator" getter="is_using_custom_integrator"> - If [code]true[/code] internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. + If [code]true[/code] internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the [method _integrate_forces] function. </member> <member name="friction" type="float" setter="set_friction" getter="get_friction"> - The body friction, from 0 (frictionless) to 1 (max friction). + The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). Default value: [code]1[/code]. </member> <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale"> - This is multiplied by the global 2D gravity setting found in "Project > Project Settings > Physics > 2d" to produce RigidBody2D's gravity. E.g. a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. + Multiplies the gravity applied to the body. The body's gravity is calculated from the "Default Gravity" value in "Project > Project Settings > Physics > 2d" and/or any additional gravity vector applied by [Area2D]s. Default value: [code]1[/code]. </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp"> - RigidBody2D's linear damp. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. + Damps the body's [member linear_velocity]. If [code]-1[/code] the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: [code]-1[/code]. </member> <member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity"> - RigidBody2D's linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. + The body's linear velocity. </member> <member name="mass" type="float" setter="set_mass" getter="get_mass"> - RigidBody2D's mass. + The body's mass. Default value: [code]1[/code]. </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="RigidBody2D.Mode"> - The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. + The body's mode. See [code]MODE_*[/code] constants. Default value: [code]MODE_RIGID[/code]. </member> <member name="sleeping" type="bool" setter="set_sleeping" getter="is_sleeping"> - If [code]true[/code] RigidBody2D is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method. + If [code]true[/code] the body is sleeping and will not calculate forces until woken up by a collision or by using [method apply_impulse] or [method add_force]. </member> <member name="weight" type="float" setter="set_weight" getter="get_weight"> - RigidBody2D's weight based on its mass and the global 2D gravity. Global values are set in "Project > Project Settings > Physics > 2d". + The body's weight based on its mass and the "Default Gravity" value in "Project > Project Settings > Physics > 2d". </member> </members> <signals> @@ -438,14 +441,14 @@ <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code]. </description> </signal> <signal name="body_exited"> <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body exits contact with this one. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code]. </description> </signal> <signal name="body_shape_entered"> @@ -458,8 +461,7 @@ <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. - This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. + Emitted when a body enters into contact with this one. Reports colliding shape information. See [CollisionObject2D] for shape index information. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code]. </description> </signal> <signal name="body_shape_exited"> @@ -472,37 +474,36 @@ <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. - This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. + Emitted when a body shape exits contact with this one. Reports colliding shape information. See [CollisionObject2D] for shape index information. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code]. </description> </signal> <signal name="sleeping_state_changed"> <description> - Emitted when the body changes its sleeping state. Either by sleeping or waking up. + Emitted when [member sleeping] changes. </description> </signal> </signals> <constants> - <constant name="MODE_STATIC" value="1"> - Static mode. The body behaves like a [StaticBody2D], and can only move by user code. - </constant> - <constant name="MODE_KINEMATIC" value="3"> - Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code. - </constant> <constant name="MODE_RIGID" value="0"> - Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. + Rigid mode. The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode. + </constant> + <constant name="MODE_STATIC" value="1"> + Static mode. The body behaves like a [StaticBody2D] and does not move. </constant> <constant name="MODE_CHARACTER" value="2"> - Character body. This behaves like a rigid body, but can not rotate. + Character mode. Similar to [code]MODE_RIGID[/code], but the body can not rotate. + </constant> + <constant name="MODE_KINEMATIC" value="3"> + Kinematic mode. The body behaves like a [KinematicBody2D], and must be moved by code. </constant> <constant name="CCD_MODE_DISABLED" value="0"> - Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. + Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. </constant> <constant name="CCD_MODE_CAST_RAY" value="1"> - Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. + Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise. </constant> <constant name="CCD_MODE_CAST_SHAPE" value="2"> - Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. + Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise. </constant> </constants> </class> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index fd32f35a06..f6a6ce36e3 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -313,7 +313,7 @@ </argument> <argument index="2" name="minsize" type="Vector2"> </argument> - <argument index="3" name="shrink" type="int" default="1"> + <argument index="3" name="shrink" type="float" default="1"> </argument> <description> </description> @@ -352,6 +352,12 @@ <description> </description> </signal> + <signal name="node_added"> + <argument index="0" name="node" type="Object"> + </argument> + <description> + </description> + </signal> <signal name="node_configuration_warning_changed"> <argument index="0" name="node" type="Object"> </argument> diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index 0aeb6472af..c9c8ac0298 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -15,14 +15,14 @@ <return type="int" enum="Error"> </return> <description> - Lowers the [Semaphore], allowing one more thread in. + Lowers the [code]Semaphore[/code], allowing one more thread in. </description> </method> <method name="wait"> <return type="int" enum="Error"> </return> <description> - Tries to wait for the [Semaphore], if its value is zero, blocks until non-zero. + Tries to wait for the [code]Semaphore[/code], if its value is zero, blocks until non-zero. </description> </method> </methods> diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index abb0bfa246..38e971b6bd 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -29,7 +29,7 @@ <return type="Spatial"> </return> <description> - Returns the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial]. + Returns the parent [code]Spatial[/code], or an empty [Object] if no parent exists or parent is not of type [code]Spatial[/code]. </description> </method> <method name="get_rotation" qualifiers="const"> diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index 2fdd4b07d5..077de3dc3c 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -43,7 +43,7 @@ <return type="int"> </return> <description> - Return the amount of bytes this [StreamPeer] has available. + Return the amount of bytes this [code]StreamPeer[/code] has available. </description> </method> <method name="get_data"> @@ -135,7 +135,7 @@ <return type="bool"> </return> <description> - Return whether this [StreamPeer] is using big-endian format. + Return whether this [code]StreamPeer[/code] is using big-endian format. </description> </method> <method name="put_16"> @@ -270,7 +270,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Set this [StreamPeer] to use big-endian format. Default is false. + Set this [code]StreamPeer[/code] to use big-endian format. Default is false. </description> </method> </methods> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 7a2843ff47..5eb3f551f4 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -29,7 +29,7 @@ <argument index="2" name="for_hostname" type="String" default=""""> </argument> <description> - Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". + Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [code]StreamPeerSSL[/code] will validate that the certificate presented by the peer matches the "for_hostname". </description> </method> <method name="disconnect_from_stream"> @@ -49,10 +49,10 @@ </methods> <constants> <constant name="STATUS_DISCONNECTED" value="0"> - A status representing a [StreamPeerSSL] that is disconnected. + A status representing a [code]StreamPeerSSL[/code] that is disconnected. </constant> <constant name="STATUS_CONNECTED" value="1"> - A status representing a [StreamPeerSSL] that is connected to a host. + A status representing a [code]StreamPeerSSL[/code] that is connected to a host. </constant> <constant name="STATUS_ERROR_NO_CERTIFICATE" value="2"> An errot status that shows the peer did not present a SSL certificate and validation was requested. diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 3b2af330b3..9b7cd91ea5 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -59,16 +59,16 @@ </methods> <constants> <constant name="STATUS_NONE" value="0"> - The initial status of the [StreamPeerTCP], also the status after a disconnect. + The initial status of the [code]StreamPeerTCP[/code], also the status after a disconnect. </constant> <constant name="STATUS_CONNECTING" value="1"> - A status representing a [StreamPeerTCP] that is connecting to a host. + A status representing a [code]StreamPeerTCP[/code] that is connecting to a host. </constant> <constant name="STATUS_CONNECTED" value="2"> - A status representing a [StreamPeerTCP] that is connected to a host. + A status representing a [code]StreamPeerTCP[/code] that is connected to a host. </constant> <constant name="STATUS_ERROR" value="3"> - A staus representing a [StreamPeerTCP] in error state. + A staus representing a [code]StreamPeerTCP[/code] in error state. </constant> </constants> </class> 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/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index 756b7f9225..eb9f82af6c 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -202,7 +202,7 @@ </argument> <argument index="1" name="radius_top_right" type="int"> </argument> - <argument index="2" name="radius_botton_right" type="int"> + <argument index="2" name="radius_bottom_right" type="int"> </argument> <argument index="3" name="radius_bottom_left" type="int"> </argument> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 1e91ee402b..987a725977 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -4,7 +4,7 @@ Helper tool to create geometry. </brief_description> <description> - The [SurfaceTool] is used to construct a [Mesh] by specifying vertex attributes individually. It can be used to construct a [Mesh] from script. All properties except index need to be added before a call to [method add_vertex]. For example adding vertex colors and UVs looks like + The [code]SurfaceTool[/code] is used to construct a [Mesh] by specifying vertex attributes individually. It can be used to construct a [Mesh] from script. All properties except index need to be added before a call to [method add_vertex]. For example adding vertex colors and UVs looks like [codeblock] var st = SurfaceTool.new() st.begin(Mesh.PRIMITIVE_TRIANGLES) @@ -12,7 +12,7 @@ st.add_uv(Vector2(0, 0)) st.add_vertex(Vector3(0, 0, 0)) [/codeblock] - The [SurfaceTool] now contains one vertex of a triangle which has a UV coordinate and a specified [Color]. If another vertex were added without calls to [method add_uv] or [method add_color] then the last values would be used. + The [code]SurfaceTool[/code] now contains one vertex of a triangle which has a UV coordinate and a specified [Color]. If another vertex were added without calls to [method add_uv] or [method add_color] then the last values would be used. It is very important that vertex attributes are passed [b]before[/b] the call to [method add_vertex], failure to do this will result in an error when committing the vertex information to a mesh. </description> <tutorials> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index ad02064862..a7dd86a459 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -4,8 +4,10 @@ Tabbed Container. </brief_description> <description> - Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking on the top tabs allows to change the currently visible one. - Children controls of this one automatically. + Sets the active tab's [code]visible[/code] property to the value [code]true[/code]. Sets all other children's to [code]false[/code]. + Ignores non-[Control] children. + Individual tabs are always visible unless you use [method set_tab_disabled] and [method set_tab_title] to hide it. + To hide only a tab's content, nest the content inside a child [Control], so it receives the [code]TabContainer[/code]'s visibility setting instead. </description> <tutorials> </tutorials> @@ -23,33 +25,35 @@ <return type="int"> </return> <description> - Returns the current tab index that is being shown. + Returns the currently visible tab's index. </description> </method> <method name="get_current_tab_control" qualifiers="const"> <return type="Control"> </return> <description> + Returns the child [Control] node located at the active tab index. </description> </method> <method name="get_popup" qualifiers="const"> <return type="Popup"> </return> <description> + Returns the [Popup] node instance if one has been set already with [method set_popup]. </description> </method> <method name="get_previous_tab" qualifiers="const"> <return type="int"> </return> <description> - Returns the previous tab index that was being shown. + Returns the previously active tab index. </description> </method> <method name="get_tab_align" qualifiers="const"> <return type="int" enum="TabContainer.TabAlign"> </return> <description> - Returns the tab alignment.See the ALIGN_* constants. + Returns the tab alignment. See the [code]ALIGN_*[/code] constants. </description> </method> <method name="get_tab_control" qualifiers="const"> @@ -58,14 +62,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the current tab control that is being shown. + Returns the currently visible tab's [Control] node. </description> </method> <method name="get_tab_count" qualifiers="const"> <return type="int"> </return> <description> - Returns the amount of tabs. + Returns the number of tabs. </description> </method> <method name="get_tab_disabled" qualifiers="const"> @@ -92,7 +96,7 @@ <argument index="0" name="tab_idx" type="int"> </argument> <description> - Returns the title for the tab at index [code]tab_idx[/code]. Tab titles are by default the children node name, but this can be overridden. + Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. </description> </method> <method name="set_current_tab"> @@ -101,7 +105,7 @@ <argument index="0" name="tab_idx" type="int"> </argument> <description> - Bring a tab (and the Control it represents) to the front, and hide the rest. + Sets to [code]false[/code] the [code]visible[/code] property for all [Control] children except for the tab at [code]tab_idx[/code]. </description> </method> <method name="set_popup"> @@ -110,6 +114,7 @@ <argument index="0" name="popup" type="Node"> </argument> <description> + If set on a [Popup] node instance, a popup menu icon appears in the top-right corner of the [code]TabContainer[/code]. Clicking it will expand the [Popup] node. </description> </method> <method name="set_tab_align"> @@ -118,7 +123,7 @@ <argument index="0" name="align" type="int" enum="TabContainer.TabAlign"> </argument> <description> - Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. + Sets tab alignment, from the [code]ALIGN_*[/code] constants. Moves tabs to the left, right, or center. </description> </method> <method name="set_tab_disabled"> @@ -129,7 +134,7 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> - Set tab at index [code]tab_idx[/code] disabled. + If [code]disabled[/code] is false, hides the tab at index [code]tab_idx[/code]. Note that its title text will remain, unless also removed with [method set_tab_title]. </description> </method> <method name="set_tab_icon"> @@ -140,7 +145,7 @@ <argument index="1" name="icon" type="Texture"> </argument> <description> - Set an icon for a tab at index [code]tab_idx[/code]. + Sets an icon for the tab at index [code]tab_idx[/code]. </description> </method> <method name="set_tab_title"> @@ -151,7 +156,7 @@ <argument index="1" name="title" type="String"> </argument> <description> - Set a title for the tab at index [code]tab_idx[/code]. Tab titles are by default the children node name, but this can be overridden. + Sets a title for the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. </description> </method> <method name="set_tabs_visible"> @@ -160,38 +165,39 @@ <argument index="0" name="visible" type="bool"> </argument> <description> - If [code]true[/code] all the tabs will be visible. + If [code]true[/code] tabs are visible. If [code]false[/code] tabs' content and titles are hidden. Default value: [code]true[/code]. </description> </method> </methods> <members> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> - The current tab. + The current tab index. When set, this index's [Control] node's [code]visible[/code] property is set to [code]true[/code] and all others are set to [code]false[/code]. </member> <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign"> - The alignment of all the tabs of the tab container. See the [code]ALIGN_*[/code] constants. + The alignment of all tabs in the tab container. See the [code]ALIGN_*[/code] constants for details. </member> <member name="tabs_visible" type="bool" setter="set_tabs_visible" getter="are_tabs_visible"> - If [code]true[/code] all tabs that are children of the TabContainer will be visible. + If [code]true[/code] tabs are visible. If [code]false[/code] tabs' content and titles are hidden. Default value: [code]true[/code]. </member> </members> <signals> <signal name="pre_popup_pressed"> <description> + Emitted when the [code]TabContainer[/code]'s [Popup] button is clicked. See [method set_popup] for details. </description> </signal> <signal name="tab_changed"> <argument index="0" name="tab" type="int"> </argument> <description> - Emitted only when the current tab changes. + Emitted when switching to another tab. </description> </signal> <signal name="tab_selected"> <argument index="0" name="tab" type="int"> </argument> <description> - Emitted when a tab is being selected, even if it is the same tab. + Emitted when a tab is selected, even if it is the current tab. </description> </signal> </signals> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 78821a244c..d3893ab9a7 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -213,12 +213,12 @@ </constant> <constant name="ALIGN_MAX" value="3"> </constant> + <constant name="CLOSE_BUTTON_SHOW_NEVER" value="0"> + </constant> <constant name="CLOSE_BUTTON_SHOW_ACTIVE_ONLY" value="1"> </constant> <constant name="CLOSE_BUTTON_SHOW_ALWAYS" value="2"> </constant> - <constant name="CLOSE_BUTTON_SHOW_NEVER" value="0"> - </constant> <constant name="CLOSE_BUTTON_MAX" value="3"> </constant> </constants> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index d77cb69eef..9a500af347 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_overriding_selected_font_color" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_selection_active" qualifiers="const"> <return type="bool"> </return> @@ -343,6 +349,14 @@ Set the maximum amount of characters editable. </description> </method> + <method name="set_override_selected_font_color"> + <return type="void"> + </return> + <argument index="0" name="override" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_readonly"> <return type="void"> </return> @@ -421,6 +435,8 @@ </member> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_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"> </member> <member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled"> diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index cbf72eb991..93cba29d09 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -125,9 +125,6 @@ <constant name="FLAG_FILTER" value="4"> Turn on magnifying filter, to enable smooth zooming in of the texture. </constant> - <constant name="FLAG_VIDEO_SURFACE" value="4096"> - Texture is a video surface. - </constant> <constant name="FLAGS_DEFAULT" value="7"> Default flags. Generate mipmaps, repeat, and filter are enabled. </constant> @@ -137,5 +134,8 @@ </constant> <constant name="FLAG_MIRRORED_REPEAT" value="32"> </constant> + <constant name="FLAG_VIDEO_SURFACE" value="4096"> + Texture is a video surface. + </constant> </constants> </class> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 2156d04614..e2326ffe98 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -4,7 +4,7 @@ A unit of execution in a process. </brief_description> <description> - A unit of execution in a process. Can run methods on [Object]\ s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects. + A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects. </description> <tutorials> </tutorials> @@ -15,14 +15,14 @@ <return type="String"> </return> <description> - Returns the current [Thread]\ s id, uniquely identifying it among all threads. + Returns the current [code]Thread[/code]s id, uniquely identifying it among all threads. </description> </method> <method name="is_active" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if this [Thread] is currently active. An active [Thread] cannot start work on a new method but can be joined with [method wait_to_finish]. + Returns true if this [code]Thread[/code] is currently active. An active [code]Thread[/code] cannot start work on a new method but can be joined with [method wait_to_finish]. </description> </method> <method name="start"> @@ -37,7 +37,7 @@ <argument index="3" name="priority" type="int" default="1"> </argument> <description> - Starts a new [Thread] that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the [Thread] can be changed by passing a PRIORITY_* enum. + Starts a new [code]Thread[/code] that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the [code]Thread[/code] can be changed by passing a PRIORITY_* enum. Returns OK on success, or ERR_CANT_CREATE on failure. </description> </method> @@ -45,7 +45,7 @@ <return type="Variant"> </return> <description> - Joins the [Thread] and waits for it to finish. Returns what the method called returned. + Joins the [code]Thread[/code] and waits for it to finish. Returns what the method called returned. </description> </method> </methods> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 76b9b0e845..a9d71d7093 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -17,7 +17,7 @@ <argument index="0" name="from" type="Transform"> </argument> <description> - Constructs the [Transform2D] from a 3D [Transform]. + Constructs the [code]Transform2D[/code] from a 3D [Transform]. </description> </method> <method name="Transform2D"> @@ -30,7 +30,7 @@ <argument index="2" name="origin" type="Vector2"> </argument> <description> - Constructs the [Transform2D] from 3 [Vector2] consisting of rows x, y and origin. + Constructs the [code]Transform2D[/code] from 3 [Vector2] consisting of rows x, y and origin. </description> </method> <method name="Transform2D"> @@ -41,7 +41,7 @@ <argument index="1" name="position" type="Vector2"> </argument> <description> - Constructs the [Transform2D] from rotation angle in radians and position [Vector2]. + Constructs the [code]Transform2D[/code] from rotation angle in radians and position [Vector2]. </description> </method> <method name="affine_inverse"> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 3cf56bbf11..f0eb23b636 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -4,7 +4,7 @@ Control for a single item inside a [Tree]. </brief_description> <description> - Control for a single item inside a [Tree]. May have child [TreeItem]\ s and be styled as well as contain buttons. + Control for a single item inside a [Tree]. May have child [code]TreeItem[/code]s and be styled as well as contain buttons. </description> <tutorials> </tutorials> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 23229aec4a..b11498083b 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -423,10 +423,10 @@ </signals> <constants> <constant name="TWEEN_PROCESS_PHYSICS" value="0"> - The [Tween] should use [code]_physics_process[/code] for timekeeping when this is enabled. + The [code]Tween[/code] should use [code]_physics_process[/code] for timekeeping when this is enabled. </constant> <constant name="TWEEN_PROCESS_IDLE" value="1"> - The [Tween] should use [code]_process[/code] for timekeeping when this is enabled (default). + The [code]Tween[/code] should use [code]_process[/code] for timekeeping when this is enabled (default). </constant> <constant name="TRANS_LINEAR" value="0"> Means that the animation is interpolated linearly. 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> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 58626356bf..28a7cb7c8e 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -303,7 +303,7 @@ <argument index="0" name="xform" type="Transform2D"> </argument> <description> - Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]\ s. This is relative to the global canvas transform of the viewport. + Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. </description> </method> <method name="set_clear_mode"> diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index ebe646679a..881ba91fad 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -39,12 +39,12 @@ </member> </members> <constants> - <constant name="ENABLER_FREEZE_BODIES" value="1"> - This enabler will freeze [RigidBody] nodes. - </constant> <constant name="ENABLER_PAUSE_ANIMATIONS" value="0"> This enabler will pause [AnimationPlayer] nodes. </constant> + <constant name="ENABLER_FREEZE_BODIES" value="1"> + This enabler will freeze [RigidBody] nodes. + </constant> <constant name="ENABLER_MAX" value="2"> </constant> </constants> diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 0359f4694d..b881de4f91 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -47,23 +47,23 @@ </member> </members> <constants> - <constant name="ENABLER_FREEZE_BODIES" value="1"> - This enabler will freeze [RigidBody2D] nodes. - </constant> <constant name="ENABLER_PAUSE_ANIMATIONS" value="0"> This enabler will pause [AnimationPlayer] nodes. </constant> + <constant name="ENABLER_FREEZE_BODIES" value="1"> + This enabler will freeze [RigidBody2D] nodes. + </constant> <constant name="ENABLER_PAUSE_PARTICLES" value="2"> This enabler will stop [Particles2D] nodes. </constant> - <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5"> - </constant> <constant name="ENABLER_PARENT_PROCESS" value="3"> This enabler will stop the parent's _process function. </constant> <constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4"> This enabler will stop the parent's _physics_process function. </constant> + <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5"> + </constant> <constant name="ENABLER_MAX" value="6"> </constant> </constants> diff --git a/doc/classes/VisualScriptBuiltinFunc.xml b/doc/classes/VisualScriptBuiltinFunc.xml index f48f5a5308..5891b24bfd 100644 --- a/doc/classes/VisualScriptBuiltinFunc.xml +++ b/doc/classes/VisualScriptBuiltinFunc.xml @@ -114,97 +114,101 @@ <constant name="MATH_LERP" value="26"> Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code]. </constant> - <constant name="MATH_DECTIME" value="27"> + <constant name="MATH_INVERSE_LERP" value="27"> + </constant> + <constant name="MATH_RANGE_LERP" value="28"> + </constant> + <constant name="MATH_DECTIME" value="29"> Return the result of 'value' decreased by 'step' * 'amount'. </constant> - <constant name="MATH_RANDOMIZE" value="28"> + <constant name="MATH_RANDOMIZE" value="30"> Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. </constant> - <constant name="MATH_RAND" value="29"> + <constant name="MATH_RAND" value="31"> Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function. </constant> - <constant name="MATH_RANDF" value="30"> + <constant name="MATH_RANDF" value="32"> Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication. </constant> - <constant name="MATH_RANDOM" value="31"> + <constant name="MATH_RANDOM" value="33"> Return a random floating-point value between the two inputs. </constant> - <constant name="MATH_SEED" value="32"> + <constant name="MATH_SEED" value="34"> Set the seed for the random number generator. </constant> - <constant name="MATH_RANDSEED" value="33"> + <constant name="MATH_RANDSEED" value="35"> Return a random value from the given seed, along with the new seed. </constant> - <constant name="MATH_DEG2RAD" value="34"> + <constant name="MATH_DEG2RAD" value="36"> Convert the input from degrees to radians. </constant> - <constant name="MATH_RAD2DEG" value="35"> + <constant name="MATH_RAD2DEG" value="37"> Convert the input from radians to degrees. </constant> - <constant name="MATH_LINEAR2DB" value="36"> + <constant name="MATH_LINEAR2DB" value="38"> Convert the input from linear volume to decibel volume. </constant> - <constant name="MATH_DB2LINEAR" value="37"> + <constant name="MATH_DB2LINEAR" value="39"> Convert the input from decibel volume to linear volume. </constant> - <constant name="LOGIC_MAX" value="38"> + <constant name="LOGIC_MAX" value="40"> Return the greater of the two numbers, also known as their maximum. </constant> - <constant name="LOGIC_MIN" value="39"> + <constant name="LOGIC_MIN" value="41"> Return the lesser of the two numbers, also known as their minimum. </constant> - <constant name="LOGIC_CLAMP" value="40"> + <constant name="LOGIC_CLAMP" value="42"> Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)` </constant> - <constant name="LOGIC_NEAREST_PO2" value="41"> + <constant name="LOGIC_NEAREST_PO2" value="43"> Return the nearest power of 2 to the input. </constant> - <constant name="OBJ_WEAKREF" value="42"> + <constant name="OBJ_WEAKREF" value="44"> Create a [WeakRef] from the input. </constant> - <constant name="FUNC_FUNCREF" value="43"> + <constant name="FUNC_FUNCREF" value="45"> Create a [FuncRef] from the input. </constant> - <constant name="TYPE_CONVERT" value="44"> + <constant name="TYPE_CONVERT" value="46"> Convert between types. </constant> - <constant name="TYPE_OF" value="45"> + <constant name="TYPE_OF" value="47"> Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned. </constant> - <constant name="TYPE_EXISTS" value="46"> + <constant name="TYPE_EXISTS" value="48"> Checks if a type is registered in the [ClassDB]. </constant> - <constant name="TEXT_CHAR" value="47"> + <constant name="TEXT_CHAR" value="49"> Return a character with the given ascii value. </constant> - <constant name="TEXT_STR" value="48"> + <constant name="TEXT_STR" value="50"> Convert the input to a string. </constant> - <constant name="TEXT_PRINT" value="49"> + <constant name="TEXT_PRINT" value="51"> Print the given string to the output window. </constant> - <constant name="TEXT_PRINTERR" value="50"> + <constant name="TEXT_PRINTERR" value="52"> Print the given string to the standard error output. </constant> - <constant name="TEXT_PRINTRAW" value="51"> + <constant name="TEXT_PRINTRAW" value="53"> Print the given string to the standard output, without adding a newline. </constant> - <constant name="VAR_TO_STR" value="52"> + <constant name="VAR_TO_STR" value="54"> Serialize a [Variant] to a string. </constant> - <constant name="STR_TO_VAR" value="53"> + <constant name="STR_TO_VAR" value="55"> Deserialize a [Variant] from a string serialized using [VAR_TO_STR]. </constant> - <constant name="VAR_TO_BYTES" value="54"> + <constant name="VAR_TO_BYTES" value="56"> Serialize a [Variant] to a [PoolByteArray]. </constant> - <constant name="BYTES_TO_VAR" value="55"> + <constant name="BYTES_TO_VAR" value="57"> Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES]. </constant> - <constant name="COLORN" value="56"> + <constant name="COLORN" value="58"> Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. </constant> - <constant name="FUNC_MAX" value="57"> + <constant name="FUNC_MAX" value="59"> The maximum value the [member function] property can have. </constant> </constants> diff --git a/doc/classes/VisualScriptSequence.xml b/doc/classes/VisualScriptSequence.xml index 4ea4203407..845da4e50b 100644 --- a/doc/classes/VisualScriptSequence.xml +++ b/doc/classes/VisualScriptSequence.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Executes a series of Sequence ports. + Executes a series of Sequence ports. </brief_description> <description> Steps through a series of one or more output Sequence ports. The [code]current[/code] data port outputs the currently executing item. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 4bc6a49e91..8e3cb8ee50 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -12,6 +12,820 @@ <demos> </demos> <methods> + <method name="black_bars_set_images"> + <return type="void"> + </return> + <argument index="0" name="left" type="RID"> + </argument> + <argument index="1" name="top" type="RID"> + </argument> + <argument index="2" name="right" type="RID"> + </argument> + <argument index="3" name="bottom" type="RID"> + </argument> + <description> + </description> + </method> + <method name="black_bars_set_margins"> + <return type="void"> + </return> + <argument index="0" name="left" type="int"> + </argument> + <argument index="1" name="top" type="int"> + </argument> + <argument index="2" name="right" type="int"> + </argument> + <argument index="3" name="bottom" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_item_add_circle"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="radius" type="float"> + </argument> + <argument index="3" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_clip_ignore"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="ignore" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_line"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="from" type="Vector2"> + </argument> + <argument index="2" name="to" type="Vector2"> + </argument> + <argument index="3" name="color" type="Color"> + </argument> + <argument index="4" name="width" type="float" default="1.0"> + </argument> + <argument index="5" name="antialiased" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_mesh"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="mesh" type="RID"> + </argument> + <argument index="2" name="skeleton" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_multimesh"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="mesh" type="RID"> + </argument> + <argument index="2" name="skeleton" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_nine_patch"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="source" type="Rect2"> + </argument> + <argument index="3" name="texture" type="RID"> + </argument> + <argument index="4" name="topleft" type="Vector2"> + </argument> + <argument index="5" name="bottomright" type="Vector2"> + </argument> + <argument index="6" name="x_axis_mode" type="int" enum="VisualServer.NinePatchAxisMode" default="0"> + </argument> + <argument index="7" name="y_axis_mode" type="int" enum="VisualServer.NinePatchAxisMode" default="0"> + </argument> + <argument index="8" name="draw_center" type="bool" default="true"> + </argument> + <argument index="9" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="10" name="normal_map" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_particles"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="particles" type="RID"> + </argument> + <argument index="2" name="texture" type="RID"> + </argument> + <argument index="3" name="normal_map" type="RID"> + </argument> + <argument index="4" name="h_frames" type="int"> + </argument> + <argument index="5" name="v_frames" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_polygon"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="points" type="PoolVector2Array"> + </argument> + <argument index="2" name="colors" type="PoolColorArray"> + </argument> + <argument index="3" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> + </argument> + <argument index="4" name="texture" type="RID"> + </argument> + <argument index="5" name="normal_map" type="RID"> + </argument> + <argument index="6" name="antialiased" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_polyline"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="points" type="PoolVector2Array"> + </argument> + <argument index="2" name="colors" type="PoolColorArray"> + </argument> + <argument index="3" name="width" type="float" default="1.0"> + </argument> + <argument index="4" name="antialiased" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_primitive"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="points" type="PoolVector2Array"> + </argument> + <argument index="2" name="colors" type="PoolColorArray"> + </argument> + <argument index="3" name="uvs" type="PoolVector2Array"> + </argument> + <argument index="4" name="texture" type="RID"> + </argument> + <argument index="5" name="width" type="float" default="1.0"> + </argument> + <argument index="6" name="normal_map" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_rect"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_set_transform"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_texture_rect"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="texture" type="RID"> + </argument> + <argument index="3" name="tile" type="bool" default="false"> + </argument> + <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="5" name="transpose" type="bool" default="false"> + </argument> + <argument index="6" name="normal_map" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_texture_rect_region"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="texture" type="RID"> + </argument> + <argument index="3" name="src_rect" type="Rect2"> + </argument> + <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="5" name="transpose" type="bool" default="false"> + </argument> + <argument index="6" name="normal_map" type="RID"> + </argument> + <argument index="7" name="clip_uv" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_triangle_array"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="indices" type="PoolIntArray"> + </argument> + <argument index="2" name="points" type="PoolVector2Array"> + </argument> + <argument index="3" name="colors" type="PoolColorArray"> + </argument> + <argument index="4" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> + </argument> + <argument index="5" name="texture" type="RID"> + </argument> + <argument index="6" name="count" type="int" default="-1"> + </argument> + <argument index="7" name="normal_map" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_clear"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_item_set_clip"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="clip" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_copy_to_backbuffer"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <argument index="2" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_custom_rect"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="use_custom_rect" type="bool"> + </argument> + <argument index="2" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_distance_field_mode"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_draw_behind_parent"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_draw_index"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_light_mask"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_material"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="material" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_modulate"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_parent"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="parent" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_self_modulate"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_sort_children_by_y"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_transform"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_use_parent_material"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_visible"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="visible" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_z"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="z" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_z_as_relative_to_parent"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_attach_to_canvas"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_light_occluder_attach_to_canvas"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_occluder_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_light_occluder_set_enabled"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_occluder_set_light_mask"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_occluder_set_polygon"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="polygon" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_occluder_set_transform"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_color"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_enabled"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_energy"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_height"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_item_cull_mask"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_item_shadow_cull_mask"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_layer_range"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="min_layer" type="int"> + </argument> + <argument index="2" name="max_layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_mode"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="VisualServer.CanvasLightMode"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_scale"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_buffer_size"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_color"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_enabled"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_filter"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="filter" type="int" enum="VisualServer.CanvasLightShadowFilter"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_gradient_length"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_smooth"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="smooth" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_texture"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="texture" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_texture_offset"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="offset" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_transform"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_z_range"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="min_z" type="int"> + </argument> + <argument index="2" name="max_z" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_occluder_polygon_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_occluder_polygon_set_cull_mode"> + <return type="void"> + </return> + <argument index="0" name="occluder_polygon" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="VisualServer.CanvasOccluderPolygonCullMode"> + </argument> + <description> + </description> + </method> + <method name="canvas_occluder_polygon_set_shape"> + <return type="void"> + </return> + <argument index="0" name="occluder_polygon" type="RID"> + </argument> + <argument index="1" name="shape" type="PoolVector2Array"> + </argument> + <argument index="2" name="closed" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_occluder_polygon_set_shape_as_lines"> + <return type="void"> + </return> + <argument index="0" name="occluder_polygon" type="RID"> + </argument> + <argument index="1" name="shape" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + <method name="canvas_set_item_mirroring"> + <return type="void"> + </return> + <argument index="0" name="canvas" type="RID"> + </argument> + <argument index="1" name="item" type="RID"> + </argument> + <argument index="2" name="mirroring" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="canvas_set_modulate"> + <return type="void"> + </return> + <argument index="0" name="canvas" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="draw"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="finish"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="force_draw"> <return type="void"> </return> @@ -24,6 +838,380 @@ <description> </description> </method> + <method name="free"> + <return type="void"> + </return> + <argument index="0" name="rid" type="RID"> + </argument> + <description> + </description> + </method> + <method name="get_render_info"> + <return type="int"> + </return> + <argument index="0" name="info" type="int" enum="VisualServer.RenderInfo"> + </argument> + <description> + </description> + </method> + <method name="get_test_cube"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_test_texture"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_white_texture"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="has_changed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="has_feature" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="feature" type="int" enum="VisualServer.Features"> + </argument> + <description> + </description> + </method> + <method name="has_os_feature" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="feature" type="String"> + </argument> + <description> + </description> + </method> + <method name="init"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="make_sphere_mesh"> + <return type="RID"> + </return> + <argument index="0" name="latitudes" type="int"> + </argument> + <argument index="1" name="longitudes" type="int"> + </argument> + <argument index="2" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="material_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="material_get_param" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="parameter" type="String"> + </argument> + <description> + </description> + </method> + <method name="material_get_shader" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="shader_material" type="RID"> + </argument> + <description> + </description> + </method> + <method name="material_set_line_width"> + <return type="void"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="width" type="float"> + </argument> + <description> + </description> + </method> + <method name="material_set_next_pass"> + <return type="void"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="next_material" type="RID"> + </argument> + <description> + </description> + </method> + <method name="material_set_param"> + <return type="void"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="parameter" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="material_set_render_priority"> + <return type="void"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="priority" type="int"> + </argument> + <description> + </description> + </method> + <method name="material_set_shader"> + <return type="void"> + </return> + <argument index="0" name="shader_material" type="RID"> + </argument> + <argument index="1" name="shader" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_add_surface_from_arrays"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="primtive" type="int" enum="VisualServer.PrimitiveType"> + </argument> + <argument index="2" name="arrays" type="Array"> + </argument> + <argument index="3" name="blend_shapes" type="Array" default="[ ]"> + </argument> + <argument index="4" name="compress_format" type="int" default="97792"> + </argument> + <description> + </description> + </method> + <method name="mesh_clear"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="mesh_get_blend_shape_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_get_blend_shape_mode" qualifiers="const"> + <return type="int" enum="VisualServer.BlendShapeMode"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_get_custom_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_get_surface_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_remove_surface"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_set_blend_shape_count"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="amount" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_set_blend_shape_mode"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="VisualServer.BlendShapeMode"> + </argument> + <description> + </description> + </method> + <method name="mesh_set_custom_aabb"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="aabb" type="Rect3"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_array" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_array_index_len" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_array_len" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_arrays" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_blend_shape_arrays" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_format" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_index_array" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_material" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_primitive_type" qualifiers="const"> + <return type="int" enum="VisualServer.PrimitiveType"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_skeleton_aabb" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_set_material"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <argument index="2" name="material" type="RID"> + </argument> + <description> + </description> + </method> <method name="request_frame_drawn_callback"> <return type="void"> </return> @@ -38,6 +1226,128 @@ The callback method must use only 1 argument which will be called with 'userdata'. </description> </method> + <method name="set_boot_image"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <argument index="2" name="scale" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_debug_generate_wireframes"> + <return type="void"> + </return> + <argument index="0" name="generate" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_default_clear_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="shader_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="shader_get_code" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <description> + </description> + </method> + <method name="shader_get_default_texture_param" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="shader_get_param_list" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <description> + </description> + </method> + <method name="shader_set_code"> + <return type="void"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <argument index="1" name="code" type="String"> + </argument> + <description> + </description> + </method> + <method name="shader_set_default_texture_param"> + <return type="void"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <argument index="2" name="texture" type="RID"> + </argument> + <description> + </description> + </method> + <method name="sky_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="sky_set_texture"> + <return type="void"> + </return> + <argument index="0" name="sky" type="RID"> + </argument> + <argument index="1" name="cube_map" type="RID"> + </argument> + <argument index="2" name="radiance_size" type="int"> + </argument> + <description> + </description> + </method> + <method name="sync"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="texture_allocate"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="width" type="int"> + </argument> + <argument index="2" name="height" type="int"> + </argument> + <argument index="3" name="format" type="int" enum="Image.Format"> + </argument> + <argument index="4" name="flags" type="int" default="7"> + </argument> + <description> + </description> + </method> <method name="texture_create"> <return type="RID"> </return> @@ -54,6 +1364,22 @@ <description> </description> </method> + <method name="texture_debug_usage"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="texture_get_data" qualifiers="const"> + <return type="Image"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> + </argument> + <description> + </description> + </method> <method name="texture_get_flags" qualifiers="const"> <return type="int"> </return> @@ -62,6 +1388,14 @@ <description> </description> </method> + <method name="texture_get_format" qualifiers="const"> + <return type="int" enum="Image.Format"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> <method name="texture_get_height" qualifiers="const"> <return type="int"> </return> @@ -70,6 +1404,22 @@ <description> </description> </method> + <method name="texture_get_path" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> + <method name="texture_get_texid" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> <method name="texture_get_width" qualifiers="const"> <return type="int"> </return> @@ -78,6 +1428,18 @@ <description> </description> </method> + <method name="texture_set_data"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="image" type="Image"> + </argument> + <argument index="2" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> + </argument> + <description> + </description> + </method> <method name="texture_set_flags"> <return type="void"> </return> @@ -88,6 +1450,16 @@ <description> </description> </method> + <method name="texture_set_path"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="path" type="String"> + </argument> + <description> + </description> + </method> <method name="texture_set_shrink_all_x2_on_set_data"> <return type="void"> </return> @@ -96,7 +1468,639 @@ <description> </description> </method> + <method name="texture_set_size_override"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="width" type="int"> + </argument> + <argument index="2" name="height" type="int"> + </argument> + <description> + </description> + </method> + <method name="textures_keep_original"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_attach_camera"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="camera" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_attach_canvas"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_attach_to_screen"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )"> + </argument> + <argument index="2" name="screen" type="int" default="0"> + </argument> + <description> + </description> + </method> + <method name="viewport_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="viewport_detach"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_get_render_info"> + <return type="int"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="info" type="int" enum="VisualServer.ViewportRenderInfo"> + </argument> + <description> + </description> + </method> + <method name="viewport_get_texture" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_remove_canvas"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_active"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="active" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_canvas_layer"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <argument index="2" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_canvas_transform"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <argument index="2" name="offset" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_clear_mode"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="clear_mode" type="int" enum="VisualServer.ViewportClearMode"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_debug_draw"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="draw" type="int" enum="VisualServer.ViewportDebugDraw"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_disable_3d"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_disable_environment"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_global_canvas_transform"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_hdr"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_hide_canvas"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_hide_scenario"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_msaa"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="msaa" type="int" enum="VisualServer.ViewportMSAA"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_parent_viewport"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="parent_viewport" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_scenario"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="scenario" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_shadow_atlas_quadrant_subdivision"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="quadrant" type="int"> + </argument> + <argument index="2" name="subdivision" type="int"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_shadow_atlas_size"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_size"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="width" type="int"> + </argument> + <argument index="2" name="height" type="int"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_transparent_background"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_update_mode"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="update_mode" type="int" enum="VisualServer.ViewportUpdateMode"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_usage"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="usage" type="int" enum="VisualServer.ViewportUsage"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_use_arvr"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="use_arvr" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_vflip"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> </methods> <constants> + <constant name="NO_INDEX_ARRAY" value="-1" enum=""> + </constant> + <constant name="ARRAY_WEIGHTS_SIZE" value="4" enum=""> + </constant> + <constant name="CANVAS_ITEM_Z_MIN" value="-4096" enum=""> + </constant> + <constant name="CANVAS_ITEM_Z_MAX" value="4096" enum=""> + </constant> + <constant name="MAX_GLOW_LEVELS" value="7" enum=""> + </constant> + <constant name="MAX_CURSORS" value="8" enum=""> + </constant> + <constant name="MATERIAL_RENDER_PRIORITY_MIN" value="-128" enum=""> + </constant> + <constant name="MATERIAL_RENDER_PRIORITY_MAX" value="127" enum=""> + </constant> + <constant name="CUBEMAP_LEFT" value="0"> + </constant> + <constant name="CUBEMAP_RIGHT" value="1"> + </constant> + <constant name="CUBEMAP_BOTTOM" value="2"> + </constant> + <constant name="CUBEMAP_TOP" value="3"> + </constant> + <constant name="CUBEMAP_FRONT" value="4"> + </constant> + <constant name="CUBEMAP_BACK" value="5"> + </constant> + <constant name="TEXTURE_FLAG_MIPMAPS" value="1"> + </constant> + <constant name="TEXTURE_FLAG_REPEAT" value="2"> + </constant> + <constant name="TEXTURE_FLAG_FILTER" value="4"> + </constant> + <constant name="TEXTURE_FLAG_ANISOTROPIC_FILTER" value="8"> + </constant> + <constant name="TEXTURE_FLAG_CONVERT_TO_LINEAR" value="16"> + </constant> + <constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32"> + </constant> + <constant name="TEXTURE_FLAG_CUBEMAP" value="2048"> + </constant> + <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="4096"> + </constant> + <constant name="TEXTURE_FLAGS_DEFAULT" value="7"> + </constant> + <constant name="SHADER_SPATIAL" value="0"> + </constant> + <constant name="SHADER_CANVAS_ITEM" value="1"> + </constant> + <constant name="SHADER_PARTICLES" value="2"> + </constant> + <constant name="SHADER_MAX" value="3"> + </constant> + <constant name="ARRAY_VERTEX" value="0"> + </constant> + <constant name="ARRAY_NORMAL" value="1"> + </constant> + <constant name="ARRAY_TANGENT" value="2"> + </constant> + <constant name="ARRAY_COLOR" value="3"> + </constant> + <constant name="ARRAY_TEX_UV" value="4"> + </constant> + <constant name="ARRAY_TEX_UV2" value="5"> + </constant> + <constant name="ARRAY_BONES" value="6"> + </constant> + <constant name="ARRAY_WEIGHTS" value="7"> + </constant> + <constant name="ARRAY_INDEX" value="8"> + </constant> + <constant name="ARRAY_MAX" value="9"> + </constant> + <constant name="ARRAY_FORMAT_VERTEX" value="1"> + </constant> + <constant name="ARRAY_FORMAT_NORMAL" value="2"> + </constant> + <constant name="ARRAY_FORMAT_TANGENT" value="4"> + </constant> + <constant name="ARRAY_FORMAT_COLOR" value="8"> + </constant> + <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + </constant> + <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> + </constant> + <constant name="ARRAY_FORMAT_BONES" value="64"> + </constant> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + </constant> + <constant name="ARRAY_FORMAT_INDEX" value="256"> + </constant> + <constant name="ARRAY_COMPRESS_VERTEX" value="512"> + </constant> + <constant name="ARRAY_COMPRESS_NORMAL" value="1024"> + </constant> + <constant name="ARRAY_COMPRESS_TANGENT" value="2048"> + </constant> + <constant name="ARRAY_COMPRESS_COLOR" value="4096"> + </constant> + <constant name="ARRAY_COMPRESS_TEX_UV" value="8192"> + </constant> + <constant name="ARRAY_COMPRESS_TEX_UV2" value="16384"> + </constant> + <constant name="ARRAY_COMPRESS_BONES" value="32768"> + </constant> + <constant name="ARRAY_COMPRESS_WEIGHTS" value="65536"> + </constant> + <constant name="ARRAY_COMPRESS_INDEX" value="131072"> + </constant> + <constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144"> + </constant> + <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288"> + </constant> + <constant name="ARRAY_COMPRESS_DEFAULT" value="97792"> + </constant> + <constant name="PRIMITIVE_POINTS" value="0"> + </constant> + <constant name="PRIMITIVE_LINES" value="1"> + </constant> + <constant name="PRIMITIVE_LINE_STRIP" value="2"> + </constant> + <constant name="PRIMITIVE_LINE_LOOP" value="3"> + </constant> + <constant name="PRIMITIVE_TRIANGLES" value="4"> + </constant> + <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> + </constant> + <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> + </constant> + <constant name="PRIMITIVE_MAX" value="7"> + </constant> + <constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0"> + </constant> + <constant name="BLEND_SHAPE_MODE_RELATIVE" value="1"> + </constant> + <constant name="LIGHT_DIRECTIONAL" value="0"> + </constant> + <constant name="LIGHT_OMNI" value="1"> + </constant> + <constant name="LIGHT_SPOT" value="2"> + </constant> + <constant name="LIGHT_PARAM_ENERGY" value="0"> + </constant> + <constant name="LIGHT_PARAM_SPECULAR" value="1"> + </constant> + <constant name="LIGHT_PARAM_RANGE" value="2"> + </constant> + <constant name="LIGHT_PARAM_ATTENUATION" value="3"> + </constant> + <constant name="LIGHT_PARAM_SPOT_ANGLE" value="4"> + </constant> + <constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="5"> + </constant> + <constant name="LIGHT_PARAM_CONTACT_SHADOW_SIZE" value="6"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="7"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="8"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="9"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="10"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="11"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_BIAS" value="12"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="13"> + </constant> + <constant name="LIGHT_PARAM_MAX" value="14"> + </constant> + <constant name="VIEWPORT_UPDATE_DISABLED" value="0"> + </constant> + <constant name="VIEWPORT_UPDATE_ONCE" value="1"> + </constant> + <constant name="VIEWPORT_UPDATE_WHEN_VISIBLE" value="2"> + </constant> + <constant name="VIEWPORT_UPDATE_ALWAYS" value="3"> + </constant> + <constant name="VIEWPORT_CLEAR_ALWAYS" value="0"> + </constant> + <constant name="VIEWPORT_CLEAR_NEVER" value="1"> + </constant> + <constant name="VIEWPORT_CLEAR_ONLY_NEXT_FRAME" value="2"> + </constant> + <constant name="VIEWPORT_MSAA_DISABLED" value="0"> + </constant> + <constant name="VIEWPORT_MSAA_2X" value="1"> + </constant> + <constant name="VIEWPORT_MSAA_4X" value="2"> + </constant> + <constant name="VIEWPORT_MSAA_8X" value="3"> + </constant> + <constant name="VIEWPORT_MSAA_16X" value="4"> + </constant> + <constant name="VIEWPORT_USAGE_2D" value="0"> + </constant> + <constant name="VIEWPORT_USAGE_2D_NO_SAMPLING" value="1"> + </constant> + <constant name="VIEWPORT_USAGE_3D" value="2"> + </constant> + <constant name="VIEWPORT_USAGE_3D_NO_EFFECTS" value="3"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME" value="0"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME" value="1"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_MAX" value="6"> + </constant> + <constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0"> + </constant> + <constant name="VIEWPORT_DEBUG_DRAW_UNSHADED" value="1"> + </constant> + <constant name="VIEWPORT_DEBUG_DRAW_OVERDRAW" value="2"> + </constant> + <constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="3"> + </constant> + <constant name="SCENARIO_DEBUG_DISABLED" value="0"> + </constant> + <constant name="SCENARIO_DEBUG_WIREFRAME" value="1"> + </constant> + <constant name="SCENARIO_DEBUG_OVERDRAW" value="2"> + </constant> + <constant name="SCENARIO_DEBUG_SHADELESS" value="3"> + </constant> + <constant name="INSTANCE_NONE" value="0"> + </constant> + <constant name="INSTANCE_MESH" value="1"> + </constant> + <constant name="INSTANCE_MULTIMESH" value="2"> + </constant> + <constant name="INSTANCE_IMMEDIATE" value="3"> + </constant> + <constant name="INSTANCE_PARTICLES" value="4"> + </constant> + <constant name="INSTANCE_LIGHT" value="5"> + </constant> + <constant name="INSTANCE_REFLECTION_PROBE" value="6"> + </constant> + <constant name="INSTANCE_GI_PROBE" value="7"> + </constant> + <constant name="INSTANCE_MAX" value="8"> + </constant> + <constant name="INSTANCE_GEOMETRY_MASK" value="30"> + </constant> + <constant name="NINE_PATCH_STRETCH" value="0"> + </constant> + <constant name="NINE_PATCH_TILE" value="1"> + </constant> + <constant name="NINE_PATCH_TILE_FIT" value="2"> + </constant> + <constant name="CANVAS_LIGHT_MODE_ADD" value="0"> + </constant> + <constant name="CANVAS_LIGHT_MODE_SUB" value="1"> + </constant> + <constant name="CANVAS_LIGHT_MODE_MIX" value="2"> + </constant> + <constant name="CANVAS_LIGHT_MODE_MASK" value="3"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_NONE" value="0"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF3" value="1"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF5" value="2"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF7" value="3"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF9" value="4"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF13" value="5"> + </constant> + <constant name="CANVAS_OCCLUDER_POLYGON_CULL_DISABLED" value="0"> + </constant> + <constant name="CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE" value="1"> + </constant> + <constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2"> + </constant> + <constant name="INFO_OBJECTS_IN_FRAME" value="0"> + </constant> + <constant name="INFO_VERTICES_IN_FRAME" value="1"> + </constant> + <constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + </constant> + <constant name="INFO_SHADER_CHANGES_IN_FRAME" value="3"> + </constant> + <constant name="INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + </constant> + <constant name="INFO_DRAW_CALLS_IN_FRAME" value="5"> + </constant> + <constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="6"> + </constant> + <constant name="INFO_VIDEO_MEM_USED" value="7"> + </constant> + <constant name="INFO_TEXTURE_MEM_USED" value="8"> + </constant> + <constant name="INFO_VERTEX_MEM_USED" value="9"> + </constant> + <constant name="FEATURE_SHADERS" value="0"> + </constant> + <constant name="FEATURE_MULTITHREADED" value="1"> + </constant> </constants> </class> diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml index a9450c1743..561cd09f43 100644 --- a/doc/classes/WorldEnvironment.xml +++ b/doc/classes/WorldEnvironment.xml @@ -4,7 +4,7 @@ Sets environment properties for the entire scene </brief_description> <description> - The [WorldEnvironment] node can be added to a scene in order to set default [Environment] variables for the scene. The [WorldEnvironment] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [WorldEnvironment] may be instanced in a given scene at a time. The [WorldEnvironment] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). + The [code]WorldEnvironment[/code] node can be added to a scene in order to set default [Environment] variables for the scene. The [code]WorldEnvironment[/code] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [code]WorldEnvironment[/code] may be instanced in a given scene at a time. The [code]WorldEnvironment[/code] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). </description> <tutorials> </tutorials> diff --git a/doc/tools/doc_status.py b/doc/tools/doc_status.py index e89b49eb4d..170ded9f50 100644 --- a/doc/tools/doc_status.py +++ b/doc/tools/doc_status.py @@ -250,15 +250,16 @@ class ClassStatus: for tag in list(c): if tag.tag in ['methods']: for sub_tag in list(tag): - methods.append(sub_tag.find('name')) + methods.append(sub_tag.attrib['name']) if tag.tag in ['members']: for sub_tag in list(tag): try: - methods.remove(sub_tag.find('setter')) - methods.remove(sub_tag.find('getter')) + if(sub_tag.attrib['setter'].startswith('_') == False): + methods.remove(sub_tag.attrib['setter']) + if(sub_tag.attrib['getter'].startswith('_') == False): + methods.remove(sub_tag.attrib['getter']) except: pass - for tag in list(c): if tag.tag == 'brief_description': @@ -269,7 +270,7 @@ class ClassStatus: elif tag.tag in ['methods', 'signals']: for sub_tag in list(tag): - if sub_tag.find('name') in methods or tag.tag == 'signals': + if sub_tag.attrib['name'] in methods or tag.tag == 'signals': descr = sub_tag.find('description') status.progresses[tag.tag].increment(len(descr.text.strip()) > 0) elif tag.tag in ['constants', 'members']: diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py index 0c67e3be4c..dc015d781b 100644 --- a/doc/tools/makerst.py +++ b/doc/tools/makerst.py @@ -189,8 +189,11 @@ def rstize_text(text, cclass): post_text = text[endq_pos + 1:] tag_text = text[pos + 1:endq_pos] + escape_post = False + if tag_text in class_names: tag_text = make_type(tag_text) + escape_post = True else: # command cmd = tag_text space_pos = tag_text.find(' ') @@ -209,7 +212,7 @@ def rstize_text(text, cclass): cmd = tag_text[:space_pos] param = tag_text[space_pos + 1:] tag_text = param - elif cmd.find('method') == 0: + elif cmd.find('method') == 0 or cmd.find('member') == 0 or cmd.find('signal') == 0: cmd = tag_text[:space_pos] param = tag_text[space_pos + 1:] @@ -218,12 +221,14 @@ def rstize_text(text, cclass): tag_text = ':ref:`' + class_param + '.' + method_param + '<class_' + class_param + '_' + method_param + '>`' else: tag_text = ':ref:`' + param + '<class_' + cclass + "_" + param + '>`' + escape_post = True elif cmd.find('image=') == 0: tag_text = "" # '' elif cmd.find('url=') == 0: tag_text = ':ref:`' + cmd[4:] + '<' + cmd[4:] + ">`" elif cmd == '/url': - tag_text = ')' + tag_text = '' + escape_post = True elif cmd == 'center': tag_text = '' elif cmd == '/center': @@ -248,6 +253,11 @@ def rstize_text(text, cclass): inside_code = True else: tag_text = make_type(tag_text) + escape_post = True + + # Properly escape things like `[Node]s` + if escape_post and post_text and post_text[0].isalnum(): # not punctuation, escape + post_text = '\ ' + post_text text = pre_text + tag_text + post_text pos = len(pre_text) + len(tag_text) @@ -300,11 +310,11 @@ def make_method( if declare or pp == None: - s = ' **' + m.attrib['name'] + '** ' + s = '**' + m.attrib['name'] + '** ' else: s = ':ref:`' + m.attrib['name'] + '<class_' + cname + "_" + m.attrib['name'] + '>` ' - s += ' **(**' + s += '**(**' argfound = False for a in mdata['argidx']: arg = mdata[a] @@ -324,10 +334,6 @@ def make_method( if 'default' in arg.attrib: s += '=' + arg.attrib['default'] - argfound = True - - if argfound: - s += ' ' s += ' **)**' if 'qualifiers' in m.attrib: @@ -440,6 +446,7 @@ def make_rst_class(node): if events != None and len(list(events)) > 0: f.write(make_heading('Signals', '-')) for m in list(events): + f.write(".. _class_" + name + "_" + m.attrib['name'] + ":\n\n") make_method(f, node.attrib['name'], m, True, name, True) f.write('\n') d = m.find('description') @@ -455,12 +462,14 @@ def make_rst_class(node): f.write(make_heading('Member Variables', '-')) for c in list(members): + # Leading two spaces necessary to prevent breaking the <ul> + f.write(" .. _class_" + name + "_" + c.attrib['name'] + ":\n\n") s = '- ' s += make_type(c.attrib['type']) + ' ' s += '**' + c.attrib['name'] + '**' if c.text.strip() != '': - s += ' - ' + c.text.strip() - f.write(s + '\n') + s += ' - ' + rstize_text(c.text.strip(), name) + f.write(s + '\n\n') f.write('\n') constants = node.find('constants') |