diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-22 01:04:47 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-27 22:30:19 +0200 |
| commit | f7f6115f7627df24a08a9a0882b2f573cc838eb1 (patch) | |
| tree | 03fd75145084c88702dbbb7e54c42c7c02d54fa6 | |
| parent | 538c8eec15d72b67e102f47f9df7624c29d14607 (diff) | |
Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
330 files changed, 2585 insertions, 2474 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index df98048a97..4f5e1a27db 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -4,7 +4,7 @@ Global scope constants and variables. </brief_description> <description> - Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc. It's not much. + Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc. Singletons are also documented here, since they can be accessed from anywhere. </description> <tutorials> @@ -13,100 +13,105 @@ </methods> <members> <member name="ARVRServer" type="ARVRServer" setter="" getter=""> - [ARVRServer] singleton + The [ARVRServer] singleton. </member> <member name="AudioServer" type="AudioServer" setter="" getter=""> - [AudioServer] singleton + The [AudioServer] singleton. </member> <member name="CameraServer" type="CameraServer" setter="" getter=""> - [CameraServer] singleton + The [CameraServer] singleton. </member> <member name="ClassDB" type="ClassDB" setter="" getter=""> - [ClassDB] singleton + The [ClassDB] singleton. </member> <member name="Engine" type="Engine" setter="" getter=""> - [Engine] singleton + The [Engine] singleton. </member> <member name="Geometry" type="Geometry" setter="" getter=""> - [Geometry] singleton + The [Geometry] singleton. </member> <member name="IP" type="IP" setter="" getter=""> - [IP] singleton + The [IP] singleton. </member> <member name="Input" type="Input" setter="" getter=""> - [Input] singleton + The [Input] singleton. </member> <member name="InputMap" type="InputMap" setter="" getter=""> - [InputMap] singleton + The [InputMap] singleton. </member> <member name="JSON" type="JSON" setter="" getter=""> - [JSON] singleton + The [JSON] singleton. </member> <member name="JavaScript" type="JavaScript" setter="" getter=""> - [JavaScript] singleton + The [JavaScript] singleton. </member> <member name="Marshalls" type="Reference" setter="" getter=""> - [Marshalls] singleton + The [Marshalls] singleton. </member> <member name="NavigationMeshGenerator" type="EditorNavigationMeshGenerator" setter="" getter=""> + The [EditorNavigationMeshGenerator] singleton. </member> <member name="OS" type="OS" setter="" getter=""> - [OS] singleton + The [OS] singleton. </member> <member name="Performance" type="Performance" setter="" getter=""> - [Performance] singleton + The [Performance] singleton. </member> <member name="Physics2DServer" type="Physics2DServer" setter="" getter=""> - [Physics2DServer] singleton + The [Physics2DServer] singleton. </member> <member name="PhysicsServer" type="PhysicsServer" setter="" getter=""> - [PhysicsServer] singleton + The [PhysicsServer] singleton. </member> <member name="ProjectSettings" type="ProjectSettings" setter="" getter=""> - [ProjectSettings] singleton + The [ProjectSettings] singleton. </member> <member name="ResourceLoader" type="ResourceLoader" setter="" getter=""> - [ResourceLoader] singleton + The [ResourceLoader] singleton. </member> <member name="ResourceSaver" type="ResourceSaver" setter="" getter=""> - [ResourceSaver] singleton + The [ResourceSaver] singleton. </member> <member name="TranslationServer" type="TranslationServer" setter="" getter=""> - [TranslationServer] singleton + The [TranslationServer] singleton. </member> <member name="VisualScriptEditor" type="VisualScriptEditor" setter="" getter=""> - [VisualScriptEditor] singleton + The [VisualScriptEditor] singleton. </member> <member name="VisualServer" type="VisualServer" setter="" getter=""> - [VisualServer] singleton + The [VisualServer] singleton. </member> </members> <constants> <constant name="MARGIN_LEFT" value="0" enum="Margin"> - Left margin, used usually for [Control] or [StyleBox] derived classes. + Left margin, usually used for [Control] or [StyleBox]-derived classes. </constant> <constant name="MARGIN_TOP" value="1" enum="Margin"> - Top margin, used usually for [Control] or [StyleBox] derived classes. + Top margin, usually used for [Control] or [StyleBox]-derived classes. </constant> <constant name="MARGIN_RIGHT" value="2" enum="Margin"> - Right margin, used usually for [Control] or [StyleBox] derived classes. + Right margin, usually used for [Control] or [StyleBox]-derived classes. </constant> <constant name="MARGIN_BOTTOM" value="3" enum="Margin"> - Bottom margin, used usually for [Control] or [StyleBox] derived classes. + Bottom margin, usually used for [Control] or [StyleBox]-derived classes. </constant> <constant name="CORNER_TOP_LEFT" value="0" enum="Corner"> + Top-left corner. </constant> <constant name="CORNER_TOP_RIGHT" value="1" enum="Corner"> + Top-right corner. </constant> <constant name="CORNER_BOTTOM_RIGHT" value="2" enum="Corner"> + Bottom-right corner. </constant> <constant name="CORNER_BOTTOM_LEFT" value="3" enum="Corner"> + Bottom-left corner. </constant> <constant name="VERTICAL" value="1" enum="Orientation"> - General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc. + General vertical alignment, usually used for [Separator], [ScrollBar], [Slider], etc. </constant> <constant name="HORIZONTAL" value="0" enum="Orientation"> - General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc. + General horizontal alignment, usually used for [Separator], [ScrollBar], [Slider], etc. </constant> <constant name="HALIGN_LEFT" value="0" enum="HAlign"> Horizontal left alignment, usually for text-derived classes. @@ -127,963 +132,966 @@ Vertical bottom alignment, usually for text-derived classes. </constant> <constant name="SPKEY" value="16777216"> - Scancodes with this bit applied are non printable. + Scancodes with this bit applied are non-printable. </constant> <constant name="KEY_ESCAPE" value="16777217" enum="KeyList"> - Escape Key + Escape key. </constant> <constant name="KEY_TAB" value="16777218" enum="KeyList"> - Tab Key + Tab key. </constant> <constant name="KEY_BACKTAB" value="16777219" enum="KeyList"> - Shift-Tab Key + Shift+Tab key. </constant> <constant name="KEY_BACKSPACE" value="16777220" enum="KeyList"> - Backspace Key + Backspace key. </constant> <constant name="KEY_ENTER" value="16777221" enum="KeyList"> - Return Key (On Main Keyboard) + Return key (on the main keyboard). </constant> <constant name="KEY_KP_ENTER" value="16777222" enum="KeyList"> - Enter Key (On Numpad) + Enter key on the numeric keypad. </constant> <constant name="KEY_INSERT" value="16777223" enum="KeyList"> - Insert Key + Insert key. </constant> <constant name="KEY_DELETE" value="16777224" enum="KeyList"> - Delete Key + Delete key. </constant> <constant name="KEY_PAUSE" value="16777225" enum="KeyList"> - Pause Key + Pause key. </constant> <constant name="KEY_PRINT" value="16777226" enum="KeyList"> - Printscreen Key + Print Screen key. </constant> <constant name="KEY_SYSREQ" value="16777227" enum="KeyList"> - System Request Key + System Request key. </constant> <constant name="KEY_CLEAR" value="16777228" enum="KeyList"> - Clear Key + Clear key. </constant> <constant name="KEY_HOME" value="16777229" enum="KeyList"> - Home Key + Home key. </constant> <constant name="KEY_END" value="16777230" enum="KeyList"> - End Key + End key. </constant> <constant name="KEY_LEFT" value="16777231" enum="KeyList"> - Left Arrow Key + Left arrow key. </constant> <constant name="KEY_UP" value="16777232" enum="KeyList"> - Up Arrow Key + Up arrow key. </constant> <constant name="KEY_RIGHT" value="16777233" enum="KeyList"> - Right Arrow Key + Right arrow key. </constant> <constant name="KEY_DOWN" value="16777234" enum="KeyList"> - Down Arrow Key + Down arrow key. </constant> <constant name="KEY_PAGEUP" value="16777235" enum="KeyList"> - Pageup Key + Page Up key. </constant> <constant name="KEY_PAGEDOWN" value="16777236" enum="KeyList"> - Pagedown Key + Page Down key. </constant> <constant name="KEY_SHIFT" value="16777237" enum="KeyList"> - Shift Key + Shift key. </constant> <constant name="KEY_CONTROL" value="16777238" enum="KeyList"> - Control Key + Control key. </constant> <constant name="KEY_META" value="16777239" enum="KeyList"> - Meta Key + Meta key. </constant> <constant name="KEY_ALT" value="16777240" enum="KeyList"> - Alt Key + Alt key. </constant> <constant name="KEY_CAPSLOCK" value="16777241" enum="KeyList"> - Capslock Key + Caps Lock key. </constant> <constant name="KEY_NUMLOCK" value="16777242" enum="KeyList"> - Numlock Key + Num Lock key. </constant> <constant name="KEY_SCROLLLOCK" value="16777243" enum="KeyList"> - Scrolllock Key + Scroll Lock key. </constant> <constant name="KEY_F1" value="16777244" enum="KeyList"> - F1 Key + F1 key. </constant> <constant name="KEY_F2" value="16777245" enum="KeyList"> - F2 Key + F2 key. </constant> <constant name="KEY_F3" value="16777246" enum="KeyList"> - F3 Key + F3 key. </constant> <constant name="KEY_F4" value="16777247" enum="KeyList"> - F4 Key + F4 key. </constant> <constant name="KEY_F5" value="16777248" enum="KeyList"> - F5 Key + F5 key. </constant> <constant name="KEY_F6" value="16777249" enum="KeyList"> - F6 Key + F6 key. </constant> <constant name="KEY_F7" value="16777250" enum="KeyList"> - F7 Key + F7 key. </constant> <constant name="KEY_F8" value="16777251" enum="KeyList"> - F8 Key + F8 key. </constant> <constant name="KEY_F9" value="16777252" enum="KeyList"> - F9 Key + F9 key. </constant> <constant name="KEY_F10" value="16777253" enum="KeyList"> - F10 Key + F10 key. </constant> <constant name="KEY_F11" value="16777254" enum="KeyList"> - F11 Key + F11 key. </constant> <constant name="KEY_F12" value="16777255" enum="KeyList"> - F12 Key + F12 key. </constant> <constant name="KEY_F13" value="16777256" enum="KeyList"> - F13 Key + F13 key. </constant> <constant name="KEY_F14" value="16777257" enum="KeyList"> - F14 Key + F14 key. </constant> <constant name="KEY_F15" value="16777258" enum="KeyList"> - F15 Key + F15 key. </constant> <constant name="KEY_F16" value="16777259" enum="KeyList"> - F16 Key + F16 key. </constant> <constant name="KEY_KP_MULTIPLY" value="16777345" enum="KeyList"> - Multiply Key on Numpad + Multiply (*) key on the numeric keypad. </constant> <constant name="KEY_KP_DIVIDE" value="16777346" enum="KeyList"> - Divide Key on Numpad + Divide (/) key on the numeric keypad. </constant> <constant name="KEY_KP_SUBTRACT" value="16777347" enum="KeyList"> - Subtract Key on Numpad + Subtract (-) key on the numeric keypad. </constant> <constant name="KEY_KP_PERIOD" value="16777348" enum="KeyList"> - Period Key on Numpad + Period (.) key on the numeric keypad. </constant> <constant name="KEY_KP_ADD" value="16777349" enum="KeyList"> - Add Key on Numpad + Add (+) key on the numeric keypad. </constant> <constant name="KEY_KP_0" value="16777350" enum="KeyList"> - Number 0 on Numpad + Number 0 on the numeric keypad. </constant> <constant name="KEY_KP_1" value="16777351" enum="KeyList"> - Number 1 on Numpad + Number 1 on the numeric keypad. </constant> <constant name="KEY_KP_2" value="16777352" enum="KeyList"> - Number 2 on Numpad + Number 2 on the numeric keypad. </constant> <constant name="KEY_KP_3" value="16777353" enum="KeyList"> - Number 3 on Numpad + Number 3 on the numeric keypad. </constant> <constant name="KEY_KP_4" value="16777354" enum="KeyList"> - Number 4 on Numpad + Number 4 on the numeric keypad. </constant> <constant name="KEY_KP_5" value="16777355" enum="KeyList"> - Number 5 on Numpad + Number 5 on the numeric keypad. </constant> <constant name="KEY_KP_6" value="16777356" enum="KeyList"> - Number 6 on Numpad + Number 6 on the numeric keypad. </constant> <constant name="KEY_KP_7" value="16777357" enum="KeyList"> - Number 7 on Numpad + Number 7 on the numeric keypad. </constant> <constant name="KEY_KP_8" value="16777358" enum="KeyList"> - Number 8 on Numpad + Number 8 on the numeric keypad. </constant> <constant name="KEY_KP_9" value="16777359" enum="KeyList"> - Number 9 on Numpad + Number 9 on the numeric keypad. </constant> <constant name="KEY_SUPER_L" value="16777260" enum="KeyList"> - Left Super Key (Windows Key) + Left Super key (Windows key). </constant> <constant name="KEY_SUPER_R" value="16777261" enum="KeyList"> - Right Super Key (Windows Key) + Right Super key (Windows key). </constant> <constant name="KEY_MENU" value="16777262" enum="KeyList"> - Context menu key + Context menu key. </constant> <constant name="KEY_HYPER_L" value="16777263" enum="KeyList"> - Left Hyper Key + Left Hyper key. </constant> <constant name="KEY_HYPER_R" value="16777264" enum="KeyList"> - Right Hyper Key + Right Hyper key. </constant> <constant name="KEY_HELP" value="16777265" enum="KeyList"> - Help key + Help key. </constant> <constant name="KEY_DIRECTION_L" value="16777266" enum="KeyList"> - Left Direction Key + Left Direction key. </constant> <constant name="KEY_DIRECTION_R" value="16777267" enum="KeyList"> - Right Direction Key + Right Direction key. </constant> <constant name="KEY_BACK" value="16777280" enum="KeyList"> - Back key + Back key. </constant> <constant name="KEY_FORWARD" value="16777281" enum="KeyList"> - Forward key + Forward key. </constant> <constant name="KEY_STOP" value="16777282" enum="KeyList"> - Stop key + Stop key. </constant> <constant name="KEY_REFRESH" value="16777283" enum="KeyList"> - Refresh key + Refresh key. </constant> <constant name="KEY_VOLUMEDOWN" value="16777284" enum="KeyList"> - Volume down key + Volume down key. </constant> <constant name="KEY_VOLUMEMUTE" value="16777285" enum="KeyList"> - Mute volume key + Mute volume key. </constant> <constant name="KEY_VOLUMEUP" value="16777286" enum="KeyList"> - Volume up key + Volume up key. </constant> <constant name="KEY_BASSBOOST" value="16777287" enum="KeyList"> - Bass Boost Key + Bass Boost key. </constant> <constant name="KEY_BASSUP" value="16777288" enum="KeyList"> - Bass Up Key + Bass up key. </constant> <constant name="KEY_BASSDOWN" value="16777289" enum="KeyList"> - Bass Down Key + Bass down key. </constant> <constant name="KEY_TREBLEUP" value="16777290" enum="KeyList"> - Treble Up Key + Treble up key. </constant> <constant name="KEY_TREBLEDOWN" value="16777291" enum="KeyList"> - Treble Down Key + Treble down key. </constant> <constant name="KEY_MEDIAPLAY" value="16777292" enum="KeyList"> - Media play key + Media play key. </constant> <constant name="KEY_MEDIASTOP" value="16777293" enum="KeyList"> - Media stop key + Media stop key. </constant> <constant name="KEY_MEDIAPREVIOUS" value="16777294" enum="KeyList"> - Previous song key + Previous song key. </constant> <constant name="KEY_MEDIANEXT" value="16777295" enum="KeyList"> - Next song key + Next song key. </constant> <constant name="KEY_MEDIARECORD" value="16777296" enum="KeyList"> - Media record key + Media record key. </constant> <constant name="KEY_HOMEPAGE" value="16777297" enum="KeyList"> - Home page key + Home page key. </constant> <constant name="KEY_FAVORITES" value="16777298" enum="KeyList"> - Favorites key + Favorites key. </constant> <constant name="KEY_SEARCH" value="16777299" enum="KeyList"> - Search key + Search key. </constant> <constant name="KEY_STANDBY" value="16777300" enum="KeyList"> - Standby Key + Standby key. </constant> <constant name="KEY_OPENURL" value="16777301" enum="KeyList"> - Open URL / Launch Browser Key + Open URL / Launch Browser key. </constant> <constant name="KEY_LAUNCHMAIL" value="16777302" enum="KeyList"> - Launch Mail Key + Launch Mail key. </constant> <constant name="KEY_LAUNCHMEDIA" value="16777303" enum="KeyList"> - Launch Media Key + Launch Media key. </constant> <constant name="KEY_LAUNCH0" value="16777304" enum="KeyList"> - Launch Shortcut 0 Key + Launch Shortcut 0 key. </constant> <constant name="KEY_LAUNCH1" value="16777305" enum="KeyList"> - Launch Shortcut 1 Key + Launch Shortcut 1 key. </constant> <constant name="KEY_LAUNCH2" value="16777306" enum="KeyList"> - Launch Shortcut 2 Key + Launch Shortcut 2 key. </constant> <constant name="KEY_LAUNCH3" value="16777307" enum="KeyList"> - Launch Shortcut 3 Key + Launch Shortcut 3 key. </constant> <constant name="KEY_LAUNCH4" value="16777308" enum="KeyList"> - Launch Shortcut 4 Key + Launch Shortcut 4 key. </constant> <constant name="KEY_LAUNCH5" value="16777309" enum="KeyList"> - Launch Shortcut 5 Key + Launch Shortcut 5 key. </constant> <constant name="KEY_LAUNCH6" value="16777310" enum="KeyList"> - Launch Shortcut 6 Key + Launch Shortcut 6 key. </constant> <constant name="KEY_LAUNCH7" value="16777311" enum="KeyList"> - Launch Shortcut 7 Key + Launch Shortcut 7 key. </constant> <constant name="KEY_LAUNCH8" value="16777312" enum="KeyList"> - Launch Shortcut 8 Key + Launch Shortcut 8 key. </constant> <constant name="KEY_LAUNCH9" value="16777313" enum="KeyList"> - Launch Shortcut 9 Key + Launch Shortcut 9 key. </constant> <constant name="KEY_LAUNCHA" value="16777314" enum="KeyList"> - Launch Shortcut A Key + Launch Shortcut A key. </constant> <constant name="KEY_LAUNCHB" value="16777315" enum="KeyList"> - Launch Shortcut B Key + Launch Shortcut B key. </constant> <constant name="KEY_LAUNCHC" value="16777316" enum="KeyList"> - Launch Shortcut C Key + Launch Shortcut C key. </constant> <constant name="KEY_LAUNCHD" value="16777317" enum="KeyList"> - Launch Shortcut D Key + Launch Shortcut D key. </constant> <constant name="KEY_LAUNCHE" value="16777318" enum="KeyList"> - Launch Shortcut E Key + Launch Shortcut E key. </constant> <constant name="KEY_LAUNCHF" value="16777319" enum="KeyList"> - Launch Shortcut F Key + Launch Shortcut F key. </constant> <constant name="KEY_UNKNOWN" value="33554431" enum="KeyList"> - Unknown Key + Unknown key. </constant> <constant name="KEY_SPACE" value="32" enum="KeyList"> - Space Key + Space key. </constant> <constant name="KEY_EXCLAM" value="33" enum="KeyList"> - ! key + ! key. </constant> <constant name="KEY_QUOTEDBL" value="34" enum="KeyList"> - " key + " key. </constant> <constant name="KEY_NUMBERSIGN" value="35" enum="KeyList"> - # key + # key. </constant> <constant name="KEY_DOLLAR" value="36" enum="KeyList"> - $ key + $ key. </constant> <constant name="KEY_PERCENT" value="37" enum="KeyList"> - % key + % key. </constant> <constant name="KEY_AMPERSAND" value="38" enum="KeyList"> - & key + & key. </constant> <constant name="KEY_APOSTROPHE" value="39" enum="KeyList"> - ' key + ' key. </constant> <constant name="KEY_PARENLEFT" value="40" enum="KeyList"> - ( key + ( key. </constant> <constant name="KEY_PARENRIGHT" value="41" enum="KeyList"> - ) key + ) key. </constant> <constant name="KEY_ASTERISK" value="42" enum="KeyList"> - * key + * key. </constant> <constant name="KEY_PLUS" value="43" enum="KeyList"> - + key + + key. </constant> <constant name="KEY_COMMA" value="44" enum="KeyList"> - , key + , key. </constant> <constant name="KEY_MINUS" value="45" enum="KeyList"> - - key + - key. </constant> <constant name="KEY_PERIOD" value="46" enum="KeyList"> - . key + . key. </constant> <constant name="KEY_SLASH" value="47" enum="KeyList"> - / key + / key. </constant> <constant name="KEY_0" value="48" enum="KeyList"> - Number 0 + Number 0. </constant> <constant name="KEY_1" value="49" enum="KeyList"> - Number 1 + Number 1. </constant> <constant name="KEY_2" value="50" enum="KeyList"> - Number 2 + Number 2. </constant> <constant name="KEY_3" value="51" enum="KeyList"> - Number 3 + Number 3. </constant> <constant name="KEY_4" value="52" enum="KeyList"> - Number 4 + Number 4. </constant> <constant name="KEY_5" value="53" enum="KeyList"> - Number 5 + Number 5. </constant> <constant name="KEY_6" value="54" enum="KeyList"> - Number 6 + Number 6. </constant> <constant name="KEY_7" value="55" enum="KeyList"> - Number 7 + Number 7. </constant> <constant name="KEY_8" value="56" enum="KeyList"> - Number 8 + Number 8. </constant> <constant name="KEY_9" value="57" enum="KeyList"> - Number 9 + Number 9. </constant> <constant name="KEY_COLON" value="58" enum="KeyList"> - : key + : key. </constant> <constant name="KEY_SEMICOLON" value="59" enum="KeyList"> - ; key + ; key. </constant> <constant name="KEY_LESS" value="60" enum="KeyList"> - Lower than key + < key. </constant> <constant name="KEY_EQUAL" value="61" enum="KeyList"> - = key + = key. </constant> <constant name="KEY_GREATER" value="62" enum="KeyList"> - Greater than key + > key. </constant> <constant name="KEY_QUESTION" value="63" enum="KeyList"> - ? key + ? key. </constant> <constant name="KEY_AT" value="64" enum="KeyList"> - @ key + @ key. </constant> <constant name="KEY_A" value="65" enum="KeyList"> - A Key + A key. </constant> <constant name="KEY_B" value="66" enum="KeyList"> - B Key + B key. </constant> <constant name="KEY_C" value="67" enum="KeyList"> - C Key + C key. </constant> <constant name="KEY_D" value="68" enum="KeyList"> - D Key + D key. </constant> <constant name="KEY_E" value="69" enum="KeyList"> - E Key + E key. </constant> <constant name="KEY_F" value="70" enum="KeyList"> - F Key + F key. </constant> <constant name="KEY_G" value="71" enum="KeyList"> - G Key + G key. </constant> <constant name="KEY_H" value="72" enum="KeyList"> - H Key + H key. </constant> <constant name="KEY_I" value="73" enum="KeyList"> - I Key + I key. </constant> <constant name="KEY_J" value="74" enum="KeyList"> - J Key + J key. </constant> <constant name="KEY_K" value="75" enum="KeyList"> - K Key + K key. </constant> <constant name="KEY_L" value="76" enum="KeyList"> - L Key + L key. </constant> <constant name="KEY_M" value="77" enum="KeyList"> - M Key + M key. </constant> <constant name="KEY_N" value="78" enum="KeyList"> - N Key + N key. </constant> <constant name="KEY_O" value="79" enum="KeyList"> - O Key + O key. </constant> <constant name="KEY_P" value="80" enum="KeyList"> - P Key + P key. </constant> <constant name="KEY_Q" value="81" enum="KeyList"> - Q Key + Q key. </constant> <constant name="KEY_R" value="82" enum="KeyList"> - R Key + R key. </constant> <constant name="KEY_S" value="83" enum="KeyList"> - S Key + S key. </constant> <constant name="KEY_T" value="84" enum="KeyList"> - T Key + T key. </constant> <constant name="KEY_U" value="85" enum="KeyList"> - U Key + U key. </constant> <constant name="KEY_V" value="86" enum="KeyList"> - V Key + V key. </constant> <constant name="KEY_W" value="87" enum="KeyList"> - W Key + W key. </constant> <constant name="KEY_X" value="88" enum="KeyList"> - X Key + X key. </constant> <constant name="KEY_Y" value="89" enum="KeyList"> - Y Key + Y key. </constant> <constant name="KEY_Z" value="90" enum="KeyList"> - Z Key + Z key. </constant> <constant name="KEY_BRACKETLEFT" value="91" enum="KeyList"> - [ key + [ key. </constant> <constant name="KEY_BACKSLASH" value="92" enum="KeyList"> - \ key + \ key. </constant> <constant name="KEY_BRACKETRIGHT" value="93" enum="KeyList"> - ] key + ] key. </constant> <constant name="KEY_ASCIICIRCUM" value="94" enum="KeyList"> - ^ key + ^ key. </constant> <constant name="KEY_UNDERSCORE" value="95" enum="KeyList"> - _ key + _ key. </constant> <constant name="KEY_QUOTELEFT" value="96" enum="KeyList"> - Left Quote Key + Left Quote key. </constant> <constant name="KEY_BRACELEFT" value="123" enum="KeyList"> - { key + { key. </constant> <constant name="KEY_BAR" value="124" enum="KeyList"> - | key + | key. </constant> <constant name="KEY_BRACERIGHT" value="125" enum="KeyList"> - } key + } key. </constant> <constant name="KEY_ASCIITILDE" value="126" enum="KeyList"> - ~ key + ~ key. </constant> <constant name="KEY_NOBREAKSPACE" value="160" enum="KeyList"> + Non-breakable space key. </constant> <constant name="KEY_EXCLAMDOWN" value="161" enum="KeyList"> + ¡ key. </constant> <constant name="KEY_CENT" value="162" enum="KeyList"> - ¢ key + ¢ key. </constant> <constant name="KEY_STERLING" value="163" enum="KeyList"> + £ key. </constant> <constant name="KEY_CURRENCY" value="164" enum="KeyList"> </constant> <constant name="KEY_YEN" value="165" enum="KeyList"> - Yen Key + Yen key. </constant> <constant name="KEY_BROKENBAR" value="166" enum="KeyList"> - ¦ key + ¦ key. </constant> <constant name="KEY_SECTION" value="167" enum="KeyList"> - § key + § key. </constant> <constant name="KEY_DIAERESIS" value="168" enum="KeyList"> - ¨ key + ¨ key. </constant> <constant name="KEY_COPYRIGHT" value="169" enum="KeyList"> - © key + © key. </constant> <constant name="KEY_ORDFEMININE" value="170" enum="KeyList"> </constant> <constant name="KEY_GUILLEMOTLEFT" value="171" enum="KeyList"> - « key + « key. </constant> <constant name="KEY_NOTSIGN" value="172" enum="KeyList"> - » key + » key. </constant> <constant name="KEY_HYPHEN" value="173" enum="KeyList"> - ‐ key + ‐ key. </constant> <constant name="KEY_REGISTERED" value="174" enum="KeyList"> - ® key + ® key. </constant> <constant name="KEY_MACRON" value="175" enum="KeyList"> - Macron Key + Macron key. </constant> <constant name="KEY_DEGREE" value="176" enum="KeyList"> - ° key + ° key. </constant> <constant name="KEY_PLUSMINUS" value="177" enum="KeyList"> - ± key + ± key. </constant> <constant name="KEY_TWOSUPERIOR" value="178" enum="KeyList"> - ² key + ² key. </constant> <constant name="KEY_THREESUPERIOR" value="179" enum="KeyList"> - ³ key + ³ key. </constant> <constant name="KEY_ACUTE" value="180" enum="KeyList"> - ´ key + ´ key. </constant> <constant name="KEY_MU" value="181" enum="KeyList"> - µ key + µ key. </constant> <constant name="KEY_PARAGRAPH" value="182" enum="KeyList"> - Paragraph Key + § key. </constant> <constant name="KEY_PERIODCENTERED" value="183" enum="KeyList"> - · key + · key. </constant> <constant name="KEY_CEDILLA" value="184" enum="KeyList"> - ¬ key + ¬ key. </constant> <constant name="KEY_ONESUPERIOR" value="185" enum="KeyList"> - ¹ key + ¹ key. </constant> <constant name="KEY_MASCULINE" value="186" enum="KeyList"> - ♂ key + ♂ key. </constant> <constant name="KEY_GUILLEMOTRIGHT" value="187" enum="KeyList"> - » key + » key. </constant> <constant name="KEY_ONEQUARTER" value="188" enum="KeyList"> - ¼ key + ¼ key. </constant> <constant name="KEY_ONEHALF" value="189" enum="KeyList"> - ½ key + ½ key. </constant> <constant name="KEY_THREEQUARTERS" value="190" enum="KeyList"> - ¾ key + ¾ key. </constant> <constant name="KEY_QUESTIONDOWN" value="191" enum="KeyList"> - ¿ key + ¿ key. </constant> <constant name="KEY_AGRAVE" value="192" enum="KeyList"> - à key + à key. </constant> <constant name="KEY_AACUTE" value="193" enum="KeyList"> - á key + á key. </constant> <constant name="KEY_ACIRCUMFLEX" value="194" enum="KeyList"> - â key + â key. </constant> <constant name="KEY_ATILDE" value="195" enum="KeyList"> - ã key + ã key. </constant> <constant name="KEY_ADIAERESIS" value="196" enum="KeyList"> - ä key + ä key. </constant> <constant name="KEY_ARING" value="197" enum="KeyList"> - å key + å key. </constant> <constant name="KEY_AE" value="198" enum="KeyList"> - æ key + æ key. </constant> <constant name="KEY_CCEDILLA" value="199" enum="KeyList"> - ç key + ç key. </constant> <constant name="KEY_EGRAVE" value="200" enum="KeyList"> - è key + è key. </constant> <constant name="KEY_EACUTE" value="201" enum="KeyList"> - é key + é key. </constant> <constant name="KEY_ECIRCUMFLEX" value="202" enum="KeyList"> - ê key + ê key. </constant> <constant name="KEY_EDIAERESIS" value="203" enum="KeyList"> - ë key + ë key. </constant> <constant name="KEY_IGRAVE" value="204" enum="KeyList"> - ì key + ì key. </constant> <constant name="KEY_IACUTE" value="205" enum="KeyList"> - í key + í key. </constant> <constant name="KEY_ICIRCUMFLEX" value="206" enum="KeyList"> - î key + î key. </constant> <constant name="KEY_IDIAERESIS" value="207" enum="KeyList"> - ë key + ë key. </constant> <constant name="KEY_ETH" value="208" enum="KeyList"> - ð key + ð key. </constant> <constant name="KEY_NTILDE" value="209" enum="KeyList"> - ñ key + ñ key. </constant> <constant name="KEY_OGRAVE" value="210" enum="KeyList"> - ò key + ò key. </constant> <constant name="KEY_OACUTE" value="211" enum="KeyList"> - ó key + ó key. </constant> <constant name="KEY_OCIRCUMFLEX" value="212" enum="KeyList"> - ô key + ô key. </constant> <constant name="KEY_OTILDE" value="213" enum="KeyList"> - õ key + õ key. </constant> <constant name="KEY_ODIAERESIS" value="214" enum="KeyList"> - ö key + ö key. </constant> <constant name="KEY_MULTIPLY" value="215" enum="KeyList"> - × key + × key. </constant> <constant name="KEY_OOBLIQUE" value="216" enum="KeyList"> - ø key + ø key. </constant> <constant name="KEY_UGRAVE" value="217" enum="KeyList"> - ù key + ù key. </constant> <constant name="KEY_UACUTE" value="218" enum="KeyList"> - ú key + ú key. </constant> <constant name="KEY_UCIRCUMFLEX" value="219" enum="KeyList"> - û key + û key. </constant> <constant name="KEY_UDIAERESIS" value="220" enum="KeyList"> - ü key + ü key. </constant> <constant name="KEY_YACUTE" value="221" enum="KeyList"> - ý key + ý key. </constant> <constant name="KEY_THORN" value="222" enum="KeyList"> - þ key + þ key. </constant> <constant name="KEY_SSHARP" value="223" enum="KeyList"> - ß key + ß key. </constant> <constant name="KEY_DIVISION" value="247" enum="KeyList"> - ÷ key + ÷ key. </constant> <constant name="KEY_YDIAERESIS" value="255" enum="KeyList"> - ÿ key + ÿ key. </constant> <constant name="KEY_CODE_MASK" value="33554431" enum="KeyModifierMask"> - Key Code Mask + Key Code mask. </constant> <constant name="KEY_MODIFIER_MASK" value="-16777216" enum="KeyModifierMask"> - Modifier Key Mask + Modifier key mask. </constant> <constant name="KEY_MASK_SHIFT" value="33554432" enum="KeyModifierMask"> - Shift Key Mask + Shift key mask. </constant> <constant name="KEY_MASK_ALT" value="67108864" enum="KeyModifierMask"> - Alt Key Mask + Alt key mask. </constant> <constant name="KEY_MASK_META" value="134217728" enum="KeyModifierMask"> - Meta Key Mask + Meta key mask. </constant> <constant name="KEY_MASK_CTRL" value="268435456" enum="KeyModifierMask"> - CTRL Key Mask + Ctrl key mask. </constant> <constant name="KEY_MASK_CMD" value="268435456" enum="KeyModifierMask"> - CMD Key Mask + Cmd key mask. </constant> <constant name="KEY_MASK_KPAD" value="536870912" enum="KeyModifierMask"> - Keypad Key Mask + Keypad key mask. </constant> <constant name="KEY_MASK_GROUP_SWITCH" value="1073741824" enum="KeyModifierMask"> - Group Switch Key Mask + Group Switch key mask. </constant> <constant name="BUTTON_LEFT" value="1" enum="ButtonList"> - Left Mouse Button + Left mouse button. </constant> <constant name="BUTTON_RIGHT" value="2" enum="ButtonList"> - Right Mouse Button + Right mouse button. </constant> <constant name="BUTTON_MIDDLE" value="3" enum="ButtonList"> - Middle Mouse Button + Middle mouse button. </constant> <constant name="BUTTON_XBUTTON1" value="8" enum="ButtonList"> - Extra Mouse Button 1 + Extra mouse button 1 (only present on some mice). </constant> <constant name="BUTTON_XBUTTON2" value="9" enum="ButtonList"> - Extra Mouse Button 2 + Extra mouse button 2 (only present on some mice). </constant> <constant name="BUTTON_WHEEL_UP" value="4" enum="ButtonList"> - Mouse wheel up + Mouse wheel up. </constant> <constant name="BUTTON_WHEEL_DOWN" value="5" enum="ButtonList"> - Mouse wheel down + Mouse wheel down. </constant> <constant name="BUTTON_WHEEL_LEFT" value="6" enum="ButtonList"> - Mouse wheel left button + Mouse wheel left button (only present on some mice). </constant> <constant name="BUTTON_WHEEL_RIGHT" value="7" enum="ButtonList"> - Mouse wheel right button + Mouse wheel right button (only present on some mice). </constant> <constant name="BUTTON_MASK_LEFT" value="1" enum="ButtonList"> - Left Mouse Button Mask + Left mouse button mask. </constant> <constant name="BUTTON_MASK_RIGHT" value="2" enum="ButtonList"> - Right Mouse Button Mask + Right mouse button mask. </constant> <constant name="BUTTON_MASK_MIDDLE" value="4" enum="ButtonList"> - Middle Mouse Button Mask + Middle mouse button mask. </constant> <constant name="BUTTON_MASK_XBUTTON1" value="128" enum="ButtonList"> - Extra Mouse Button 1 Mask + Extra mouse button 1 mask. </constant> <constant name="BUTTON_MASK_XBUTTON2" value="256" enum="ButtonList"> - Extra Mouse Button 2 Mask + Extra mouse button 2 mask. </constant> <constant name="JOY_BUTTON_0" value="0" enum="JoystickList"> - Joypad Button 0 + Gamepad button 0. </constant> <constant name="JOY_BUTTON_1" value="1" enum="JoystickList"> - Joypad Button 1 + Gamepad button 1. </constant> <constant name="JOY_BUTTON_2" value="2" enum="JoystickList"> - Joypad Button 2 + Gamepad button 2. </constant> <constant name="JOY_BUTTON_3" value="3" enum="JoystickList"> - Joypad Button 3 + Gamepad button 3. </constant> <constant name="JOY_BUTTON_4" value="4" enum="JoystickList"> - Joypad Button 4 + Gamepad button 4. </constant> <constant name="JOY_BUTTON_5" value="5" enum="JoystickList"> - Joypad Button 5 + Gamepad button 5. </constant> <constant name="JOY_BUTTON_6" value="6" enum="JoystickList"> - Joypad Button 6 + Gamepad button 6. </constant> <constant name="JOY_BUTTON_7" value="7" enum="JoystickList"> - Joypad Button 7 + Gamepad button 7. </constant> <constant name="JOY_BUTTON_8" value="8" enum="JoystickList"> - Joypad Button 8 + Gamepad button 8. </constant> <constant name="JOY_BUTTON_9" value="9" enum="JoystickList"> - Joypad Button 9 + Gamepad button 9. </constant> <constant name="JOY_BUTTON_10" value="10" enum="JoystickList"> - Joypad Button 10 + Gamepad button 10. </constant> <constant name="JOY_BUTTON_11" value="11" enum="JoystickList"> - Joypad Button 11 + Gamepad button 11. </constant> <constant name="JOY_BUTTON_12" value="12" enum="JoystickList"> - Joypad Button 12 + Gamepad button 12. </constant> <constant name="JOY_BUTTON_13" value="13" enum="JoystickList"> - Joypad Button 13 + Gamepad button 13. </constant> <constant name="JOY_BUTTON_14" value="14" enum="JoystickList"> - Joypad Button 14 + Gamepad button 14. </constant> <constant name="JOY_BUTTON_15" value="15" enum="JoystickList"> - Joypad Button 15 + Gamepad button 15. </constant> <constant name="JOY_BUTTON_MAX" value="16" enum="JoystickList"> Represents the maximum number of joystick buttons supported. </constant> <constant name="JOY_SONY_CIRCLE" value="1" enum="JoystickList"> - DUALSHOCK circle button + DualShock circle button. </constant> <constant name="JOY_SONY_X" value="0" enum="JoystickList"> - DUALSHOCK X button + DualShock X button. </constant> <constant name="JOY_SONY_SQUARE" value="2" enum="JoystickList"> - DUALSHOCK square button + DualShock square button. </constant> <constant name="JOY_SONY_TRIANGLE" value="3" enum="JoystickList"> - DUALSHOCK triangle button + DualShock triangle button. </constant> <constant name="JOY_XBOX_B" value="1" enum="JoystickList"> - XBOX controller B button + Xbox controller B button. </constant> <constant name="JOY_XBOX_A" value="0" enum="JoystickList"> - XBOX controller A button + Xbox controller A button. </constant> <constant name="JOY_XBOX_X" value="2" enum="JoystickList"> - XBOX controller X button + Xbox controller X button. </constant> <constant name="JOY_XBOX_Y" value="3" enum="JoystickList"> - XBOX controller Y button + Xbox controller Y button. </constant> <constant name="JOY_DS_A" value="1" enum="JoystickList"> - DualShock controller A button + DualShock controller A button. </constant> <constant name="JOY_DS_B" value="0" enum="JoystickList"> - DualShock controller B button + DualShock controller B button. </constant> <constant name="JOY_DS_X" value="3" enum="JoystickList"> - DualShock controller X button + DualShock controller X button. </constant> <constant name="JOY_DS_Y" value="2" enum="JoystickList"> - DualShock controller Y button + DualShock controller Y button. </constant> <constant name="JOY_VR_GRIP" value="2" enum="JoystickList"> - Grip (side) buttons on a VR controller + Grip (side) buttons on a VR controller. </constant> <constant name="JOY_VR_PAD" value="14" enum="JoystickList"> - Push down on the touchpad or main joystick on a VR controller + Push down on the touchpad or main joystick on a VR controller. </constant> <constant name="JOY_VR_TRIGGER" value="15" enum="JoystickList"> - Trigger on a VR controller + Trigger on a VR controller. </constant> <constant name="JOY_OCULUS_AX" value="7" enum="JoystickList"> - A button on the right Oculus Touch controller, X button on the left controller (also when used in OpenVR) + A button on the right Oculus Touch controller, X button on the left controller (also when used in OpenVR). </constant> <constant name="JOY_OCULUS_BY" value="1" enum="JoystickList"> - B button on the right Oculus Touch controller, Y button on the left controller (also when used in OpenVR) + B button on the right Oculus Touch controller, Y button on the left controller (also when used in OpenVR). </constant> <constant name="JOY_OCULUS_MENU" value="3" enum="JoystickList"> Menu button on either Oculus Touch controller. </constant> <constant name="JOY_OPENVR_MENU" value="1" enum="JoystickList"> - Menu button in OpenVR (Except when Oculus Touch controllers are used) + Menu button in OpenVR (Except when Oculus Touch controllers are used). </constant> <constant name="JOY_SELECT" value="10" enum="JoystickList"> - Joypad Button Select + Gamepad button Select. </constant> <constant name="JOY_START" value="11" enum="JoystickList"> - Joypad Button Start + Gamepad button Start. </constant> <constant name="JOY_DPAD_UP" value="12" enum="JoystickList"> - Joypad DPad Up + Gamepad DPad up. </constant> <constant name="JOY_DPAD_DOWN" value="13" enum="JoystickList"> - Joypad DPad Down + Gamepad DPad down. </constant> <constant name="JOY_DPAD_LEFT" value="14" enum="JoystickList"> - Joypad DPad Left + Gamepad DPad left. </constant> <constant name="JOY_DPAD_RIGHT" value="15" enum="JoystickList"> - Joypad DPad Right + Gamepad DPad right. </constant> <constant name="JOY_L" value="4" enum="JoystickList"> - Joypad Left Shoulder Button + Gamepad left Shoulder button. </constant> <constant name="JOY_L2" value="6" enum="JoystickList"> - Joypad Left Trigger + Gamepad left trigger. </constant> <constant name="JOY_L3" value="8" enum="JoystickList"> - Joypad Left Stick Click + Gamepad left stick click. </constant> <constant name="JOY_R" value="5" enum="JoystickList"> - Joypad Right Shoulder Button + Gamepad right Shoulder button. </constant> <constant name="JOY_R2" value="7" enum="JoystickList"> - Joypad Right Trigger + Gamepad right trigger. </constant> <constant name="JOY_R3" value="9" enum="JoystickList"> - Joypad Right Stick Click + Gamepad right stick click. </constant> <constant name="JOY_AXIS_0" value="0" enum="JoystickList"> - Joypad Left Stick Horizontal Axis + Gamepad left stick horizontal axis. </constant> <constant name="JOY_AXIS_1" value="1" enum="JoystickList"> - Joypad Left Stick Vertical Axis + Gamepad left stick vertical axis. </constant> <constant name="JOY_AXIS_2" value="2" enum="JoystickList"> - Joypad Right Stick Horizontal Axis + Gamepad right stick horizontal axis. </constant> <constant name="JOY_AXIS_3" value="3" enum="JoystickList"> - Joypad Right Stick Vertical Axis + Gamepad right stick vertical axis. </constant> <constant name="JOY_AXIS_4" value="4" enum="JoystickList"> </constant> <constant name="JOY_AXIS_5" value="5" enum="JoystickList"> </constant> <constant name="JOY_AXIS_6" value="6" enum="JoystickList"> - Joypad Left Trigger Analog Axis + Gamepad left trigger analog axis. </constant> <constant name="JOY_AXIS_7" value="7" enum="JoystickList"> - Joypad Right Trigger Analog Axis + Gamepad right trigger analog axis. </constant> <constant name="JOY_AXIS_8" value="8" enum="JoystickList"> </constant> @@ -1093,34 +1101,34 @@ Represents the maximum number of joystick axes supported. </constant> <constant name="JOY_ANALOG_LX" value="0" enum="JoystickList"> - Joypad Left Stick Horizontal Axis + Gamepad left stick horizontal axis. </constant> <constant name="JOY_ANALOG_LY" value="1" enum="JoystickList"> - Joypad Left Stick Vertical Axis + Gamepad left stick vertical axis. </constant> <constant name="JOY_ANALOG_RX" value="2" enum="JoystickList"> - Joypad Right Stick Horizontal Axis + Gamepad right stick horizontal axis. </constant> <constant name="JOY_ANALOG_RY" value="3" enum="JoystickList"> - Joypad Right Stick Vertical Axis + Gamepad right stick vertical axis. </constant> <constant name="JOY_ANALOG_L2" value="6" enum="JoystickList"> - Joypad Left Analog Trigger + Gamepad left analog trigger. </constant> <constant name="JOY_ANALOG_R2" value="7" enum="JoystickList"> - Joypad Right Analog Trigger + Gamepad right analog trigger. </constant> <constant name="JOY_VR_ANALOG_TRIGGER" value="2" enum="JoystickList"> - VR Controller Analog Trigger + VR Controller analog trigger. </constant> <constant name="JOY_VR_ANALOG_GRIP" value="4" enum="JoystickList"> - VR Controller Analog Grip (side buttons) + VR Controller analog grip (side buttons). </constant> <constant name="JOY_OPENVR_TOUCHPADX" value="0" enum="JoystickList"> - OpenVR touchpad X axis (Joystick axis on Oculus Touch and Windows MR controllers) + OpenVR touchpad X axis (Joystick axis on Oculus Touch and Windows MR controllers). </constant> <constant name="JOY_OPENVR_TOUCHPADY" value="1" enum="JoystickList"> - OpenVR touchpad Y axis (Joystick axis on Oculus Touch and Windows MR controllers) + OpenVR touchpad Y axis (Joystick axis on Oculus Touch and Windows MR controllers). </constant> <constant name="MIDI_MESSAGE_NOTE_OFF" value="8" enum="MidiMessageList"> </constant> @@ -1137,7 +1145,7 @@ <constant name="MIDI_MESSAGE_PITCH_BEND" value="14" enum="MidiMessageList"> </constant> <constant name="OK" value="0" enum="Error"> - Methods that return [enum Error] return [constant OK] when no error occurred. Note that many functions don't return an error code but will print error messages to stdout. + Methods that return [enum Error] return [constant OK] when no error occurred. Note that many functions don't return an error code but will print error messages to standard output. Since [constant OK] has value 0, and all other failure codes are positive integers, it can also be used in boolean checks, e.g.: [codeblock] var err = method_that_returns_error() @@ -1293,16 +1301,16 @@ Printer on fire error. (This is an easter egg, no engine methods return this error code.) </constant> <constant name="PROPERTY_HINT_NONE" value="0" enum="PropertyHint"> - No hint for edited property. + No hint for the edited property. </constant> <constant name="PROPERTY_HINT_RANGE" value="1" enum="PropertyHint"> - Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats. + Hints that the string is a range, defined as [code]"min,max"[/code] or [code]"min,max,step"[/code]. This is valid for integers and floats. </constant> <constant name="PROPERTY_HINT_EXP_RANGE" value="2" enum="PropertyHint"> - Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. + Hints that the string is an exponential range, defined as [code]"min,max"[/code] or [code]"min,max,step"[/code]. This is valid for integers and floats. </constant> <constant name="PROPERTY_HINT_ENUM" value="3" enum="PropertyHint"> - Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties. + Property hint for an enumerated value, like [code]"Hello,Something,Else"[/code]. This is valid for integer, float and string properties. </constant> <constant name="PROPERTY_HINT_EXP_EASING" value="4" enum="PropertyHint"> </constant> @@ -1311,7 +1319,7 @@ <constant name="PROPERTY_HINT_KEY_ACCEL" value="7" enum="PropertyHint"> </constant> <constant name="PROPERTY_HINT_FLAGS" value="8" enum="PropertyHint"> - Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. + Property hint for a bitmask description. For example, for bits 0, 1, 2, 3 and 5, the hint could be something like [code]"Bit0,Bit1,Bit2,Bit3,,Bit5"[/code]. This is only valid for integer properties. </constant> <constant name="PROPERTY_HINT_LAYERS_2D_RENDER" value="9" enum="PropertyHint"> </constant> @@ -1322,17 +1330,17 @@ <constant name="PROPERTY_HINT_LAYERS_3D_PHYSICS" value="12" enum="PropertyHint"> </constant> <constant name="PROPERTY_HINT_FILE" value="13" enum="PropertyHint"> - String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". + String property is a file, will pop up a file dialog when edited. Hint string can be a set of wildcards like [code]"*.doc"[/code]. </constant> <constant name="PROPERTY_HINT_DIR" value="14" enum="PropertyHint"> - String property is a directory (so pop up a file dialog when edited). + String property is a directory, will pop up a file dialog when edited. </constant> <constant name="PROPERTY_HINT_GLOBAL_FILE" value="15" enum="PropertyHint"> </constant> <constant name="PROPERTY_HINT_GLOBAL_DIR" value="16" enum="PropertyHint"> </constant> <constant name="PROPERTY_HINT_RESOURCE_TYPE" value="17" enum="PropertyHint"> - String property is a resource, so open the resource popup menu when edited. + String property is a resource, will open the resource popup menu when edited. </constant> <constant name="PROPERTY_HINT_MULTILINE_TEXT" value="18" enum="PropertyHint"> </constant> @@ -1380,29 +1388,29 @@ <constant name="PROPERTY_USAGE_NOEDITOR" value="5" enum="PropertyUsageFlags"> </constant> <constant name="METHOD_FLAG_NORMAL" value="1" enum="MethodFlags"> - Flag for normal method + Flag for a normal method. </constant> <constant name="METHOD_FLAG_EDITOR" value="2" enum="MethodFlags"> - Flag for editor method + Flag for an editor method. </constant> <constant name="METHOD_FLAG_NOSCRIPT" value="4" enum="MethodFlags"> </constant> <constant name="METHOD_FLAG_CONST" value="8" enum="MethodFlags"> - Flag for constant method + Flag for a constant method. </constant> <constant name="METHOD_FLAG_REVERSE" value="16" enum="MethodFlags"> </constant> <constant name="METHOD_FLAG_VIRTUAL" value="32" enum="MethodFlags"> - Flag for virtual method + Flag for a virtual method. </constant> <constant name="METHOD_FLAG_FROM_SCRIPT" value="64" enum="MethodFlags"> - Flag for method from script + Flag for a method from a script. </constant> <constant name="METHOD_FLAGS_DEFAULT" value="1" enum="MethodFlags"> - Default method flags + Default method flags. </constant> <constant name="TYPE_NIL" value="0" enum="Variant.Type"> - Variable is of type nil (only applied for null). + Variable is of type nil (only applied for [code]null[/code]). </constant> <constant name="TYPE_BOOL" value="1" enum="Variant.Type"> Variable is of type [bool]. diff --git a/doc/classes/ARVRAnchor.xml b/doc/classes/ARVRAnchor.xml index ff2691f7a7..453a0b3a02 100644 --- a/doc/classes/ARVRAnchor.xml +++ b/doc/classes/ARVRAnchor.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ARVRAnchor" inherits="Spatial" category="Core" version="3.2"> <brief_description> - Anchor point in AR Space. + An anchor point in AR space. </brief_description> <description> The ARVR Anchor point is a spatial node that maps a real world location identified by the AR platform to a position within the game world. For example, as long as plane detection in ARKit is on, ARKit will identify and update the position of planes (tables, floors, etc) and create anchors for them. - This node is mapped to one of the anchors through its unique id. When you receive a signal that a new anchor is available, you should add this node to your scene for that anchor. You can predefine nodes and set the id and the nodes will simply remain on 0,0,0 until a plane is recognized. + This node is mapped to one of the anchors through its unique ID. When you receive a signal that a new anchor is available, you should add this node to your scene for that anchor. You can predefine nodes and set the ID; the nodes will simply remain on 0,0,0 until a plane is recognized. Keep in mind that, as long as plane detection is enabled, the size, placing and orientation of an anchor will be updated as the detection logic learns more about the real world out there especially if only part of the surface is in view. </description> <tutorials> @@ -22,14 +22,14 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if the anchor is being tracked and [code]false[/code] if no anchor with this id is currently known. + Returns [code]true[/code] if the anchor is being tracked and [code]false[/code] if no anchor with this ID is currently known. </description> </method> <method name="get_mesh" qualifiers="const"> <return type="Mesh"> </return> <description> - If provided by the ARVR Interface this returns a mesh object for the anchor. For an anchor this can be a shape related to the object being tracked or it can be a mesh that provides topology related to the anchor and can be used to create shadows/reflections on surfaces or for generating collision shapes. + If provided by the ARVR Interface, this returns a mesh object for the anchor. For an anchor, this can be a shape related to the object being tracked or it can be a mesh that provides topology related to the anchor and can be used to create shadows/reflections on surfaces or for generating collision shapes. </description> </method> <method name="get_plane" qualifiers="const"> @@ -49,7 +49,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. + 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> <signals> @@ -57,7 +57,7 @@ <argument index="0" name="mesh" type="Mesh"> </argument> <description> - Emitted when the mesh associated with the anchor changes or when one becomes available. This is especially important for topology that is constantly being mesh_updated. + Emitted when the mesh associated with the anchor changes or when one becomes available. This is especially important for topology that is constantly being [code]mesh_updated[/code]. </description> </signal> </signals> diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index c2b7fb2c08..e79e18f44f 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ARVRController" inherits="Spatial" category="Core" version="3.2"> <brief_description> - A spatial node representing a spatially tracked controller. + A spatial node representing a spatially-tracked controller. </brief_description> <description> This is a helper spatial node that is linked to the tracking of controllers. It also offers several handy passthroughs to the state of buttons and such on the controllers. - Controllers are linked by their id. You can create controller nodes before the controllers are available. Say your game always uses two controllers (one for each hand) you can predefine the controllers with id 1 and 2 and they will become active as soon as the controllers are identified. If you expect additional controllers to be used, you should react to the signals and add ARVRController nodes to your scene. - The position of the controller node is automatically updated by the ARVR Server. This makes this node ideal to add child nodes to visualise the controller. + Controllers are linked by their ID. You can create controller nodes before the controllers are available. If your game always uses two controllers (one for each hand), you can predefine the controllers with ID 1 and 2; they will become active as soon as the controllers are identified. If you expect additional controllers to be used, you should react to the signals and add ARVRController nodes to your scene. + The position of the controller node is automatically updated by the [ARVRServer]. This makes this node ideal to add child nodes to visualize the controller. </description> <tutorials> </tutorials> @@ -22,7 +22,7 @@ <return type="int" enum="ARVRPositionalTracker.TrackerHand"> </return> <description> - Returns the hand holding this controller, if known. See TRACKER_* constants in [ARVRPositionalTracker]. + Returns the hand holding this controller, if known. See [code]TRACKER_*[/code] constants in [ARVRPositionalTracker]. </description> </method> <method name="get_is_active" qualifiers="const"> @@ -45,14 +45,14 @@ <return type="int"> </return> <description> - Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. + Returns the ID of the joystick object bound to this. Every controller tracked by the [ARVRServer] that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. </description> </method> <method name="get_mesh" qualifiers="const"> <return type="Mesh"> </return> <description> - If provided by the ARVR Interface this returns a mesh associated with the controller. This can be used to visualise the controller. + If provided by the [ARVRInterface], this returns a mesh associated with the controller. This can be used to visualize the controller. </description> </method> <method name="is_button_pressed" qualifiers="const"> @@ -67,10 +67,10 @@ </methods> <members> <member name="controller_id" type="int" setter="set_controller_id" getter="get_controller_id"> - The controller's id. - A controller id of 0 is unbound and will always result in an inactive node. Controller id 1 is reserved for the first controller that identifies itself as the left hand controller and id 2 is reserved for the first controller that identifies itself as the right hand controller. - For any other controller that the [ARVRServer] detects, we continue with controller id 3. - When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. + The controller's ID. + A controller ID of 0 is unbound and will always result in an inactive node. Controller ID 1 is reserved for the first controller that identifies itself as the left-hand controller and ID 2 is reserved for the first controller that identifies itself as the right-hand controller. + For any other controller that the [ARVRServer] detects, we continue with controller ID 3. + When a controller is turned off, its slot is freed. This ensures controllers will keep the same ID even when controllers with lower IDs are turned off. </member> <member name="rumble" type="float" setter="set_rumble" getter="get_rumble"> The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. If changed, updates [member ARVRPositionalTracker.rumble] accordingly. diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml index c286811b5d..a971580924 100644 --- a/doc/classes/ARVRInterface.xml +++ b/doc/classes/ARVRInterface.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ARVRInterface" inherits="Reference" category="Core" version="3.2"> <brief_description> - Base class for ARVR interface implementation. + Base class for an AR/VR interface implementation. </brief_description> <description> This class needs to be implemented to make an AR or VR platform available to Godot and these should be implemented as C++ modules or GDNative modules (note that for GDNative the subclass ARVRScriptInterface should be used). Part of the interface is exposed to GDScript so you can detect, enable and configure an AR or VR platform. - Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces through ARVRServer. + Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces through [ARVRServer]. </description> <tutorials> </tutorials> @@ -14,7 +14,7 @@ <return type="int"> </return> <description> - If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed id in the [CameraServer] for this interface. + If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed ID in the [CameraServer] for this interface. </description> </method> <method name="get_capabilities" qualifiers="const"> @@ -51,9 +51,9 @@ <description> Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output. After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence. - Note that you must enable the AR/VR mode on the main viewport for any device that uses the main output of Godot such as for mobile VR. - If you do this for a platform that handles its own output (such as OpenVR) Godot will show just one eye without distortion on screen. Alternatively you can add a separate viewport node to your scene and enable AR/VR on that viewport and it will be used to output to the HMD leaving you free to do anything you like in the main window such as using a separate camera as a spectator camera or render out something completely different. - While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD. + [b]Note:[/b] You must enable the AR/VR mode on the main viewport for any device that uses the main output of Godot such as for mobile VR. + If you do this for a platform that handles its own output (such as OpenVR) Godot will show just one eye without distortion on screen. Alternatively, you can add a separate viewport node to your scene and enable AR/VR on that viewport and it will be used to output to the HMD leaving you free to do anything you like in the main window such as using a separate camera as a spectator camera or render out something completely different. + While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However, at this point in time only one interface can render to an HMD. </description> </method> <method name="is_stereo"> @@ -96,7 +96,7 @@ This interface support AR (video background and real world tracking). </constant> <constant name="ARVR_EXTERNAL" value="8" enum="Capabilities"> - This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes. + This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of [method get_render_targetsize]). Using a separate viewport node frees up the main viewport for other purposes. </constant> <constant name="EYE_MONO" value="0" enum="Eyes"> Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported. @@ -111,10 +111,10 @@ Tracking is behaving as expected. </constant> <constant name="ARVR_EXCESSIVE_MOTION" value="1" enum="Tracking_status"> - Tracking is hindered by excessive motion, player is moving faster then tracking can keep up. + Tracking is hindered by excessive motion, player is moving faster than tracking can keep up. </constant> <constant name="ARVR_INSUFFICIENT_FEATURES" value="2" enum="Tracking_status"> - Tracking is hindered by insufficient features, it's too dark (for camera based tracking), player is blocked, etc. + Tracking is hindered by insufficient features, it's too dark (for camera-based tracking), player is blocked, etc. </constant> <constant name="ARVR_UNKNOWN_TRACKING" value="3" enum="Tracking_status"> We don't know the status of the tracking or this interface does not provide feedback. diff --git a/doc/classes/ARVROrigin.xml b/doc/classes/ARVROrigin.xml index 758f00a9ca..cd0e616977 100644 --- a/doc/classes/ARVROrigin.xml +++ b/doc/classes/ARVROrigin.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ARVROrigin" inherits="Spatial" category="Core" version="3.2"> <brief_description> - Our origin point in AR/VR. + The origin point in AR/VR. </brief_description> <description> This is a special node within the AR/VR system that maps the physical location of the center of our tracking space to the virtual location within our game world. There should be only one of these nodes in your scene and you must have one. All the ARVRCamera, ARVRController and ARVRAnchor nodes should be direct children of this node for spatial tracking to work correctly. It is the position of this node that you update when your character needs to move through your game world while we're not moving in the real world. Movement in the real world is always in relation to this origin point. - So say that your character is driving a car, the ARVROrigin node should be a child node of this car. If you implement a teleport system to move your character, you change the position of this node. Etc. + For example, if your character is driving a car, the ARVROrigin node should be a child node of this car. Or, if you're implementing a teleport system to move your character, you should change the position of this node. </description> <tutorials> </tutorials> @@ -15,8 +15,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. + Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter. + [b]Note:[/b] 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 de8b6b0620..94661c6db7 100644 --- a/doc/classes/ARVRPositionalTracker.xml +++ b/doc/classes/ARVRPositionalTracker.xml @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ARVRPositionalTracker" inherits="Object" category="Core" version="3.2"> <brief_description> - A tracked object + A tracked object. </brief_description> <description> - An instance of this object represents a device that is tracked such as a controller or anchor point. HMDs aren't represented here as they are fully handled internally. - As controllers are turned on and the AR/VR interface detects them instances of this object are automatically added to this list of active tracking objects accessible through the ARVRServer - The ARVRController and ARVRAnchor both consume objects of this type and should be the objects you use in game. The positional trackers are just the under the hood objects that make this all work and are mostly exposed so GDNative based interfaces can interact with them. + An instance of this object represents a device that is tracked, such as a controller or anchor point. HMDs aren't represented here as they are handled internally. + As controllers are turned on and the AR/VR interface detects them, instances of this object are automatically added to this list of active tracking objects accessible through the [ARVRServer]. + The [ARVRController] and [ARVRAnchor] both consume objects of this type and should be used in your project. The positional trackers are just under-the-hood objects that make this all work. These are mostly exposed so that GDNative-based interfaces can interact with them. </description> <tutorials> </tutorials> @@ -15,14 +15,14 @@ <return type="int" enum="ARVRPositionalTracker.TrackerHand"> </return> <description> - Returns the hand holding this tracker, if known. See TRACKER_* constants. + Returns the hand holding this tracker, if known. See [code]TRACKER_*[/code] constants. </description> </method> <method name="get_joy_id" qualifiers="const"> <return type="int"> </return> <description> - If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id. + If this is a controller that is being tracked, the controller will also be represented by a joystick entry with this ID. </description> </method> <method name="get_mesh" qualifiers="const"> diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index 6f5a76943f..1d90437395 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ARVRServer" inherits="Object" category="Core" version="3.2"> <brief_description> - This is our AR/VR Server. + The AR/VR server. </brief_description> <description> - The AR/VR Server is the heart of our AR/VR solution and handles all the processing. + The AR/VR server is the heart of our AR/VR solution and handles all the processing. </description> <tutorials> </tutorials> @@ -17,12 +17,12 @@ <argument index="1" name="keep_height" type="bool"> </argument> <description> - This is a really important function to understand correctly. AR and VR platforms all handle positioning slightly differently. - For platforms that do not offer spatial tracking our origin point (0,0,0) is the location of our HMD but you have little control over the direction the player is facing in the real world. - For platforms that do offer spatial tracking our origin point depends very much on the system. For OpenVR our origin point is usually the center of the tracking space, on the ground. For other platforms its often the location of the tracking camera. - This method allows you to center our tracker on the location of the HMD, it will take the current location of the HMD and use that to adjust all our tracking data in essence realigning the real world to your players current position in your game world. - For this method to produce usable results tracking information should be available and this often takes a few frames after starting your game. - You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism. + This is an important function to understand correctly. AR and VR platforms all handle positioning slightly differently. + For platforms that do not offer spatial tracking, our origin point (0,0,0) is the location of our HMD, but you have little control over the direction the player is facing in the real world. + For platforms that do offer spatial tracking, our origin point depends very much on the system. For OpenVR, our origin point is usually the center of the tracking space, on the ground. For other platforms, it's often the location of the tracking camera. + This method allows you to center your tracker on the location of the HMD. It will take the current location of the HMD and use that to adjust all your tracking data; in essence, realigning the real world to your player's current position in the game world. + For this method to produce usable results, tracking information must be available. This often takes a few frames after starting your game. + You should call this method after a few seconds have passed. For instance, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, or when implementing a teleport mechanism. </description> </method> <method name="find_interface" qualifiers="const"> @@ -31,7 +31,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it. + Finds an interface by its name. For instance, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it. </description> </method> <method name="get_hmd_transform"> @@ -47,21 +47,21 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the interface registered at a given index in our list of interfaces. + Gets the interface registered at a given index in our list of interfaces. </description> </method> <method name="get_interface_count" qualifiers="const"> <return type="int"> </return> <description> - Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try an initialize each interface and use the first one that returns [code]true[/code]. + Gets the number of interfaces currently registered with the AR/VR server. If your project supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try to initialize each interface and use the first one that returns [code]true[/code]. </description> </method> <method name="get_interfaces" qualifiers="const"> <return type="Array"> </return> <description> - Returns a list of available interfaces with both id and name of the interface. + Returns a list of available interfaces the ID and name of each interface. </description> </method> <method name="get_last_commit_usec"> @@ -86,7 +86,7 @@ <return type="Transform"> </return> <description> - Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces. + Gets the reference frame transform. Mostly used internally and exposed for GDNative build interfaces. </description> </method> <method name="get_tracker" qualifiers="const"> @@ -95,14 +95,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the positional tracker at the given ID. + Gets the positional tracker at the given ID. </description> </method> <method name="get_tracker_count" qualifiers="const"> <return type="int"> </return> <description> - Get the number of trackers currently registered. + Gets the number of trackers currently registered. </description> </method> </methods> @@ -110,7 +110,7 @@ <member name="primary_interface" type="ARVRInterface" setter="set_primary_interface" getter="get_primary_interface"> </member> <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. + Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter. </member> </members> <signals> @@ -118,14 +118,14 @@ <argument index="0" name="interface_name" type="String"> </argument> <description> - Signal send when a new interface has been added. + Emitted when a new interface has been added. </description> </signal> <signal name="interface_removed"> <argument index="0" name="interface_name" type="String"> </argument> <description> - Signal send when an interface is removed. + Emitted when an interface is removed. </description> </signal> <signal name="tracker_added"> @@ -136,7 +136,7 @@ <argument index="2" name="id" type="int"> </argument> <description> - Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker. + Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using [ARVRAnchor]s for an AR solution, it is important to react to this signal to add the appropriate [ARVRController] or [ARVRAnchor] nodes related to this new tracker. </description> </signal> <signal name="tracker_removed"> @@ -147,19 +147,19 @@ <argument index="2" name="id" type="int"> </argument> <description> - Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). + Emitted when a tracker is removed. You should remove any [ARVRController] or [ARVRAnchor] points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). </description> </signal> </signals> <constants> <constant name="TRACKER_CONTROLLER" value="1" enum="TrackerType"> - Our tracker tracks the location of a controller. + The tracker tracks the location of a controller. </constant> <constant name="TRACKER_BASESTATION" value="2" enum="TrackerType"> - Our tracker tracks the location of a base station. + The tracker tracks the location of a base station. </constant> <constant name="TRACKER_ANCHOR" value="4" enum="TrackerType"> - Our tracker tracks the location and size of an AR anchor. + The tracker tracks the location and size of an AR anchor. </constant> <constant name="TRACKER_ANY_KNOWN" value="127" enum="TrackerType"> Used internally to filter trackers of any known type. diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index 0c7de55329..99e2db6d83 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -47,7 +47,7 @@ var as = AStar.new() as.add_point(1, Vector3(1, 0, 0), 4) # Adds the point (1, 0, 0) with weight_scale 4 and id 1 [/codeblock] - If there already exists a point for the given id, its position and weight scale are updated to the given values. + If there already exists a point for the given [code]id[/code], its position and weight scale are updated to the given values. </description> </method> <method name="are_points_connected" qualifiers="const"> @@ -102,7 +102,7 @@ <return type="int"> </return> <description> - Returns the next available point id with no point associated to it. + Returns the next available point ID with no point associated to it. </description> </method> <method name="get_closest_point" qualifiers="const"> @@ -111,7 +111,7 @@ <argument index="0" name="to_position" type="Vector3"> </argument> <description> - Returns the id of the closest point to [code]to_position[/code]. Returns -1 if there are no points in the points pool. + Returns the ID of the closest point to [code]to_position[/code]. Returns -1 if there are no points in the points pool. </description> </method> <method name="get_closest_position_in_segment" qualifiers="const"> @@ -126,7 +126,7 @@ as.add_point(1, Vector3(0, 0, 0)) as.add_point(2, Vector3(0, 5, 0)) as.connect_points(1, 2) - var res = as.get_closest_position_in_segment(Vector3(3, 3, 0)) # returns (0, 3, 0) + var res = as.get_closest_position_in_segment(Vector3(3, 3, 0)) # Returns (0, 3, 0) [/codeblock] The result is in the segment that goes from [code]y = 0[/code] to [code]y = 5[/code]. It's the closest position in the segment to the given point. </description> @@ -139,11 +139,11 @@ <argument index="1" name="to_id" type="int"> </argument> <description> - Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. + Returns an array with the IDs of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. [codeblock] var as = AStar.new() as.add_point(1, Vector3(0, 0, 0)) - as.add_point(2, Vector3(0, 1, 0), 1) # default weight is 1 + as.add_point(2, Vector3(0, 1, 0), 1) # Default weight is 1 as.add_point(3, Vector3(1, 1, 0)) as.add_point(4, Vector3(2, 0, 0)) @@ -153,7 +153,7 @@ as.connect_points(1, 4, false) as.connect_points(5, 4, false) - var res = as.get_id_path(1, 3) # returns [1, 2, 3] + var res = as.get_id_path(1, 3) # Returns [1, 2, 3] [/codeblock] If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. </description> @@ -164,7 +164,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns an array with the ids of the points that form the connect with the given point. + Returns an array with the IDs of the points that form the connection with the given point. [codeblock] var as = AStar.new() as.add_point(1, Vector3(0, 0, 0)) @@ -175,7 +175,7 @@ as.connect_points(1, 2, true) as.connect_points(1, 3, true) - var neighbors = as.get_point_connections(1) # returns [2, 3] + var neighbors = as.get_point_connections(1) # Returns [2, 3] [/codeblock] </description> </method> @@ -196,7 +196,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns the position of the point associated with the given id. + Returns the position of the point associated with the given [code]id[/code]. </description> </method> <method name="get_point_weight_scale" qualifiers="const"> @@ -205,7 +205,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns the weight scale of the point associated with the given id. + Returns the weight scale of the point associated with the given [code]id[/code]. </description> </method> <method name="get_points"> @@ -221,7 +221,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns whether a point associated with the given id exists. + Returns whether a point associated with the given [code]id[/code] exists. </description> </method> <method name="is_point_disabled" qualifiers="const"> @@ -239,7 +239,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Removes the point associated with the given id from the points pool. + Removes the point associated with the given [code]id[/code] from the points pool. </description> </method> <method name="set_point_disabled"> @@ -261,7 +261,7 @@ <argument index="1" name="position" type="Vector3"> </argument> <description> - Sets the position for the point with the given id. + Sets the [code]position[/code] for the point with the given [code]id[/code]. </description> </method> <method name="set_point_weight_scale"> @@ -272,7 +272,7 @@ <argument index="1" name="weight_scale" type="float"> </argument> <description> - Sets the [code]weight_scale[/code] for the point with the given id. + Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. </description> </method> </methods> diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index b86e53d4d4..526d1c16da 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -24,7 +24,7 @@ var as = AStar2D.new() as.add_point(1, Vector2(1, 0), 4) # Adds the point (1, 0) with weight_scale 4 and id 1 [/codeblock] - If there already exists a point for the given id, its position and weight scale are updated to the given values. + If there already exists a point for the given [code]id[/code], its position and weight scale are updated to the given values. </description> </method> <method name="are_points_connected" qualifiers="const"> @@ -79,7 +79,7 @@ <return type="int"> </return> <description> - Returns the next available point id with no point associated to it. + Returns the next available point ID with no point associated to it. </description> </method> <method name="get_closest_point" qualifiers="const"> @@ -88,7 +88,7 @@ <argument index="0" name="to_position" type="Vector2"> </argument> <description> - Returns the id of the closest point to [code]to_position[/code]. Returns -1 if there are no points in the points pool. + Returns the ID of the closest point to [code]to_position[/code]. Returns -1 if there are no points in the points pool. </description> </method> <method name="get_closest_position_in_segment" qualifiers="const"> @@ -103,7 +103,7 @@ as.add_point(1, Vector2(0, 0)) as.add_point(2, Vector2(0, 5)) as.connect_points(1, 2) - var res = as.get_closest_position_in_segment(Vector2(3, 3)) # returns (0, 3) + var res = as.get_closest_position_in_segment(Vector2(3, 3)) # Returns (0, 3) [/codeblock] The result is in the segment that goes from [code]y = 0[/code] to [code]y = 5[/code]. It's the closest position in the segment to the given point. </description> @@ -116,11 +116,11 @@ <argument index="1" name="to_id" type="int"> </argument> <description> - Returns an array with the ids of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. + Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. [codeblock] var as = AStar2D.new() as.add_point(1, Vector2(0, 0)) - as.add_point(2, Vector2(0, 1), 1) # default weight is 1 + as.add_point(2, Vector2(0, 1), 1) # Default weight is 1 as.add_point(3, Vector2(1, 1)) as.add_point(4, Vector2(2, 0)) @@ -130,7 +130,7 @@ as.connect_points(1, 4, false) as.connect_points(5, 4, false) - var res = as.get_id_path(1, 3) # returns [1, 2, 3] + var res = as.get_id_path(1, 3) # Returns [1, 2, 3] [/codeblock] If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. </description> @@ -141,7 +141,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns an array with the ids of the points that form the connect with the given point. + Returns an array with the IDs of the points that form the connection with the given point. [codeblock] var as = AStar2D.new() as.add_point(1, Vector2(0, 0)) @@ -152,7 +152,7 @@ as.connect_points(1, 2, true) as.connect_points(1, 3, true) - var neighbors = as.get_point_connections(1) # returns [2, 3] + var neighbors = as.get_point_connections(1) # Returns [2, 3] [/codeblock] </description> </method> @@ -173,7 +173,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns the position of the point associated with the given id. + Returns the position of the point associated with the given [code]id[/code]. </description> </method> <method name="get_point_weight_scale" qualifiers="const"> @@ -182,7 +182,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns the weight scale of the point associated with the given id. + Returns the weight scale of the point associated with the given [code]id[/code]. </description> </method> <method name="get_points"> @@ -198,7 +198,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns whether a point associated with the given id exists. + Returns whether a point associated with the given [code]id[/code] exists. </description> </method> <method name="is_point_disabled" qualifiers="const"> @@ -216,7 +216,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Removes the point associated with the given id from the points pool. + Removes the point associated with the given [code]id[/code] from the points pool. </description> </method> <method name="set_point_disabled"> @@ -238,7 +238,7 @@ <argument index="1" name="position" type="Vector2"> </argument> <description> - Sets the position for the point with the given id. + Sets the [code]position[/code] for the point with the given [code]id[/code]. </description> </method> <method name="set_point_weight_scale"> @@ -249,7 +249,7 @@ <argument index="1" name="weight_scale" type="float"> </argument> <description> - Sets the [code]weight_scale[/code] for the point with the given id. + Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. </description> </method> </methods> diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 3ea280cba3..6701e3cbbd 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -19,8 +19,8 @@ <argument index="2" name="action" type="String" default=""""> </argument> <description> - Adds a button with label [i]text[/i] and a custom [i]action[/i] to the dialog and returns the created button. [i]action[/i] will be passed to the [signal custom_action] signal when pressed. - If [code]true[/code], [i]right[/i] will place the button to the right of any sibling buttons. Default value: [code]false[/code]. + Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed. + If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons. Default value: [code]false[/code]. </description> </method> <method name="add_cancel"> @@ -29,7 +29,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Adds a button with label [i]name[/i] and a cancel action to the dialog and returns the created button. + Adds a button with label [code]name[/code] and a cancel action to the dialog and returns the created button. </description> </method> <method name="get_label"> @@ -43,7 +43,7 @@ <return type="Button"> </return> <description> - Returns the OK Button. + Returns the OK [Button] instance. </description> </method> <method name="register_text_enter"> @@ -62,7 +62,7 @@ </member> <member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok"> If [code]true[/code], the dialog is hidden when the OK button is pressed. You can set it to [code]false[/code] if you want to do e.g. input validation when receiving the [signal confirmed] signal, and handle hiding the dialog in your own logic. Default value: [code]true[/code]. - Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example [FileDialog] defaults to [code]false[/code], and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in [FileDialog] to disable hiding the dialog when pressing OK. + [b]Note:[/b] Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example [FileDialog] defaults to [code]false[/code], and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such, this property can't be used in [FileDialog] to disable hiding the dialog when pressing OK. </member> <member name="dialog_text" type="String" setter="set_text" getter="get_text"> The text displayed by the dialog. diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index da85f91367..f7dc794d93 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -13,7 +13,7 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if an animation if currently being played. + Returns [code]true[/code] if an animation is currently being played. </description> </method> <method name="play"> @@ -24,14 +24,14 @@ <argument index="1" name="backwards" type="bool" default="false"> </argument> <description> - Play the animation set in parameter. If no parameter is provided, the current animation is played. Property [code]backwards[/code] plays the animation in reverse if set to [code]true[/code]. + Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. If [code]backwards[/code] is [code]true[/code], the animation will be played in reverse. </description> </method> <method name="stop"> <return type="void"> </return> <description> - Stop the current animation (does not reset the frame counter). + Stops the current animation (does not reset the frame counter). </description> </method> </methods> diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 96196f7601..e4223d21f8 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -13,7 +13,7 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if an animation if currently being played. + Returns [code]true[/code] if an animation is currently being played. </description> </method> <method name="play"> @@ -22,14 +22,14 @@ <argument index="0" name="anim" type="String" default=""""> </argument> <description> - Play the animation set in parameter. If no parameter is provided, the current animation is played. + Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. </description> </method> <method name="stop"> <return type="void"> </return> <description> - Stop the current animation (does not reset the frame counter). + Stops the current animation (does not reset the frame counter). </description> </method> </methods> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index c79903cb80..16db993cd7 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -28,7 +28,7 @@ <argument index="1" name="at_position" type="int" default="-1"> </argument> <description> - Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. + Adds a track to the Animation. </description> </method> <method name="animation_track_get_key_animation" qualifiers="const"> @@ -314,7 +314,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Remove a track by specifying the track index. + Removes a track by specifying the track index. </description> </method> <method name="track_find_key" qualifiers="const"> @@ -327,7 +327,7 @@ <argument index="2" name="exact" type="bool" default="false"> </argument> <description> - Find the key index by time in a given track. Optionally, only find it if the exact time is given. + Finds the key index by time in a given track. Optionally, only find it if the exact time is given. </description> </method> <method name="track_get_interpolation_loop_wrap" qualifiers="const"> @@ -345,7 +345,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the interpolation type of a given track, from the INTERPOLATION_* enum. + Returns the interpolation type of a given track. </description> </method> <method name="track_get_key_count" qualifiers="const"> @@ -376,7 +376,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Returns the transition curve (easing) for a specific key (see built-in math function "ease"). + Returns the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]). </description> </method> <method name="track_get_key_value" qualifiers="const"> @@ -396,7 +396,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the path of a track. for more information on the path format, see [method track_set_path] + Gets the path of a track. For more information on the path format, see [method track_set_path]. </description> </method> <method name="track_get_type" qualifiers="const"> @@ -405,7 +405,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the type of a track. + Gets the type of a track. </description> </method> <method name="track_insert_key"> @@ -447,7 +447,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Move a track down. + Moves a track down. </description> </method> <method name="track_move_to"> @@ -467,7 +467,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Move a track up. + Moves a track up. </description> </method> <method name="track_remove_key"> @@ -478,7 +478,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Remove a key by index in a given track. + Removes a key by index in a given track. </description> </method> <method name="track_remove_key_at_position"> @@ -489,7 +489,7 @@ <argument index="1" name="position" type="float"> </argument> <description> - Remove a key by position (seconds) in a given track. + Removes a key by position (seconds) in a given track. </description> </method> <method name="track_set_enabled"> @@ -511,7 +511,7 @@ <argument index="1" name="imported" type="bool"> </argument> <description> - Set the given track as imported or not. + Sets the given track as imported or not. </description> </method> <method name="track_set_interpolation_loop_wrap"> @@ -533,7 +533,7 @@ <argument index="1" name="interpolation" type="int" enum="Animation.InterpolationType"> </argument> <description> - Set the interpolation type of a given track, from the INTERPOLATION_* enum. + Sets the interpolation type of a given track. </description> </method> <method name="track_set_key_time"> @@ -546,7 +546,7 @@ <argument index="2" name="time" type="float"> </argument> <description> - Set the time of an existing key. + Sets the time of an existing key. </description> </method> <method name="track_set_key_transition"> @@ -559,7 +559,7 @@ <argument index="2" name="transition" type="float"> </argument> <description> - Set the transition curve (easing) for a specific key (see built-in math function "ease"). + Sets the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]). </description> </method> <method name="track_set_key_value"> @@ -572,7 +572,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Set the value of an existing key. + Sets the value of an existing key. </description> </method> <method name="track_set_path"> @@ -583,8 +583,8 @@ <argument index="1" name="path" type="NodePath"> </argument> <description> - Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". - [b]Example:[/b] "character/skeleton:ankle" or "character/mesh:transform/local". + Sets the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by [code]":"[/code]. + For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code]. </description> </method> <method name="track_swap"> @@ -656,13 +656,14 @@ <argument index="1" name="mode" type="int" enum="Animation.UpdateMode"> </argument> <description> - Set the update mode (UPDATE_*) of a value track. + Sets the update mode ([code]UPDATE_*[/code]) of a value track. </description> </method> </methods> <members> <member name="length" type="float" setter="set_length" getter="get_length"> - The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. + The total length of the animation (in seconds). + [b]Note:[/b] Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. </member> <member name="loop" type="bool" setter="set_loop" getter="has_loop"> A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. @@ -682,7 +683,7 @@ Value tracks set values in node properties, but only those which can be Interpolated. </constant> <constant name="TYPE_TRANSFORM" value="1" enum="TrackType"> - Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated. + Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are interpolated. </constant> <constant name="TYPE_METHOD" value="2" enum="TrackType"> Method tracks call functions with given arguments per key. diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 23f7a316d9..7d5d8a2db1 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -4,7 +4,7 @@ Base resource for [AnimationTree] nodes. </brief_description> <description> - Base resource for [AnimationTree] nodes. In general it's not used directly but you can create custom ones with custom blending formulas. + Base resource for [AnimationTree] nodes. In general, it's not used directly, but you can create custom ones with custom blending formulas. Inherit this when creating nodes mainly for use in [AnimationNodeBlendTree], otherwise [AnimationRootNode] should be used instead. </description> <tutorials> @@ -16,7 +16,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Add an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree] + Adds an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree] </description> </method> <method name="blend_animation"> @@ -80,7 +80,7 @@ <return type="String"> </return> <description> - Get the text caption for this node (used by some editors) + Gets the text caption for this node (used by some editors). </description> </method> <method name="get_child_by_name" qualifiers="virtual"> @@ -89,14 +89,14 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get the a child node by index (used by editors inheriting from [AnimationRootNode]). + Gets a child node by index (used by editors inheriting from [AnimationRootNode]). </description> </method> <method name="get_child_nodes" qualifiers="virtual"> <return type="Dictionary"> </return> <description> - Get all children nodes, in order as a name:node dictionary. Only useful when inheriting [AnimationRootNode]. + Gets all children nodes in order as a [code]name: node[/code] dictionary. Only useful when inheriting [AnimationRootNode]. </description> </method> <method name="get_input_count" qualifiers="const"> @@ -112,7 +112,7 @@ <argument index="0" name="input" type="int"> </argument> <description> - Get the name of an input by index. + Gets the name of an input by index. </description> </method> <method name="get_parameter" qualifiers="const"> @@ -121,7 +121,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. + Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. </description> </method> <method name="get_parameter_default_value" qualifiers="virtual"> @@ -130,14 +130,14 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. + Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. </description> </method> <method name="get_parameter_list" qualifiers="virtual"> <return type="Array"> </return> <description> - Get the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list]. + Gets the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list]. </description> </method> <method name="has_filter" qualifiers="virtual"> @@ -176,7 +176,7 @@ <argument index="0" name="index" type="int"> </argument> <description> - Remove an input, call this only when inactive. + Removes an input, call this only when inactive. </description> </method> <method name="set_filter_path"> @@ -187,7 +187,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> - Add/Remove a path for the filter. + Adds or removes a path for the filter. </description> </method> <method name="set_parameter"> @@ -198,7 +198,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> - Set a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes. + Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes. </description> </method> </methods> diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml index 6fb5c6312b..c6a1d47c2d 100644 --- a/doc/classes/AnimationNodeBlendSpace1D.xml +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -22,7 +22,7 @@ <argument index="2" name="at_index" type="int" default="-1"> </argument> <description> - Add a new point that represents a [code]node[/code] on the virtual axis at a given position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code] , the point is inserted at the end of the blend points array. + Adds a new point that represents a [code]node[/code] on the virtual axis at a given position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code] , the point is inserted at the end of the blend points array. </description> </method> <method name="get_blend_point_count" qualifiers="const"> diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml index 6567098d6c..ba3635793c 100644 --- a/doc/classes/AnimationNodeBlendSpace2D.xml +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -21,7 +21,7 @@ <argument index="2" name="at_index" type="int" default="-1"> </argument> <description> - Add a new point that represents a [code]node[/code] at the position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code] , the point is inserted at the end of the blend points array. + Adds a new point that represents a [code]node[/code] at the position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code] , the point is inserted at the end of the blend points array. </description> </method> <method name="add_triangle"> diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index 2834f83d2f..9a21492b8a 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -4,7 +4,8 @@ State machine for control of animations. </brief_description> <description> - Contains multiple nodes representing animation states, connected in a graph. Nodes transitions can be configured to happen automatically or via code, using a shortest-path algorithm. Retrieve the AnimationNodeStateMachinePlayback object from the [AnimationTree] node to control it programatically. Example: + Contains multiple nodes representing animation states, connected in a graph. Node transitions can be configured to happen automatically or via code, using a shortest-path algorithm. Retrieve the AnimationNodeStateMachinePlayback object from the [AnimationTree] node to control it programmatically. + [b]Example:[/b] [codeblock] var state_machine = $AnimationTree.get("parameters/playback") state_machine.travel("some_state") diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml index 796d92d7d6..ab9652fcd8 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -4,7 +4,8 @@ Playback control for AnimationNodeStateMachine. </brief_description> <description> - Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code]. Example: + Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code]. + [b]Example:[/b] [codeblock] var state_machine = $AnimationTree.get("parameters/playback") state_machine.travel("some_state") diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 3e2fad8a92..759787c26e 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -4,7 +4,7 @@ Container and player of [Animation] resources. </brief_description> <description> - An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. + An animation player is used for general-purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/getting_started/step_by_step/animations.html</link> @@ -55,7 +55,7 @@ <return type="void"> </return> <description> - [AnimationPlayer] caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again. + [AnimationPlayer] caches animated nodes. It may not notice if a node disappears; [method clear_caches] forces it to update the cache again. </description> </method> <method name="clear_queue"> @@ -98,14 +98,14 @@ <argument index="1" name="anim_to" type="String"> </argument> <description> - Get the blend time (in seconds) between two animations, referenced by their names. + Gets the blend time (in seconds) between two animations, referenced by their names. </description> </method> <method name="get_playing_speed" qualifiers="const"> <return type="float"> </return> <description> - Get the actual playing speed of current animation or 0 if not playing. This speed is the [code]playback_speed[/code] property multiplied by [code]custom_speed[/code] argument specified when calling the [code]play[/code] method. + Gets the actual playing speed of current animation or 0 if not playing. This speed is the [code]playback_speed[/code] property multiplied by [code]custom_speed[/code] argument specified when calling the [code]play[/code] method. </description> </method> <method name="get_queue"> @@ -142,8 +142,8 @@ <argument index="3" name="from_end" type="bool" default="false"> </argument> <description> - Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being [code]true[/code] can play the animation backwards. - If the animation has been paused by [code]stop(true)[/code] it will be resumed. Calling [code]play()[/code] without arguments will also resume the animation. + Plays the animation with key [code]name[/code]. Custom speed and blend times can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards. + If the animation has been paused by [method stop], it will be resumed. Calling [method play] without arguments will also resume the animation. </description> </method> <method name="play_backwards"> @@ -154,8 +154,8 @@ <argument index="1" name="custom_blend" type="float" default="-1"> </argument> <description> - Play the animation with key [code]name[/code] in reverse. - If the animation has been paused by [code]stop(true)[/code] it will be resumed backwards. Calling [code]play_backwards()[/code] without arguments will also resume the animation backwards. + Plays the animation with key [code]name[/code] in reverse. + If the animation has been paused by [code]stop(true)[/code], it will be resumed backwards. Calling [code]play_backwards()[/code] without arguments will also resume the animation backwards. </description> </method> <method name="queue"> @@ -164,7 +164,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Queue an animation for playback once the current one is done. + Queues an animation for playback once the current one is done. </description> </method> <method name="remove_animation"> @@ -173,7 +173,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Remove the animation with key [code]name[/code]. + Removes the animation with key [code]name[/code]. </description> </method> <method name="rename_animation"> @@ -184,7 +184,7 @@ <argument index="1" name="newname" type="String"> </argument> <description> - Rename an existing animation with key [code]name[/code] to [code]newname[/code]. + Renames an existing animation with key [code]name[/code] to [code]newname[/code]. </description> </method> <method name="seek"> @@ -195,7 +195,7 @@ <argument index="1" name="update" type="bool" default="false"> </argument> <description> - Seek the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped. + Seeks the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped. </description> </method> <method name="set_blend_time"> @@ -208,7 +208,7 @@ <argument index="2" name="sec" type="float"> </argument> <description> - Specify a blend time (in seconds) between two animations, referenced by their names. + Specifies a blend time (in seconds) between two animations, referenced by their names. </description> </method> <method name="stop"> @@ -217,8 +217,8 @@ <argument index="0" name="reset" type="bool" default="true"> </argument> <description> - Stop the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. - If [code]reset[/code] is [code]false[/code], then calling [code]play()[/code] without arguments or [code]play("same_as_before")[/code] will resume the animation. Works the same for the [code]play_backwards()[/code] method. + Stops the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. + If [code]reset[/code] is [code]false[/code], then calling [method play] without arguments or [code]play("same_as_before")[/code] will resume the animation. Works the same for the [method play_backwards]. </description> </method> </methods> @@ -251,7 +251,7 @@ The process notification in which to update animations. Default value: [constant ANIMATION_PROCESS_IDLE]. </member> <member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale"> - The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: [code]1[/code]. + The speed scaling ratio. For instance, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed. Default value: [code]1[/code]. </member> <member name="root_node" type="NodePath" setter="set_root" getter="get_root"> The node from which node path references will travel. Default value: [code]".."[/code]. @@ -294,7 +294,7 @@ Process animation during the idle process. </constant> <constant name="ANIMATION_PROCESS_MANUAL" value="2" enum="AnimationProcessMode"> - Do not process animation. Use the 'advance' method to process the animation manually. + Do not process animation. Use [method advance] to process the animation manually. </constant> <constant name="ANIMATION_METHOD_CALL_DEFERRED" value="0" enum="AnimationMethodCallMode"> Batch method calls during the animation process, then do the calls after events are processed. This avoids bugs involving deleting nodes or modifying the AnimationPlayer while playing. diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index 179dc5577b..41dfd69fb7 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -238,7 +238,7 @@ </argument> <description> Sets mix amount of a Mix node given its name and value. - A Mix node adds input b to input a by a the amount given by ratio. + A Mix node adds input b to input a by the amount given by ratio. </description> </method> <method name="node_exists" qualifiers="const"> @@ -285,7 +285,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Get the node type, will return from NODE_* enum. + Gets the node type, will return from [code]NODE_*[/code] enum. </description> </method> <method name="node_rename"> @@ -503,7 +503,7 @@ <argument index="1" name="seconds" type="float"> </argument> <description> - Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code] + Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code]. This functions as a seek in the [Animation] or the blend or mix of [Animation]s input in it. </description> </method> diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index 17d9678f64..d23e8567aa 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Area" inherits="CollisionObject" category="Core" version="3.2"> <brief_description> - General purpose area node for detection and 3D physics influence. + General-purpose area node for detection and 3D physics influence. </brief_description> <description> 3D area that detects [CollisionObject] nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping). @@ -47,7 +47,8 @@ <argument index="0" name="area" type="Node"> </argument> <description> - If [code]true[/code], the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + If [code]true[/code], the given area overlaps the Area. + [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="overlaps_body" qualifiers="const"> @@ -56,7 +57,8 @@ <argument index="0" name="body" type="Node"> </argument> <description> - If [code]true[/code], the given physics body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + If [code]true[/code], the given physics body overlaps the Area. + [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. The [code]body[/code] argument can either be a [PhysicsBody] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </method> @@ -106,7 +108,7 @@ The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. </member> <member name="gravity_point" type="bool" setter="set_gravity_is_point" getter="is_gravity_a_point"> - If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). Also see [member space_override]. Default value: [code]false[/code]. + If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. Default value: [code]false[/code]. </member> <member name="gravity_vec" type="Vector3" setter="set_gravity_vector" getter="get_gravity_vector"> The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index c287f2b6f5..950166a0e2 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -47,7 +47,8 @@ <argument index="0" name="area" type="Node"> </argument> <description> - If [code]true[/code], the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + If [code]true[/code], the given area overlaps the Area2D. + [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="overlaps_body" qualifiers="const"> @@ -56,7 +57,8 @@ <argument index="0" name="body" type="Node"> </argument> <description> - If [code]true[/code], the given physics body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + If [code]true[/code], the given physics body overlaps the Area2D. + [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </method> @@ -106,7 +108,7 @@ The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. </member> <member name="gravity_point" type="bool" setter="set_gravity_is_point" getter="is_gravity_a_point"> - If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). Also see [member space_override]. Default value: [code]false[/code]. + If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. Default value: [code]false[/code]. </member> <member name="gravity_vec" type="Vector2" setter="set_gravity_vector" getter="get_gravity_vector"> The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction. diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 75194fbf76..130908b842 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -4,7 +4,8 @@ Generic array datatype. </brief_description> <description> - Generic array which can contain several elements of any type, accessible by a numerical index starting at 0. Negative indices can be used to count from the back, like in Python (-1 is the last element, -2 the second to last, etc.). Example: + Generic array which can contain several elements of any type, accessible by a numerical index starting at 0. Negative indices can be used to count from the back, like in Python (-1 is the last element, -2 the second to last, etc.). + [b]Example:[/b] [codeblock] var array = ["One", 2, 3, "Four"] print(array[0]) # One @@ -103,7 +104,8 @@ <argument index="1" name="before" type="bool" default="True"> </argument> <description> - Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. </description> </method> <method name="bsearch_custom"> @@ -118,12 +120,13 @@ <argument index="3" name="before" type="bool" default="True"> </argument> <description> - Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. </description> </method> <method name="clear"> <description> - Clears the array (resizes to 0). + Clears the array. This is equivalent to using [method resize] with a size of [code]0[/code]. </description> </method> <method name="count"> @@ -275,7 +278,7 @@ <argument index="0" name="size" type="int"> </argument> <description> - Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null. + Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are [code]null[/code]. </description> </method> <method name="rfind"> @@ -303,7 +306,8 @@ </method> <method name="sort"> <description> - Sorts the array. Note: strings are sorted in alphabetical, not natural order. + Sorts the array. + [b]Note:[/b] strings are sorted in alphabetical, not natural order. </description> </method> <method name="sort_custom"> diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 19fe833334..96bcadc939 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -31,7 +31,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Add name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added. + Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added. </description> </method> <method name="add_surface_from_arrays"> @@ -57,7 +57,7 @@ <return type="void"> </return> <description> - Remove all blend shapes from this [ArrayMesh]. + Removes all blend shapes from this [ArrayMesh]. </description> </method> <method name="get_blend_shape_count" qualifiers="const"> @@ -100,7 +100,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found -1 is returned. + Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found, -1 is returned. </description> </method> <method name="surface_get_array_index_len" qualifiers="const"> @@ -136,7 +136,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Get the name assigned to this surface. + Gets the name assigned to this surface. </description> </method> <method name="surface_get_primitive_type" qualifiers="const"> @@ -154,7 +154,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. + Removes a surface at position [code]surf_idx[/code], shifting greater surfaces one [code]surf_idx[/code] slot down. </description> </method> <method name="surface_set_name"> @@ -165,7 +165,7 @@ <argument index="1" name="name" type="String"> </argument> <description> - Set a name for a given surface. + Sets a name for a given surface. </description> </method> <method name="surface_update_region"> @@ -178,7 +178,8 @@ <argument index="2" name="data" type="PoolByteArray"> </argument> <description> - Updates a specified region of mesh arrays on GPU. Warning: only use if you know what you are doing. You can easily cause crashes by calling this function with improper arguments. + Updates a specified region of mesh arrays on the GPU. + [b]Warning:[/b] Only use if you know what you are doing. You can easily cause crashes by calling this function with improper arguments. </description> </method> </methods> diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index e573512f5a..834f066bdb 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -19,7 +19,7 @@ If [code]true[/code], clips the area outside of the region to avoid bleeding of the surrounding texture pixels. </member> <member name="margin" type="Rect2" setter="set_margin" getter="get_margin"> - The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. + The margin around the region. The [Rect2]'s [member Rect2.size] parameter ("w" and "h" in the editor) resizes the texture so it fits within the margin. </member> <member name="region" type="Rect2" setter="set_region" getter="get_region"> The AtlasTexture's used region. diff --git a/doc/classes/AudioBusLayout.xml b/doc/classes/AudioBusLayout.xml index 771e0390d3..fb36440a67 100644 --- a/doc/classes/AudioBusLayout.xml +++ b/doc/classes/AudioBusLayout.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioBusLayout" inherits="Resource" category="Core" version="3.2"> <brief_description> - Stores information about the audiobusses. + Stores information about the audio buses. </brief_description> <description> Stores position, muting, solo, bypass, effects, effect position, volume, and the connections between buses. See [AudioServer] for usage. diff --git a/doc/classes/AudioEffect.xml b/doc/classes/AudioEffect.xml index 7c21d04b03..3e7863a44c 100644 --- a/doc/classes/AudioEffect.xml +++ b/doc/classes/AudioEffect.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffect" inherits="Resource" category="Core" version="3.2"> <brief_description> - Audio Effect For Audio. + Audio effect for audio. </brief_description> <description> Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on. diff --git a/doc/classes/AudioEffectAmplify.xml b/doc/classes/AudioEffectAmplify.xml index 9fd3e73b12..52f7afad76 100644 --- a/doc/classes/AudioEffectAmplify.xml +++ b/doc/classes/AudioEffectAmplify.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a Amplify audio effect to an Audio bus. + Adds an amplifying audio effect to an audio bus. Increases or decreases the volume of the selected audio bus. </brief_description> <description> @@ -13,7 +13,7 @@ </methods> <members> <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> - Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: [code]0[/code]. + Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: [code]0[/code]. </member> </members> <constants> diff --git a/doc/classes/AudioEffectBandLimitFilter.xml b/doc/classes/AudioEffectBandLimitFilter.xml index 1b511dfab0..f85c8cdd32 100644 --- a/doc/classes/AudioEffectBandLimitFilter.xml +++ b/doc/classes/AudioEffectBandLimitFilter.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.2"> <brief_description> - Adds a band limit filter to the Audio Bus. + Adds a band limit filter to the audio bus. </brief_description> <description> Limits the frequencies in a range around the [member AudioEffectFilter.cutoff_hz] and allows frequencies outside of this range to pass. diff --git a/doc/classes/AudioEffectBandPassFilter.xml b/doc/classes/AudioEffectBandPassFilter.xml index 8df922da3a..359eb9d669 100644 --- a/doc/classes/AudioEffectBandPassFilter.xml +++ b/doc/classes/AudioEffectBandPassFilter.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.2"> <brief_description> - Adds a band pass filter to the Audio Bus. + Adds a band pass filter to the audio bus. </brief_description> <description> Attenuates the frequencies inside of a range around the [member AudioEffectFilter.cutoff_hz] and cuts frequencies outside of this band. diff --git a/doc/classes/AudioEffectCompressor.xml b/doc/classes/AudioEffectCompressor.xml index 78b8047987..191f733956 100644 --- a/doc/classes/AudioEffectCompressor.xml +++ b/doc/classes/AudioEffectCompressor.xml @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectCompressor" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a Compressor audio effect to an Audio bus. + Adds a compressor audio effect to an audio bus. Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume. </brief_description> <description> Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB). Compressor has many uses in the mix: - - In the Master bus to compress the whole output (Although a [AudioEffectLimiter] is probably better) + - In the Master bus to compress the whole output (although an [AudioEffectLimiter] is probably better). - In voice channels to ensure they sound as balanced as possible. - - Sidechained. Sidechained, which can reduce the sound level sidechained with another audio bus for threshold detection.. This technique is very common in video game mixing to download the level of Music/SFX while voices are being heard. + - Sidechained. This can reduce the sound level sidechained with another audio bus for threshold detection. This technique is common in video game mixing to the level of music and SFX while voices are being heard. - Accentuates transients by using a wider attack, making effects sound more punchy. </description> <tutorials> @@ -18,7 +18,7 @@ </methods> <members> <member name="attack_us" type="float" setter="set_attack_us" getter="get_attack_us"> - Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: [code]20ms[/code]. + Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000. Default value: [code]20us[/code]. </member> <member name="gain" type="float" setter="set_gain" getter="get_gain"> Gain applied to the output signal. @@ -27,10 +27,10 @@ Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: [code]1[/code]. </member> <member name="ratio" type="float" setter="set_ratio" getter="get_ratio"> - Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: [code]4[/code]. + Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: [code]4[/code]. </member> <member name="release_ms" type="float" setter="set_release_ms" getter="get_release_ms"> - Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: [code]250ms[/code]. + Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000. Default value: [code]250ms[/code]. </member> <member name="sidechain" type="String" setter="set_sidechain" getter="get_sidechain"> Reduce the sound level using another audio bus for threshold detection. diff --git a/doc/classes/AudioEffectDelay.xml b/doc/classes/AudioEffectDelay.xml index 0e19a4a89f..e838998d70 100644 --- a/doc/classes/AudioEffectDelay.xml +++ b/doc/classes/AudioEffectDelay.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectDelay" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a Delay audio effect to an Audio bus. Plays input signal back after a period of time. + Adds a delay audio effect to an audio bus. Plays input signal back after a period of time. Two tap delay and feedback options. </brief_description> <description> @@ -25,13 +25,13 @@ Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code]. </member> <member name="feedback/lowpass" type="float" setter="set_feedback_lowpass" getter="get_feedback_lowpass"> - Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: [code]16000[/code]. + Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal. Default value: [code]16000[/code]. </member> <member name="tap1/active" type="bool" setter="set_tap1_active" getter="is_tap1_active"> If [code]true[/code], [code]tap1[/code] will be enabled. Default value: [code]true[/code]. </member> <member name="tap1/delay_ms" type="float" setter="set_tap1_delay_ms" getter="get_tap1_delay_ms"> - [b]Tap1[/b] delay time in milliseconds. Default value: [code]250ms[/code]. + [code]tap1[/code] delay time in milliseconds. Default value: [code]250ms[/code]. </member> <member name="tap1/level_db" type="float" setter="set_tap1_level_db" getter="get_tap1_level_db"> Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code]. diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml index cf02a8fb6d..91f45742a2 100644 --- a/doc/classes/AudioEffectDistortion.xml +++ b/doc/classes/AudioEffectDistortion.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectDistortion" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a Distortion audio effect to an Audio bus. + Adds a distortion audio effect to an Audio bus. Modify the sound to make it dirty. </brief_description> <description> - Modify the sound and make it dirty. Different types are available : clip, tan, lofi (bit crushing), overdrive, or waveshape. + Modify the sound and make it dirty. Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape. By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently. </description> <tutorials> @@ -17,7 +17,7 @@ Distortion power. Value can range from 0 to 1. Default value: [code]0[/code]. </member> <member name="keep_hf_hz" type="float" setter="set_keep_hf_hz" getter="get_keep_hf_hz"> - High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: [code]16000[/code]. + High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: [code]16000[/code]. </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="AudioEffectDistortion.Mode"> Distortion type. Default value: [constant MODE_CLIP]. diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml index fef3868d02..d30b6fc71d 100644 --- a/doc/classes/AudioEffectEQ.xml +++ b/doc/classes/AudioEffectEQ.xml @@ -5,7 +5,7 @@ Use it to create a custom equalizer if [AudioEffectEQ6], [AudioEffectEQ10] or [AudioEffectEQ21] don't fit your needs. </brief_description> <description> - AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQ are very useful on the Master Bus to completely master a mix and give it character. They are also very useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged). + AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQs are useful on the Master bus to completely master a mix and give it more character. They are also useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged). </description> <tutorials> </tutorials> diff --git a/doc/classes/AudioEffectEQ10.xml b/doc/classes/AudioEffectEQ10.xml index e9fd0d72cb..e94c4c71df 100644 --- a/doc/classes/AudioEffectEQ10.xml +++ b/doc/classes/AudioEffectEQ10.xml @@ -5,17 +5,17 @@ Each frequency can be modulated between -60/+24 dB. </brief_description> <description> - Frequency bands : - Band 1 : 31 Hz - Band 2 : 62 Hz - Band 3 : 125 Hz - Band 4 : 250 Hz - Band 5 : 500 Hz - Band 6 : 1000 Hz - Band 7 : 2000 Hz - Band 8 : 4000 Hz - Band 9 : 8000 Hz - Band 10 : 16000 Hz + Frequency bands: + Band 1: 31 Hz + Band 2: 62 Hz + Band 3: 125 Hz + Band 4: 250 Hz + Band 5: 500 Hz + Band 6: 1000 Hz + Band 7: 2000 Hz + Band 8: 4000 Hz + Band 9: 8000 Hz + Band 10: 16000 Hz See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ21]. </description> <tutorials> diff --git a/doc/classes/AudioEffectEQ21.xml b/doc/classes/AudioEffectEQ21.xml index d1b39d9824..dd26e06ee8 100644 --- a/doc/classes/AudioEffectEQ21.xml +++ b/doc/classes/AudioEffectEQ21.xml @@ -5,28 +5,28 @@ Each frequency can be modulated between -60/+24 dB. </brief_description> <description> - Frequency bands : - Band 1 : 22 Hz - Band 2 : 32 Hz - Band 3 : 44 Hz - Band 4 : 63 Hz - Band 5 : 90 Hz - Band 6 : 125 Hz - Band 7 : 175 Hz - Band 8 : 250 Hz - Band 9 : 350 Hz - Band 10 : 500 Hz - Band 11 : 700 Hz - Band 12 : 1000 Hz - Band 13 : 1400 Hz - Band 14 : 2000 Hz - Band 15 : 2800 Hz - Band 16 : 4000 Hz - Band 17 : 5600 Hz - Band 18 : 8000 Hz - Band 19 : 11000 Hz - Band 20 : 16000 Hz - Band 21 : 22000 Hz + Frequency bands: + Band 1: 22 Hz + Band 2: 32 Hz + Band 3: 44 Hz + Band 4: 63 Hz + Band 5: 90 Hz + Band 6: 125 Hz + Band 7: 175 Hz + Band 8: 250 Hz + Band 9: 350 Hz + Band 10: 500 Hz + Band 11: 700 Hz + Band 12: 1000 Hz + Band 13: 1400 Hz + Band 14: 2000 Hz + Band 15: 2800 Hz + Band 16: 4000 Hz + Band 17: 5600 Hz + Band 18: 8000 Hz + Band 19: 11000 Hz + Band 20: 16000 Hz + Band 21: 22000 Hz See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ10]. </description> <tutorials> diff --git a/doc/classes/AudioEffectEQ6.xml b/doc/classes/AudioEffectEQ6.xml index d40471dbd6..eb3dc738ef 100644 --- a/doc/classes/AudioEffectEQ6.xml +++ b/doc/classes/AudioEffectEQ6.xml @@ -5,13 +5,13 @@ Each frequency can be modulated between -60/+24 dB. </brief_description> <description> - Frequency bands : - Band 1 : 32 Hz - Band 2 : 100 Hz - Band 3 : 320 Hz - Band 4 : 1000 Hz - Band 5 : 3200 Hz - Band 6 : 10000 Hz + Frequency bands: + Band 1: 32 Hz + Band 2: 100 Hz + Band 3: 320 Hz + Band 4: 1000 Hz + Band 5: 3200 Hz + Band 6: 10000 Hz See also [AudioEffectEQ], [AudioEffectEQ10], [AudioEffectEQ21]. </description> <tutorials> diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 5ed4ae28db..e3cc707613 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a filter to the Audio Bus. + Adds a filter to the audio bus. </brief_description> <description> Allows frequencies other than the [member cutoff_hz] to pass. @@ -12,7 +12,7 @@ </methods> <members> <member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff"> - Threshold frequency for the filter. + Threshold frequency for the filter, in Hz. </member> <member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB"> </member> diff --git a/doc/classes/AudioEffectHighPassFilter.xml b/doc/classes/AudioEffectHighPassFilter.xml index 3a486acab8..589195da02 100644 --- a/doc/classes/AudioEffectHighPassFilter.xml +++ b/doc/classes/AudioEffectHighPassFilter.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.2"> <brief_description> - Adds a high pass filter to the Audio Bus. + Adds a high-pass filter to the Audio Bus. </brief_description> <description> Cuts frequencies lower than the [member AudioEffectFilter.cutoff_hz] and allows higher frequencies to pass. diff --git a/doc/classes/AudioEffectLimiter.xml b/doc/classes/AudioEffectLimiter.xml index c17816bb87..09fec556e1 100644 --- a/doc/classes/AudioEffectLimiter.xml +++ b/doc/classes/AudioEffectLimiter.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectLimiter" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a soft clip Limiter audio effect to an Audio bus. + Adds a soft-clip limiter audio effect to an Audio bus. </brief_description> <description> - A limiter is similar to a compressor, but it's less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master Bus is always recommended to reduce the effects of clipping. + A limiter is similar to a compressor, but it's less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master bus is always recommended to reduce the effects of clipping. Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded. </description> <tutorials> @@ -13,15 +13,15 @@ </methods> <members> <member name="ceiling_db" type="float" setter="set_ceiling_db" getter="get_ceiling_db"> - The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: [code]-0.1dB[/code]. + The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1. Default value: [code]-0.1dB[/code]. </member> <member name="soft_clip_db" type="float" setter="set_soft_clip_db" getter="get_soft_clip_db"> - Applies a gain to the limited waves. Value can range from 0 to 6. Default value: [code]2dB[/code]. + Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. Default value: [code]2dB[/code]. </member> <member name="soft_clip_ratio" type="float" setter="set_soft_clip_ratio" getter="get_soft_clip_ratio"> </member> <member name="threshold_db" type="float" setter="set_threshold_db" getter="get_threshold_db"> - Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: [code]0dB[/code]. + Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0. Default value: [code]0dB[/code]. </member> </members> <constants> diff --git a/doc/classes/AudioEffectLowPassFilter.xml b/doc/classes/AudioEffectLowPassFilter.xml index 9402045150..c0319a6713 100644 --- a/doc/classes/AudioEffectLowPassFilter.xml +++ b/doc/classes/AudioEffectLowPassFilter.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.2"> <brief_description> - Adds a low pass filter to the Audio Bus. + Adds a low-pass filter to the Audio bus. </brief_description> <description> Cuts frequencies higher than the [member AudioEffectFilter.cutoff_hz] and allows lower frequencies to pass. diff --git a/doc/classes/AudioEffectNotchFilter.xml b/doc/classes/AudioEffectNotchFilter.xml index 00e950b43a..4b5cfd7e51 100644 --- a/doc/classes/AudioEffectNotchFilter.xml +++ b/doc/classes/AudioEffectNotchFilter.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.2"> <brief_description> - Adds a notch filter to the Audio Bus. + Adds a notch filter to the Audio bus. </brief_description> <description> Attenuates frequencies in a narrow band around the [member AudioEffectFilter.cutoff_hz] and cuts frequencies outside of this range. diff --git a/doc/classes/AudioEffectPanner.xml b/doc/classes/AudioEffectPanner.xml index 7d01a73b0b..26f5a9c385 100644 --- a/doc/classes/AudioEffectPanner.xml +++ b/doc/classes/AudioEffectPanner.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectPanner" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a Panner audio effect to an Audio bus. Pans sound left or right. + Adds a panner audio effect to an Audio bus. Pans sound left or right. </brief_description> <description> Determines how much of an audio signal is sent to the left and right buses. diff --git a/doc/classes/AudioEffectPhaser.xml b/doc/classes/AudioEffectPhaser.xml index c42b5f59ee..20781c018a 100644 --- a/doc/classes/AudioEffectPhaser.xml +++ b/doc/classes/AudioEffectPhaser.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectPhaser" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a Phaser audio effect to an Audio bus. + Adds a phaser audio effect to an Audio bus. Combines the original signal with a copy that is slightly out of phase with the original. </brief_description> <description> - Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low Frequency Oscillator. + Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a low-frequency oscillator. </description> <tutorials> </tutorials> @@ -19,13 +19,13 @@ Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: [code]0.7[/code]. </member> <member name="range_max_hz" type="float" setter="set_range_max_hz" getter="get_range_max_hz"> - Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: [code]1600hz[/code]. + Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. Default value: [code]1600hz[/code]. </member> <member name="range_min_hz" type="float" setter="set_range_min_hz" getter="get_range_min_hz"> - Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: [code]440hz[/code]. + Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. Default value: [code]440hz[/code]. </member> <member name="rate_hz" type="float" setter="set_rate_hz" getter="get_rate_hz"> - Adjusts the rate at which the effect sweeps up and down across the frequency range. + Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range. </member> </members> <constants> diff --git a/doc/classes/AudioEffectPitchShift.xml b/doc/classes/AudioEffectPitchShift.xml index 271e1a2a4c..e31f311af5 100644 --- a/doc/classes/AudioEffectPitchShift.xml +++ b/doc/classes/AudioEffectPitchShift.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectPitchShift" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a Pitch shift audio effect to an Audio bus. + Adds a pitch-shifting audio effect to an Audio bus. Raises or lowers the pitch of original sound. </brief_description> <description> diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml index 8c9652eee2..84caa2e373 100644 --- a/doc/classes/AudioEffectReverb.xml +++ b/doc/classes/AudioEffectReverb.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.2"> <brief_description> - Adds a Reverb audio effect to an Audio bus. + Adds a reverberation audio effect to an Audio bus. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces. </brief_description> <description> @@ -25,7 +25,7 @@ Output percent of predelay. Value can range from 0 to 1. Default value: [code]1[/code]. </member> <member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec"> - Time between the original signal and the early reflections of the reverb signal. Default value: [code]150ms[/code]. + Time between the original signal and the early reflections of the reverb signal, in milliseconds. Default value: [code]150ms[/code]. </member> <member name="room_size" type="float" setter="set_room_size" getter="get_room_size"> Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: [code]0.8[/code]. diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 6dc1600cf2..dec1de42bc 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioServer" inherits="Object" category="Core" version="3.2"> <brief_description> - Server interface for low level audio access. + Server interface for low-level audio access. </brief_description> <description> - AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. + AudioServer is a low-level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link> @@ -407,7 +407,7 @@ <return type="void"> </return> <description> - Unlocks the audiodriver's main loop. After locking it always unlock it. + Unlocks the audio driver's main loop. (After locking it, you should always unlock it.) </description> </method> </methods> diff --git a/doc/classes/AudioStreamPlayback.xml b/doc/classes/AudioStreamPlayback.xml index 773a396bc4..92e654a50f 100644 --- a/doc/classes/AudioStreamPlayback.xml +++ b/doc/classes/AudioStreamPlayback.xml @@ -4,7 +4,7 @@ Meta class for playing back audio. </brief_description> <description> - Can play, loop, pause a scroll through Audio. See [AudioStream] and [AudioStreamOGGVorbis] for usage. + Can play, loop, pause a scroll through audio. See [AudioStream] and [AudioStreamOGGVorbis] for usage. </description> <tutorials> </tutorials> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index c6ec45f15e..09316f47c3 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.2"> <brief_description> - Plays back audio. + Plays back audio non-positionally. </brief_description> <description> - Plays background audio. + Plays an audio stream non-positionally. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> @@ -29,7 +29,7 @@ <argument index="0" name="from_position" type="float" default="0.0"> </argument> <description> - Plays the audio from the given position 'from_position', in seconds. + Plays the audio from the given [code]from_position[/code], in seconds. </description> </method> <method name="seek"> diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 51bf5e7574..c8c01b0426 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -29,7 +29,7 @@ <argument index="0" name="from_position" type="float" default="0.0"> </argument> <description> - Plays the audio from the given position 'from_position', in seconds. + Plays the audio from the given position [code]from_position[/code], in seconds. </description> </method> <method name="seek"> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 2bd3ac1eaa..823cacbcaa 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -29,7 +29,7 @@ <argument index="0" name="from_position" type="float" default="0.0"> </argument> <description> - Plays the audio from the given position 'from_position', in seconds. + Plays the audio from the given position [code]from_position[/code], in seconds. </description> </method> <method name="seek"> @@ -78,16 +78,16 @@ If [code]true[/code], the audio should be dampened according to the direction of the sound. </member> <member name="emission_angle_filter_attenuation_db" type="float" setter="set_emission_angle_filter_attenuation_db" getter="get_emission_angle_filter_attenuation_db"> - dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. + Dampens audio if camera is outside of [member emission_angle_degrees] and [member emission_angle_enabled] is set by this factor, in dB. </member> <member name="max_db" type="float" setter="set_max_db" getter="get_max_db"> Sets the absolute maximum of the soundlevel, in dB. </member> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance"> - Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. + Sets the distance from which the [member out_of_range_mode] takes effect. Has no effect if set to 0. </member> <member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode"> - Decides if audio should pause when source is outside of 'max_distance' range. + Decides if audio should pause when source is outside of [member max_distance] range. </member> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale"> Changes the pitch and the tempo of the audio. @@ -110,7 +110,7 @@ <signals> <signal name="finished"> <description> - Fires when the audio stops playing. + Emitted when the audio stops playing. </description> </signal> </signals> diff --git a/doc/classes/AudioStreamRandomPitch.xml b/doc/classes/AudioStreamRandomPitch.xml index 49aa5a0192..27d7c480ba 100644 --- a/doc/classes/AudioStreamRandomPitch.xml +++ b/doc/classes/AudioStreamRandomPitch.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioStreamRandomPitch" inherits="AudioStream" category="Core" version="3.2"> <brief_description> - Plays audio with random pitch tweaking. + Plays audio with random pitch shifting. </brief_description> <description> Randomly varies pitch on each start. diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 4bcf8ea791..5f9e454fb6 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.2"> <brief_description> - Stores audio data loaded from [code].wav[/code] files. + Stores audio data loaded from WAV files. </brief_description> <description> - AudioStreamSample stores sound samples loaded from [code].wav[/code] files. To play the stored sound use an [AudioStreamPlayer] (for background music) or [AudioStreamPlayer2D]/[AudioStreamPlayer3D] (for positional audio). The sound can be looped. - This class can also be used to store dynamically generated PCM audio data. + AudioStreamSample stores sound samples loaded from WAV files. To play the stored sound, use an [AudioStreamPlayer] (for non-positional audio) or [AudioStreamPlayer2D]/[AudioStreamPlayer3D] (for positional audio). The sound can be looped. + This class can also be used to store dynamically-generated PCM audio data. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ </argument> <description> Saves the AudioStreamSample as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved. - Note that a [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing. + [b]Note:[/b] A [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing. </description> </method> </methods> @@ -26,7 +26,7 @@ Contains the audio data in bytes. </member> <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format"> - Audio format. See FORMAT_* constants for values. + Audio format. See [code]FORMAT_*[/code] constants for values. </member> <member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin"> Loop start in bytes. @@ -35,7 +35,7 @@ Loop end in bytes. </member> <member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode"> - Loop mode. See LOOP_* constants for values. + Loop mode. See [code]LOOP_*[/code] constants for values. </member> <member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate"> The sample rate for mixing this audio. @@ -46,25 +46,25 @@ </members> <constants> <constant name="FORMAT_8_BITS" value="0" enum="Format"> - Audio codec 8 bit. + 8-bit audio codec. </constant> <constant name="FORMAT_16_BITS" value="1" enum="Format"> - Audio codec 16 bit. + 16-bit audio codec. </constant> <constant name="FORMAT_IMA_ADPCM" value="2" enum="Format"> - Audio codec IMA ADPCM. + Audio is compressed using IMA ADPCM. </constant> <constant name="LOOP_DISABLED" value="0" enum="LoopMode"> Audio does not loop. </constant> <constant name="LOOP_FORWARD" value="1" enum="LoopMode"> - Audio loops the data between loop_begin and loop_end playing forward only. + Audio loops the data between [member loop_begin] and [member loop_end] playing forward only. </constant> <constant name="LOOP_PING_PONG" value="2" enum="LoopMode"> - Audio loops the data between loop_begin and loop_end playing back and forth. + Audio loops the data between [member loop_begin] and [member loop_end] playing back and forth. </constant> <constant name="LOOP_BACKWARD" value="3" enum="LoopMode"> - Audio loops the data between loop_begin and loop_end playing backward only. + Audio loops the data between [member loop_begin] and [member loop_end] playing backward only. </constant> </constants> </class> diff --git a/doc/classes/BackBufferCopy.xml b/doc/classes/BackBufferCopy.xml index 1ee4f08a38..c2ffae9c14 100644 --- a/doc/classes/BackBufferCopy.xml +++ b/doc/classes/BackBufferCopy.xml @@ -4,7 +4,7 @@ Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with [code]SCREEN_TEXTURE[/code] in the [code]texture()[/code] function. </brief_description> <description> - Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Use [code]SCREEN_TEXTURE[/code] in the [code]texture()[/code] function to access the buffer. + Node for back-buffering the currently-displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Use [code]SCREEN_TEXTURE[/code] in the [code]texture()[/code] function to access the buffer. </description> <tutorials> </tutorials> diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index 735e55cd39..af9666b6e4 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -34,10 +34,10 @@ <member name="bake_energy" type="float" setter="set_energy" getter="get_energy"> </member> <member name="bake_extents" type="Vector3" setter="set_extents" getter="get_extents"> - Size of affected area. + The size of the affected area. </member> <member name="bake_hdr" type="bool" setter="set_hdr" getter="is_hdr"> - If [code]true[/code], lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller lightmap. Default value:[code]false[/code]. + If [code]true[/code], the lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller file size. Default value: [code]false[/code]. </member> <member name="bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="BakedLightmap.BakeMode"> Lightmapping mode. See [enum BakeMode]. @@ -51,7 +51,7 @@ Grid size used for real-time capture information on dynamic objects. Cannot be larger than [member bake_cell_size]. </member> <member name="image_path" type="String" setter="set_image_path" getter="get_image_path"> - Location where lightmaps will be saved. + The location where lightmaps will be saved. </member> <member name="light_data" type="BakedLightmapData" setter="set_light_data" getter="get_light_data"> The calculated light data. @@ -59,13 +59,13 @@ </members> <constants> <constant name="BAKE_QUALITY_LOW" value="0" enum="BakeQuality"> - Lowest bake quality mode. Fastest to calculate. + The lowest bake quality mode. Fastest to calculate. </constant> <constant name="BAKE_QUALITY_MEDIUM" value="1" enum="BakeQuality"> - Default bake quality mode. + The default bake quality mode. </constant> <constant name="BAKE_QUALITY_HIGH" value="2" enum="BakeQuality"> - Highest bake quality mode. Takes longer to calculate. + The highest bake quality mode. Takes longer to calculate. </constant> <constant name="BAKE_MODE_CONE_TRACE" value="0" enum="BakeMode"> Less precise but faster bake mode. diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 6d1a7a8f87..ad2edadb75 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -29,7 +29,7 @@ <return type="int" enum="BaseButton.DrawMode"> </return> <description> - Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. + Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the [code]DRAW_*[/code] enum. </description> </method> <method name="is_hovered" qualifiers="const"> @@ -42,7 +42,7 @@ </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. + Determines when the button is considered clicked, one of the [code]ACTION_MODE_*[/code] constants. </member> <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask"> Binary mask to choose which mouse buttons this button will respond to. @@ -86,14 +86,14 @@ </signal> <signal name="pressed"> <description> - This signal is emitted every time the button is toggled or pressed (i.e. activated, so on [code]button_down[/code] if "Click on press" is active and on [code]button_up[/code] otherwise). + Emitted when the button is toggled or pressed. This is on [signal button_down] if [member action_mode] is [constant ACTION_MODE_BUTTON_PRESS] and on [signal button_up] otherwise. </description> </signal> <signal name="toggled"> <argument index="0" name="button_pressed" type="bool"> </argument> <description> - This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the [i]button_pressed[/i] argument. + Emitted when the button was just toggled between pressed and normal states (only if [member toggle_mode] is active). The new state is contained in the [code]button_pressed[/code] argument. </description> </signal> </signals> diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index ae7a3ff323..4809dd21bc 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Basis" category="Built-In Types" version="3.2"> <brief_description> - 3x3 matrix datatype. + 3×3 matrix datatype. </brief_description> <description> - 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized (due to scaling). Almost always used as orthogonal basis for a [Transform]. + 3×3 matrix used for 3D rotation and scale. Contains 3 vector fields X, Y and Z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized (due to scaling). Almost always used as an orthogonal basis for a [Transform]. For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). </description> <tutorials> @@ -26,7 +26,7 @@ <argument index="0" name="from" type="Vector3"> </argument> <description> - Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle). + Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X angle, Y angle, Z angle). </description> </method> <method name="Basis"> @@ -64,7 +64,7 @@ <return type="Vector3"> </return> <description> - Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). + Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). </description> </method> <method name="get_orthogonal_index"> @@ -148,7 +148,7 @@ <argument index="0" name="with" type="Vector3"> </argument> <description> - Transposed dot product with the x axis of the matrix. + Transposed dot product with the X axis of the matrix. </description> </method> <method name="tdoty"> @@ -157,7 +157,7 @@ <argument index="0" name="with" type="Vector3"> </argument> <description> - Transposed dot product with the y axis of the matrix. + Transposed dot product with the Y axis of the matrix. </description> </method> <method name="tdotz"> @@ -166,7 +166,7 @@ <argument index="0" name="with" type="Vector3"> </argument> <description> - Transposed dot product with the z axis of the matrix. + Transposed dot product with the Z axis of the matrix. </description> </method> <method name="transposed"> @@ -191,19 +191,20 @@ <argument index="0" name="v" type="Vector3"> </argument> <description> - Returns a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. + Returns a vector transformed (multiplied) by the transposed matrix. + [b]Note:[/b] This results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. </description> </method> </methods> <members> <member name="x" type="Vector3" setter="" getter=""> - The basis matrix's x vector. + The basis matrix's X vector. </member> <member name="y" type="Vector3" setter="" getter=""> - The basis matrix's y vector. + The basis matrix's Y vector. </member> <member name="z" type="Vector3" setter="" getter=""> - The basis matrix's z vector. + The basis matrix's Z vector. </member> </members> <constants> diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index 149d92e870..b6b5d9d244 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -23,7 +23,7 @@ <argument index="4" name="advance" type="float" default="-1"> </argument> <description> - Adds a character to the font, where [code]character[/code] is the unicode value, [code]texture[/code] is the texture index, [code]rect[/code] is the region in the texture (in pixels!), [code]align[/code] is the (optional) alignment for the character and [code]advance[/code] is the (optional) advance. + Adds a character to the font, where [code]character[/code] is the Unicode value, [code]texture[/code] is the texture index, [code]rect[/code] is the region in the texture (in pixels!), [code]align[/code] is the (optional) alignment for the character and [code]advance[/code] is the (optional) advance. </description> </method> <method name="add_kerning_pair"> diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml index 9aa69e4164..dc263d3c71 100644 --- a/doc/classes/BoxContainer.xml +++ b/doc/classes/BoxContainer.xml @@ -15,13 +15,13 @@ <argument index="0" name="begin" type="bool"> </argument> <description> - Adds a control to the box as a spacer. If [code]true[/code], [i]begin[/i] will insert the spacer control in front of other children. + Adds a control to the box as a spacer. If [code]true[/code], [code]begin[/code] will insert the spacer control in front of other children. </description> </method> </methods> <members> <member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode"> - The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END). + The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]). </member> </members> <constants> diff --git a/doc/classes/BoxShape.xml b/doc/classes/BoxShape.xml index 3678c0e393..5152f17f51 100644 --- a/doc/classes/BoxShape.xml +++ b/doc/classes/BoxShape.xml @@ -12,7 +12,7 @@ </methods> <members> <member name="extents" type="Vector3" setter="set_extents" getter="get_extents"> - The shape's half extents. + The box's half extents. The width, height and depth of this shape is twice the half extents. </member> </members> <constants> diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index 5d3027e347..86381676e1 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -12,7 +12,7 @@ </methods> <members> <member name="align" type="int" setter="set_text_align" getter="get_text_align" enum="Button.TextAlign"> - Text alignment policy for the button's text, use one of the ALIGN_* constants. + Text alignment policy for the button's text, use one of the [code]ALIGN_*[/code] constants. </member> <member name="clip_text" type="bool" setter="set_clip_text" getter="get_clip_text"> When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index c9c92102f3..0a860f4b21 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -95,7 +95,7 @@ <member name="emission_points" type="PoolVector3Array" setter="set_emission_points" getter="get_emission_points"> </member> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles.EmissionShape"> - Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT]. + Particles will be emitted inside this region. See [enum EmissionShape] for possible values. Default value: [constant EMISSION_SHAPE_POINT]. </member> <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius"> The sphere's radius if [enum EmissionShape] is set to [constant EMISSION_SHAPE_SPHERE]. @@ -110,19 +110,19 @@ The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself. </member> <member name="flag_align_y" type="bool" setter="set_particle_flag" getter="get_particle_flag"> - Align y-axis of particle with the direction of its velocity. + Align Y axis of particle with the direction of its velocity. </member> <member name="flag_disable_z" type="bool" setter="set_particle_flag" getter="get_particle_flag"> If [code]true[/code], particles will not move on the z axis. Default value: [code]false[/code]. </member> <member name="flag_rotate_y" type="bool" setter="set_particle_flag" getter="get_particle_flag"> - If [code]true[/code], particles rotate around y-axis by [member angle]. + If [code]true[/code], particles rotate around Y axis by [member angle]. </member> <member name="flatness" type="float" setter="set_flatness" getter="get_flatness"> Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane. Default [code]0[/code]. </member> <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta"> - If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code] + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]. </member> <member name="gravity" type="Vector3" setter="set_gravity" getter="get_gravity"> Gravity applied to every particle. Default value: [code](0, -9.8, 0)[/code]. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 7283d5084c..379d57bef1 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -96,7 +96,7 @@ The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE]. </member> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles2D.EmissionShape"> - Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT]. + Particles will be emitted inside this region. See [enum EmissionShape] for possible values. Default value: [constant EMISSION_SHAPE_POINT]. </member> <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius"> The sphere's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_SPHERE]. @@ -111,12 +111,12 @@ The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. </member> <member name="flag_align_y" type="bool" setter="set_particle_flag" getter="get_particle_flag"> - Align y-axis of particle with the direction of its velocity. + Align Y axis of particle with the direction of its velocity. </member> <member name="flatness" type="float" setter="set_flatness" getter="get_flatness"> </member> <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta"> - If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code] + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]. </member> <member name="gravity" type="Vector2" setter="set_gravity" getter="get_gravity"> Gravity applied to every particle. Default value: [code](0, 98)[/code]. @@ -206,7 +206,7 @@ Tangential acceleration randomness ratio. Default value: [code]0[/code]. </member> <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> - Particle texture. If [code]null[/code] particles will be squares. + Particle texture. If [code]null[/code], particles will be squares. </member> </members> <constants> diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index b7d983afa2..99431c2e00 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -4,7 +4,7 @@ Camera node, displays from a point of view. </brief_description> <description> - Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides [i]3D[/i] display capabilities to a [Viewport], and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed. + Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the camera will register in the global viewport. In other words, a camera just provides 3D display capabilities to a [Viewport], and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed. </description> <tutorials> </tutorials> @@ -15,7 +15,7 @@ <argument index="0" name="enable_next" type="bool" default="true"> </argument> <description> - If this is the current Camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next Camera current, if any. + If this is the current camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next camera current, if any. </description> </method> <method name="get_camera_rid" qualifiers="const"> @@ -29,7 +29,7 @@ <return type="Transform"> </return> <description> - Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. + Gets the camera transform. Subclassed cameras such as [InterpolatedCamera] may provide different transforms than the [Node] transform. </description> </method> <method name="get_cull_mask_bit" qualifiers="const"> @@ -52,14 +52,15 @@ <argument index="0" name="world_point" type="Vector3"> </argument> <description> - Returns [code]true[/code] if the given position is behind the Camera. Note that a position which returns [code]false[/code] may still be outside the Camera's field of view. + Returns [code]true[/code] if the given position is behind the camera. + [b]Note:[/b] A position which returns [code]false[/code] may still be outside the camera's field of view. </description> </method> <method name="make_current"> <return type="void"> </return> <description> - Makes this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. + Makes this camera the current camera for the [Viewport] (see class description). If the camera node is outside the scene tree, it will attempt to become current once it's added. </description> </method> <method name="project_local_ray_normal" qualifiers="const"> @@ -134,7 +135,7 @@ <argument index="2" name="z_far" type="float"> </argument> <description> - Sets the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) + Sets the camera projection to orthogonal mode, by specifying a width and the [code]near[/code] and [code]far[/code] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) </description> </method> <method name="set_perspective"> @@ -147,7 +148,7 @@ <argument index="2" name="z_far" type="float"> </argument> <description> - Sets the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. + Sets the camera projection to perspective mode, by specifying a [code]fov[/code] angle in degrees (FOV means Field of View), and the [code]near[/code] and [code]far[/code] clip planes in world-space units. </description> </method> <method name="unproject_position" qualifiers="const"> @@ -165,16 +166,16 @@ The culling mask that describes which 3D render layers are rendered by this camera. </member> <member name="current" type="bool" setter="set_current" getter="is_current"> - If [code]true[/code], the ancestor [Viewport] is currently using this Camera. Default value: [code]false[/code]. + If [code]true[/code], the ancestor [Viewport] is currently using this camera. Default value: [code]false[/code]. </member> <member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="Camera.DopplerTracking"> - If not [constant DOPPLER_TRACKING_DISABLED] this Camera will simulate the Doppler effect for objects changed in particular [code]_process[/code] methods. Default value: [constant DOPPLER_TRACKING_DISABLED]. + If not [constant DOPPLER_TRACKING_DISABLED], this camera will simulate the Doppler effect for objects changed in particular [code]_process[/code] methods. See [enum DopplerTracking] for possible values. Default value: [constant DOPPLER_TRACKING_DISABLED]. </member> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> - The [Environment] to use for this Camera. + The [Environment] to use for this camera. </member> <member name="far" type="float" setter="set_zfar" getter="get_zfar"> - The distance to the far culling boundary for this Camera relative to its local z-axis. + The distance to the far culling boundary for this camera relative to its local Z axis. </member> <member name="fov" type="float" setter="set_fov" getter="get_fov"> The camera's field of view angle (in degrees). Only applicable in perspective mode. Since [member keep_aspect] locks one axis, [code]fov[/code] sets the other axis' field of view angle. @@ -182,47 +183,48 @@ <member name="frustum_offset" type="Vector2" setter="set_frustum_offset" getter="get_frustum_offset"> </member> <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset"> - The horizontal (X) offset of the Camera viewport. + The horizontal (X) offset of the camera viewport. </member> <member name="keep_aspect" type="int" setter="set_keep_aspect_mode" getter="get_keep_aspect_mode" enum="Camera.KeepAspect"> The axis to lock during [member fov]/[member size] adjustments. Can be either [constant KEEP_WIDTH] or [constant KEEP_HEIGHT]. </member> <member name="near" type="float" setter="set_znear" getter="get_znear"> - The distance to the near culling boundary for this Camera relative to its local z-axis. + The distance to the near culling boundary for this camera relative to its local Z axis. </member> <member name="projection" type="int" setter="set_projection" getter="get_projection" enum="Camera.Projection"> - The camera's projection mode. In [constant PROJECTION_PERSPECTIVE] mode, objects' z-distance from the camera's local space scales their perceived size. + The camera's projection mode. In [constant PROJECTION_PERSPECTIVE] mode, objects' Z distance from the camera's local space scales their perceived size. </member> <member name="size" type="float" setter="set_size" getter="get_size"> The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since [member keep_aspect] locks on axis, [code]size[/code] sets the other axis' size length. </member> <member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset"> - The vertical (Y) offset of the Camera viewport. + The vertical (Y) offset of the camera viewport. </member> </members> <constants> <constant name="PROJECTION_PERSPECTIVE" value="0" enum="Projection"> - Perspective Projection (object's size on the screen becomes smaller when far away). + Perspective projection. Objects on the screen becomes smaller when they are far away. </constant> <constant name="PROJECTION_ORTHOGONAL" value="1" enum="Projection"> - Orthogonal Projection (objects remain the same size on the screen no matter how far away they are; also known as orthographic projection). + Orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are. </constant> <constant name="PROJECTION_FRUSTUM" value="2" enum="Projection"> + Frustum projection. This mode allows adjusting [member frustum_offset] to create "tilted frustum" effects. </constant> <constant name="KEEP_WIDTH" value="0" enum="KeepAspect"> - Preserves the horizontal aspect ratio. + Preserves the horizontal aspect ratio; also known as Vert- scaling. This is usually the best option for projects running in portrait mode, as taller aspect ratios will benefit from a wider vertical FOV. </constant> <constant name="KEEP_HEIGHT" value="1" enum="KeepAspect"> - Preserves the vertical aspect ratio. + Preserves the vertical aspect ratio; also known as Hor+ scaling. This is usually the best option for projects running in landscape mode, as wider aspect ratios will automatically benefit from a wider horizontal FOV. </constant> <constant name="DOPPLER_TRACKING_DISABLED" value="0" enum="DopplerTracking"> - Disable Doppler effect simulation (default). + Disables Doppler effect simulation (default). </constant> <constant name="DOPPLER_TRACKING_IDLE_STEP" value="1" enum="DopplerTracking"> - Simulate Doppler effect by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). + Simulate Doppler effect by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). </constant> <constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2" enum="DopplerTracking"> - Simulate Doppler effect by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). + Simulate Doppler effect by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). </constant> </constants> </class> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index fcc99123d2..86f0b00d2f 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -4,8 +4,8 @@ Camera node for 2D scenes. </brief_description> <description> - Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem] based nodes. - This node is intended to be a simple helper to get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from [Node2D] and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in [Viewport]. + Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem]-based nodes. + This node is intended to be a simple helper to get things going quickly and it may happen that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from [Node2D] and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in [Viewport]. </description> <tutorials> </tutorials> @@ -14,7 +14,7 @@ <return type="void"> </return> <description> - Align the camera to the tracked node + Aligns the camera to the tracked node. </description> </method> <method name="clear_current"> @@ -28,7 +28,7 @@ <return type="void"> </return> <description> - Force the camera to update scroll immediately. + Forces the camera to update scroll immediately. </description> </method> <method name="get_camera_position" qualifiers="const"> @@ -49,14 +49,14 @@ <return type="void"> </return> <description> - Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. + Make this the current 2D camera for the scene (viewport and layer), in case there are many cameras in the scene. </description> </method> <method name="reset_smoothing"> <return type="void"> </return> <description> - Set the camera's position immediately to its current smoothing destination. + Sets the camera's position immediately to its current smoothing destination. This has no effect if smoothing is disabled. </description> </method> @@ -69,7 +69,7 @@ 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="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport"> - The custom [Viewport] node attached to the [Camera2D]. If null or not a [Viewport], uses the default viewport instead. + The custom [Viewport] node attached to the [Camera2D]. If [code]null[/code] or not a [Viewport], uses the default viewport instead. </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. @@ -90,13 +90,13 @@ If [code]true[/code], the camera only moves when reaching the vertical drag margins. If [code]false[/code], the camera moves vertically regardless of margins. Default value: [code]true[/code]. </member> <member name="editor_draw_drag_margin" type="bool" setter="set_margin_drawing_enabled" getter="is_margin_drawing_enabled"> - If [code]true[/code], draws the camera's drag margin rectangle in the editor. Default value: [code]false[/code] + If [code]true[/code], draws the camera's drag margin rectangle in the editor. Default value: [code]false[/code]. </member> <member name="editor_draw_limits" type="bool" setter="set_limit_drawing_enabled" getter="is_limit_drawing_enabled"> - If [code]true[/code], draws the camera's limits rectangle in the editor. Default value: [code]true[/code] + If [code]true[/code], draws the camera's limits rectangle in the editor. Default value: [code]true[/code]. </member> <member name="editor_draw_screen" type="bool" setter="set_screen_drawing_enabled" getter="is_screen_drawing_enabled"> - If [code]true[/code], draws the camera's screen rectangle in the editor. Default value: [code]false[/code] + If [code]true[/code], draws the camera's screen rectangle in the editor. Default value: [code]false[/code]. </member> <member name="limit_bottom" type="int" setter="set_limit" getter="get_limit"> Bottom scroll limit in pixels. The camera stops moving when reaching this value. @@ -108,7 +108,7 @@ Right scroll limit in pixels. The camera stops moving when reaching this value. </member> <member name="limit_smoothed" type="bool" setter="set_limit_smoothing_enabled" getter="is_limit_smoothing_enabled"> - If [code]true[/code], the camera smoothly stops when reaches its limits. Default value: [code]false[/code] + If [code]true[/code], the camera smoothly stops when reaches its limits. Default value: [code]false[/code]. </member> <member name="limit_top" type="int" setter="set_limit" getter="get_limit"> Top scroll limit in pixels. The camera stops moving when reaching this value. @@ -117,24 +117,24 @@ The camera's offset, useful for looking around or camera shake animations. </member> <member name="offset_h" type="float" setter="set_h_offset" getter="get_h_offset"> - The horizontal offset of the camera, relative to the drag margins. Default value: [code]0[/code] + The horizontal offset of the camera, relative to the drag margins. Default value: [code]0[/code]. </member> <member name="offset_v" type="float" setter="set_v_offset" getter="get_v_offset"> - The vertical offset of the camera, relative to the drag margins. Default value: [code]0[/code] + The vertical offset of the camera, relative to the drag margins. Default value: [code]0[/code]. </member> <member name="process_mode" type="int" setter="set_process_mode" getter="get_process_mode" enum="Camera2D.Camera2DProcessMode"> </member> <member name="rotating" type="bool" setter="set_rotating" getter="is_rotating"> - If [code]true[/code], the camera rotates with the target. Default value: [code]false[/code] + If [code]true[/code], the camera rotates with the target. Default value: [code]false[/code]. </member> <member name="smoothing_enabled" type="bool" setter="set_enable_follow_smoothing" getter="is_follow_smoothing_enabled"> - If [code]true[/code], the camera smoothly moves towards the target at [member smoothing_speed]. Default value: [code]false[/code] + If [code]true[/code], the camera smoothly moves towards the target at [member smoothing_speed]. Default value: [code]false[/code]. </member> <member name="smoothing_speed" type="float" setter="set_follow_smoothing" getter="get_follow_smoothing"> - Speed in pixels per second of the camera's smoothing effect when [member smoothing_enabled] is [code]true[/code] + Speed in pixels per second of the camera's smoothing effect when [member smoothing_enabled] is [code]true[/code]. </member> <member name="zoom" type="Vector2" setter="set_zoom" getter="get_zoom"> - The camera's zoom relative to the viewport. Values larger than [code]Vector2(1, 1)[/code] zoom out and smaller values zoom in. For an example, use [code]Vector2(0.5, 0.5)[/code] for a 2x zoom in, and [code]Vector2(4, 4)[/code] for a 4x zoom out. + 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 2× zoom-in, and [code]Vector2(4, 4)[/code] for a 4× zoom-out. </member> </members> <constants> diff --git a/doc/classes/CameraFeed.xml b/doc/classes/CameraFeed.xml index 4611b9c507..28280d688f 100644 --- a/doc/classes/CameraFeed.xml +++ b/doc/classes/CameraFeed.xml @@ -4,8 +4,8 @@ A camera feed gives you access to a single physical camera attached to your device. </brief_description> <description> - A camera feed gives you access to a single physical camera attached to your device. - When enabled Godot will start capturing frames from the camera which can then be used. Do note that many cameras will return YCbCr images which are split into two textures and need to be combined in a shader. Godot does this automatically for you if you set the environment to show the camera image in the background. + A camera feed gives you access to a single physical camera attached to your device. When enabled, Godot will start capturing frames from the camera which can then be used. + [b]Note:[/b] Many cameras will return YCbCr images which are split into two textures and need to be combined in a shader. Godot does this automatically for you if you set the environment to show the camera image in the background. </description> <tutorials> </tutorials> @@ -14,14 +14,14 @@ <return type="int"> </return> <description> - Get unique id for this feed + Gets the unique ID for this feed. </description> </method> <method name="get_name" qualifiers="const"> <return type="String"> </return> <description> - Get name of the camera + Gets the camera's name. </description> </method> <method name="get_position" qualifiers="const"> @@ -58,7 +58,7 @@ Camera is mounted at the front of the device. </constant> <constant name="FEED_BACK" value="2" enum="FeedPosition"> - Camera is moutned at the back of the device. + Camera is mounted at the back of the device. </constant> </constants> </class> diff --git a/doc/classes/CameraServer.xml b/doc/classes/CameraServer.xml index ee41f08ec6..850794c1da 100644 --- a/doc/classes/CameraServer.xml +++ b/doc/classes/CameraServer.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CameraServer" inherits="Object" category="Core" version="3.2"> <brief_description> - Our camera server keeps track of different cameras accessible in Godot. These are external cameras such as webcams or the cameras on your phone. + The CameraServer keeps track of different cameras accessible in Godot. These are external cameras such as webcams or the cameras on your phone. </brief_description> <description> </description> diff --git a/doc/classes/CameraTexture.xml b/doc/classes/CameraTexture.xml index 02f7f8bf58..5017df7a32 100644 --- a/doc/classes/CameraTexture.xml +++ b/doc/classes/CameraTexture.xml @@ -1,7 +1,8 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CameraTexture" inherits="Texture" category="Core" version="3.2"> <brief_description> - This texture gives access to the camera texture provided by a [CameraFeed]. Note that many cameras supply YCbCr images which need to be converted in a shader. + This texture gives access to the camera texture provided by a [CameraFeed]. + [b]Note:[/b] Many cameras supply YCbCr images which need to be converted in a shader. </brief_description> <description> </description> @@ -11,7 +12,7 @@ </methods> <members> <member name="camera_feed_id" type="int" setter="set_camera_feed_id" getter="get_camera_feed_id"> - Id of the [CameraFeed] for which we want to display the image. + The ID of the [CameraFeed] for which we want to display the image. </member> <member name="camera_is_active" type="bool" setter="set_camera_active" getter="get_camera_active"> Convenience property that gives access to the active property of the [CameraFeed]. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 2426471a49..f1a5c3a62f 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -356,63 +356,63 @@ <return type="Transform2D"> </return> <description> - Get the transform matrix of this item's canvas. + Gets the transform matrix of this item's canvas. </description> </method> <method name="get_global_mouse_position" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the global position of the mouse. + Gets the global position of the mouse. </description> </method> <method name="get_global_transform" qualifiers="const"> <return type="Transform2D"> </return> <description> - Get the global transform matrix of this item. + Gets the global transform matrix of this item. </description> </method> <method name="get_global_transform_with_canvas" qualifiers="const"> <return type="Transform2D"> </return> <description> - Get the global transform matrix of this item in relation to the canvas. + Gets the global transform matrix of this item in relation to the canvas. </description> </method> <method name="get_local_mouse_position" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the mouse position relative to this item's position. + Gets the mouse position relative to this item's position. </description> </method> <method name="get_transform" qualifiers="const"> <return type="Transform2D"> </return> <description> - Get the transform matrix of this item. + Gets the transform matrix of this item. </description> </method> <method name="get_viewport_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Get the viewport's boundaries as a [Rect2]. + Gets the viewport's boundaries as a [Rect2]. </description> </method> <method name="get_viewport_transform" qualifiers="const"> <return type="Transform2D"> </return> <description> - Get this item's transform in relation to the viewport. + Gets this item's transform in relation to the viewport. </description> </method> <method name="get_world_2d" qualifiers="const"> <return type="World2D"> </return> <description> - Get the [World2D] where this item is in. + Gets the [World2D] where this item is in. </description> </method> <method name="hide"> @@ -575,7 +575,7 @@ Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. </constant> <constant name="BLEND_MODE_DISABLED" value="5" enum="BlendMode"> - Disable blending mode. Colors including alpha are written as-is. Only applicable for render targets with a transparent background. No lighting will be applied. + Disables blending mode. Colors including alpha are written as-is. Only applicable for render targets with a transparent background. No lighting will be applied. </constant> <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="2000"> The CanvasItem's transform has changed. This notification is only received if enabled by [method set_notify_transform] or [method set_notify_local_transform]. diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index d152442b85..a9b6b9f561 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -21,7 +21,7 @@ </methods> <members> <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport"> - The custom [Viewport] node assigned to the [CanvasLayer]. If null, uses the default viewport instead. + The custom [Viewport] node assigned to the [CanvasLayer]. If [code]null[/code], uses the default viewport instead. </member> <member name="follow_viewport_enable" type="bool" setter="set_follow_viewport" getter="is_following_viewport"> </member> diff --git a/doc/classes/CanvasModulate.xml b/doc/classes/CanvasModulate.xml index c409b690e7..aa956e3f51 100644 --- a/doc/classes/CanvasModulate.xml +++ b/doc/classes/CanvasModulate.xml @@ -4,7 +4,7 @@ Tint the entire canvas. </brief_description> <description> - [CanvasModulate] tints the canvas elements using its assigned [code]color[/code]. + [CanvasModulate] tints the canvas elements using its assigned [member color]. </description> <tutorials> </tutorials> diff --git a/doc/classes/CenterContainer.xml b/doc/classes/CenterContainer.xml index 5460831ce3..e7403daa00 100644 --- a/doc/classes/CenterContainer.xml +++ b/doc/classes/CenterContainer.xml @@ -4,7 +4,7 @@ Keeps children controls centered. </brief_description> <description> - CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center. + CenterContainer keeps children controls centered. This container keeps all children to their minimum size, in the center. </description> <tutorials> </tutorials> diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index d486b5fad2..91b176bc60 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -4,7 +4,7 @@ Binary choice user interface widget. </brief_description> <description> - A checkbox allows the user to make a binary choice (choosing only one of two possible options), for example Answer 'yes' or 'no'. + A checkbox allows the user to make a binary choice (choosing only one of two possible options). </description> <tutorials> </tutorials> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index ddbe66380a..b7b77bc02a 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -15,7 +15,7 @@ <argument index="0" name="class" type="String"> </argument> <description> - Returns [code]true[/code] if you can instance objects from the specified 'class', [code]false[/code] in other case. + Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case. </description> </method> <method name="class_exists" qualifiers="const"> @@ -24,7 +24,7 @@ <argument index="0" name="class" type="String"> </argument> <description> - Returns whether the specified 'class' is available or not. + Returns whether the specified [code]class[/code] is available or not. </description> </method> <method name="class_get_category" qualifiers="const"> @@ -44,7 +44,7 @@ <argument index="1" name="name" type="String"> </argument> <description> - Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found. + Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found. </description> </method> <method name="class_get_integer_constant_list" qualifiers="const"> @@ -55,7 +55,7 @@ <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns an array with the names all the integer constants of 'class' or its ancestry. + Returns an array with the names all the integer constants of [code]class[/code] or its ancestry. </description> </method> <method name="class_get_method_list" qualifiers="const"> @@ -66,7 +66,7 @@ <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). + Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. </description> </method> <method name="class_get_property" qualifiers="const"> @@ -77,7 +77,7 @@ <argument index="1" name="property" type="String"> </argument> <description> - Returns the value of 'property' of 'class' or its ancestry. + Returns the value of [code]property[/code] of [code]class[/code] or its ancestry. </description> </method> <method name="class_get_property_list" qualifiers="const"> @@ -88,7 +88,7 @@ <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is [code]false[/code]. + Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. </description> </method> <method name="class_get_signal" qualifiers="const"> @@ -99,7 +99,7 @@ <argument index="1" name="signal" type="String"> </argument> <description> - Returns the 'signal' data of 'class' or its ancestry. The returned value is a [Dictionary] with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). + Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. </description> </method> <method name="class_get_signal_list" qualifiers="const"> @@ -110,7 +110,7 @@ <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal]. + Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal]. </description> </method> <method name="class_has_integer_constant" qualifiers="const"> @@ -121,7 +121,7 @@ <argument index="1" name="name" type="String"> </argument> <description> - Returns whether 'class' or its ancestry has an integer constant called 'name' or not. + Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not. </description> </method> <method name="class_has_method" qualifiers="const"> @@ -134,7 +134,7 @@ <argument index="2" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. + Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is false) has a method called [code]method[/code] or not. </description> </method> <method name="class_has_signal" qualifiers="const"> @@ -145,7 +145,7 @@ <argument index="1" name="signal" type="String"> </argument> <description> - Returns whether 'class' or its ancestry has a signal called 'signal' or not. + Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not. </description> </method> <method name="class_set_property" qualifiers="const"> @@ -158,7 +158,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Sets 'property' value of 'class' to 'value'. + Sets [code]property[/code] value of [code]class[/code] to [code]value[/code]. </description> </method> <method name="get_class_list" qualifiers="const"> @@ -174,7 +174,7 @@ <argument index="0" name="class" type="String"> </argument> <description> - Returns the names of all the classes that directly or indirectly inherit from 'class'. + Returns the names of all the classes that directly or indirectly inherit from [code]class[/code]. </description> </method> <method name="get_parent_class" qualifiers="const"> @@ -183,7 +183,7 @@ <argument index="0" name="class" type="String"> </argument> <description> - Returns the parent class of 'class'. + Returns the parent class of [code]class[/code]. </description> </method> <method name="instance" qualifiers="const"> @@ -192,7 +192,7 @@ <argument index="0" name="class" type="String"> </argument> <description> - Creates an instance of 'class'. + Creates an instance of [code]class[/code]. </description> </method> <method name="is_class_enabled" qualifiers="const"> @@ -212,7 +212,7 @@ <argument index="1" name="inherits" type="String"> </argument> <description> - Returns whether 'inherits' is an ancestor of 'class' or not. + Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not. </description> </method> </methods> diff --git a/doc/classes/CollisionPolygon.xml b/doc/classes/CollisionPolygon.xml index 85eb17cae7..74ff41a854 100644 --- a/doc/classes/CollisionPolygon.xml +++ b/doc/classes/CollisionPolygon.xml @@ -4,7 +4,7 @@ Editor-only class for defining a collision polygon in 3D space. </brief_description> <description> - Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a [Shape] for gameplay. Properties modified during gameplay will have no effect. + Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at run-time. Creates a [Shape] for gameplay. Properties modified during gameplay will have no effect. </description> <tutorials> </tutorials> @@ -18,7 +18,8 @@ If [code]true[/code], no collision will be produced. </member> <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> - Array of vertices which define the polygon. Note that the returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member. + Array of vertices which define the polygon. + [b]Note:[/b] The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member. </member> </members> <constants> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 30e80fa512..41b8e735c2 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -4,7 +4,7 @@ Color in RGBA format with some support for ARGB format. </brief_description> <description> - A color is represented by red, green, and blue [code](r, g, b)[/code] components. Additionally, [code]a[/code] represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some properties (such as [member CanvasItem.modulate]) may accept values > 1. + A color is represented by red, green, and blue [code](r, g, b)[/code] components. Additionally, [code]a[/code] represents the alpha component, often used for transparency. Values are in floating-point and usually range from 0 to 1. Some properties (such as [member CanvasItem.modulate]) may accept values greater than 1. You can also create a color from standardized color names by using [method @GDScript.ColorN]. </description> <tutorials> @@ -19,9 +19,9 @@ Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also [method @GDScript.ColorN]. [codeblock] # Each of the following creates the same color RGBA(178, 217, 10, 255) - var c1 = Color("#ffb2d90a") # ARGB format with '#' + var c1 = Color("#ffb2d90a") # ARGB format with "#" var c2 = Color("ffb2d90a") # ARGB format - var c3 = Color("#b2d90a") # RGB format with '#' + var c3 = Color("#b2d90a") # RGB format with "#" var c4 = Color("b2d90a") # RGB format [/codeblock] </description> @@ -136,7 +136,7 @@ The gray value is calculated as [code](r + g + b) / 3[/code]. [codeblock] var c = Color(0.2, 0.45, 0.82) - var gray = c.gray() # a value of 0.466667 + var gray = c.gray() # A value of 0.466667 [/codeblock] </description> </method> @@ -147,7 +147,7 @@ Returns the inverted color [code](1 - r, 1 - g, 1 - b, a)[/code]. [codeblock] var c = Color(0.3, 0.4, 0.9) - var inverted_color = c.inverted() # a color of an RGBA(178, 153, 26, 255) + var inverted_color = c.inverted() # A color of an RGBA(178, 153, 26, 255) [/codeblock] </description> </method> @@ -176,7 +176,7 @@ [codeblock] var c1 = Color(1.0, 0.0, 0.0) var c2 = Color(0.0, 1.0, 0.0) - var li_c = c1.linear_interpolate(c2, 0.5) # a color of an RGBA(128, 128, 0, 255) + var li_c = c1.linear_interpolate(c2, 0.5) # A color of an RGBA(128, 128, 0, 255) [/codeblock] </description> </method> @@ -234,8 +234,8 @@ Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string. [codeblock] var c = Color(1, 1, 1, 0.5) - var s1 = c.to_html() # Results "7fffffff" - var s2 = c.to_html(false) # Results 'ffffff' + var s1 = c.to_html() # Returns "7fffffff" + var s2 = c.to_html(false) # Returns "ffffff" [/codeblock] </description> </method> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index 0ab91e9621..08ddfd5770 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -15,7 +15,8 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for [i]this[/i] color picker. + Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. + [b]Note:[/b] the presets list is only for [i]this[/i] color picker. </description> </method> <method name="erase_preset"> @@ -24,7 +25,7 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Remove the given color from the list of color presets of this color picker. + Removes the given color from the list of color presets of this color picker. </description> </method> <method name="get_presets" qualifiers="const"> @@ -46,7 +47,7 @@ If [code]true[/code], shows an alpha channel slider (transparency). </member> <member name="hsv_mode" type="bool" setter="set_hsv_mode" getter="is_hsv_mode"> - If [code]true[/code], allows to edit color with Hue/Saturation/Value sliders. + If [code]true[/code], allows editing the color with Hue/Saturation/Value sliders. [b]Note:[/b] Cannot be enabled if raw mode is on. </member> <member name="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled"> @@ -55,7 +56,7 @@ </member> <member name="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode"> If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). - [b]Note:[/b] Cannot be enabled if hsv mode is on. + [b]Note:[/b] Cannot be enabled if HSV mode is on. </member> </members> <signals> diff --git a/doc/classes/ConcavePolygonShape.xml b/doc/classes/ConcavePolygonShape.xml index 62d42f4eb4..a09b5005b9 100644 --- a/doc/classes/ConcavePolygonShape.xml +++ b/doc/classes/ConcavePolygonShape.xml @@ -22,7 +22,7 @@ <argument index="0" name="faces" type="PoolVector3Array"> </argument> <description> - Set the faces (an array of triangles). + Sets the faces (an array of triangles). </description> </method> </methods> diff --git a/doc/classes/ConcavePolygonShape2D.xml b/doc/classes/ConcavePolygonShape2D.xml index 5414fe42c5..a4d91991cf 100644 --- a/doc/classes/ConcavePolygonShape2D.xml +++ b/doc/classes/ConcavePolygonShape2D.xml @@ -4,7 +4,7 @@ Concave polygon 2D shape resource for physics. </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. + Concave polygon 2D shape resource for physics. It is made out of segments and is optimal for complex polygonal concave collisions. However, it is 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. </description> <tutorials> diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index 28dee22b7f..c268e66abd 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -5,7 +5,7 @@ </brief_description> <description> The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint]. - The twist axis is initiated as the x-axis of the [Joint]. + The twist axis is initiated as the X axis of the [Joint]. Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies. </description> <tutorials> diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index b65f3c5609..5b8f0c32d1 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -16,7 +16,7 @@ [codeblock] var config = ConfigFile.new() var err = config.load("user://settings.cfg") - if err == OK: # if not, something went wrong with the file loading + if err == OK: # If not, something went wrong with the file loading # Look for the display/width pair, and default to 1024 if missing var screen_width = config.get_value("display", "width", 1024) # Store a variable if and only if it hasn't been defined yet diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index d2c6b02e6e..a99c29def2 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -4,12 +4,12 @@ All User Interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent. </brief_description> <description> - Base class for all User Interface or [i]UI[/i] related nodes. [Control] features a bounding rectangle that defines its extents, an anchor position relative to its parent control or the current viewport, and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change. + Base class for all UI-related nodes. [Control] features a bounding rectangle that defines its extents, an anchor position relative to its parent control or the current viewport, and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change. For more information on Godot's UI system, anchors, margins, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from [Control] and [Container] nodes. [b]User Interface nodes and input[/b] Godot sends input events to the scene's root node first, by calling [method Node._input]. [method Node._input] forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls [method MainLoop._input_event]. Call [method accept_event] so no other node receives the event. Once you accepted an input, it becomes handled so [method Node._unhandled_input] will not process it. Only one [Control] node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the focus, call [method grab_focus]. [Control] nodes lose focus when another node grabs it, or if you hide the node in focus. - Set [member mouse_filter] to [constant MOUSE_FILTER_IGNORE] to tell a [Control] node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. + Sets [member mouse_filter] to [constant MOUSE_FILTER_IGNORE] to tell a [Control] node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. [Theme] resources change the Control's appearance. If you change the [Theme] on a [Control] node, it affects all of its children. To override some of the theme's parameters, call one of the [code]add_*_override[/code] methods, like [method add_font_override]. You can override the theme with the inspector. </description> <tutorials> @@ -135,9 +135,9 @@ extends Control func can_drop_data(position, data): - # check position if it is relevant to you - # otherwise just check data - return typeof(data) == TYPE_DICTIONARY and data.has('expected') + # Check position if it is relevant to you + # Otherwise, just check data + return typeof(data) == TYPE_DICTIONARY and data.has("expected") [/codeblock] </description> </method> @@ -154,10 +154,10 @@ extends ColorRect func can_drop_data(position, data): - return typeof(data) == TYPE_DICTIONARY and data.has('color') + return typeof(data) == TYPE_DICTIONARY and data.has("color") func drop_data(position, data): - color = data['color'] + color = data["color"] [/codeblock] </description> </method> @@ -221,7 +221,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns null if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. + Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. [codeblock] extends Control @@ -862,16 +862,16 @@ Show the system's forbidden mouse cursor when the user hovers the node. Often a crossed circle. </constant> <constant name="CURSOR_VSIZE" value="9" enum="CursorShape"> - Show the system's vertical resize mouse cursor when the user hovers the node. A double headed vertical arrow. It tells the user they can resize the window or the panel vertically. + Show the system's vertical resize mouse cursor when the user hovers the node. A double-headed vertical arrow. It tells the user they can resize the window or the panel vertically. </constant> <constant name="CURSOR_HSIZE" value="10" enum="CursorShape"> - Show the system's horizontal resize mouse cursor when the user hovers the node. A double headed horizontal arrow. It tells the user they can resize the window or the panel horizontally. + Show the system's horizontal resize mouse cursor when the user hovers the node. A double-headed horizontal arrow. It tells the user they can resize the window or the panel horizontally. </constant> <constant name="CURSOR_BDIAGSIZE" value="11" enum="CursorShape"> - Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically. + Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double-headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically. </constant> <constant name="CURSOR_FDIAGSIZE" value="12" enum="CursorShape"> - Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double headed arrow that goes from the top left to the bottom right, the opposite of [constant CURSOR_BDIAGSIZE]. It tells the user they can resize the window or the panel both horizontally and vertically. + Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double-headed arrow that goes from the top left to the bottom right, the opposite of [constant CURSOR_BDIAGSIZE]. It tells the user they can resize the window or the panel both horizontally and vertically. </constant> <constant name="CURSOR_MOVE" value="13" enum="CursorShape"> Show the system's move mouse cursor when the user hovers the node. It shows 2 double-headed arrows at a 90 degree angle. It tells the user they can move a UI element freely. @@ -931,7 +931,7 @@ Snap all 4 anchors to a horizontal line that cuts the parent control in half. Use with [method set_anchors_preset]. </constant> <constant name="PRESET_WIDE" value="15" enum="LayoutPreset"> - Snap all 4 anchors to the respective corners of the parent control. Set all 4 margins to 0 after you applied this preset and the [Control] will fit its parent control. This is equivalent to to the "Full Rect" layout option in the editor. Use with [method set_anchors_preset]. + Snap all 4 anchors to the respective corners of the parent control. Set all 4 margins to 0 after you applied this preset and the [Control] will fit its parent control. This is equivalent to the "Full Rect" layout option in the editor. Use with [method set_anchors_preset]. </constant> <constant name="PRESET_MODE_MINSIZE" value="0" enum="LayoutPresetMode"> </constant> @@ -957,13 +957,13 @@ Tells the parent [Container] to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical]. </constant> <constant name="MOUSE_FILTER_STOP" value="0" enum="MouseFilter"> - The control will receive mouse button input events through [method _gui_input] if clicked on. And the control will receive the [signal mouse_entered] and [signal mouse_exited] signals. These events are automatically marked as handled and they will not propagate further to other controls. This also results in blocking signals in other controls. + The control will receive mouse button input events through [method _gui_input] if clicked on. And the control will receive the [signal mouse_entered] and [signal mouse_exited] signals. These events are automatically marked as handled, and they will not propagate further to other controls. This also results in blocking signals in other controls. </constant> <constant name="MOUSE_FILTER_PASS" value="1" enum="MouseFilter"> The control will receive mouse button input events through [method _gui_input] if clicked on. And the control will receive the [signal mouse_entered] and [signal mouse_exited] signals. If this control does not handle the event, the parent control (if any) will be considered, and so on until there is no more parent control to potentially handle it. This also allows signals to fire in other controls. Even if no control handled it at all, the event will still be handled automatically, so unhandled input will not be fired. </constant> <constant name="MOUSE_FILTER_IGNORE" value="2" enum="MouseFilter"> - The control will not receive mouse button input events through [method _gui_input]. Also the control will not receive the [signal mouse_entered] nor [signal mouse_exited] signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically. + The control will not receive mouse button input events through [method _gui_input]. The control will also not receive the [signal mouse_entered] nor [signal mouse_exited] signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically. </constant> <constant name="GROW_DIRECTION_BEGIN" value="0" enum="GrowDirection"> The control will grow to the left or top to make up if its minimum size is changed to be greater than its current size on the respective axis. diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index 7add252481..fc21cb2ba9 100644 --- a/doc/classes/ConvexPolygonShape2D.xml +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core" version="3.2"> <brief_description> - Convex Polygon Shape for 2D physics. + Convex polygon shape for 2D physics. </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). + 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. </description> <tutorials> diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index f5d2823115..21329628a0 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CubeMap" inherits="Resource" category="Core" version="3.2"> <brief_description> - A CubeMap is a 6 sided 3D texture. + A CubeMap is a 6-sided 3D texture. </brief_description> <description> A 6-sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods. diff --git a/doc/classes/CubeMesh.xml b/doc/classes/CubeMesh.xml index 6162474ed1..d60bea3015 100644 --- a/doc/classes/CubeMesh.xml +++ b/doc/classes/CubeMesh.xml @@ -16,13 +16,13 @@ Size of the cuboid mesh. Defaults to (2, 2, 2). </member> <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth"> - Number of extra edge loops inserted along the z-axis. Defaults to 0. + Number of extra edge loops inserted along the Z axis. Defaults to 0. </member> <member name="subdivide_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height"> - Number of extra edge loops inserted along the y-axis. Defaults to 0. + Number of extra edge loops inserted along the Y axis. Defaults to 0. </member> <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width"> - Number of extra edge loops inserted along the x-axis. Defaults to 0. + Number of extra edge loops inserted along the X axis. Defaults to 0. </member> </members> <constants> diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index f7af2c159f..cc721b674b 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -4,7 +4,7 @@ A mathematic curve. </brief_description> <description> - A curve that can be saved and re-used for other objects. By default it ranges between [code]0[/code] and [code]1[/code] on the y-axis and positions points relative to the [code]0.5[/code] y-position. + A curve that can be saved and re-used for other objects. By default, it ranges between [code]0[/code] and [code]1[/code] on the Y axis and positions points relative to the [code]0.5[/code] Y position. </description> <tutorials> </tutorials> @@ -60,7 +60,7 @@ <argument index="0" name="index" type="int"> </argument> <description> - Returns the left [code]TangentMode[/code] for the point at [code]index[/code]. + Returns the left [enum TangentMode] for the point at [code]index[/code]. </description> </method> <method name="get_point_left_tangent" qualifiers="const"> @@ -87,7 +87,7 @@ <argument index="0" name="index" type="int"> </argument> <description> - Returns the right [code]TangentMode[/code] for the point at [code]index[/code]. + Returns the right [enum TangentMode] for the point at [code]index[/code]. </description> </method> <method name="get_point_right_tangent" qualifiers="const"> @@ -105,7 +105,7 @@ <argument index="0" name="offset" type="float"> </argument> <description> - Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve. + Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve. </description> </method> <method name="interpolate_baked"> @@ -114,7 +114,7 @@ <argument index="0" name="offset" type="float"> </argument> <description> - Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked. + Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked. </description> </method> <method name="remove_point"> @@ -134,7 +134,7 @@ <argument index="1" name="mode" type="int" enum="Curve.TangentMode"> </argument> <description> - Sets the left [code]TangentMode[/code] for the point at [code]index[/code] to [code]mode[/code]. + Sets the left [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. </description> </method> <method name="set_point_left_tangent"> @@ -156,7 +156,7 @@ <argument index="1" name="offset" type="float"> </argument> <description> - Sets the offset from [code]0.5[/code] + Sets the offset from [code]0.5[/code]. </description> </method> <method name="set_point_right_mode"> @@ -167,7 +167,7 @@ <argument index="1" name="mode" type="int" enum="Curve.TangentMode"> </argument> <description> - Sets the right [code]TangentMode[/code] for the point at [code]index[/code] to [code]mode[/code]. + Sets the right [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. </description> </method> <method name="set_point_right_tangent"> diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 3631711a8f..995010c247 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Curve2D" inherits="Resource" category="Core" version="3.2"> <brief_description> - Describes a Bezier curve in 2D space. + Describes a Bézier curve in 2D space. </brief_description> <description> - This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a [Path2D], but can be manually sampled for other purposes. - It keeps a cache of precalculated points along the curve, to speed further calculations up. + This class describes a Bézier curve in 2D space. It is mainly used to give a shape to a [Path2D], but can be manually sampled for other purposes. + It keeps a cache of precalculated points along the curve, to speed up further calculations. </description> <tutorials> </tutorials> @@ -22,7 +22,7 @@ <argument index="3" name="at_position" type="int" default="-1"> </argument> <description> - Adds a point to a curve, at [code]position[/code], with control points [code]in[/code] and [code]out[/code]. + Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code]. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. </description> </method> diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 2966e2f8c0..190655153a 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Curve3D" inherits="Resource" category="Core" version="3.2"> <brief_description> - Describes a Bezier curve in 3D space. + Describes a Bézier curve in 3D space. </brief_description> <description> - This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a [Path], but can be manually sampled for other purposes. - It keeps a cache of precalculated points along the curve, to speed further calculations up. + This class describes a Bézier curve in 3D space. It is mainly used to give a shape to a [Path], but can be manually sampled for other purposes. + It keeps a cache of precalculated points along the curve, to speed up further calculations. </description> <tutorials> </tutorials> @@ -22,7 +22,7 @@ <argument index="3" name="at_position" type="int" default="-1"> </argument> <description> - Adds a point to a curve, at [code]position[/code], with control points [code]in[/code] and [code]out[/code]. + Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code]. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. </description> </method> diff --git a/doc/classes/DampedSpringJoint2D.xml b/doc/classes/DampedSpringJoint2D.xml index d6973848e2..cfcf2d20e2 100644 --- a/doc/classes/DampedSpringJoint2D.xml +++ b/doc/classes/DampedSpringJoint2D.xml @@ -12,16 +12,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] + 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] + 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] + 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] + 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 ec70fd311b..831a0bb02f 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -47,7 +47,7 @@ <argument index="0" name="key" type="Variant"> </argument> <description> - Erase a dictionary key/value pair by key. Returns [code]true[/code] if the given key was present in the dictionary, [code]false[/code] otherwise. Do not erase elements while iterating over the dictionary. + Erase a dictionary key/value pair by key. Returns [code]true[/code] if the given key was present in the dictionary, [code]false[/code] otherwise. Does not erase elements while iterating over the dictionary. </description> </method> <method name="get"> @@ -58,7 +58,7 @@ <argument index="1" name="default" type="Variant" default="Null"> </argument> <description> - Returns the current value for the specified key in the [Dictionary]. If the key does not exist, the method returns the value of the optional default argument, or Null if it is omitted. + Returns the current value for the specified key in the [Dictionary]. If the key does not exist, the method returns the value of the optional default argument, or [code]null[/code] if it is omitted. </description> </method> <method name="has"> diff --git a/doc/classes/DirectionalLight.xml b/doc/classes/DirectionalLight.xml index c6650a1641..eb02504398 100644 --- a/doc/classes/DirectionalLight.xml +++ b/doc/classes/DirectionalLight.xml @@ -4,7 +4,7 @@ Directional light from a distance, as from the Sun. </brief_description> <description> - A directional light is a type of [Light] node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used do determine light direction. + A directional light is a type of [Light] node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used to determine light direction. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link> @@ -13,10 +13,10 @@ </methods> <members> <member name="directional_shadow_bias_split_scale" type="float" setter="set_param" getter="get_param"> - Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them. + Amount of extra bias for shadow splits that are far away. If self-shadowing occurs only on the splits far away, increasing this value can fix them. </member> <member name="directional_shadow_blend_splits" type="bool" setter="set_blend_splits" getter="is_blend_splits_enabled"> - If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:[code]false[/code]. + If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits. Default value: [code]false[/code]. </member> <member name="directional_shadow_depth_range" type="int" setter="set_shadow_depth_range" getter="get_shadow_depth_range" enum="DirectionalLight.ShadowDepthRange"> Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange]. @@ -31,10 +31,10 @@ Can be used to fix special cases of self shadowing when objects are perpendicular to the light. </member> <member name="directional_shadow_split_1" type="float" setter="set_param" getter="get_param"> - The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is one of the [code]SHADOW_PARALLEL_*_SPLITS[/code] constants. + The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_2_SPLITS[/code] or [code]SHADOW_PARALLEL_4_SPLITS[/code]. </member> <member name="directional_shadow_split_2" type="float" setter="set_param" getter="get_param"> - The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_3_SPLITS[/code] or [code]SHADOW_PARALLEL_4_SPLITS[/code]. + The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_2_SPLITS[/code] or [code]SHADOW_PARALLEL_4_SPLITS[/code]. </member> <member name="directional_shadow_split_3" type="float" setter="set_param" getter="get_param"> The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_4_SPLITS[/code]. diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index 9c33b4fc0e..9294a515d2 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -32,8 +32,8 @@ <argument index="0" name="todir" type="String"> </argument> <description> - Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]). - The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*). + Changes the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]). + The method returns one of the error code constants defined in [@GlobalScope] ([code]OK[/code] or [code]ERR_*[/code]). </description> </method> <method name="copy"> @@ -44,8 +44,8 @@ <argument index="1" name="to" type="String"> </argument> <description> - Copy the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. - Returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). + Copies the [code]from[/code] file to the [code]to[/code] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. + Returns one of the error code constants defined in [@GlobalScope] ([code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code]). </description> </method> <method name="current_is_dir" qualifiers="const"> @@ -93,14 +93,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - On Windows, return the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On other platforms, or if the requested drive does not existed, the method returns an empty String. + On Windows, returns the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On other platforms, or if the requested drive does not existed, the method returns an empty String. </description> </method> <method name="get_drive_count"> <return type="int"> </return> <description> - On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. + On Windows, returns the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. </description> </method> <method name="get_next"> @@ -115,7 +115,7 @@ <return type="int"> </return> <description> - On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1. + On UNIX desktop systems, returns the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1. </description> </method> <method name="list_dir_begin"> @@ -126,7 +126,7 @@ <argument index="1" name="skip_hidden" type="bool" default="false"> </argument> <description> - Initialize the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. + Initializes the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. If you pass [code]skip_navigational[/code], then [code].[/code] and [code]..[/code] would be filtered out. If you pass [code]skip_hidden[/code], then hidden files would be filtered out. </description> @@ -135,7 +135,7 @@ <return type="void"> </return> <description> - Close the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] or not does not matter). + Closes the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] or not does not matter). </description> </method> <method name="make_dir"> @@ -144,8 +144,8 @@ <argument index="0" name="path" type="String"> </argument> <description> - Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]). - The method returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). + Creates a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]). + The method returns one of the error code constants defined in [@GlobalScope] ([code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code]). </description> </method> <method name="make_dir_recursive"> @@ -154,8 +154,8 @@ <argument index="0" name="path" type="String"> </argument> <description> - Create a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. - Returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). + Creates a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. + Returns one of the error code constants defined in [@GlobalScope] ([code]0K[/code], [code]FAILED[/code] or [code]ERR_*[/code]). </description> </method> <method name="open"> @@ -164,8 +164,8 @@ <argument index="0" name="path" type="String"> </argument> <description> - Open an existing directory of the filesystem. The [i]path[/i] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]). - The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*). + Opens an existing directory of the filesystem. The [code]path[/code] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]). + The method returns one of the error code constants defined in [@GlobalScope] ([code]OK[/code] or [code]ERR_*[/code]). </description> </method> <method name="remove"> @@ -174,8 +174,8 @@ <argument index="0" name="path" type="String"> </argument> <description> - Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. - Returns one of the error code constants defined in [@GlobalScope] (OK or FAILED). + Deletes the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. + Returns one of the error code constants defined in [@GlobalScope] ([code]OK[/code] or [code]FAILED[/code]). </description> </method> <method name="rename"> @@ -186,8 +186,8 @@ <argument index="1" name="to" type="String"> </argument> <description> - Rename (move) the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. - Returns one of the error code constants defined in [@GlobalScope] (OK or FAILED). + Renames (move) the [code]from[/code] file to the [code]to[/code] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. + Returns one of the error code constants defined in [@GlobalScope] ([code]OK[/code] or [code]FAILED[/code]). </description> </method> </methods> diff --git a/doc/classes/DynamicFontData.xml b/doc/classes/DynamicFontData.xml index 8eff5fb993..afdd09055c 100644 --- a/doc/classes/DynamicFontData.xml +++ b/doc/classes/DynamicFontData.xml @@ -23,7 +23,7 @@ </members> <constants> <constant name="HINTING_NONE" value="0" enum="Hinting"> - Disable font hinting (smoother but less crisp). + Disables font hinting (smoother but less crisp). </constant> <constant name="HINTING_LIGHT" value="1" enum="Hinting"> Use the light font hinting mode. diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 15271b8050..1d648db20d 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -14,7 +14,7 @@ </argument> <description> Adds a comma-delimited file extension filter option to the [EditorFileDialog] with an optional semi-colon-delimited label. - Example: "*.tscn, *.scn; Scenes", results in filter text "Scenes (*.tscn, *.scn)". + For example, [code]"*.tscn, *.scn; Scenes"[/code] results in filter text "Scenes (*.tscn, *.scn)". </description> </method> <method name="clear_filters"> @@ -59,7 +59,7 @@ The view format in which the [EditorFileDialog] displays resources to the user. </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="EditorFileDialog.Mode"> - The purpose of the [EditorFileDialog]. Changes allowed behaviors. + The purpose of the [EditorFileDialog], which defines the allowed behaviors. </member> <member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files"> If [code]true[/code], hidden files and directories will be visible in the [EditorFileDialog]. diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index 1c7a68fc0b..798658c8d0 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -15,14 +15,14 @@ <argument index="0" name="path" type="String"> </argument> <description> - Get the type of the file, given the full path. + Gets the type of the file, given the full path. </description> </method> <method name="get_filesystem"> <return type="EditorFileSystemDirectory"> </return> <description> - Get the root directory object. + Gets the root directory object. </description> </method> <method name="get_filesystem_path"> diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index c7920c6ed6..cb2ed28b38 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -97,7 +97,7 @@ <return type="EditorFileSystemDirectory"> </return> <description> - Returns the parent directory for this directory or null if called on a directory at [code]res://[/code] or [code]user://[/code]. + Returns the parent directory for this directory or [code]null[/code] if called on a directory at [code]res://[/code] or [code]user://[/code]. </description> </method> <method name="get_path" qualifiers="const"> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index e66596412b..af804f88b5 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -5,7 +5,7 @@ </brief_description> <description> EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your [EditorPlugin] with [method EditorPlugin.add_import_plugin]. - EditorImportPlugins work by associating with specific file extensions and a resource type. See [method get_recognized_extensions] and [method get_resource_type]). They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the [code].import[/code] directory. + EditorImportPlugins work by associating with specific file extensions and a resource type. See [method get_recognized_extensions] and [method get_resource_type]. They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the [code].import[/code] directory. Below is an example EditorImportPlugin that imports a [Mesh] from a file with the extension ".special" or ".spec": [codeblock] tool @@ -41,7 +41,7 @@ return FAILED var mesh = Mesh.new() - # Fill the Mesh with data read in 'file', left as exercise to the reader + # Fill the Mesh with data read in "file", left as an exercise to the reader var filename = save_path + "." + get_save_extension() ResourceSaver.save(filename, mesh) @@ -58,21 +58,21 @@ <argument index="0" name="preset" type="int"> </argument> <description> - Get the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional). + Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional). </description> </method> <method name="get_import_order" qualifiers="virtual"> <return type="int"> </return> <description> - Get the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. + Gets the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. </description> </method> <method name="get_importer_name" qualifiers="virtual"> <return type="String"> </return> <description> - Get the unique name of the importer. + Gets the unique name of the importer. </description> </method> <method name="get_option_visibility" qualifiers="virtual"> @@ -89,7 +89,7 @@ <return type="int"> </return> <description> - Get the number of initial presets defined by the plugin. Use [method get_import_options] to get the default options for the preset and [method get_preset_name] to get the name of the preset. + Gets the number of initial presets defined by the plugin. Use [method get_import_options] to get the default options for the preset and [method get_preset_name] to get the name of the preset. </description> </method> <method name="get_preset_name" qualifiers="virtual"> @@ -98,42 +98,42 @@ <argument index="0" name="preset" type="int"> </argument> <description> - Get the name of the options preset at this index. + Gets the name of the options preset at this index. </description> </method> <method name="get_priority" qualifiers="virtual"> <return type="float"> </return> <description> - Get the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. + Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. </description> </method> <method name="get_recognized_extensions" qualifiers="virtual"> <return type="Array"> </return> <description> - Get the list of file extensions to associate with this loader (case insensitive). e.g. [code]["obj"][/code]. + Gets the list of file extensions to associate with this loader (case-insensitive). e.g. [code]["obj"][/code]. </description> </method> <method name="get_resource_type" qualifiers="virtual"> <return type="String"> </return> <description> - Get the Godot resource type associated with this loader. e.g. [code]"Mesh"[/code] or [code]"Animation"[/code]. + Gets the Godot resource type associated with this loader. e.g. [code]"Mesh"[/code] or [code]"Animation"[/code]. </description> </method> <method name="get_save_extension" qualifiers="virtual"> <return type="String"> </return> <description> - Get the extension used to save this resource in the [code].import[/code] directory. + Gets the extension used to save this resource in the [code].import[/code] directory. </description> </method> <method name="get_visible_name" qualifiers="virtual"> <return type="String"> </return> <description> - Get the name to display in the import window. + Gets the name to display in the import window. </description> </method> <method name="import" qualifiers="virtual"> diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index c2b13ff89e..cab5af3985 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -21,7 +21,7 @@ <argument index="0" name="control" type="Control"> </argument> <description> - Add a custom control, not necessarily a property editor. + Adds a custom control, not necessarily a property editor. </description> </method> <method name="add_property_editor"> @@ -32,7 +32,7 @@ <argument index="1" name="editor" type="Control"> </argument> <description> - Add a property editor, this must inherit [EditorProperty]. + Adds a property editor, this must inherit [EditorProperty]. </description> </method> <method name="add_property_editor_for_multiple_properties"> @@ -45,7 +45,7 @@ <argument index="2" name="editor" type="Control"> </argument> <description> - Add am editor that allows modifying multiple properties, this must inherit [EditorProperty]. + Adds an editor that allows modifying multiple properties, this must inherit [EditorProperty]. </description> </method> <method name="can_handle" qualifiers="virtual"> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index ecbb5da10c..6f07682b04 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -146,7 +146,7 @@ <return type="int" enum="Error"> </return> <description> - Saves the scene. Returns either OK or ERR_CANT_CREATE. See [@GlobalScope] constants. + Saves the scene. Returns either [code]OK[/code] or [code]ERR_CANT_CREATE[/code] (see [@GlobalScope] constants). </description> </method> <method name="save_scene_as"> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 36d6e38be9..bd9a100267 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -4,7 +4,7 @@ Used by the editor to extend its functionality. </brief_description> <description> - Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. Also see [EditorScript] to add functions to the editor. + Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. See also [EditorScript] to add functions to the editor. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/plugins/editor/index.html</link> @@ -18,7 +18,7 @@ <argument index="1" name="path" type="String"> </argument> <description> - Add a script at [code]path[/code] to the Autoload list as [code]name[/code]. + Adds a script at [code]path[/code] to the Autoload list as [code]name[/code]. </description> </method> <method name="add_control_to_bottom_panel"> @@ -29,7 +29,7 @@ <argument index="1" name="title" type="String"> </argument> <description> - Add a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [code]queue_free()[/code]. + Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [code]queue_free()[/code]. </description> </method> <method name="add_control_to_container"> @@ -40,7 +40,7 @@ <argument index="1" name="control" type="Control"> </argument> <description> - Add a custom control to a container (see CONTAINER_* enum). There are many locations where custom controls can be added in the editor UI. + Adds a custom control to a container (see [code]CONTAINER_*[/code] enum). There are many locations where custom controls can be added in the editor UI. Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_container] and free it with [code]queue_free()[/code]. </description> @@ -53,7 +53,7 @@ <argument index="1" name="control" type="Control"> </argument> <description> - Add the control to a specific dock slot (see DOCK_* enum for options). + Adds the control to a specific dock slot (see [code]DOCK_*[/code] enum for options). If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_docks] and free it with [code]queue_free()[/code]. </description> @@ -70,9 +70,9 @@ <argument index="3" name="icon" type="Texture"> </argument> <description> - Add a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. + Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. When given node or resource is selected, the base type will be instanced (ie, "Spatial", "Control", "Resource"), then the script will be loaded and set to this object. - You can use the virtual method [method handles] to check if your custom object is being edited by checking the script or using 'is' keyword. + You can use the virtual method [method handles] to check if your custom object is being edited by checking the script or using the [code]is[/code] keyword. During run-time, this will be a simple object with a script so this function does not need to be called then. </description> </method> @@ -128,7 +128,7 @@ <argument index="3" name="ud" type="Variant" default="null"> </argument> <description> - Add a custom menu to 'Project > Tools' as [code]name[/code] that calls [code]callback[/code] on an instance of [code]handler[/code] with a parameter [code]ud[/code] when user activates it. + Adds a custom menu to [b]Project > Tools[/b] as [code]name[/code] that calls [code]callback[/code] on an instance of [code]handler[/code] with a parameter [code]ud[/code] when user activates it. </description> </method> <method name="add_tool_submenu_item"> @@ -234,7 +234,7 @@ <return type="PoolStringArray"> </return> <description> - This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25 + This is for editors that edit script-based objects. You can return a list of breakpoints in the format ([code]script:line[/code]), for example: [code]res://path_to_script.gd:25[/code]. </description> </method> <method name="get_editor_interface"> @@ -260,21 +260,22 @@ <return type="ScriptCreateDialog"> </return> <description> - Gets the Editor's dialogue used for making scripts. Note that users can configure it before use. + Gets the Editor's dialogue used for making scripts. + [b]Note:[/b] Users can configure it before use. </description> </method> <method name="get_state" qualifiers="virtual"> <return type="Dictionary"> </return> <description> - Get the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). + Gets the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). </description> </method> <method name="get_undo_redo"> <return type="UndoRedo"> </return> <description> - Get the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. + Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. </description> </method> <method name="get_window_layout" qualifiers="virtual"> @@ -283,7 +284,7 @@ <argument index="0" name="layout" type="ConfigFile"> </argument> <description> - Get the GUI layout of the plugin. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock). + Gets the GUI layout of the plugin. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock). </description> </method> <method name="handles" qualifiers="virtual"> @@ -299,7 +300,7 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). + Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspace selector together with [b]2D[/b], [b]3D[/b], [b]Script[/b] and [b]AssetLib[/b]). </description> </method> <method name="hide_bottom_panel"> @@ -339,7 +340,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Remove an Autoload [code]name[/code] from the list. + Removes an Autoload [code]name[/code] from the list. </description> </method> <method name="remove_control_from_bottom_panel"> @@ -348,7 +349,7 @@ <argument index="0" name="control" type="Control"> </argument> <description> - Remove the control from the bottom panel. You have to manually [code]queue_free()[/code] the control. + Removes the control from the bottom panel. You have to manually [code]queue_free()[/code] the control. </description> </method> <method name="remove_control_from_container"> @@ -359,7 +360,7 @@ <argument index="1" name="control" type="Control"> </argument> <description> - Remove the control from the specified container. You have to manually [code]queue_free()[/code] the control. + Removes the control from the specified container. You have to manually [code]queue_free()[/code] the control. </description> </method> <method name="remove_control_from_docks"> @@ -368,7 +369,7 @@ <argument index="0" name="control" type="Control"> </argument> <description> - Remove the control from the dock. You have to manually [code]queue_free()[/code] the control. + Removes the control from the dock. You have to manually [code]queue_free()[/code] the control. </description> </method> <method name="remove_custom_type"> @@ -377,7 +378,7 @@ <argument index="0" name="type" type="String"> </argument> <description> - Remove a custom type added by [method add_custom_type] + Removes a custom type added by [method add_custom_type]. </description> </method> <method name="remove_export_plugin"> @@ -426,7 +427,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Removes a menu [code]name[/code] from 'Project > Tools'. + Removes a menu [code]name[/code] from [b]Project > Tools[/b]. </description> </method> <method name="save_external_data" qualifiers="virtual"> @@ -480,7 +481,7 @@ <argument index="0" name="screen_name" type="String"> </argument> <description> - Emitted when user changes the workspace (2D, 3D, Script, AssetLib). Also works with custom screens defined by plugins. + Emitted when user changes the workspace ([b]2D[/b], [b]3D[/b], [b]Script[/b], [b]AssetLib[/b]). Also works with custom screens defined by plugins. </description> </signal> <signal name="resource_saved"> @@ -493,7 +494,7 @@ <argument index="0" name="scene_root" type="Node"> </argument> <description> - Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be null. + Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be [code]null[/code]. </description> </signal> <signal name="scene_closed"> diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 735c270279..35c4e645a8 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorProperty" inherits="Container" category="Core" version="3.2"> <brief_description> - Custom control to edit properties for adding into the inspector + Custom control to edit properties for adding into the inspector. </brief_description> <description> This control allows property editing for one or multiple properties into [EditorInspector]. It is added via [EditorInspectorPlugin]. @@ -30,21 +30,21 @@ <argument index="3" name="changing" type="bool" default="false"> </argument> <description> - If one (or many properties) changed, this must be called. "Field" is used in case your editor can modify fields separately (as an example, Vector3.x). The "changing" argument avoids the editor requesting this property to be refreshed (leave as false if unsure). + If one or several properties have changed, this must be called. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure). </description> </method> <method name="get_edited_object"> <return type="Object"> </return> <description> - Get the edited object. + Gets the edited object. </description> </method> <method name="get_edited_property"> <return type="String"> </return> <description> - Get the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return it.. + Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return the property. </description> </method> <method name="get_tooltip_text" qualifiers="const"> @@ -60,7 +60,7 @@ <argument index="0" name="editor" type="Control"> </argument> <description> - Add controls with this function if you want them on the bottom (below the label). + Adds controls with this function if you want them on the bottom (below the label). </description> </method> <method name="update_property" qualifiers="virtual"> @@ -82,10 +82,10 @@ Used by the inspector, when the property must draw with error color. </member> <member name="keying" type="bool" setter="set_keying" getter="is_keying"> - Used by the inspector, when the property can add keys for animation/ + Used by the inspector, when the property can add keys for animation. </member> <member name="label" type="String" setter="set_label" getter="get_label"> - Set this property to change the label (if you want to show one) + Sets this property to change the label (if you want to show one). </member> <member name="read_only" type="bool" setter="set_read_only" getter="is_read_only"> Used by the inspector, when the property is read-only. @@ -98,7 +98,7 @@ <argument index="1" name="value" type="Array"> </argument> <description> - Emit yourself if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin.parse_property] + Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin.parse_property]. </description> </signal> <signal name="object_id_selected"> @@ -107,7 +107,7 @@ <argument index="1" name="id" type="int"> </argument> <description> - Used by sub-inspectors. Emit if what was selected was an Object ID. + Used by sub-inspectors. Emit it if what was selected was an Object ID. </description> </signal> <signal name="property_changed"> @@ -125,14 +125,14 @@ <argument index="1" name="bool" type="String"> </argument> <description> - Used internally, when a property was checked. + Emitted when a property was checked. Used internally. </description> </signal> <signal name="property_keyed"> <argument index="0" name="property" type="String"> </argument> <description> - Emit if you want to add this value as an animation key (check keying being enabled first). + Emit it if you want to add this value as an animation key (check for keying being enabled first). </description> </signal> <signal name="property_keyed_with_value"> @@ -141,7 +141,7 @@ <argument index="1" name="value" type="Nil"> </argument> <description> - Emit if you want to key a property with a single value. + Emit it if you want to key a property with a single value. </description> </signal> <signal name="resource_selected"> @@ -159,7 +159,7 @@ <argument index="1" name="focusable_idx" type="int"> </argument> <description> - Internal, used when selected. + Emitted when selected. Used internally. </description> </signal> </signals> diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index 8de905e710..9d3f4b0b12 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -24,7 +24,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Check if the resource changed, if so it will be invalidated and the corresponding signal emitted. + Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. </description> </method> <method name="queue_edited_resource_preview"> @@ -63,7 +63,7 @@ <argument index="0" name="generator" type="EditorResourcePreviewGenerator"> </argument> <description> - Remove a custom preview generator. + Removes a custom preview generator. </description> </method> </methods> @@ -72,7 +72,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - If a preview was invalidated (changed) this signal will emit (using the path of the preview) + Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview. </description> </signal> </signals> diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index 156cc62941..4e61943c8f 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -4,7 +4,7 @@ Custom generator of previews. </brief_description> <description> - Custom code to generate previews. Please check "file_dialog/thumbnail_size" in EditorSettings to find out the right size to do previews at. + Custom code to generate previews. Please check [code]file_dialog/thumbnail_size[/code] in [EditorSettings] to find out the right size to do previews at. </description> <tutorials> </tutorials> @@ -13,8 +13,8 @@ <return type="bool"> </return> <description> - If this function returns true the generator will call [method generate] or [method generate_from_path] for small previews too. - By default it returns false. + If this function returns [code]true[/code], the generator will call [method generate] or [method generate_from_path] for small previews as well. + By default, it returns [code]false[/code]. </description> </method> <method name="generate" qualifiers="virtual"> @@ -47,8 +47,8 @@ <return type="bool"> </return> <description> - If this function returns true the generator will automatically generate the small previews from the normal preview texture generated by the methods [method generate] or [method generate_from_path]. - By default it returns false. + If this function returns [code]true[/code], the generator will automatically generate the small previews from the normal preview texture generated by the methods [method generate] or [method generate_from_path]. + By default, it returns [code]false[/code]. </description> </method> <method name="handles" qualifiers="virtual"> @@ -57,7 +57,7 @@ <argument index="0" name="type" type="String"> </argument> <description> - Returns if your generator supports this resource type. + Returns [code]true[/code] if your generator supports the resource of type [code]type[/code]. </description> </method> </methods> diff --git a/doc/classes/EditorSceneImporterAssimp.xml b/doc/classes/EditorSceneImporterAssimp.xml index b1f397e2b9..e2d73be870 100644 --- a/doc/classes/EditorSceneImporterAssimp.xml +++ b/doc/classes/EditorSceneImporterAssimp.xml @@ -1,30 +1,30 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorSceneImporterAssimp" inherits="EditorSceneImporter" category="Core" version="3.2"> <brief_description> - This is a multi-format 3d asset importer. + Multi-format 3D asset importer based on [url=http://assimp.org/]Assimp[/url]. </brief_description> <description> - This is a multi-format 3d asset importer. - Use these FBX export settings from Autodesk Maya. + This is a multi-format 3D asset importer based on [url=http://assimp.org/]Assimp[/url]. See [url=https://assimp-docs.readthedocs.io/en/latest/about/intoduction.html#installation]this page[/url] for a full list of supported formats. + If exporting a FBX scene from Autodesk Maya, use these FBX export settings: [codeblock] - * Smoothing Groups - * Smooth Mesh - * Triangluate (For mesh with blendshapes) - * Bake Animation - * Resample All - * Deformed Models - * Skins - * Blend Shapes - * Curve Filters - * Constant Key Reducer - * Auto Tangents Only - * DO NOT CHECK Constraints (Will Break File) - * Can check Embed Media (Embeds textures into FBX file to import) - -- Note: When importing embed media, texture and mesh will be a un-alterable file. - -- Reimport of fbx with updated texture is need if texture is updated. - * Units: Centimeters - * Up Axis: Y - * Binary format in FBX 2017 + - Smoothing Groups + - Smooth Mesh + - Triangluate (for meshes with blend shapes) + - Bake Animation + - Resample All + - Deformed Models + - Skins + - Blend Shapes + - Curve Filters + - Constant Key Reducer + - Auto Tangents Only + - *Do not check* Constraints (as it will break the file) + - Can check Embed Media (embeds textures into the exported FBX file) + - Note that when importing embedded media, the texture and mesh will be a single immutable file. + - You will have to re-export then re-import the FBX if the texture has changed. + - Units: Centimeters + - Up Axis: Y + - Binary format in FBX 2017 [/codeblock] </description> <tutorials> diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml index 3b0590f78c..df6cdd4b35 100644 --- a/doc/classes/EditorScenePostImport.xml +++ b/doc/classes/EditorScenePostImport.xml @@ -1,22 +1,22 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorScenePostImport" inherits="Reference" category="Core" version="3.2"> <brief_description> - Post process scenes after import + Post-processes scenes after import. </brief_description> <description> - Imported scenes can be automatically modified right after import by setting their [i]Custom Script[/i] Import property to a [code]tool[/code] script that inherits from this class. + Imported scenes can be automatically modified right after import by setting their [b]Custom Script[/b] Import property to a [code]tool[/code] script that inherits from this class. The [method post_import] callback receives the imported scene's root node and returns the modified version of the scene. Usage example: [codeblock] - tool # needed so it runs in editor + tool # Needed so it runs in editor extends EditorScenePostImport # This sample changes all node names # Called right after the scene is imported and gets the root node func post_import(scene): - # change all node names to "modified_[oldnodename]" + # Change all node names to "modified_[oldnodename]" iterate(scene) - return scene # remember to return the imported scene + return scene # Remember to return the imported scene func iterate(node): if node != null: @@ -49,7 +49,7 @@ <argument index="0" name="scene" type="Object"> </argument> <description> - Gets called after the scene got imported and has to return the modified version of the scene. + Called after the scene was imported. This method must return the modified version of the scene. </description> </method> </methods> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 52d7ce3f17..5c49e227be 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -4,8 +4,9 @@ Base script that can be used to add extension functions to the editor. </brief_description> <description> - 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: + Scripts extending this class and implementing its [method _run] method can be executed from the Script Editor's [b]File > Run[/b] 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. + [b]Note:[/b] Extending scripts need to have [code]tool mode[/code] enabled. + [b]Example script:[/b] [codeblock] tool extends EditorScript @@ -13,7 +14,7 @@ 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. + [b]Note:[/b] 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 [b]Output[/b] dock. </description> <tutorials> </tutorials> @@ -22,7 +23,7 @@ <return type="void"> </return> <description> - This method is executed by the Editor when [code]File -> Run[/code] is used. + This method is executed by the Editor when [b]File > Run[/b] is used. </description> </method> <method name="add_root_node"> @@ -32,7 +33,7 @@ </argument> <description> Adds [code]node[/code] as a child of the root node in the editor context. - WARNING: The implementation of this method is currently disabled. + [b]Warning:[/b] The implementation of this method is currently disabled. </description> </method> <method name="get_editor_interface"> diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml index 336390b2b1..57df71ab01 100644 --- a/doc/classes/EditorSelection.xml +++ b/doc/classes/EditorSelection.xml @@ -15,7 +15,7 @@ <argument index="0" name="node" type="Node"> </argument> <description> - Add a node to the selection. + Adds a node to the selection. </description> </method> <method name="clear"> @@ -29,14 +29,14 @@ <return type="Array"> </return> <description> - Get the list of selected nodes. + Gets the list of selected nodes. </description> </method> <method name="get_transformable_selected_nodes"> <return type="Array"> </return> <description> - Get the list of selected nodes, optimized for transform operations (ie, moving them, rotating, etc). This list avoids situations where a node is selected and also chid/grandchild. + Gets the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc). This list avoids situations where a node is selected and also child/grandchild. </description> </method> <method name="remove_node"> @@ -45,7 +45,7 @@ <argument index="0" name="node" type="Node"> </argument> <description> - Remove a node from the selection. + Removes a node from the selection. </description> </method> </methods> diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 7d38031a4c..3719ad67de 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -4,7 +4,7 @@ Object that holds the project-independent editor settings. </brief_description> <description> - Object that holds the project-independent editor settings. These settings are generally visible in the Editor Settings menu. + Object that holds the project-independent editor settings. These settings are generally visible in the [b]Editor > Editor Settings[/b] menu. Accessing the settings is done by using the regular [Object] API, such as: [codeblock] settings.set(prop,value) @@ -21,8 +21,8 @@ <argument index="0" name="info" type="Dictionary"> </argument> <description> - Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String]. - Example: + Adds a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see [code]TYPE_*[/code] in [@GlobalScope]), and optionally hint:[int](see [code]PROPERTY_HINT_*[/code] in [@GlobalScope]), hint_string:[String]. + [b]Example:[/b] [codeblock] editor_settings.set("category/property_name", 0) @@ -50,7 +50,7 @@ <return type="PoolStringArray"> </return> <description> - Get the list of favorite files and directories for this project. + Gets the list of favorite files and directories for this project. </description> </method> <method name="get_project_metadata" qualifiers="const"> @@ -69,14 +69,14 @@ <return type="String"> </return> <description> - Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved. + Gets the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved. </description> </method> <method name="get_recent_dirs" qualifiers="const"> <return type="PoolStringArray"> </return> <description> - Get the list of recently visited folders in the file dialog for this project. + Gets the list of recently visited folders in the file dialog for this project. </description> </method> <method name="get_setting" qualifiers="const"> @@ -91,9 +91,9 @@ <return type="String"> </return> <description> - Get the global settings path for the engine. Inside this path you can find some standard paths such as: - settings/tmp - used for temporary storage of files - settings/templates - where export templates are located + Gets the global settings path for the engine. Inside this path, you can find some standard paths such as: + [code]settings/tmp[/code] - Used for temporary storage of files + [code]settings/templates[/code] - Where export templates are located </description> </method> <method name="has_setting" qualifiers="const"> @@ -126,7 +126,7 @@ <argument index="0" name="dirs" type="PoolStringArray"> </argument> <description> - Set the list of favorite files and directories for this project. + Sets the list of favorite files and directories for this project. </description> </method> <method name="set_initial_value"> @@ -159,7 +159,7 @@ <argument index="0" name="dirs" type="PoolStringArray"> </argument> <description> - Set the list of recently visited folders in the file dialog for this project. + Sets the list of recently visited folders in the file dialog for this project. </description> </method> <method name="set_setting"> diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index 5d5c37b212..03a274e23e 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -23,7 +23,7 @@ <argument index="0" name="triangles" type="TriangleMesh"> </argument> <description> - Add collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw]. + Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw]. </description> </method> <method name="add_handles"> @@ -38,7 +38,7 @@ <argument index="3" name="secondary" type="bool" default="false"> </argument> <description> - Add a list of handles (points) which can be used to deform the object being edited. + Adds a list of handles (points) which can be used to deform the object being edited. There are virtual functions which will be called upon editing of these handles. Call this function during [method redraw]. </description> </method> @@ -52,7 +52,7 @@ <argument index="2" name="billboard" type="bool" default="false"> </argument> <description> - Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method redraw]. + Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method redraw]. </description> </method> <method name="add_mesh"> @@ -77,7 +77,7 @@ <argument index="1" name="default_scale" type="float" default="1"> </argument> <description> - Add an unscaled billboard for visualization. Call this function during [method redraw]. + Adds an unscaled billboard for visualization. Call this function during [method redraw]. </description> </method> <method name="clear"> @@ -97,7 +97,7 @@ </argument> <description> Commit a handle being edited (handles must have been previously added by [method add_handles]). - If the cancel parameter is [code]true[/code], an option to restore the edited value to the original is provided. + If the [code]cancel[/code] parameter is [code]true[/code], an option to restore the edited value to the original is provided. </description> </method> <method name="get_handle_name" qualifiers="virtual"> @@ -106,7 +106,7 @@ <argument index="0" name="index" type="int"> </argument> <description> - Get the name of an edited handle (handles must have been previously added by [method add_handles]). + Gets the name of an edited handle (handles must have been previously added by [method add_handles]). Handles can be named for reference to the user when editing. </description> </method> @@ -116,7 +116,7 @@ <argument index="0" name="index" type="int"> </argument> <description> - Get actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method commit_handle]. + Gets actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method commit_handle]. </description> </method> <method name="get_plugin" qualifiers="const"> @@ -139,7 +139,7 @@ <argument index="0" name="index" type="int"> </argument> <description> - Get whether a handle is highlighted or not. + Gets whether a handle is highlighted or not. </description> </method> <method name="redraw" qualifiers="virtual"> diff --git a/doc/classes/EditorSpatialGizmoPlugin.xml b/doc/classes/EditorSpatialGizmoPlugin.xml index 40d6376ca3..28586312f3 100644 --- a/doc/classes/EditorSpatialGizmoPlugin.xml +++ b/doc/classes/EditorSpatialGizmoPlugin.xml @@ -114,7 +114,7 @@ <argument index="1" name="index" type="int"> </argument> <description> - Get actual value of a handle from gizmo. Called for this plugin's active gizmos. + Gets actual value of a handle from gizmo. Called for this plugin's active gizmos. </description> </method> <method name="get_material"> @@ -125,7 +125,7 @@ <argument index="1" name="gizmo" type="EditorSpatialGizmo"> </argument> <description> - Get material from the internal list of materials. If an [EditorSpatialGizmo] is provided it will try to get the corresponding variant (selected and/or editable). + Gets material from the internal list of materials. If an [EditorSpatialGizmo] is provided, it will try to get the corresponding variant (selected and/or editable). </description> </method> <method name="get_name" qualifiers="virtual"> @@ -158,7 +158,7 @@ <argument index="1" name="index" type="int"> </argument> <description> - Get whether a handle is highlighted or not. Called for this plugin's active gizmos. + Gets whether a handle is highlighted or not. Called for this plugin's active gizmos. </description> </method> <method name="is_selectable_when_hidden" qualifiers="virtual"> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index d446363a83..265396e7cf 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 [Engine] class allows you to query and modify the project's run-time parameters, such as frames per second, time scale, and others. </description> <tutorials> </tutorials> @@ -14,10 +14,10 @@ </return> <description> Returns engine author information in a Dictionary. - "lead_developers" - Array of Strings, lead developer names - "founders" - Array of Strings, founder names - "project_managers" - Array of Strings, project manager names - "developers" - Array of Strings, developer names + [code]lead_developers[/code] - Array of Strings, lead developer names + [code]founders[/code] - Array of Strings, founder names + [code]project_managers[/code] - Array of Strings, project manager names + [code]developers[/code] - Array of Strings, developer names </description> </method> <method name="get_copyright_info" qualifiers="const"> @@ -25,8 +25,8 @@ </return> <description> Returns an Array of copyright information Dictionaries. - "name" - String, component name - "parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component + [code]name[/code] - String, component name + [code]parts[/code] - Array of Dictionaries {[code]files[/code], [code]copyright[/code], [code]license[/code]} describing subsections of the component </description> </method> <method name="get_donor_info" qualifiers="const"> @@ -34,7 +34,7 @@ </return> <description> Returns a Dictionary of Arrays of donor names. - {"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"} + {[code]platinum_sponsors[/code], [code]gold_sponsors[/code], [code]mini_sponsors[/code], [code]gold_donors[/code], [code]silver_donors[/code], [code]bronze_donors[/code]} </description> </method> <method name="get_frames_drawn"> @@ -88,18 +88,18 @@ [code]major[/code] - Holds the major version number as an int [code]minor[/code] - Holds the minor version number as an int [code]patch[/code] - Holds the patch version number as an int - [code]hex[/code] - Holds the full version number encoded as an hexadecimal int with one byte (2 places) per number (see example below) + [code]hex[/code] - Holds the full version number encoded as a hexadecimal int with one byte (2 places) per number (see example below) [code]status[/code] - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String [code]build[/code] - Holds the build name (e.g. "custom_build") as a String [code]hash[/code] - Holds the full Git commit hash as a String [code]year[/code] - Holds the year the version was released in as an int [code]string[/code] - [code]major[/code] + [code]minor[/code] + [code]patch[/code] + [code]status[/code] + [code]build[/code] in a single String - The [code]hex[/code] value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be [code]0x03010C[/code]. Note that it's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code: + The [code]hex[/code] value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be [code]0x03010C[/code]. [b]Note:[/b] It's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code: [codeblock] if Engine.get_version_info().hex >= 0x030200: - # do things specific to version 3.2 or later + # Do things specific to version 3.2 or later else: - # do things specific to versions before 3.2 + # Do things specific to versions before 3.2 [/codeblock] </description> </method> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 72993103e8..7158c132e6 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -5,10 +5,9 @@ </brief_description> <description> Resource for environment nodes (like [WorldEnvironment]) that define multiple environment operations (such as background [Sky] or [Color], ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is: - - DOF Blur - - Motion Blur - - Bloom - - Tonemap (auto exposure) + - Depth of Field Blur + - Glow + - Tonemap (Auto Exposure) - Adjustments </description> <tutorials> @@ -282,7 +281,7 @@ Screen glow blending mode. Increases brightness, used frequently with bloom. </constant> <constant name="GLOW_BLEND_MODE_SOFTLIGHT" value="2" enum="GlowBlendMode"> - Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom. + Soft light glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom. </constant> <constant name="GLOW_BLEND_MODE_REPLACE" value="3" enum="GlowBlendMode"> Replace glow blending mode. Replaces all pixels' color by the glow value. @@ -291,7 +290,7 @@ Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. </constant> <constant name="TONE_MAPPER_REINHARDT" value="1" enum="ToneMapper"> - Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color). + Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: [code]color = color / (1 + color)[/code]. </constant> <constant name="TONE_MAPPER_FILMIC" value="2" enum="ToneMapper"> Filmic tonemapper operator. diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 42fee8df17..fb462d001d 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -36,7 +36,8 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if the file cursor has read past the end of the file. Note that this function will still return [code]false[/code] while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low level file access works in all operating systems. There is always [method get_len] and [method get_position] to implement a custom logic. + Returns [code]true[/code] if the file cursor has read past the end of the file. + [b]Note:[/b] This function will still return [code]false[/code] while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low-level file access works in all operating systems. There is always [method get_len] and [method get_position] to implement a custom logic. </description> </method> <method name="file_exists" qualifiers="const"> @@ -46,7 +47,7 @@ </argument> <description> Returns [code]true[/code] if the file exists in the given path. - Note that many resources types are imported (e.g. textures or sound files), and that their source asset will not be included in the exported game, as only the imported version is used (in the [code]res://.import[/code] folder). To check for the existence of such resources while taking into account the remapping to their imported location, use [method ResourceLoader.exists]. Typically, using [code]File.file_exists[/code] on an imported resource would work while you are developing in the editor (the source asset is present in [code]res://[/code], but fail when exported). + [b]Note:[/b] Many resources types are imported (e.g. textures or sound files), and that their source asset will not be included in the exported game, as only the imported version is used (in the [code]res://.import[/code] folder). To check for the existence of such resources while taking into account the remapping to their imported location, use [method ResourceLoader.exists]. Typically, using [code]File.file_exists[/code] on an imported resource would work while you are developing in the editor (the source asset is present in [code]res://[/code], but fail when exported). </description> </method> <method name="get_16" qualifiers="const"> @@ -100,7 +101,7 @@ <argument index="0" name="delim" type="String" default="",""> </argument> <description> - Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long. + Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long. Text is interpreted as being UTF-8 encoded. </description> </method> @@ -108,7 +109,7 @@ <return type="float"> </return> <description> - Returns the next 64 bits from the file as a floating point number. + Returns the next 64 bits from the file as a floating-point number. </description> </method> <method name="get_error" qualifiers="const"> @@ -122,7 +123,7 @@ <return type="float"> </return> <description> - Returns the next 32 bits from the file as a floating point number. + Returns the next 32 bits from the file as a floating-point number. </description> </method> <method name="get_len" qualifiers="const"> @@ -191,7 +192,7 @@ <return type="float"> </return> <description> - Returns the next bits from the file as a floating point number. + Returns the next bits from the file as a floating-point number. </description> </method> <method name="get_sha256" qualifiers="const"> @@ -209,8 +210,8 @@ <argument index="0" name="allow_objects" type="bool" default="false"> </argument> <description> - Returns the next [Variant] value from the file. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. - [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). + Returns the next [Variant] value from the file. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. + [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </description> </method> <method name="is_open" qualifiers="const"> @@ -241,7 +242,7 @@ <argument index="2" name="compression_mode" type="int" enum="File.CompressionMode" default="0"> </argument> <description> - Opens a compressed file for reading or writing. Use [enum CompressionMode] constants to set [code]compression_mode[/code]. + Opens a compressed file for reading or writing. </description> </method> <method name="open_encrypted"> @@ -276,7 +277,7 @@ <argument index="0" name="position" type="int"> </argument> <description> - Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). + Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). </description> </method> <method name="seek_end"> @@ -285,7 +286,8 @@ <argument index="0" name="position" type="int" default="0"> </argument> <description> - Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. + Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). + [b]Note:[/b] This is an offset, so you should use negative numbers or the cursor will be at the end of the file. </description> </method> <method name="store_16"> @@ -341,7 +343,7 @@ <argument index="1" name="delim" type="String" default="",""> </argument> <description> - Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long. + Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long. Text will be encoded as UTF-8. </description> </method> @@ -351,7 +353,7 @@ <argument index="0" name="value" type="float"> </argument> <description> - Stores a floating point number as 64 bits in the file. + Stores a floating-point number as 64 bits in the file. </description> </method> <method name="store_float"> @@ -360,7 +362,7 @@ <argument index="0" name="value" type="float"> </argument> <description> - Stores a floating point number as 32 bits in the file. + Stores a floating-point number as 32 bits in the file. </description> </method> <method name="store_line"> @@ -389,7 +391,7 @@ <argument index="0" name="value" type="float"> </argument> <description> - Stores a floating point number in the file. + Stores a floating-point number in the file. </description> </method> <method name="store_string"> @@ -410,14 +412,14 @@ <argument index="1" name="full_objects" type="bool" default="false"> </argument> <description> - Stores any Variant value in the file. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). + Stores any Variant value in the file. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). </description> </method> </methods> <members> <member name="endian_swap" type="bool" setter="set_endian_swap" getter="get_endian_swap"> - If [code]true[/code], the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. - Note that this is about the file format, not CPU type. This is always reset to [code]false[/code] whenever you open the file. + If [code]true[/code], the file's endianness is swapped. Use this if you're dealing with files written on big-endian machines. + [b]Note:[/b] This is about the file format, not CPU type. This is always reset to [code]false[/code] whenever you open the file. </member> </members> <constants> @@ -434,16 +436,16 @@ Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists. </constant> <constant name="COMPRESSION_FASTLZ" value="0" enum="CompressionMode"> - Uses the FastLZ compression method. + Uses the [url=http://fastlz.org/]FastLZ[/url] compression method. </constant> <constant name="COMPRESSION_DEFLATE" value="1" enum="CompressionMode"> - Uses the Deflate compression method. + Uses the [url=https://en.wikipedia.org/wiki/DEFLATE]DEFLATE[/url] compression method. </constant> <constant name="COMPRESSION_ZSTD" value="2" enum="CompressionMode"> - Uses the Zstd compression method. + Uses the [url=https://facebook.github.io/zstd/]Zstandard[/url] compression method. </constant> <constant name="COMPRESSION_GZIP" value="3" enum="CompressionMode"> - Uses the gzip compression method. + Uses the [url=https://www.gzip.org/]gzip[/url] compression method. </constant> </constants> </class> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index f8df356da2..bc64f844f6 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -15,7 +15,7 @@ <argument index="0" name="filter" type="String"> </argument> <description> - Add a custom filter. Example: [code]add_filter("*.png ; PNG Images")[/code] + Adds [code]filter[/code] as a custom filter; [code]filter[/code] should be of the form [code]"filename.extension ; Description"[/code]. For example, [code]"*.png ; PNG Images"[/code]. </description> </method> <method name="clear_filters"> @@ -68,10 +68,10 @@ The currently selected file path of the file dialog. </member> <member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters"> - Set file type filters. This example shows only .png and .gd files [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GD Script"]))[/code]. + The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code]. </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode"> - Set dialog to open or save mode, changes selection behavior. See enum [code]Mode[/code] constants. + The dialog's open or save mode, which affects the selection behavior. See enum [code]Mode[/code] constants. </member> <member name="mode_overrides_title" type="bool" setter="set_mode_overrides_title" getter="is_mode_overriding_title"> If [code]true[/code], changing the [code]Mode[/code] property will set the window title accordingly (e.g. setting mode to [constant MODE_OPEN_FILE] will change the window title to "Open a File"). @@ -85,48 +85,48 @@ <argument index="0" name="dir" type="String"> </argument> <description> - Event emitted when the user selects a directory. + Emitted when the user selects a directory. </description> </signal> <signal name="file_selected"> <argument index="0" name="path" type="String"> </argument> <description> - Event emitted when the user selects a file (double clicks it or presses the OK button). + Emitted when the user selects a file by double-clicking it or pressing the [b]OK[/b] button. </description> </signal> <signal name="files_selected"> <argument index="0" name="paths" type="PoolStringArray"> </argument> <description> - Event emitted when the user selects multiple files. + Emitted when the user selects multiple files. </description> </signal> </signals> <constants> <constant name="MODE_OPEN_FILE" value="0" enum="Mode"> - The dialog allows the selection of one, and only one file. + The dialog allows selecting one, and only one file. </constant> <constant name="MODE_OPEN_FILES" value="1" enum="Mode"> - The dialog allows the selection of multiple files. + The dialog allows selecting multiple files. </constant> <constant name="MODE_OPEN_DIR" value="2" enum="Mode"> - The dialog functions as a folder selector, disallowing the selection of any file. + The dialog only allows selecting a directory, disallowing the selection of any file. </constant> <constant name="MODE_OPEN_ANY" value="3" enum="Mode"> - The dialog allows the selection of a file or a directory. + The dialog allows selecting one file or directory. </constant> <constant name="MODE_SAVE_FILE" value="4" enum="Mode"> The dialog will warn when a file exists. </constant> <constant name="ACCESS_RESOURCES" value="0" enum="Access"> - The dialog allows the selection of file and directory. + The dialog only allows accessing files under the [Resource] path ([code]res://[/code]). </constant> <constant name="ACCESS_USERDATA" value="1" enum="Access"> - The dialog allows access files under [Resource] path(res://) . + The dialog only allows accessing files under user data path ([code]user://[/code]). </constant> <constant name="ACCESS_FILESYSTEM" value="2" enum="Access"> - The dialog allows access files in whole file system. + The dialog allows accessing files on the whole file system. </constant> </constants> <theme_items> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index d65dad9fe1..6ec1545bc7 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -4,7 +4,7 @@ Internationalized font and text drawing support. </brief_description> <description> - Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. + Font contains a Unicode-compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. </description> <tutorials> </tutorials> @@ -25,7 +25,7 @@ <argument index="5" name="outline_modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> <description> - Draw "string" into a canvas item using the font at a given position, with "modulate" color, and optionally clipping the width. "position" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. + Draw [code]string[/code] into a canvas item using the font at a given position, with [code]modulate[/code] color, and optionally clipping the width. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. </description> </method> <method name="draw_char" qualifiers="const"> @@ -44,7 +44,7 @@ <argument index="5" name="outline" type="bool" default="false"> </argument> <description> - Draw character "char" into a canvas item using the font at a given position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "position" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. + Draw character [code]char[/code] into a canvas item using the font at a given position, with [code]modulate[/code] color, and optionally kerning if [code]next[/code] is passed. clipping the width. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. </description> </method> <method name="get_ascent" qualifiers="const"> diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index 52888e9587..8d2f1285a9 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.2"> <brief_description> - The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation. + The generic 6-degrees-of-freedom joint can implement a variety of joint types by locking certain axes' rotation or translation. </brief_description> <description> The first 3 DOF axes are linear axes, which represent translation of Bodies, and the latter 3 DOF axes represent the angular motion. Each axis can be either locked, or limited. @@ -12,104 +12,104 @@ </methods> <members> <member name="angular_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x"> - The amount of rotational damping across the x-axis. + The amount of rotational damping across the X axis. The lower, the longer an impulse from one side takes to travel to the other side. </member> <member name="angular_limit_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> - If [code]true[/code], rotation across the x-axis is limited. + If [code]true[/code], rotation across the X axis is limited. </member> <member name="angular_limit_x/erp" type="float" setter="set_param_x" getter="get_param_x"> - When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. + When rotating across the X axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> - The maximum amount of force that can occur, when rotating around x-axis. + The maximum amount of force that can occur, when rotating around the X axis. </member> <member name="angular_limit_x/lower_angle" type="float" setter="_set_angular_lo_limit_x" getter="_get_angular_lo_limit_x"> - The minimum rotation in negative direction to break loose and rotate around the x-axis. + The minimum rotation in negative direction to break loose and rotate around the X axis. </member> <member name="angular_limit_x/restitution" type="float" setter="set_param_x" getter="get_param_x"> - The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. + The amount of rotational restitution across the X axis. The lower, the more restitution occurs. </member> <member name="angular_limit_x/softness" type="float" setter="set_param_x" getter="get_param_x"> - The speed of all rotations across the x-axis. + The speed of all rotations across the X axis. </member> <member name="angular_limit_x/upper_angle" type="float" setter="_set_angular_hi_limit_x" getter="_get_angular_hi_limit_x"> - The minimum rotation in positive direction to break loose and rotate around the x-axis. + The minimum rotation in positive direction to break loose and rotate around the X axis. </member> <member name="angular_limit_y/damping" type="float" setter="set_param_y" getter="get_param_y"> - The amount of rotational damping across the y-axis. The lower, the more dampening occurs. + The amount of rotational damping across the Y axis. The lower, the more dampening occurs. </member> <member name="angular_limit_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> - If [code]true[/code], rotation across the y-axis is limited. + If [code]true[/code], rotation across the Y axis is limited. </member> <member name="angular_limit_y/erp" type="float" setter="set_param_y" getter="get_param_y"> - When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. + When rotating across the Y axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> - The maximum amount of force that can occur, when rotating around y-axis. + The maximum amount of force that can occur, when rotating around the Y axis. </member> <member name="angular_limit_y/lower_angle" type="float" setter="_set_angular_lo_limit_y" getter="_get_angular_lo_limit_y"> - The minimum rotation in negative direction to break loose and rotate around the y-axis. + The minimum rotation in negative direction to break loose and rotate around the Y axis. </member> <member name="angular_limit_y/restitution" type="float" setter="set_param_y" getter="get_param_y"> - The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. + The amount of rotational restitution across the Y axis. The lower, the more restitution occurs. </member> <member name="angular_limit_y/softness" type="float" setter="set_param_y" getter="get_param_y"> - The speed of all rotations across the y-axis. + The speed of all rotations across the Y axis. </member> <member name="angular_limit_y/upper_angle" type="float" setter="_set_angular_hi_limit_y" getter="_get_angular_hi_limit_y"> - The minimum rotation in positive direction to break loose and rotate around the y-axis. + The minimum rotation in positive direction to break loose and rotate around the Y axis. </member> <member name="angular_limit_z/damping" type="float" setter="set_param_z" getter="get_param_z"> - The amount of rotational damping across the z-axis. The lower, the more dampening occurs. + The amount of rotational damping across the Z axis. The lower, the more dampening occurs. </member> <member name="angular_limit_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> - If [code]true[/code], rotation across the z-axis is limited. + If [code]true[/code], rotation across the Z axis is limited. </member> <member name="angular_limit_z/erp" type="float" setter="set_param_z" getter="get_param_z"> - When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. + When rotating across the Z axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> - The maximum amount of force that can occur, when rotating around z-axis. + The maximum amount of force that can occur, when rotating around the Z axis. </member> <member name="angular_limit_z/lower_angle" type="float" setter="_set_angular_lo_limit_z" getter="_get_angular_lo_limit_z"> - The minimum rotation in negative direction to break loose and rotate around the z-axis. + The minimum rotation in negative direction to break loose and rotate around the Z axis. </member> <member name="angular_limit_z/restitution" type="float" setter="set_param_z" getter="get_param_z"> - The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. + The amount of rotational restitution across the Z axis. The lower, the more restitution occurs. </member> <member name="angular_limit_z/softness" type="float" setter="set_param_z" getter="get_param_z"> - The speed of all rotations across the z-axis. + The speed of all rotations across the Z axis. </member> <member name="angular_limit_z/upper_angle" type="float" setter="_set_angular_hi_limit_z" getter="_get_angular_hi_limit_z"> - The minimum rotation in positive direction to break loose and rotate around the z-axis. + The minimum rotation in positive direction to break loose and rotate around the Z axis. </member> <member name="angular_motor_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> - If [code]true[/code], a rotating motor at the x-axis is enabled. + If [code]true[/code], a rotating motor at the X axis is enabled. </member> <member name="angular_motor_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> - Maximum acceleration for the motor at the x-axis. + Maximum acceleration for the motor at the X axis. </member> <member name="angular_motor_x/target_velocity" type="float" setter="set_param_x" getter="get_param_x"> - Target speed for the motor at the x-axis. + Target speed for the motor at the X axis. </member> <member name="angular_motor_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> - If [code]true[/code], a rotating motor at the y-axis is enabled. + If [code]true[/code], a rotating motor at the Y axis is enabled. </member> <member name="angular_motor_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> - Maximum acceleration for the motor at the y-axis. + Maximum acceleration for the motor at the Y axis. </member> <member name="angular_motor_y/target_velocity" type="float" setter="set_param_y" getter="get_param_y"> - Target speed for the motor at the y-axis. + Target speed for the motor at the Y axis. </member> <member name="angular_motor_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> - If [code]true[/code], a rotating motor at the z-axis is enabled. + If [code]true[/code], a rotating motor at the Z axis is enabled. </member> <member name="angular_motor_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> - Maximum acceleration for the motor at the z-axis. + Maximum acceleration for the motor at the Z axis. </member> <member name="angular_motor_z/target_velocity" type="float" setter="set_param_z" getter="get_param_z"> - Target speed for the motor at the z-axis. + Target speed for the motor at the Z axis. </member> <member name="angular_spring_x/damping" type="float" setter="set_param_x" getter="get_param_x"> </member> @@ -136,85 +136,85 @@ <member name="angular_spring_z/stiffness" type="float" setter="set_param_z" getter="get_param_z"> </member> <member name="linear_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x"> - The amount of damping that happens at the x-motion. + The amount of damping that happens at the X motion. </member> <member name="linear_limit_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> - If [code]true[/code], the linear motion across the x-axis is limited. + If [code]true[/code], the linear motion across the X axis is limited. </member> <member name="linear_limit_x/lower_distance" type="float" setter="set_param_x" getter="get_param_x"> - The minimum difference between the pivot points' x-axis. + The minimum difference between the pivot points' X axis. </member> <member name="linear_limit_x/restitution" type="float" setter="set_param_x" getter="get_param_x"> - The amount of restitution on the x-axis movement The lower, the more momentum gets lost. + The amount of restitution on the X axis movement. The lower, the more momentum gets lost. </member> <member name="linear_limit_x/softness" type="float" setter="set_param_x" getter="get_param_x"> - A factor applied to the movement across the x-axis The lower, the slower the movement. + A factor applied to the movement across the X axis. The lower, the slower the movement. </member> <member name="linear_limit_x/upper_distance" type="float" setter="set_param_x" getter="get_param_x"> - The maximum difference between the pivot points' x-axis. + The maximum difference between the pivot points' X axis. </member> <member name="linear_limit_y/damping" type="float" setter="set_param_y" getter="get_param_y"> - The amount of damping that happens at the y-motion. + The amount of damping that happens at the Y motion. </member> <member name="linear_limit_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> - If [code]true[/code], the linear motion across the y-axis is limited. + If [code]true[/code], the linear motion across the Y axis is limited. </member> <member name="linear_limit_y/lower_distance" type="float" setter="set_param_y" getter="get_param_y"> - The minimum difference between the pivot points' y-axis. + The minimum difference between the pivot points' Y axis. </member> <member name="linear_limit_y/restitution" type="float" setter="set_param_y" getter="get_param_y"> - The amount of restitution on the y-axis movement The lower, the more momentum gets lost. + The amount of restitution on the Y axis movement. The lower, the more momentum gets lost. </member> <member name="linear_limit_y/softness" type="float" setter="set_param_y" getter="get_param_y"> - A factor applied to the movement across the y-axis The lower, the slower the movement. + A factor applied to the movement across the Y axis. The lower, the slower the movement. </member> <member name="linear_limit_y/upper_distance" type="float" setter="set_param_y" getter="get_param_y"> - The maximum difference between the pivot points' y-axis. + The maximum difference between the pivot points' Y axis. </member> <member name="linear_limit_z/damping" type="float" setter="set_param_z" getter="get_param_z"> - The amount of damping that happens at the z-motion. + The amount of damping that happens at the Z motion. </member> <member name="linear_limit_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> - If [code]true[/code], the linear motion across the z-axis is limited. + If [code]true[/code], the linear motion across the Z axis is limited. </member> <member name="linear_limit_z/lower_distance" type="float" setter="set_param_z" getter="get_param_z"> - The minimum difference between the pivot points' z-axis. + The minimum difference between the pivot points' Z axis. </member> <member name="linear_limit_z/restitution" type="float" setter="set_param_z" getter="get_param_z"> - The amount of restitution on the z-axis movement The lower, the more momentum gets lost. + The amount of restitution on the Z axis movement. The lower, the more momentum gets lost. </member> <member name="linear_limit_z/softness" type="float" setter="set_param_z" getter="get_param_z"> - A factor applied to the movement across the z-axis The lower, the slower the movement. + A factor applied to the movement across the Z axis. The lower, the slower the movement. </member> <member name="linear_limit_z/upper_distance" type="float" setter="set_param_z" getter="get_param_z"> - The maximum difference between the pivot points' z-axis. + The maximum difference between the pivot points' Z axis. </member> <member name="linear_motor_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> - If [code]true[/code], then there is a linear motor on the x-axis. It will attempt to reach the target velocity while staying within the force limits. + If [code]true[/code], then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits. </member> <member name="linear_motor_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> - The maximum force the linear motor can apply on the x-axis while trying to reach the target velocity. + The maximum force the linear motor can apply on the X axis while trying to reach the target velocity. </member> <member name="linear_motor_x/target_velocity" type="float" setter="set_param_x" getter="get_param_x"> - The speed that the linear motor will attempt to reach on the x-axis. + The speed that the linear motor will attempt to reach on the X axis. </member> <member name="linear_motor_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> - If [code]true[/code], then there is a linear motor on the y-axis. It will attempt to reach the target velocity while staying within the force limits. + If [code]true[/code], then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits. </member> <member name="linear_motor_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> - The maximum force the linear motor can apply on the y-axis while trying to reach the target velocity. + The maximum force the linear motor can apply on the Y axis while trying to reach the target velocity. </member> <member name="linear_motor_y/target_velocity" type="float" setter="set_param_y" getter="get_param_y"> - The speed that the linear motor will attempt to reach on the y-axis. + The speed that the linear motor will attempt to reach on the Y axis. </member> <member name="linear_motor_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> - If [code]true[/code], then there is a linear motor on the z-axis. It will attempt to reach the target velocity while staying within the force limits. + If [code]true[/code], then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits. </member> <member name="linear_motor_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> - The maximum force the linear motor can apply on the z-axis while trying to reach the target velocity. + The maximum force the linear motor can apply on the Z axis while trying to reach the target velocity. </member> <member name="linear_motor_z/target_velocity" type="float" setter="set_param_z" getter="get_param_z"> - The speed that the linear motor will attempt to reach on the z-axis. + The speed that the linear motor will attempt to reach on the Z axis. </member> <member name="linear_spring_x/damping" type="float" setter="set_param_x" getter="get_param_x"> </member> @@ -251,10 +251,10 @@ The maximum difference between the pivot points' axes. </constant> <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2" enum="Param"> - A factor applied to the movement across the axes The lower, the slower the movement. + A factor applied to the movement across the axes. The lower, the slower the movement. </constant> <constant name="PARAM_LINEAR_RESTITUTION" value="3" enum="Param"> - The amount of restitution on the axes movement The lower, the more momentum gets lost. + The amount of restitution on the axes' movement. The lower, the more momentum gets lost. </constant> <constant name="PARAM_LINEAR_DAMPING" value="4" enum="Param"> The amount of damping that happens at the linear motion across the axes. @@ -296,19 +296,20 @@ Represents the size of the [enum Param] enum. </constant> <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="Flag"> - If [code]set[/code] there is linear motion possible within the given limits. + If enabled, linear motion is possible within the given limits. </constant> <constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1" enum="Flag"> - If [code]set[/code] there is rotational motion possible. + If enabled, rotational motion is possible within the given limits. </constant> <constant name="FLAG_ENABLE_LINEAR_SPRING" value="3" enum="Flag"> </constant> <constant name="FLAG_ENABLE_ANGULAR_SPRING" value="2" enum="Flag"> </constant> <constant name="FLAG_ENABLE_MOTOR" value="4" enum="Flag"> - If [code]set[/code] there is a rotational motor across these axes. + If enabled, there is a rotational motor across these axes. </constant> <constant name="FLAG_ENABLE_LINEAR_MOTOR" value="5" enum="Flag"> + If enabled, there is a linear motor across these axes. </constant> <constant name="FLAG_MAX" value="6" enum="Flag"> Represents the size of the [enum Flag] enum. diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 002b224d6f..3cbbe6da56 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -68,7 +68,7 @@ </argument> <description> Clips [code]polygon_a[/code] against [code]polygon_b[/code] and returns an array of clipped polygons. This performs [constant OPERATION_DIFFERENCE] between polygons. Returns an empty array if [code]polygon_b[/code] completely overlaps [code]polygon_a[/code]. - If [code]polygon_b[/code] is enclosed by [code]polygon_a[/code], returns an outer polygon (boundary) and inner polygon (hole) which could be distinguished by calling [method is_polygon_clockwise]. + If [code]polygon_b[/code] is enclosed by [code]polygon_a[/code], returns an outer polygon (boundary) and inner polygon (hole) which could be distiguished by calling [method is_polygon_clockwise]. </description> </method> <method name="clip_polyline_with_polygon_2d"> @@ -88,7 +88,7 @@ <argument index="0" name="points" type="PoolVector2Array"> </argument> <description> - Given an array of [Vector2]s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one. + Given an array of [Vector2]s, returns the convex hull as a list of points in counterclockwise order. The last point is the same as the first one. </description> </method> <method name="exclude_polygons_2d"> @@ -99,8 +99,8 @@ <argument index="1" name="polygon_b" type="PoolVector2Array"> </argument> <description> - Mutually excludes common area defined by intersection of [code]polygon_a[/code] and [code]polygon_b[/code] (see [method intersect_polygons_2d]) and returns an array of excluded polygons. This performs [constant OPERATION_XOR] between polygons. In other words, returns all but common area between polygons. - The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. + Mutually excludes common area defined by intersection of [code]polygon_a[/code] and [code]polygon_b[/code] (see [method intersect_polygons_2d]) and returns an array of excluded polygons. This performs [constant OPERATION_XOR] between polygons. In other words, returns all but common area between polygons. + The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise]. </description> </method> <method name="get_closest_point_to_segment"> @@ -248,7 +248,8 @@ <argument index="3" name="dir_b" type="Vector2"> </argument> <description> - Checks if the two lines ([code]from_a[/code], [code]dir_a[/code]) and ([code]from_b[/code], [code]dir_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns an empty [Variant]. Note that the lines are specified using direction vectors, not end points. + Checks if the two lines ([code]from_a[/code], [code]dir_a[/code]) and ([code]from_b[/code], [code]dir_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns an empty [Variant]. + [b]Note:[/b] The lines are specified using direction vectors, not end points. </description> </method> <method name="make_atlas"> @@ -435,8 +436,8 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> - Transforms an array of points by [code]transform[/code] and returns the result. - Can be useful in conjuction with performing polygon boolean operations in CSG manner, see [method merge_polygons_2d], [method clip_polygons_2d], [method intersect_polygons_2d], [method exclude_polygons_2d]. + Transforms an array of points by [code]transform[/code] and returns the result. + Can be useful in conjunction with performing polygon boolean operations in a CSG-like manner, see [method merge_polygons_2d], [method clip_polygons_2d], [method intersect_polygons_2d], [method exclude_polygons_2d]. </description> </method> <method name="triangulate_delaunay_2d"> @@ -478,7 +479,7 @@ While flattened paths can never perfectly trace an arc, they are approximated by a series of arc chords. </constant> <constant name="JOIN_MITER" value="2" enum="PolyJoinType"> - There's a necessary limit to mitered joins since offsetting edges that join at very acute angles will produce excessively long and narrow 'spikes'. For any given edge join, when miter offsetting would exceed that maximum distance, 'square' joining is applied. + There's a necessary limit to mitered joins since offsetting edges that join at very acute angles will produce excessively long and narrow "spikes". For any given edge join, when miter offsetting would exceed that maximum distance, "square" joining is applied. </constant> <constant name="END_POLYGON" value="0" enum="PolyEndType"> Endpoints are joined using the [enum PolyJoinType] value and the path filled as a polygon. diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index 22135a048e..d3e3dfce92 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="GeometryInstance" inherits="VisualInstance" category="Core" version="3.2"> <brief_description> - Base node for geometry based visual instances. + Base node for geometry-based visual instances. </brief_description> <description> - Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials. + Base node for geometry-based visual instances. Shares some common functionality like visibility and custom materials. </description> <tutorials> </tutorials> diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index d80fed204e..62c23d1974 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Gradient" inherits="Resource" category="Core" version="3.2"> <brief_description> - Color interpolator node. + A color interpolator resource which can be used to generate colors between user-defined color points. </brief_description> <description> - Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color 3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset 0 and the other (white) at the ramp higher offset 1. + Given a set of colors, this resource will interpolate them in order. This means that if you have color 1, color 2 and color 3, the ramp will interpolate from color 1 to color 2 and from color 2 to color 3. The ramp will initially have 2 colors (black and white), one (black) at ramp lower offset 0 and the other (white) at the ramp higher offset 1. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Adds the specified color to the end of the ramp, with the specified offset + Adds the specified color to the end of the ramp, with the specified offset. </description> </method> <method name="get_color" qualifiers="const"> @@ -26,7 +26,7 @@ <argument index="0" name="point" type="int"> </argument> <description> - Returns the color of the ramp color at index [i]point[/i] + Returns the color of the ramp color at index [code]point[/code]. </description> </method> <method name="get_offset" qualifiers="const"> @@ -35,14 +35,14 @@ <argument index="0" name="point" type="int"> </argument> <description> - Returns the offset of the ramp color at index [i]point[/i] + Returns the offset of the ramp color at index [code]point[/code]. </description> </method> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> <description> - Returns the number of colors in the ramp + Returns the number of colors in the ramp. </description> </method> <method name="interpolate"> @@ -51,7 +51,7 @@ <argument index="0" name="offset" type="float"> </argument> <description> - Returns the interpolated color specified by [i]offset[/i] + Returns the interpolated color specified by [code]offset[/code]. </description> </method> <method name="remove_point"> @@ -60,7 +60,7 @@ <argument index="0" name="offset" type="int"> </argument> <description> - Removes the color at the index [i]offset[/i] + Removes the color at the index [code]offset[/code]. </description> </method> <method name="set_color"> @@ -71,7 +71,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Sets the color of the ramp color at index [i]point[/i] + Sets the color of the ramp color at index [code]point[/code]. </description> </method> <method name="set_offset"> @@ -82,7 +82,7 @@ <argument index="1" name="offset" type="float"> </argument> <description> - Sets the offset for the ramp color at index [i]point[/i] + Sets the offset for the ramp color at index [code]point[/code]. </description> </method> </methods> diff --git a/doc/classes/GradientTexture.xml b/doc/classes/GradientTexture.xml index fc952346ad..a191af3a8d 100644 --- a/doc/classes/GradientTexture.xml +++ b/doc/classes/GradientTexture.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="GradientTexture" inherits="Texture" category="Core" version="3.2"> <brief_description> - Gradient filled texture. + Gradient-filled texture. </brief_description> <description> - Uses a [Gradient] to fill the texture data, the gradient will be filled from left to right using colors obtained from the gradient, this means that the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see [member width]). + GradientTexture uses a [Gradient] to fill the texture data. The gradient will be filled from left to right using colors obtained from the gradient. This means the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see [member width]). </description> <tutorials> </tutorials> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 034a64a3fa..b39b8e9f48 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -4,8 +4,8 @@ GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. </brief_description> <description> - GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. - It is greatly advised to enable low processor usage mode (see [member OS.low_processor_usage_mode]) when using GraphEdits. + GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNode slots is disabled by default. + It is greatly advised to enable low-processor usage mode (see [member OS.low_processor_usage_mode]) when using GraphEdits. </description> <tutorials> </tutorials> @@ -43,7 +43,7 @@ <return type="void"> </return> <description> - Remove all connections between nodes. + Removes all connections between nodes. </description> </method> <method name="connect_node"> @@ -58,7 +58,7 @@ <argument index="3" name="to_port" type="int"> </argument> <description> - Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. + Create a connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection already exists, no connection is created. </description> </method> <method name="disconnect_node"> @@ -73,14 +73,14 @@ <argument index="3" name="to_port" type="int"> </argument> <description> - Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. + Removes the connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection does not exist, no connection is removed. </description> </method> <method name="get_connection_list" qualifiers="const"> <return type="Array"> </return> <description> - Returns an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" } + Returns an Array containing the list of connections. A connection consists in a structure of the form [code]{ from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" }[/code]. </description> </method> <method name="get_zoom_hbox"> @@ -101,7 +101,7 @@ <argument index="3" name="to_port" type="int"> </argument> <description> - Returns [code]true[/code] if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. + Returns [code]true[/code] if the [code]from_port[/code] slot of the [code]from[/code] GraphNode is connected to the [code]to_port[/code] slot of the [code]to[/code] GraphNode. </description> </method> <method name="is_valid_connection_type" qualifiers="const"> @@ -208,7 +208,7 @@ <argument index="3" name="to_slot" type="int"> </argument> <description> - Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. + Signal sent to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created. </description> </signal> <signal name="connection_from_empty"> @@ -248,12 +248,12 @@ <argument index="3" name="to_slot" type="int"> </argument> <description> - Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. + Emitted to the GraphEdit when the connection between [code]from_slot[/code] slot of [code]from[/code] GraphNode and [code]to_slot[/code] slot of [code]to[/code] GraphNode is attempted to be removed. </description> </signal> <signal name="duplicate_nodes_request"> <description> - Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. + Emitted when a GraphNode is attempted to be duplicated in the GraphEdit. </description> </signal> <signal name="node_selected"> @@ -267,7 +267,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. + Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. [code]position[/code] is the position of the mouse pointer when the signal is sent. </description> </signal> <signal name="scroll_offset_changed"> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index a19676798b..e72b617bae 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -4,7 +4,7 @@ A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. </brief_description> <description> - A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. + A GraphNode is a container defined by a title. It can have one or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. </description> <tutorials> </tutorials> @@ -13,7 +13,7 @@ <return type="void"> </return> <description> - Disable all input and output slots of the GraphNode. + Disables all input and output slots of the GraphNode. </description> </method> <method name="clear_slot"> @@ -22,7 +22,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Disable input and output slot whose index is 'idx'. + Disables input and output slot whose index is [code]idx[/code]. </description> </method> <method name="get_connection_input_color"> @@ -31,7 +31,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the color of the input connection 'idx'. + Returns the color of the input connection [code]idx[/code]. </description> </method> <method name="get_connection_input_count"> @@ -47,7 +47,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the position of the input connection 'idx'. + Returns the position of the input connection [code]idx[/code]. </description> </method> <method name="get_connection_input_type"> @@ -56,7 +56,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the type of the input connection 'idx'. + Returns the type of the input connection [code]idx[/code]. </description> </method> <method name="get_connection_output_color"> @@ -65,7 +65,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the color of the output connection 'idx'. + Returns the color of the output connection [code]idx[/code]. </description> </method> <method name="get_connection_output_count"> @@ -81,7 +81,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the position of the output connection 'idx'. + Returns the position of the output connection [code]idx[/code]. </description> </method> <method name="get_connection_output_type"> @@ -90,7 +90,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the type of the output connection 'idx'. + Returns the type of the output connection [code]idx[/code]. </description> </method> <method name="get_slot_color_left" qualifiers="const"> @@ -99,7 +99,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the color set to 'idx' left (input) slot. + Returns the color set to [code]idx[/code] left (input) slot. </description> </method> <method name="get_slot_color_right" qualifiers="const"> @@ -108,7 +108,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the color set to 'idx' right (output) slot. + Returns the color set to [code]idx[/code] right (output) slot. </description> </method> <method name="get_slot_type_left" qualifiers="const"> @@ -117,7 +117,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the (integer) type of left (input) 'idx' slot. + Returns the (integer) type of left (input) [code]idx[/code] slot. </description> </method> <method name="get_slot_type_right" qualifiers="const"> @@ -126,7 +126,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the (integer) type of right (output) 'idx' slot. + Returns the (integer) type of right (output) [code]idx[/code] slot. </description> </method> <method name="is_slot_enabled_left" qualifiers="const"> @@ -135,7 +135,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns [code]true[/code] if left (input) slot 'idx' is enabled, [code]false[/code] otherwise. + Returns [code]true[/code] if left (input) slot [code]idx[/code] is enabled, [code]false[/code] otherwise. </description> </method> <method name="is_slot_enabled_right" qualifiers="const"> @@ -144,7 +144,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns [code]true[/code] if right (output) slot 'idx' is enabled, [code]false[/code] otherwise. + Returns [code]true[/code] if right (output) slot [code]idx[/code] is enabled, [code]false[/code] otherwise. </description> </method> <method name="set_slot"> @@ -176,7 +176,8 @@ <member name="comment" type="bool" setter="set_comment" getter="is_comment"> </member> <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> - The offset of the GraphNode, relative to the scroll offset of the [GraphEdit]. Note that you cannot use position directly, as [GraphEdit] is a [Container]. + The offset of the GraphNode, relative to the scroll offset of the [GraphEdit]. + [b]Note:[/b] You cannot use position directly, as [GraphEdit] is a [Container]. </member> <member name="overlay" type="int" setter="set_overlay" getter="get_overlay" enum="GraphNode.Overlay"> </member> diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml index 94d805e3f6..ba6b55be21 100644 --- a/doc/classes/GridContainer.xml +++ b/doc/classes/GridContainer.xml @@ -4,7 +4,7 @@ Grid container used to arrange elements in a grid like layout. </brief_description> <description> - Grid container will arrange its children in a grid like structure, the grid columns are specified using the [member columns] property and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. + Grid container will arrange its children in a grid like structure, the grid columns are specified using the [member columns] property and the number of rows will be equal to the number of children in the container divided by the number of columns. For example, if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. </description> <tutorials> </tutorials> diff --git a/doc/classes/GrooveJoint2D.xml b/doc/classes/GrooveJoint2D.xml index dd758d0bd3..295338682e 100644 --- a/doc/classes/GrooveJoint2D.xml +++ b/doc/classes/GrooveJoint2D.xml @@ -12,10 +12,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] + 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] + 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/HSeparator.xml b/doc/classes/HSeparator.xml index c2c22d3bcd..ad607292a1 100644 --- a/doc/classes/HSeparator.xml +++ b/doc/classes/HSeparator.xml @@ -4,7 +4,7 @@ Horizontal separator. </brief_description> <description> - Horizontal separator. See [Separator]. It is used to separate objects vertically, though (but it looks horizontal!). + Horizontal separator. See [Separator]. Even though it looks horizontal, it is used to separate objects vertically. </description> <tutorials> </tutorials> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 325e6ca48e..1c0f0e5440 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -4,8 +4,8 @@ Hyper-text transfer protocol client. </brief_description> <description> - Hyper-text transfer protocol client (sometimes called "User Agent"). Used to make HTTP requests to download web content, upload files and other data or to communicate with various services, among other use cases. - Note that this client only needs to connect to a host once (see [method connect_to_host]) to send multiple requests. Because of this, methods that take URLs usually take just the part after the host instead of the full URL, as the client is already connected to a host. See [method request] for a full example and to get started. + Hyper-text transfer protocol client (sometimes called "User Agent"). Used to make HTTP requests to download web content, upload files and other data or to communicate with various services, among other use cases. See [HTTPRequest] for an higher-level alternative. + [b]Note:[/b] This client only needs to connect to a host once (see [method connect_to_host]) to send multiple requests. Because of this, methods that take URLs usually take just the part after the host instead of the full URL, as the client is already connected to a host. See [method request] for a full example and to get started. A [HTTPClient] should be reused between multiple requests or to connect to different hosts instead of creating one client per request. Supports SSL and SSL server certificate verification. HTTP status codes in the 2xx range indicate success, 3xx redirection (i.e. "try again, but over here"), 4xx something was wrong with the request, and 5xx something went wrong on the server's side. For more information on HTTP, see https://developer.mozilla.org/en-US/docs/Web/HTTP (or read RFC 2616 to get it straight from the source: https://tools.ietf.org/html/rfc2616). </description> @@ -33,7 +33,7 @@ <argument index="3" name="verify_host" type="bool" default="true"> </argument> <description> - Connect to a host. This needs to be done before any requests are sent. + Connects to a host. This needs to be done before any requests are sent. The host should not have http:// prepended but will strip the protocol identifier if provided. If no [code]port[/code] is specified (or [code]-1[/code] is used), it is automatically set to 80 for HTTP and 443 for HTTPS (if [code]use_ssl[/code] is enabled). [code]verify_host[/code] will check the SSL identity of the host if set to [code]true[/code]. @@ -64,16 +64,21 @@ <return type="Dictionary"> </return> <description> - Returns all response headers as dictionary where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. - Structure: ("key":"value1; value2") - Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Returns all response headers as a Dictionary of structure [code]{ "key": "value1; value2" }[/code] where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. + [b]Example:[/b] + [codeblock] + { + "content-length": 12, + "Content-Type": "application/json; charset=UTF-8", + } + [/codeblock] </description> </method> <method name="get_status" qualifiers="const"> <return type="int" enum="HTTPClient.Status"> </return> <description> - Returns a STATUS_* enum constant. Need to call [method poll] in order to get status updates. + Returns a [code]STATUS_*[/code] enum constant. Need to call [method poll] in order to get status updates. </description> </method> <method name="has_response" qualifiers="const"> @@ -107,13 +112,13 @@ [codeblock] var fields = {"username": "user", "password": "pass"} String query_string = http_client.query_string_from_dict(fields) - # returns: "username=user&password=pass" + # Returns "username=user&password=pass" [/codeblock] - Furthermore, if a key has a null value, only the key itself is added, without equal sign and value. If the value is an array, for each value in it a pair with the same key is added. + Furthermore, if a key has a [code]null[/code] value, only the key itself is added, without equal sign and value. If the value is an array, for each value in it a pair with the same key is added. [codeblock] var fields = {"single": 123, "not_valued": null, "multiple": [22, 33, 44]} String query_string = http_client.query_string_from_dict(fields) - # returns: "single=123&not_valued&multiple=22&multiple=33&multiple=44" + # Returns "single=123&not_valued&multiple=22&multiple=33&multiple=44" [/codeblock] </description> </method> @@ -298,10 +303,10 @@ HTTP status code [code]304 Not Modified[/code]. A conditional GET or HEAD request has been received and would have resulted in a 200 OK response if it were not for the fact that the condition evaluated to [code]false[/code]. </constant> <constant name="RESPONSE_USE_PROXY" value="305" enum="ResponseCode"> - HTTP status code [code]305 Use Proxy[/code]. Deprecated. Do not use. + HTTP status code [code]305 Use Proxy[/code]. [i]Deprecated. Do not use.[/i] </constant> <constant name="RESPONSE_SWITCH_PROXY" value="306" enum="ResponseCode"> - HTTP status code [code]306 Switch Proxy[/code]. Deprecated. Do not use. + HTTP status code [code]306 Switch Proxy[/code]. [i]Deprecated. Do not use.[/i] </constant> <constant name="RESPONSE_TEMPORARY_REDIRECT" value="307" enum="ResponseCode"> HTTP status code [code]307 Temporary Redirect[/code]. The target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 58833bd84b..eed81e4a8c 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -83,7 +83,7 @@ <argument index="3" name="body" type="PoolByteArray"> </argument> <description> - This signal is emitted upon request completion. + Emitted when a request is completed. </description> </signal> </signals> diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index 2fde885ee8..0a4c4d6564 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -4,7 +4,7 @@ A hinge between two 3D bodies. </brief_description> <description> - Normally uses the z-axis of body A as the hinge axis, another axis can be specified when adding it manually though. + A HingeJoint normally uses the Z axis of body A as the hinge axis, another axis can be specified when adding it manually though. </description> <tutorials> </tutorials> @@ -18,7 +18,7 @@ If [code]true[/code], the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects. </member> <member name="angular_limit/lower" type="float" setter="_set_lower_limit" getter="_get_lower_limit"> - The minimum rotation. only active if [member angular_limit/enable] is [code]true[/code]. + The minimum rotation. Only active if [member angular_limit/enable] is [code]true[/code]. </member> <member name="angular_limit/relaxation" type="float" setter="set_param" getter="get_param"> The lower this value, the more the rotation gets slowed down. @@ -26,7 +26,7 @@ <member name="angular_limit/softness" type="float" setter="set_param" getter="get_param"> </member> <member name="angular_limit/upper" type="float" setter="_set_upper_limit" getter="_get_upper_limit"> - The maximum rotation. only active if [member angular_limit/enable] is [code]true[/code]. + The maximum rotation. Only active if [member angular_limit/enable] is [code]true[/code]. </member> <member name="motor/enable" type="bool" setter="set_flag" getter="get_flag"> When activated, a motor turns the hinge. @@ -46,10 +46,10 @@ The speed with which the two bodies get pulled together when they move in different directions. </constant> <constant name="PARAM_LIMIT_UPPER" value="1" enum="Param"> - The maximum rotation. only active if [member angular_limit/enable] is [code]true[/code]. + The maximum rotation. Only active if [member angular_limit/enable] is [code]true[/code]. </constant> <constant name="PARAM_LIMIT_LOWER" value="2" enum="Param"> - The minimum rotation. only active if [member angular_limit/enable] is [code]true[/code]. + The minimum rotation. Only active if [member angular_limit/enable] is [code]true[/code]. </constant> <constant name="PARAM_LIMIT_BIAS" value="3" enum="Param"> The speed with which the rotation across the axis perpendicular to the hinge gets corrected. diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index 1d64ee1085..b8b5f0bd39 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="IP" inherits="Object" category="Core" version="3.2"> <brief_description> - Internet protocol (IP) support functions like DNS resolution. + Internet protocol (IP) support functions such as DNS resolution. </brief_description> <description> IP contains support functions for the Internet Protocol (IP). TCP/IP support is in different classes (see [StreamPeerTCP] and [TCP_Server]). IP provides DNS hostname resolution support, both blocking and threaded. @@ -15,7 +15,7 @@ <argument index="0" name="hostname" type="String" default=""""> </argument> <description> - Removes all of a "hostname"'s cached references. If no "hostname" is given then all cached IP addresses are removed. + Removes all of a [code]hostname[/code]'s cached references. If no [code]hostname[/code] is given, all cached IP addresses are removed. </description> </method> <method name="erase_resolve_item"> @@ -24,7 +24,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Removes a given item "id" from the queue. This should be used to free a queue after it has completed to enable more queries to happen. + Removes a given item [code]id[/code] from the queue. This should be used to free a queue after it has completed to enable more queries to happen. </description> </method> <method name="get_local_addresses" qualifiers="const"> @@ -56,7 +56,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns a queued hostname's IP address, given its queue "id". Returns an empty string on error or if resolution hasn't happened yet (see [method get_resolve_item_status]). + Returns a queued hostname's IP address, given its queue [code]id[/code]. Returns an empty string on error or if resolution hasn't happened yet (see [method get_resolve_item_status]). </description> </method> <method name="get_resolve_item_status" qualifiers="const"> @@ -65,7 +65,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns a queued hostname's status as a RESOLVER_STATUS_* constant, given its queue "id". + Returns a queued hostname's status as a [code]RESOLVER_STATUS_*[/code] constant, given its queue [code]id[/code]. </description> </method> <method name="resolve_hostname"> @@ -76,7 +76,7 @@ <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> </argument> <description> - Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the TYPE_* constant given as "ip_type". + Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the [code]TYPE_*[/code] constant given as [code]ip_type[/code]. </description> </method> <method name="resolve_hostname_queue_item"> @@ -87,7 +87,7 @@ <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> </argument> <description> - Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the TYPE_* constant given as "ip_type". Returns the queue ID if successful, or RESOLVER_INVALID_ID on error. + Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the [code]TYPE_*[/code] constant given as [code]ip_type[/code]. Returns the queue ID if successful, or [constant RESOLVER_INVALID_ID] on error. </description> </method> </methods> diff --git a/doc/classes/IP_Unix.xml b/doc/classes/IP_Unix.xml index 4e09bf5dc0..2a97c40ef8 100644 --- a/doc/classes/IP_Unix.xml +++ b/doc/classes/IP_Unix.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="IP_Unix" inherits="IP" category="Core" version="3.2"> <brief_description> - Unix IP support. See [IP]. + UNIX IP support. See [IP]. </brief_description> <description> - Unix-specific implementation of IP support functions. See [IP]. + UNIX-specific implementation of IP support functions. See [IP]. </description> <tutorials> </tutorials> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index f2b6ddc7e9..501210cb92 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -123,7 +123,7 @@ <argument index="3" name="format" type="int" enum="Image.Format"> </argument> <description> - Creates an empty image of given size and format. See [code]FORMAT_*[/code] constants. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [code]generate_mipmaps[/code] method. + Creates an empty image of given size and format. See [code]FORMAT_*[/code] constants. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps]. </description> </method> <method name="create_from_data"> @@ -140,7 +140,7 @@ <argument index="4" name="data" type="PoolByteArray"> </argument> <description> - Creates a new image of given size and format. See [code]FORMAT_*[/code] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [code]generate_mipmaps[/code] method. + Creates a new image of given size and format. See [code]FORMAT_*[/code] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps]. </description> </method> <method name="crop"> @@ -485,126 +485,141 @@ <constant name="FORMAT_LA8" value="1" enum="Format"> </constant> <constant name="FORMAT_R8" value="2" enum="Format"> - OpenGL texture format RED with a single component and a bitdepth of 8. + OpenGL texture format [code]RED[/code] with a single component and a bitdepth of 8. </constant> <constant name="FORMAT_RG8" value="3" enum="Format"> - OpenGL texture format RG with two components and a bitdepth of 8 for each. + OpenGL texture format [code]RG[/code] with two components and a bitdepth of 8 for each. </constant> <constant name="FORMAT_RGB8" value="4" enum="Format"> - OpenGL texture format RGB with three components, each with a bitdepth of 8. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + OpenGL texture format [code]RGB[/code] with three components, each with a bitdepth of 8. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_RGBA8" value="5" enum="Format"> - OpenGL texture format RGBA with four components, each with a bitdepth of 8. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + OpenGL texture format [code]RGBA[/code] with four components, each with a bitdepth of 8. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_RGBA4444" value="6" enum="Format"> - OpenGL texture format RGBA with four components, each with a bitdepth of 4. + OpenGL texture format [code]RGBA[/code] with four components, each with a bitdepth of 4. </constant> <constant name="FORMAT_RGBA5551" value="7" enum="Format"> - OpenGL texture format GL_RGB5_A1 where 5 bits of depth for each component of RGB and one bit for alpha. + OpenGL texture format [code]GL_RGB5_A1[/code] where 5 bits of depth for each component of RGB and one bit for alpha. </constant> <constant name="FORMAT_RF" value="8" enum="Format"> - OpenGL texture format GL_R32F where there's one component, a 32-bit floating-point value. + OpenGL texture format [code]GL_R32F[/code] where there's one component, a 32-bit floating-point value. </constant> <constant name="FORMAT_RGF" value="9" enum="Format"> - OpenGL texture format GL_RG32F where there are two components, each a 32-bit floating-point values. + OpenGL texture format [code]GL_RG32F[/code] where there are two components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RGBF" value="10" enum="Format"> - OpenGL texture format GL_RGB32F where there are three components, each a 32-bit floating-point values. + OpenGL texture format [code]GL_RGB32F[/code] where there are three components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RGBAF" value="11" enum="Format"> - OpenGL texture format GL_RGBA32F where there are four components, each a 32-bit floating-point values. + OpenGL texture format [code]GL_RGBA32F[/code] where there are four components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RH" value="12" enum="Format"> - OpenGL texture format GL_R32F where there's one component, a 16-bit "half-precision" floating-point value. + OpenGL texture format [code]GL_R32F[/code] where there's one component, a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGH" value="13" enum="Format"> - OpenGL texture format GL_RG32F where there's two components, each a 16-bit "half-precision" floating-point value. + OpenGL texture format [code]GL_RG32F[/code] where there are two components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBH" value="14" enum="Format"> - OpenGL texture format GL_RGB32F where there's three components, each a 16-bit "half-precision" floating-point value. + OpenGL texture format [code]GL_RGB32F[/code] where there are three components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBAH" value="15" enum="Format"> - OpenGL texture format GL_RGBA32F where there's four components, each a 16-bit "half-precision" floating-point value. + OpenGL texture format [code]GL_RGBA32F[/code] where there are four components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBE9995" value="16" enum="Format"> - A special OpenGL texture format where the three color components have 9 bits of precision and all three share a single exponent. + A special OpenGL texture format where the three color components have 9 bits of precision and all three share a single 5-bit exponent. </constant> <constant name="FORMAT_DXT1" value="17" enum="Format"> - The S3TC texture format that uses Block Compression 1, and is the smallest variation of S3TC, only providing 1 bit of alpha and color data being premultiplied with alpha. More information can be found at https://www.khronos.org/opengl/wiki/S3_Texture_Compression. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format that uses Block Compression 1, and is the smallest variation of S3TC, only providing 1 bit of alpha and color data being premultiplied with alpha. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_DXT3" value="18" enum="Format"> - The S3TC texture format that uses Block Compression 2, and color data is interpreted as not having been premultiplied by alpha. Well suited for images with sharp alpha transitions between translucent and opaque areas. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format that uses Block Compression 2, and color data is interpreted as not having been premultiplied by alpha. Well suited for images with sharp alpha transitions between translucent and opaque areas. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_DXT5" value="19" enum="Format"> - The S3TC texture format also known as Block Compression 3 or BC3 that contains 64 bits of alpha channel data followed by 64 bits of DXT1-encoded color data. Color data is not premultiplied by alpha, same as DXT3. DXT5 generally produces superior results for transparency gradients than DXT3. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format also known as Block Compression 3 or BC3 that contains 64 bits of alpha channel data followed by 64 bits of DXT1-encoded color data. Color data is not premultiplied by alpha, same as DXT3. DXT5 generally produces superior results for transparent gradients compared to DXT3. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_RGTC_R" value="20" enum="Format"> - Texture format that uses Red Green Texture Compression, normalizing the red channel data using the same compression algorithm that DXT5 uses for the alpha channel. More information can be found here https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression. + Texture format that uses [url=https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression]Red Green Texture Compression[/url], normalizing the red channel data using the same compression algorithm that DXT5 uses for the alpha channel. </constant> <constant name="FORMAT_RGTC_RG" value="21" enum="Format"> - Texture format that uses Red Green Texture Compression, normalizing the red and green channel data using the same compression algorithm that DXT5 uses for the alpha channel. + Texture format that uses [url=https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression]Red Green Texture Compression[/url], normalizing the red and green channel data using the same compression algorithm that DXT5 uses for the alpha channel. </constant> <constant name="FORMAT_BPTC_RGBA" value="22" enum="Format"> - Texture format that uses BPTC compression with unsigned normalized RGBA components. More information can be found at https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + Texture format that uses [url=https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression]BPTC[/url] compression with unsigned normalized RGBA components. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_BPTC_RGBF" value="23" enum="Format"> - Texture format that uses BPTC compression with signed floating-point RGB components. + Texture format that uses [url=https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression]BPTC[/url] compression with signed floating-point RGB components. </constant> <constant name="FORMAT_BPTC_RGBFU" value="24" enum="Format"> - Texture format that uses BPTC compression with unsigned floating-point RGB components. + Texture format that uses [url=https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression]BPTC[/url] compression with unsigned floating-point RGB components. </constant> <constant name="FORMAT_PVRTC2" value="25" enum="Format"> - Texture format used on PowerVR-supported mobile platforms, uses 2 bit color depth with no alpha. More information on PVRTC can be found here https://en.wikipedia.org/wiki/PVRTC. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + Texture format used on PowerVR-supported mobile platforms, uses 2-bit color depth with no alpha. More information can be found [url=https://en.wikipedia.org/wiki/PVRTC]here[/url]. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_PVRTC2A" value="26" enum="Format"> - Same as PVRTC2, but with an alpha component. + Same as [url=https://en.wikipedia.org/wiki/PVRTC]PVRTC2[/url], but with an alpha component. </constant> <constant name="FORMAT_PVRTC4" value="27" enum="Format"> - Similar to PVRTC2, but with 4 bit color depth and no alpha. + Similar to [url=https://en.wikipedia.org/wiki/PVRTC]PVRTC2[/url], but with 4-bit color depth and no alpha. </constant> <constant name="FORMAT_PVRTC4A" value="28" enum="Format"> - Same as PVRTC4, but with an alpha component. + Same as [url=https://en.wikipedia.org/wiki/PVRTC]PVRTC4[/url], but with an alpha component. </constant> <constant name="FORMAT_ETC" value="29" enum="Format"> - Ericsson Texture Compression format, also referred to as 'ETC1', and is part of the OpenGL ES graphics standard. An overview of the format is given at https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC1. + [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC1]Ericsson Texture Compression format 1[/url], also referred to as "ETC1", and is part of the OpenGL ES graphics standard. This format cannot store an alpha channel. </constant> <constant name="FORMAT_ETC2_R11" value="30" enum="Format"> - Ericsson Texture Compression format 2 variant R11_EAC, which provides one channel of unsigned data. + [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] ([code]R11_EAC[/code] variant), which provides one channel of unsigned data. </constant> <constant name="FORMAT_ETC2_R11S" value="31" enum="Format"> - Ericsson Texture Compression format 2 variant SIGNED_R11_EAC, which provides one channel of signed data. + [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] ([code]SIGNED_R11_EAC[/code] variant), which provides one channel of signed data. </constant> <constant name="FORMAT_ETC2_RG11" value="32" enum="Format"> - Ericsson Texture Compression format 2 variant RG11_EAC, which provides two channels of unsigned data. + [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] ([code]RG11_EAC[/code] variant), which provides two channels of unsigned data. </constant> <constant name="FORMAT_ETC2_RG11S" value="33" enum="Format"> - Ericsson Texture Compression format 2 variant SIGNED_RG11_EAC, which provides two channels of signed data. + [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] ([code]SIGNED_RG11_EAC[/code] variant), which provides two channels of signed data. </constant> <constant name="FORMAT_ETC2_RGB8" value="34" enum="Format"> - Ericsson Texture Compression format 2 variant RGB8, which is a followup of ETC1 and compresses RGB888 data. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] ([code]RGB8[/code] variant), which is a follow-up of ETC1 and compresses RGB888 data. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_ETC2_RGBA8" value="35" enum="Format"> - Ericsson Texture Compression format 2 variant RGBA8, which compresses RGBA8888 data with full alpha support. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] ([code]RGBA8[/code]variant), which compresses RGBA8888 data with full alpha support. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_ETC2_RGB8A1" value="36" enum="Format"> - Ericsson Texture Compression format 2 variant RGB8_PUNCHTHROUGH_ALPHA1, which compresses RGBA data to make alpha either fully transparent or fully opaque. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed. + [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] ([code]RGB8_PUNCHTHROUGH_ALPHA1[/code] variant), which compresses RGBA data to make alpha either fully transparent or fully opaque. + [b]Note:[/b] When creating an [ImageTexture], an sRGB to linear color space conversion is performed. </constant> <constant name="FORMAT_MAX" value="37" enum="Format"> Represents the size of the [enum Format] enum. </constant> <constant name="INTERPOLATE_NEAREST" value="0" enum="Interpolation"> + Performs nearest-neighbor interpolation. If the image is resized, it will be pixelated. </constant> <constant name="INTERPOLATE_BILINEAR" value="1" enum="Interpolation"> + Performs bilinear interpolation. If the image is resized, it will be blurry. This mode is faster than [constant INTERPOLATE_CUBIC], but it results in lower quality. </constant> <constant name="INTERPOLATE_CUBIC" value="2" enum="Interpolation"> + Performs cubic interpolation. If the image is resized, it will be blurry. This mode often gives better results compared to [constant INTERPOLATE_BILINEAR], at the cost of being slower. </constant> <constant name="INTERPOLATE_TRILINEAR" value="3" enum="Interpolation"> - Performs bilinear separately on the two most suited mipmap levels, then linearly interpolates between them. - It's slower than [constant INTERPOLATE_BILINEAR], but produces higher quality results, with much less aliasing artifacts. - If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image. (Note that if you intend to scale multiple copies of the original image, it's better to call [code]generate_mipmaps[/code] on it in advance, to avoid wasting processing power in generating them again and again.) + Performs bilinear separately on the two most-suited mipmap levels, then linearly interpolates between them. + It's slower than [constant INTERPOLATE_BILINEAR], but produces higher-quality results with much less aliasing artifacts. + If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image. + [b]Note:[/b] If you intend to scale multiple copies of the original image, it's better to call [method generate_mipmaps]] on it in advance, to avoid wasting processing power in generating them again and again. On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image. </constant> <constant name="INTERPOLATE_LANCZOS" value="4" enum="Interpolation"> + Performs Lanczos interpolation. This is the slowest image resizing mode, but it typically gives the best results, especially when downscalng images. </constant> <constant name="ALPHA_NONE" value="0" enum="AlphaMode"> </constant> diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index 00a3c5c614..0be09d1c8d 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -58,7 +58,7 @@ <argument index="0" name="image" type="Image"> </argument> <description> - Set the [Image] of this [ImageTexture]. + Sets the [Image] of this [ImageTexture]. </description> </method> <method name="set_size_override"> diff --git a/doc/classes/ImmediateGeometry.xml b/doc/classes/ImmediateGeometry.xml index ca45fc5f9e..ddfd3d74d5 100644 --- a/doc/classes/ImmediateGeometry.xml +++ b/doc/classes/ImmediateGeometry.xml @@ -21,7 +21,7 @@ <argument index="3" name="add_uv" type="bool" default="true"> </argument> <description> - Simple helper to draw a uvsphere, with given latitudes, longitude and radius. + Simple helper to draw an UV sphere with given latitude, longitude and radius. </description> </method> <method name="add_vertex"> @@ -42,7 +42,7 @@ </argument> <description> Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references. - For the type of primitive, use the [Mesh].PRIMITIVE_* enumerations. + For the type of primitive, use the [Mesh].[code]PRIMITIVE_*[/code] enumerations. </description> </method> <method name="clear"> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 1c2826ee57..cae8356094 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -4,7 +4,7 @@ A Singleton that deals with inputs. </brief_description> <description> - A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. + A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the [b]Input Map[/b] tab in the [b]Project > Project Settings[/b], or with the [InputMap] class. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/inputs/index.html</link> @@ -39,7 +39,7 @@ <argument index="1" name="update_existing" type="bool" default="false"> </argument> <description> - Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. + Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. </description> </method> <method name="get_accelerometer" qualifiers="const"> @@ -83,7 +83,7 @@ <return type="Vector3"> </return> <description> - If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis. Otherwise, it returns an empty [Vector3]. + If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's X, Y, and Z axes. Otherwise, it returns an empty [Vector3]. </description> </method> <method name="get_joy_axis" qualifiers="const"> @@ -130,7 +130,7 @@ <argument index="0" name="button_index" type="int"> </argument> <description> - Receives a joy button from [enum JoystickList] and returns its equivalent name as a string. + Receives a gamepad button from [enum JoystickList] and returns its equivalent name as a string. </description> </method> <method name="get_joy_guid" qualifiers="const"> @@ -139,7 +139,7 @@ <argument index="0" name="device" type="int"> </argument> <description> - Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise. + Returns a SDL2-compatible device GUID on platforms that use gamepad remapping. Returns [code]"Default Gamepad"[/code] otherwise. </description> </method> <method name="get_joy_name"> @@ -148,7 +148,7 @@ <argument index="0" name="device" type="int"> </argument> <description> - Returns the name of the joypad at the specified device index + Returns the name of the joypad at the specified device index. </description> </method> <method name="get_joy_vibration_duration"> @@ -187,7 +187,7 @@ <return type="int"> </return> <description> - Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together. + Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. </description> </method> <method name="get_mouse_mode" qualifiers="const"> @@ -292,7 +292,7 @@ <argument index="0" name="guid" type="String"> </argument> <description> - Removes all mappings from the internal db that match the given uid. + Removes all mappings from the internal database that match the given GUID. </description> </method> <method name="set_custom_mouse_cursor"> @@ -306,7 +306,7 @@ </argument> <description> Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See enum [code]CURSOR_*[/code] for the list of shapes. - [code]image[/code]'s size must be lower than 256x256. + [code]image[/code]'s size must be lower than 256×256. [code]hotspot[/code] must be within [code]image[/code]'s size. </description> </method> @@ -317,7 +317,7 @@ </argument> <description> Sets the default cursor shape to be used in the viewport instead of [constant CURSOR_ARROW]. - Note that if you want to change the default cursor shape for [Control]'s nodes, use [member Control.mouse_default_cursor_shape] instead. + [b]Note:[/b] If you want to change the default cursor shape for [Control]'s nodes, use [member Control.mouse_default_cursor_shape] instead. </description> </method> <method name="set_mouse_mode"> @@ -326,7 +326,7 @@ <argument index="0" name="mode" type="int" enum="Input.MouseMode"> </argument> <description> - Set the mouse mode. See the constants for more information. + Sets the mouse mode. See the constants for more information. </description> </method> <method name="set_use_accumulated_input"> @@ -350,8 +350,8 @@ <argument index="3" name="duration" type="float" default="0"> </argument> <description> - Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). - Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds. + Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. [code]weak_magnitude[/code] is the strength of the weak motor (between 0 and 1) and [code]strong_magnitude[/code] is the strength of the strong motor (between 0 and 1). [code]duration[/code] is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). + [b]Note:[/b] Not every hardware is compatible with long effect durations; it is recommended to restart an effect if it has to be played for more than a few seconds. </description> </method> <method name="stop_joy_vibration"> @@ -392,7 +392,7 @@ Makes the mouse cursor hidden if it is visible. </constant> <constant name="MOUSE_MODE_CAPTURED" value="2" enum="MouseMode"> - Captures the mouse. The mouse will be hidden and unable to leave the game window. But it will still register movement and mouse button presses. + Captures the mouse. The mouse will be hidden and unable to leave the game window, but it will still register movement and mouse button presses. </constant> <constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode"> Makes the mouse cursor visible but confines it to the game window. @@ -410,10 +410,10 @@ Cross cursor. Typically appears over regions in which a drawing operation can be performed or for selections. </constant> <constant name="CURSOR_WAIT" value="4" enum="CursorShape"> - Wait cursor. Indicates that the application is busy performing an operation. + Wait cursor. Indicates that the application is busy performing an operation. This cursor shape denotes that the application is still usable during the operation. </constant> <constant name="CURSOR_BUSY" value="5" enum="CursorShape"> - Busy cursor. See [constant CURSOR_WAIT]. + Busy cursor. Indicates that the application is busy performing an operation. This cursor shape denotes that the application isn't usable during the operation (e.g. something is blocking its main thread). </constant> <constant name="CURSOR_DRAG" value="6" enum="CursorShape"> Drag cursor. Usually displayed when dragging something. @@ -425,16 +425,16 @@ Forbidden cursor. Indicates that the current action is forbidden (for example, when dragging something) or that the control at a position is disabled. </constant> <constant name="CURSOR_VSIZE" value="9" enum="CursorShape"> - Vertical resize mouse cursor. A double headed vertical arrow. It tells the user they can resize the window or the panel vertically. + Vertical resize mouse cursor. A double-headed vertical arrow. It tells the user they can resize the window or the panel vertically. </constant> <constant name="CURSOR_HSIZE" value="10" enum="CursorShape"> - Horizontal resize mouse cursor. A double headed horizontal arrow. It tells the user they can resize the window or the panel horizontally. + Horizontal resize mouse cursor. A double-headed horizontal arrow. It tells the user they can resize the window or the panel horizontally. </constant> <constant name="CURSOR_BDIAGSIZE" value="11" enum="CursorShape"> - Window resize mouse cursor. The cursor is a double headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically. + Window resize mouse cursor. The cursor is a double-headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically. </constant> <constant name="CURSOR_FDIAGSIZE" value="12" enum="CursorShape"> - Window resize mouse cursor. The cursor is a double headed arrow that goes from the top left to the bottom right, the opposite of [constant CURSOR_BDIAGSIZE]. It tells the user they can resize the window or the panel both horizontally and vertically. + Window resize mouse cursor. The cursor is a double-headed arrow that goes from the top left to the bottom right, the opposite of [constant CURSOR_BDIAGSIZE]. It tells the user they can resize the window or the panel both horizontally and vertically. </constant> <constant name="CURSOR_MOVE" value="13" enum="CursorShape"> Move cursor. Indicates that something can be moved. diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index 9df7bbca74..f5b93fd73e 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -4,7 +4,7 @@ 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]. + Contains a generic action which can be targeted from several types of inputs. Actions can be created from the [b]Input Map[/b] tab in the [b]Project > Project Settings[/b] menu. See [method Node._input]. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html#actions</link> @@ -19,7 +19,7 @@ If [code]true[/code], the action's state is pressed. If [code]false[/code], the action's state is released. </member> <member name="strength" type="float" setter="set_strength" getter="get_strength"> - The action's strength between 0 and 1. This value is consired as equal to 0 if pressed is [code]false[/code]. The event strength allows faking analog joypad motion events, by precising how strongly is the joypad axis bent or pressed. + The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is [code]false[/code]. The event strength allows faking analog joypad motion events, by precising how strongly is the joypad axis bent or pressed. </member> </members> <constants> diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index 78cd55b79a..9df25d59e1 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -4,7 +4,7 @@ Input event for gamepad buttons. </brief_description> <description> - Input event type for gamepad buttons. For joysticks see [InputEventJoypadMotion]. + Input event type for gamepad buttons. For gamepad analog sticks and joysticks, see [InputEventJoypadMotion]. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index 5330b2a6e0..a5deacdf0a 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.2"> <brief_description> - Input event type for gamepad joysticks and other motions. For buttons see [code]InputEventJoypadButton[/code]. + Input event type for gamepad joysticks and other motions. For buttons, see [code]InputEventJoypadButton[/code]. </brief_description> <description> Stores information about joystick motions. One [InputEventJoypadMotion] represents one axis at a time. diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 53b1f74bd4..0fe288cbda 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -29,7 +29,7 @@ Key scancode, one of the [enum KeyList] constants. </member> <member name="unicode" type="int" setter="set_unicode" getter="get_unicode"> - Key unicode identifier when relevant. Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information. + Key Unicode identifier when relevant. Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information. </member> </members> <constants> diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 8ba272d470..001be82c8d 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -13,13 +13,13 @@ </methods> <members> <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask"> - Mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks. + The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks. </member> <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position"> - Mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0. + The global 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"> - Mouse local position relative to the [Viewport]. If used in [method Control._gui_input] the position is relative to the current [Control] which is under the mouse. + The local mouse position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] which is under the mouse. </member> </members> <constants> diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index 99e25d2c6f..a2437ca450 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -13,13 +13,13 @@ </methods> <members> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index"> - Mouse button identifier, one of the [enum ButtonList] button or button wheel constants. + The mouse button identifier, one of the [enum ButtonList] button or button wheel constants. </member> <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick"> If [code]true[/code], the mouse button's state is a double-click. </member> <member name="factor" type="float" setter="set_factor" getter="get_factor"> - Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scroll amount (vertically or horizontally). Only supported on some platforms, sensitivity varies by platform. May be 0 if not supported. + The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be [code]0[/code] if not supported. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> If [code]true[/code], the mouse button's state is pressed. If [code]false[/code], the mouse button's state is released. diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 3df47177dc..a96543e4c2 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -13,10 +13,10 @@ </methods> <members> <member name="relative" type="Vector2" setter="set_relative" getter="get_relative"> - Mouse position relative to the previous position (position at the last frame). + The mouse position relative to the previous position (position at the last frame). </member> <member name="speed" type="Vector2" setter="set_speed" getter="get_speed"> - Mouse speed. + The mouse speed in pixels per second. </member> </members> <constants> diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index 36e47ee51a..5b18697791 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -1,8 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.2"> <brief_description> - Input event type for screen drag events. - (only available on mobile devices) + Input event type for screen drag events. Only available on mobile devices. </brief_description> <description> Contains screen drag information. See [method Node._input]. @@ -14,16 +13,16 @@ </methods> <members> <member name="index" type="int" setter="set_index" getter="get_index"> - Drag event index in the case of a multi-drag event. + The drag event index in the case of a multi-drag event. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position"> - Drag position. + The drag position. </member> <member name="relative" type="Vector2" setter="set_relative" getter="get_relative"> - Drag position relative to its start position. + The drag position relative to its start position. </member> <member name="speed" type="Vector2" setter="set_speed" getter="get_speed"> - Drag speed. + The drag speed. </member> </members> <constants> diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index 8f537f12bc..279425aca6 100644 --- a/doc/classes/InputEventScreenTouch.xml +++ b/doc/classes/InputEventScreenTouch.xml @@ -14,10 +14,10 @@ </methods> <members> <member name="index" type="int" setter="set_index" getter="get_index"> - Touch index in the case of a multi-touch event. One index = one finger. + The 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"> - Touch position. + The touch position. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> If [code]true[/code], the touch's state is pressed. If [code]false[/code], the touch's state is released. diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index bb29a09d22..6bbb402b15 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -4,7 +4,7 @@ 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]. + Manages all [InputEventAction] which can be created/modified from the project settings menu [b]Project > Project Settings > Input Map[/b] or in code with [method add_action] and [method action_add_event]. See [method Node._input]. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html#inputmap</link> diff --git a/doc/classes/InstancePlaceholder.xml b/doc/classes/InstancePlaceholder.xml index c4752c735d..4b98166ef2 100644 --- a/doc/classes/InstancePlaceholder.xml +++ b/doc/classes/InstancePlaceholder.xml @@ -24,7 +24,7 @@ <return type="String"> </return> <description> - Retrieve the path to the [PackedScene] resource file that is loaded by default when calling [method replace_by_instance]. + Gets the path to the [PackedScene] resource file that is loaded by default when calling [method replace_by_instance]. </description> </method> <method name="get_stored_values"> @@ -41,7 +41,7 @@ <argument index="0" name="custom_scene" type="PackedScene" default="null"> </argument> <description> - Replace this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided. + Replaces this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided. </description> </method> </methods> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index d78c930351..42a21016f8 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -5,7 +5,7 @@ </brief_description> <description> This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, or both text and icon. Tooltips are supported and may be different for every item in the list. - Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). + Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be "activated" by double-clicking them or by pressing Enter. </description> <tutorials> </tutorials> @@ -31,15 +31,15 @@ <argument index="2" name="selectable" type="bool" default="true"> </argument> <description> - Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. - If selectable is [code]true[/code] the list item will be selectable. + Adds an item to the item list with specified text. Specify an [code]icon[/code], or use [code]null[/code] as the [code]icon[/code] for a list item with no icon. + If selectable is [code]true[/code], the list item will be selectable. </description> </method> <method name="clear"> <return type="void"> </return> <description> - Remove all items from the list. + Removes all items from the list. </description> </method> <method name="ensure_current_is_visible"> @@ -91,7 +91,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the icon associated with the specified index. Default value is [code]null[/code] + Returns the icon associated with the specified index. Default value is [code]null[/code]. </description> </method> <method name="get_item_icon_modulate" qualifiers="const"> @@ -165,7 +165,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether or not the item at the specified index is disabled. + Returns [code]true[/code] if the item at the specified index is disabled. </description> </method> <method name="is_item_icon_transposed" qualifiers="const"> @@ -182,7 +182,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether or not the item at the specified index is selectable. + Returns [code]true[/code] if the item at the specified index is selectable. </description> </method> <method name="is_item_tooltip_enabled" qualifiers="const"> @@ -191,7 +191,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether the tooltip is enabled for specified item index. + Returns [code]true[/code] if the tooltip is enabled for specified item index. </description> </method> <method name="is_selected" qualifiers="const"> @@ -200,7 +200,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether or not item at the specified index is currently selected. + Returns [code]true[/code] if the item at the specified index is currently selected. </description> </method> <method name="move_item"> @@ -232,7 +232,7 @@ </argument> <description> Select the item at the specified index. - Note: This method does not trigger the item selection signal. + [b]Note:[/b] This method does not trigger the item selection signal. </description> </method> <method name="set_item_custom_bg_color"> @@ -273,8 +273,8 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> - Disable (or enable) item at the specified index. - Disabled items are not be selectable and do not trigger activation (Enter or double-click) signals. + Disables (or enables) the item at the specified index. + Disabled items cannot be selected and do not trigger activation signals (when double-clicking or pressing Enter). </description> </method> <method name="set_item_icon"> @@ -285,7 +285,7 @@ <argument index="1" name="icon" type="Texture"> </argument> <description> - Set (or replace) the icon's [Texture] associated with the specified index. + Sets (or replaces) the icon's [Texture] associated with the specified index. </description> </method> <method name="set_item_icon_modulate"> @@ -338,7 +338,7 @@ <argument index="1" name="selectable" type="bool"> </argument> <description> - Allow or disallow selection of the item associated with the specified index. + Allows or disallows selection of the item associated with the specified index. </description> </method> <method name="set_item_text"> @@ -360,7 +360,7 @@ <argument index="1" name="tooltip" type="String"> </argument> <description> - Sets tooltip hint for the item associated with the specified index. + Sets the tooltip hint for the item associated with the specified index. </description> </method> <method name="set_item_tooltip_enabled"> @@ -387,14 +387,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Ensure the item associated with the specified index is not selected. + Ensures the item associated with the specified index is not selected. </description> </method> <method name="unselect_all"> <return type="void"> </return> <description> - Ensure there are no items selected. + Ensures there are no items selected. </description> </method> </methods> @@ -409,8 +409,7 @@ If [code]true[/code], the control will automatically resize the height to fit its content. </member> <member name="fixed_column_width" type="int" setter="set_fixed_column_width" getter="get_fixed_column_width"> - Sets the default column width in pixels. - If left to default value, each item will have a width equal to the width of its content and the columns will have an uneven width. + Sets the default column width in pixels. If left to default value, each item will have a width equal to the width of its content and the columns will have an uneven width. </member> <member name="fixed_icon_size" type="Vector2" setter="set_fixed_icon_size" getter="get_fixed_icon_size"> Sets the default icon size in pixels. @@ -422,8 +421,7 @@ Sets the icon size to its initial size multiplied by the specified scale. Default value is 1.0. </member> <member name="max_columns" type="int" setter="set_max_columns" getter="get_max_columns"> - Sets the maximum columns the list will have. - If set to anything other than the default, the content will be split among the specified columns. + Sets the maximum columns the list will have. If set to anything other than the default, the content will be split among the specified columns. </member> <member name="max_text_lines" type="int" setter="set_max_text_lines" getter="get_max_text_lines"> </member> @@ -431,7 +429,7 @@ If set to [code]true[/code], all columns will have the same width specified by [member fixed_column_width]. </member> <member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="ItemList.SelectMode"> - Allow single or multiple item selection. See the [enum SelectMode] constants. + Allows single or multiple item selection. See the [enum SelectMode] constants. </member> </members> <signals> @@ -439,7 +437,7 @@ <argument index="0" name="index" type="int"> </argument> <description> - Triggered when specified list item is activated via double click or Enter. + Triggered when specified list item is activated via double-clicking or by pressing Enter. </description> </signal> <signal name="item_rmb_selected"> @@ -449,8 +447,7 @@ </argument> <description> Triggered when specified list item has been selected via right mouse clicking. - The click position is also provided to allow appropriate popup of context menus - at the correct location. + The click position is also provided to allow appropriate popup of context menus at the correct location. [member allow_rmb_select] must be enabled. </description> </signal> @@ -491,8 +488,10 @@ <constant name="ICON_MODE_LEFT" value="1" enum="IconMode"> </constant> <constant name="SELECT_SINGLE" value="0" enum="SelectMode"> + Only allow selecting a single item. </constant> <constant name="SELECT_MULTI" value="1" enum="SelectMode"> + Allows selecting multiple items by holding Ctrl or Shift. </constant> </constants> <theme_items> diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index cb62a1e88e..e834f5cb39 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -28,7 +28,7 @@ <argument index="2" name="sort_keys" type="bool" default="false"> </argument> <description> - Converts a Variant var to JSON text and returns the result. Useful for serializing data to store or send over the network. + Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network. </description> </method> </methods> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index c9caa5c5d4..f83c80924c 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 == OK[/code]. + Returned by [method JSON.parse], [JSONParseResult] contains the decoded JSON or error information if the JSON source wasn't successfully parsed. You can check if the JSON source was successfully parsed with [code]if json_result.error == OK[/code]. </description> <tutorials> </tutorials> @@ -12,22 +12,22 @@ </methods> <members> <member name="error" type="int" setter="set_error" getter="get_error" enum="Error"> - The error type if JSON source was not successfully parsed. See [@GlobalScope] ERR_* constants. + The error type if the JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants. </member> <member name="error_line" type="int" setter="set_error_line" getter="get_error_line"> The line number where the error occurred if JSON source was not successfully parsed. </member> <member name="error_string" type="String" setter="set_error_string" getter="get_error_string"> - The error message if JSON source was not successfully parsed. See [@GlobalScope] ERR_* constants. + The error message if JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants. </member> <member name="result" type="Variant" setter="set_result" getter="get_result"> - A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces ([code]{}[/code]) a [Dictionary] will be returned, if JSON source starts with braces ([code][][/code]) an [Array] will be returned. - [i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.[/i] - Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements:[/i] + A [Variant] containing the parsed JSON. Use [method @GDScript.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with braces ([code][][/code]), an [Array] will be returned. + [b]Note:[/b] The JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types. + [b]Note:[/b] JSON objects do not preserve key order like Godot dictionaries, thus, you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements: [codeblock] var p = JSON.parse('["hello", "world", "!"]') if typeof(p.result) == TYPE_ARRAY: - print(p.result[0]) # prints 'hello' + print(p.result[0]) # Prints "hello" else: print("unexpected results") [/codeblock] diff --git a/doc/classes/JavaScript.xml b/doc/classes/JavaScript.xml index 68b6831103..7737001a6c 100644 --- a/doc/classes/JavaScript.xml +++ b/doc/classes/JavaScript.xml @@ -4,7 +4,7 @@ Singleton that connects the engine with the browser's JavaScript context in HTML5 export. </brief_description> <description> - The JavaScript singleton is implemented only in HTML5 export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. + The JavaScript singleton is implemented only in the HTML5 export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script</link> diff --git a/doc/classes/Joint.xml b/doc/classes/Joint.xml index 5cd59852df..0235c841b7 100644 --- a/doc/classes/Joint.xml +++ b/doc/classes/Joint.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Joint" inherits="Spatial" category="Core" version="3.2"> <brief_description> - Base class for all 3D joints + Base class for all 3D joints. </brief_description> <description> Joints are used to bind together two physics bodies. They have a solver priority and can define if the bodies of the two attached nodes should be able to collide with each other. diff --git a/doc/classes/Joint2D.xml b/doc/classes/Joint2D.xml index b700bbd991..ee7395d2d3 100644 --- a/doc/classes/Joint2D.xml +++ b/doc/classes/Joint2D.xml @@ -12,7 +12,7 @@ </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] + 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]. diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 8ea3d8c188..72cce106d9 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -4,9 +4,9 @@ Kinematic body 3D node. </brief_description> <description> - Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: - Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). - Kinematic Characters: KinematicBody also has an API for moving objects (the [method move_and_collide] and [method move_and_slide] methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. + Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all; to other types of bodies, such as a character or a rigid body, these are the same as a static body. However, they have two main uses: + [b]Simulated motion:[/b] When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). + [b]Kinematic characters:[/b] KinematicBody also has an API for moving objects (the [method move_and_collide] and [method move_and_slide] methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/physics/kinematic_character_2d.html</link> @@ -94,7 +94,7 @@ If [code]stop_on_slope[/code] is [code]true[/code], body will not slide on slopes if you include gravity in [code]linear_velocity[/code]. If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. - If [code]infinite_inertia[/code] is [code]true[/code], body will be able to push [RigidBody] nodes, but it won't also detect any collisions with them. If [code]false[/code] it will interact with [RigidBody] nodes like with [StaticBody]. + If [code]infinite_inertia[/code] is [code]true[/code], body will be able to push [RigidBody] nodes, but it won't also detect any collisions with them. If [code]false[/code], it will interact with [RigidBody] nodes like with [StaticBody]. Returns the [code]linear_velocity[/code] vector, rotated and/or scaled if a slide collision occurred. To get detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> @@ -139,13 +139,13 @@ If the body is at least this close to another body, this body will consider them to be colliding. </member> <member name="move_lock_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's movement in the x-axis. + Lock the body's X axis movement. </member> <member name="move_lock_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's movement in the y-axis. + Lock the body's Y axis movement. </member> <member name="move_lock_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's movement in the z-axis. + Lock the body's Z axis movement. </member> </members> <constants> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index b7ff4bac84..949e364ed3 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -4,9 +4,9 @@ Kinematic body 2D node. </brief_description> <description> - Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: - Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). - Kinematic Characters: KinematicBody2D also has an API for moving objects (the [method move_and_collide] and [method move_and_slide] methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. + Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all; to other types of bodies, such as a character or a rigid body, these are the same as a static body. However, they have two main uses: + [b]Simulated motion:[/b] When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). + [b]Kinematic characters:[/b] KinematicBody2D also has an API for moving objects (the [method move_and_collide] and [method move_and_slide] methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/physics/kinematic_character_2d.html</link> @@ -27,7 +27,7 @@ </argument> <description> Returns a [KinematicCollision2D], which contains information about a collision that occurred during the last [method move_and_slide] call. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). - Example usage: + [b]Example usage:[/b] [codeblock] for i in get_slide_count(): var collision = get_slide_collision(i) @@ -100,7 +100,7 @@ If [code]stop_on_slope[/code] is [code]true[/code], body will not slide on slopes when you include gravity in [code]linear_velocity[/code] and the body is standing still. If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. - If [code]infinite_inertia[/code] is [code]true[/code], body will be able to push [RigidBody2D] nodes, but it won't also detect any collisions with them. If [code]false[/code] it will interact with [RigidBody2D] nodes like with [StaticBody2D]. + If [code]infinite_inertia[/code] is [code]true[/code], body will be able to push [RigidBody2D] nodes, but it won't also detect any collisions with them. If [code]false[/code], it will interact with [RigidBody2D] nodes like with [StaticBody2D]. Returns the [code]linear_velocity[/code] vector, rotated and/or scaled if a slide collision occurred. To get detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml index 4ce74df767..38e7384fca 100644 --- a/doc/classes/KinematicCollision.xml +++ b/doc/classes/KinematicCollision.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="KinematicCollision" inherits="Reference" category="Core" version="3.2"> <brief_description> - Collision data for KinematicBody collisions. + Collision data for [KinematicBody] collisions. </brief_description> <description> - Contains collision data for KinematicBody collisions. When a [KinematicBody] is moved using [method KinematicBody.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision object is returned. + Contains collision data for [KinematicBody] collisions. When a [KinematicBody] is moved using [method KinematicBody.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision object is returned. This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. </description> <tutorials> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index 5a0303b7ba..04d53be3d0 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="KinematicCollision2D" inherits="Reference" category="Core" version="3.2"> <brief_description> - Collision data for KinematicBody2D collisions. + Collision data for [KinematicBody2D] collisions. </brief_description> <description> - Contains collision data for KinematicBody2D collisions. When a [KinematicBody2D] is moved using [method KinematicBody2D.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision2D object is returned. + Contains collision data for [KinematicBody2D] collisions. When a [KinematicBody2D] is moved using [method KinematicBody2D.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision2D object is returned. This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. </description> <tutorials> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 8d52cae186..f9978bb1f3 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -5,7 +5,7 @@ </brief_description> <description> Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment, and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics or other formatting. For that, use [RichTextLabel] instead. - Note that contrarily to most other [Control]s, Label's [member Control.mouse_filter] defaults to MOUSE_FILTER_IGNORE (i.e. it doesn't react to mouse input events). This implies that a label won't display any configured [member Control.hint_tooltip], unless you change its mouse filter. + [b]Note:[/b] Contrarily to most other [Control]s, Label's [member Control.mouse_filter] defaults to [constant Control.MOUSE_FILTER_IGNORE] (i.e. it doesn't react to mouse input events). This implies that a label won't display any configured [member Control.hint_tooltip], unless you change its mouse filter. </description> <tutorials> </tutorials> @@ -35,7 +35,7 @@ <return type="int"> </return> <description> - Returns the number of lines shown. Useful if the [Label] 's height cannot currently display all lines. + Returns the number of lines shown. Useful if the [Label]'s height cannot currently display all lines. </description> </method> </methods> @@ -79,7 +79,7 @@ Align rows centered. </constant> <constant name="ALIGN_RIGHT" value="2" enum="Align"> - Align rows to the right (default). + Align rows to the right. </constant> <constant name="ALIGN_FILL" value="3" enum="Align"> Expand row whitespaces to fit the width. diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml index 4611bc228e..b4267f55f0 100644 --- a/doc/classes/LargeTexture.xml +++ b/doc/classes/LargeTexture.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="LargeTexture" inherits="Texture" category="Core" version="3.2"> <brief_description> - A Texture capable of storing many smaller Textures with offsets. + A [Texture] capable of storing many smaller textures with offsets. </brief_description> <description> - A Texture capable of storing many smaller Textures with offsets. - You can dynamically add pieces([Texture]) to this [LargeTexture] using different offsets. + A [Texture] capable of storing many smaller textures with offsets. + You can dynamically add pieces ([Texture]s) to this [LargeTexture] using different offsets. </description> <tutorials> </tutorials> @@ -18,7 +18,7 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> - Add another [Texture] to this [LargeTexture], starting on offset "ofs". + Adds [code]texture[/code] to this [LargeTexture], starting on offset [code]ofs[/code]. </description> </method> <method name="clear"> @@ -41,7 +41,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the offset of the piece with index "idx". + Returns the offset of the piece with the index [code]idx[/code]. </description> </method> <method name="get_piece_texture" qualifiers="const"> @@ -50,7 +50,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the [Texture] of the piece with index "idx". + Returns the [Texture] of the piece with the index [code]idx[/code]. </description> </method> <method name="set_piece_offset"> @@ -61,7 +61,7 @@ <argument index="1" name="ofs" type="Vector2"> </argument> <description> - Sets the offset of the piece with index "idx" to "ofs". + Sets the offset of the piece with the index [code]idx[/code] to [code]ofs[/code]. </description> </method> <method name="set_piece_texture"> @@ -72,7 +72,7 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> - Sets the [Texture] of the piece with index "idx" to "texture". + Sets the [Texture] of the piece with index [code]idx[/code] to [code]texture[/code]. </description> </method> <method name="set_size"> diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index 05eb44b2f1..8acc4ff643 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -4,7 +4,7 @@ Provides a base class for different kinds of light nodes. </brief_description> <description> - Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting. + Light is the abstract base class for light nodes, so it shouldn't be used directly (it can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link> @@ -13,7 +13,7 @@ </methods> <members> <member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only"> - If [code]true[/code], the light only appears in the editor and will not be visible at runtime. Default value:[code]false[/code]. + If [code]true[/code], the light only appears in the editor and will not be visible at runtime. Default value: [code]false[/code]. </member> <member name="light_bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="Light.BakeMode"> The light's bake mode. See [enum BakeMode]. @@ -28,7 +28,7 @@ The light's strength multiplier. </member> <member name="light_indirect_energy" type="float" setter="set_param" getter="get_param"> - Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. + Secondary multiplier used with indirect light (light bounces). This works on both [BakedLightmap] and [GIProbe]. </member> <member name="light_negative" type="bool" setter="set_negative" getter="is_negative"> If [code]true[/code], the light's effect is reversed, darkening areas and casting bright shadows. Default value: [code]false[/code]. @@ -37,7 +37,7 @@ The intensity of the specular blob in objects affected by the light. At [code]0[/code] the light becomes a pure diffuse light. </member> <member name="shadow_bias" type="float" setter="set_param" getter="get_param"> - Used to adjust shadow appearance. Too small a value results in self shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. + Used to adjust shadow appearance. Too small a value results in self-shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. </member> <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color"> The color of shadows cast by this light. @@ -86,13 +86,15 @@ Represents the size of the [enum Param] enum. </constant> <constant name="BAKE_DISABLED" value="0" enum="BakeMode"> - Light is ignored when baking. Note: hiding a light does [i]not[/i] affect baking. + Light is ignored when baking. + [b]Note:[/b] Hiding a light does [i]not[/i] affect baking. </constant> <constant name="BAKE_INDIRECT" value="1" enum="BakeMode"> - Only indirect lighting will be baked. Default value. + Only indirect lighting will be baked (default). </constant> <constant name="BAKE_ALL" value="2" enum="BakeMode"> - Both direct and indirect light will be baked. Note: you should hide the light if you don't want it to appear twice (dynamic and baked). + Both direct and indirect light will be baked. + [b]Note:[/b] You should hide the light if you don't want it to appear twice (dynamic and baked). </constant> </constants> </class> diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index a83b48da88..1d7ccb020e 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -4,7 +4,8 @@ Casts light in a 2D environment. </brief_description> <description> - Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. + Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). + [b]Note:[/b] Light2D can also be used as a mask. </description> <tutorials> <link>http://docs.godotengine.org/en/latest/tutorials/2d/2d_lights_and_shadows.html</link> @@ -25,7 +26,7 @@ The Light2D's energy value. The larger the value, the stronger the light. </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="Light2D.Mode"> - The Light2D's mode. See MODE_* constants for values. + The Light2D's mode. See [code]MODE_*[/code] constants for values. </member> <member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset"> The offset of the Light2D's [code]texture[/code]. @@ -58,7 +59,7 @@ If [code]true[/code], the Light2D will cast shadows. Default value: [code]false[/code]. </member> <member name="shadow_filter" type="int" setter="set_shadow_filter" getter="get_shadow_filter" enum="Light2D.ShadowFilter"> - Shadow filter type. Use [enum ShadowFilter] constants as values. Default value: [constant SHADOW_FILTER_NONE]. + Shadow filter type. See [enum ShadowFilter] for possible values. Default value: [constant SHADOW_FILTER_NONE]. </member> <member name="shadow_filter_smooth" type="float" setter="set_shadow_smooth" getter="get_shadow_smooth"> Smoothing value for shadows. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 8a13e044f0..ab10426ebf 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -17,7 +17,7 @@ <argument index="1" name="at_position" type="int" default="-1"> </argument> <description> - Add a point at the [code]position[/code]. Appends the point at the end of the line. + Adds a point at the [code]position[/code]. Appends the point at the end of the line. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position < 0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. </description> </method> @@ -50,7 +50,7 @@ <argument index="0" name="i" type="int"> </argument> <description> - Remove the point at index [code]i[/code] from the line. + Removes the point at index [code]i[/code] from the line. </description> </method> <method name="set_point_position"> @@ -111,7 +111,7 @@ The line's joints will be rounded. </constant> <constant name="LINE_CAP_NONE" value="0" enum="LineCapMode"> - Don't have a line cap. + Don't draw a line cap. </constant> <constant name="LINE_CAP_BOX" value="1" enum="LineCapMode"> Draws the line cap as a box. @@ -123,10 +123,10 @@ Takes the left pixels of the texture and renders it over the whole line. </constant> <constant name="LINE_TEXTURE_TILE" value="1" enum="LineTextureMode"> - Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly. + Tiles the texture over the line. The texture must be imported with [b]Repeat[/b] enabled for it to work properly. </constant> <constant name="LINE_TEXTURE_STRETCH" value="2" enum="LineTextureMode"> - Stretches the texture across the line. Import the texture with Repeat Disabled for best results. + Stretches the texture across the line. Import the texture with [b]Repeat[/b] disabled for best results. </constant> </constants> </class> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 44043a5a16..0f41e38d58 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -54,7 +54,7 @@ <argument index="0" name="option" type="int"> </argument> <description> - Executes a given action as defined in the MENU_* enum. + Executes a given action as defined in the[code]MENU_*[/code] enum. </description> </method> <method name="select"> @@ -65,12 +65,12 @@ <argument index="1" name="to" type="int" default="-1"> </argument> <description> - Selects characters inside [LineEdit] between [code]from[/code] and [code]to[/code]. By default [code]from[/code] is at the beginning and [code]to[/code] at the end. + Selects characters inside [LineEdit] between [code]from[/code] and [code]to[/code]. By default, [code]from[/code] is at the beginning and [code]to[/code] at the end. [codeblock] text = "Welcome" - select() # Welcome - select(4) # ome - select(2, 5) # lco + select() # Will select "Welcome" + select(4) # Will select "ome" + select(2, 5) # Will select "lco" [/codeblock] </description> </method> @@ -84,7 +84,7 @@ </methods> <members> <member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align"> - Text alignment as defined in the ALIGN_* enum. + Text alignment as defined in the [code]ALIGN_*[/code] enum. </member> <member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled"> If [code]true[/code], the caret (visual cursor) blinks. @@ -99,7 +99,7 @@ If [code]true[/code], the [LineEdit] will show a clear button if [code]text[/code] is not empty. </member> <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled"> - If [code]true[/code], the context menu will appear when right clicked. + If [code]true[/code], the context menu will appear when right-clicked. </member> <member name="editable" type="bool" setter="set_editable" getter="is_editable"> If [code]false[/code], existing text cannot be modified and new text cannot be added. @@ -147,13 +147,13 @@ </signals> <constants> <constant name="ALIGN_LEFT" value="0" enum="Align"> - Aligns the text on the left hand side of the [LineEdit]. + Aligns the text on the left-hand side of the [LineEdit]. </constant> <constant name="ALIGN_CENTER" value="1" enum="Align"> Centers the text in the middle of the [LineEdit]. </constant> <constant name="ALIGN_RIGHT" value="2" enum="Align"> - Aligns the text on the right hand side of the [LineEdit]. + Aligns the text on the right-hand side of the [LineEdit]. </constant> <constant name="ALIGN_FILL" value="3" enum="Align"> Stretches whitespaces to fit the [LineEdit]'s width. diff --git a/doc/classes/LineShape2D.xml b/doc/classes/LineShape2D.xml index 94409cbd83..67cb9b0eee 100644 --- a/doc/classes/LineShape2D.xml +++ b/doc/classes/LineShape2D.xml @@ -4,7 +4,7 @@ Line shape for 2D collisions. </brief_description> <description> - Line shape for 2D collisions. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. + Line shape for 2D collisions. It works like a 2D plane and will not allow any physics body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. </description> <tutorials> </tutorials> diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index ef9f785f0f..1dc0c3f91d 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -4,7 +4,7 @@ Simple button used to represent a link to some resource. </brief_description> <description> - This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page). + This kind of button is primarily used when the interaction with the button causes a context change (like linking to a web page). </description> <tutorials> </tutorials> @@ -18,7 +18,7 @@ </members> <constants> <constant name="UNDERLINE_MODE_ALWAYS" value="0" enum="UnderlineMode"> - The LinkButton will always show an underline at the bottom of its text + The LinkButton will always show an underline at the bottom of its text. </constant> <constant name="UNDERLINE_MODE_ON_HOVER" value="1" enum="UnderlineMode"> The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it. diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index 312b2ff692..f5bf12a876 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -5,7 +5,7 @@ </brief_description> <description> [MainLoop] is the abstract base class for a Godot project's game loop. It in inherited by [SceneTree], which is the default game loop implementation used in Godot projects, though it is also possible to write and use one's own [MainLoop] subclass instead of the scene tree. - Upon application start, a [MainLoop] implementation has to be provided to the OS, or the application will exit. This happens automatically (and a [SceneTree] is created) unless a main [Script] is provided from the command line (with e.g. [code]godot -s my_loop.gd[/code], which should then be a [MainLoop] implementation. + Upon the application start, a [MainLoop] implementation must be provided to the OS; otherwise, the application will exit. This happens automatically (and a [SceneTree] is created) unless a main [Script] is provided from the command line (with e.g. [code]godot -s my_loop.gd[/code], which should then be a [MainLoop] implementation. Here is an example script implementing a simple [MainLoop]: [codeblock] extends MainLoop diff --git a/doc/classes/MarginContainer.xml b/doc/classes/MarginContainer.xml index 3ea3204e56..fe63ba956f 100644 --- a/doc/classes/MarginContainer.xml +++ b/doc/classes/MarginContainer.xml @@ -5,7 +5,7 @@ </brief_description> <description> Adds a top, left, bottom, and right margin to all [Control] nodes that are direct children of the container. To control the [MarginContainer]'s margin, use the [code]margin_*[/code] theme properties listed below. - [b]Note:[/b] Be careful, [Control] margin values are different than the constant margin values. If you want to change the custom margin values of the [MarginContainer] by code you should use the following examples: + [b]Note:[/b] Be careful, [Control] margin values are different than the constant margin values. If you want to change the custom margin values of the [MarginContainer] by code, you should use the following examples: [codeblock] var margin_value = 100 set("custom_constants/margin_top", margin_value) diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index c7118a4d9f..083a3163ce 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -15,7 +15,7 @@ <argument index="0" name="base64_str" type="String"> </argument> <description> - Returns [PoolByteArray] of a given base64 encoded String. + Returns a decoded [PoolByteArray] corresponding to the Base64-encoded string [code]base64_str[/code]. </description> </method> <method name="base64_to_utf8"> @@ -24,7 +24,7 @@ <argument index="0" name="base64_str" type="String"> </argument> <description> - Returns utf8 String of a given base64 encoded String. + Returns a decoded string corresponding to the Base64-encoded string [code]base64_str[/code]. </description> </method> <method name="base64_to_variant"> @@ -35,8 +35,8 @@ <argument index="1" name="allow_objects" type="bool" default="false"> </argument> <description> - Returns [Variant] of a given base64 encoded String. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. - [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). + Returns a decoded [Variant] corresponding to the Base64-encoded string [code]base64_str[/code]. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. + [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </description> </method> <method name="raw_to_base64"> @@ -45,7 +45,7 @@ <argument index="0" name="array" type="PoolByteArray"> </argument> <description> - Returns base64 encoded String of a given [PoolByteArray]. + Returns a Base64-encoded string of a given [PoolByteArray]. </description> </method> <method name="utf8_to_base64"> @@ -54,7 +54,7 @@ <argument index="0" name="utf8_str" type="String"> </argument> <description> - Returns base64 encoded String of a given utf8 String. + Returns a Base64-encoded string of the UTF-8 string [code]utf8_str[/code]. </description> </method> <method name="variant_to_base64"> @@ -65,7 +65,7 @@ <argument index="1" name="full_objects" type="bool" default="false"> </argument> <description> - Returns base64 encoded String of a given [Variant]. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). + Returns a Base64-encoded string of the [Variant] [code]variant[/code]. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). </description> </method> </methods> diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index d2911fd299..6066d09b4e 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Mesh" inherits="Resource" category="Core" version="3.2"> <brief_description> - A [Resource] that contains vertex-array based geometry. + A [Resource] that contains vertex array-based geometry. </brief_description> <description> - Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. + Mesh is a type of [Resource] that contains vertex array-based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. </description> <tutorials> </tutorials> @@ -22,7 +22,8 @@ <argument index="0" name="margin" type="float"> </argument> <description> - Calculate an outline mesh at a defined offset (margin) from the original mesh. Note: Typically returns the vertices in reverse order (e.g. clockwise to anti-clockwise). + Calculate an outline mesh at a defined offset (margin) from the original mesh. + [b]Note:[/b] This method typically returns the vertices in reverse order (e.g. clockwise to counterclockwise). </description> </method> <method name="create_trimesh_shape" qualifiers="const"> @@ -88,7 +89,7 @@ <argument index="1" name="material" type="Material"> </argument> <description> - Set a [Material] for a given surface. Surface will be rendered using this material. + Sets a [Material] for a given surface. Surface will be rendered using this material. </description> </method> </methods> diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index 5cee9915ff..22c31306bf 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -4,9 +4,9 @@ Helper tool to access and edit [Mesh] data. </brief_description> <description> - The MeshDataTool provides access to individual vertices in a [Mesh]. It allows users to read and edit vertex data of meshes. It also creates an array of faces and edges. - To use the MeshDataTool, load a mesh with [method create_from_surface]. When you are finished editing the data commit the data to a mesh with [method commit_to_surface]. - Below is an example of how the MeshDataTool may be used. + MeshDataTool provides access to individual vertices in a [Mesh]. It allows users to read and edit vertex data of meshes. It also creates an array of faces and edges. + To use MeshDataTool, load a mesh with [method create_from_surface]. When you are finished editing the data commit the data to a mesh with [method commit_to_surface]. + Below is an example of how MeshDataTool may be used. [codeblock] var mdt = MeshDataTool.new() mdt.create_from_surface(mesh, 0) @@ -111,7 +111,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns meta data associated with given face. + Returns the metadata associated with the given face. </description> </method> <method name="get_face_normal" qualifiers="const"> @@ -120,7 +120,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Calculates and returns face normal of given face. + Calculates and returns the face normal of the given face. </description> </method> <method name="get_face_vertex" qualifiers="const"> @@ -131,7 +131,7 @@ <argument index="1" name="vertex" type="int"> </argument> <description> - Returns specified vertex of given face. + Returns the specified vertex of the given face. Vertex argument must be 2 or less because faces contain three vertices. </description> </method> @@ -139,15 +139,15 @@ <return type="int"> </return> <description> - Returns format of [Mesh]. Format is an integer made up of [Mesh] format flags combined together. For example, a mesh containing both vertices and normals would return a format of [code]3[/code] because [constant ArrayMesh.ARRAY_FORMAT_VERTEX] is [code]1[/code] and [constant ArrayMesh.ARRAY_FORMAT_NORMAL] is [code]2[/code]. - For list of format flags see [enum ArrayMesh.ArrayFormat]. + Returns the [Mesh]'s format. Format is an integer made up of [Mesh] format flags combined together. For example, a mesh containing both vertices and normals would return a format of [code]3[/code] because [constant ArrayMesh.ARRAY_FORMAT_VERTEX] is [code]1[/code] and [constant ArrayMesh.ARRAY_FORMAT_NORMAL] is [code]2[/code]. + See [enum ArrayMesh.ArrayFormat] for a list of format flags. </description> </method> <method name="get_material" qualifiers="const"> <return type="Material"> </return> <description> - Returns material assigned to the [Mesh]. + Returns the material assigned to the [Mesh]. </description> </method> <method name="get_vertex" qualifiers="const"> @@ -190,7 +190,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns array of edges that share given vertex. + Returns an array of edges that share the given vertex. </description> </method> <method name="get_vertex_faces" qualifiers="const"> @@ -199,7 +199,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns array of faces that share given vertex. + Returns an array of faces that share the given vertex. </description> </method> <method name="get_vertex_meta" qualifiers="const"> @@ -208,7 +208,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns meta data associated with given vertex. + Returns the metadata associated with the given vertex. </description> </method> <method name="get_vertex_normal" qualifiers="const"> @@ -217,7 +217,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns normal of given vertex. + Returns the normal of the given vertex. </description> </method> <method name="get_vertex_tangent" qualifiers="const"> @@ -226,7 +226,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns tangent of given vertex. + Returns the tangent of the given vertex. </description> </method> <method name="get_vertex_uv" qualifiers="const"> @@ -235,7 +235,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns UV of given vertex. + Returns the UV of the given vertex. </description> </method> <method name="get_vertex_uv2" qualifiers="const"> @@ -244,7 +244,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns UV2 of given vertex. + Returns the UV2 of the given vertex. </description> </method> <method name="get_vertex_weights" qualifiers="const"> @@ -253,7 +253,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns bone weights of given vertex. + Returns bone weights of the given vertex. </description> </method> <method name="set_edge_meta"> @@ -264,7 +264,7 @@ <argument index="1" name="meta" type="Variant"> </argument> <description> - Sets the meta data of given edge. + Sets the metadata of the given edge. </description> </method> <method name="set_face_meta"> @@ -275,7 +275,7 @@ <argument index="1" name="meta" type="Variant"> </argument> <description> - Sets the meta data of given face. + Sets the metadata of the given face. </description> </method> <method name="set_material"> @@ -284,7 +284,7 @@ <argument index="0" name="material" type="Material"> </argument> <description> - Sets the material to be used by newly constructed [Mesh]. + Sets the material to be used by newly-constructed [Mesh]. </description> </method> <method name="set_vertex"> @@ -295,7 +295,7 @@ <argument index="1" name="vertex" type="Vector3"> </argument> <description> - Sets the position of given vertex. + Sets the position of the given vertex. </description> </method> <method name="set_vertex_bones"> @@ -306,7 +306,7 @@ <argument index="1" name="bones" type="PoolIntArray"> </argument> <description> - Sets the bones of given vertex. + Sets the bones of the given vertex. </description> </method> <method name="set_vertex_color"> @@ -317,7 +317,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Sets the color of given vertex. + Sets the color of the given vertex. </description> </method> <method name="set_vertex_meta"> @@ -328,7 +328,7 @@ <argument index="1" name="meta" type="Variant"> </argument> <description> - Sets the meta data associated with given vertex. + Sets the metadata associated with the given vertex. </description> </method> <method name="set_vertex_normal"> @@ -339,7 +339,7 @@ <argument index="1" name="normal" type="Vector3"> </argument> <description> - Sets the normal of given vertex. + Sets the normal of the given vertex. </description> </method> <method name="set_vertex_tangent"> @@ -350,7 +350,7 @@ <argument index="1" name="tangent" type="Plane"> </argument> <description> - Sets the tangent of given vertex. + Sets the tangent of the given vertex. </description> </method> <method name="set_vertex_uv"> @@ -361,7 +361,7 @@ <argument index="1" name="uv" type="Vector2"> </argument> <description> - Sets the UV of given vertex. + Sets the UV of the given vertex. </description> </method> <method name="set_vertex_uv2"> @@ -372,7 +372,7 @@ <argument index="1" name="uv2" type="Vector2"> </argument> <description> - Sets the UV2 of given vertex. + Sets the UV2 of the given vertex. </description> </method> <method name="set_vertex_weights"> @@ -383,7 +383,7 @@ <argument index="1" name="weights" type="PoolRealArray"> </argument> <description> - Sets the bone weights of given vertex. + Sets the bone weights of the given vertex. </description> </method> </methods> diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index ad5824640d..041d1fa80d 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -4,7 +4,7 @@ Library of meshes. </brief_description> <description> - Library of meshes. Contains a list of [Mesh] resources, each with name and ID. Useful for GridMap or painting Terrain. + Library of meshes. Contains a list of [Mesh] resources, each with name and ID. This resource is used in [GridMap]. </description> <tutorials> </tutorials> @@ -94,7 +94,7 @@ <return type="int"> </return> <description> - Get an unused id for a new item. + Gets an unused id for a new item. </description> </method> <method name="remove_item"> @@ -103,7 +103,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Remove the item. + Removes the item. </description> </method> <method name="set_item_mesh"> @@ -114,7 +114,7 @@ <argument index="1" name="mesh" type="Mesh"> </argument> <description> - Set the mesh of the item. + Sets the mesh of the item. </description> </method> <method name="set_item_name"> @@ -125,7 +125,7 @@ <argument index="1" name="name" type="String"> </argument> <description> - Set the name of the item. + Sets the name of the item. </description> </method> <method name="set_item_navmesh"> diff --git a/doc/classes/MeshTexture.xml b/doc/classes/MeshTexture.xml index d305cca482..ba2b1621ff 100644 --- a/doc/classes/MeshTexture.xml +++ b/doc/classes/MeshTexture.xml @@ -12,13 +12,13 @@ </methods> <members> <member name="base_texture" type="Texture" setter="set_base_texture" getter="get_base_texture"> - Set the base texture that the Mesh will use to draw. + Sets the base texture that the Mesh will use to draw. </member> <member name="image_size" type="Vector2" setter="set_image_size" getter="get_image_size"> - Set the size of the image, needed for reference. + Sets the size of the image, needed for reference. </member> <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> - Set the mesh used to draw. It must be a mesh using 2D vertices. + Sets the mesh used to draw. It must be a mesh using 2D vertices. </member> </members> <constants> diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 0784fc3a42..d0b9a04824 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="MultiMesh" inherits="Resource" category="Core" version="3.2"> <brief_description> - Provides high performance mesh instancing. + Provides high-performance mesh instancing. </brief_description> <description> - MultiMesh provides low level mesh instancing. Drawing thousands of [MeshInstance] nodes can be slow because each object is submitted to the GPU to be drawn individually. - MultiMesh is much faster because it can draw thousands of instances with a single draw call, resulting in less API overhead. + MultiMesh provides low-level mesh instancing. Drawing thousands of [MeshInstance] nodes can be slow, since each object is submitted to the GPU then drawn individually. + MultiMesh is much faster as it can draw thousands of instances with a single draw call, resulting in less API overhead. As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). Since instances may have any behavior, the AABB used for visibility must be provided by the user. </description> @@ -17,7 +17,7 @@ <return type="AABB"> </return> <description> - Returns the visibility AABB. + Returns the visibility axis-aligned bounding box. </description> </method> <method name="get_instance_color" qualifiers="const"> @@ -26,7 +26,7 @@ <argument index="0" name="instance" type="int"> </argument> <description> - Get the color of a specific instance. + Gets a specific instance's color. </description> </method> <method name="get_instance_custom_data" qualifiers="const"> @@ -62,9 +62,9 @@ <argument index="0" name="array" type="PoolRealArray"> </argument> <description> - Set all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative. + Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative. All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc... - [Transform] is stored as 12 floats, [Transform2D] is stored as 8 floats, COLOR_8BIT / CUSTOM_DATA_8BIT is stored as 1 float (4 bytes as is) and COLOR_FLOAT / CUSTOM_DATA_FLOAT is stored as 4 floats. + [Transform] is stored as 12 floats, [Transform2D] is stored as 8 floats, [code]COLOR_8BIT[/code] / [code]CUSTOM_DATA_8BIT[/code] is stored as 1 float (4 bytes as is) and [code]COLOR_FLOAT[/code] / [code]CUSTOM_DATA_FLOAT[/code] is stored as 4 floats. </description> </method> <method name="set_instance_color"> @@ -75,7 +75,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Set the color of a specific instance. + Sets the color of a specific instance. For the color to take effect, ensure that [member color_format] is non-[code]null[/code] on the [MultiMesh] and [member SpatialMaterial.vertex_color_use_as_albedo] is [code]true[/code] on the material. </description> </method> @@ -87,7 +87,7 @@ <argument index="1" name="custom_data" type="Color"> </argument> <description> - Set custom data for a specific instance. Although [Color] is used, it is just a container for 4 numbers. + Sets custom data for a specific instance. Although [Color] is used, it is just a container for 4 numbers. </description> </method> <method name="set_instance_transform"> @@ -98,7 +98,7 @@ <argument index="1" name="transform" type="Transform"> </argument> <description> - Set the [Transform] for a specific instance. + Sets the [Transform] for a specific instance. </description> </method> <method name="set_instance_transform_2d"> @@ -109,7 +109,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> - Set the [Transform2D] for a specific instance. + Sets the [Transform2D] for a specific instance. </description> </method> </methods> @@ -121,7 +121,7 @@ Format of custom data in custom data array that gets passed to shader. </member> <member name="instance_count" type="int" setter="set_instance_count" getter="get_instance_count"> - Number of instances that will get drawn. This clears and (re)sizes the buffers. By default all instances are drawn but you can limit this with [member visible_instance_count]. + Number of instances that will get drawn. This clears and (re)sizes the buffers. By default, all instances are drawn but you can limit this with [member visible_instance_count]. </member> <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> Mesh to be drawn. diff --git a/doc/classes/MultiMeshInstance.xml b/doc/classes/MultiMeshInstance.xml index 70834d6085..16f16fdc8b 100644 --- a/doc/classes/MultiMeshInstance.xml +++ b/doc/classes/MultiMeshInstance.xml @@ -5,7 +5,7 @@ </brief_description> <description> [MultiMeshInstance] is a specialized node to instance [GeometryInstance]s based on a [MultiMesh] resource. - This is useful to optimize the rendering of a high amount of instances of a given mesh (for example tree in a forest or grass strands). + This is useful to optimize the rendering of a high amount of instances of a given mesh (for example trees in a forest or grass strands). </description> <tutorials> <link>http://docs.godotengine.org/en/latest/tutorials/3d/vertex_animation/animating_thousands_of_fish.html</link> diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index b67d83efec..afe2ebc40f 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="MultiplayerAPI" inherits="Reference" category="Core" version="3.2"> <brief_description> - High Level Multiplayer API. + High-level multiplayer API. </brief_description> <description> - This class implements most of the logic behind the high level multiplayer API. + This class implements most of the logic behind the high-level multiplayer API. By default, [SceneTree] has a reference to this class that is used to provide multiplayer capabilities (i.e. RPC/RSET) across the whole scene. It is possible to override the MultiplayerAPI instance used by specific Nodes by setting the [member Node.custom_multiplayer] property, effectively allowing to run both client and server in the same scene. </description> @@ -37,7 +37,7 @@ </return> <description> Returns the sender's peer ID for the RPC currently being executed. - NOTE: If not inside an RPC this method will return 0. + [b]Note:[/b] If not inside an RPC this method will return 0. </description> </method> <method name="has_network_peer" qualifiers="const"> @@ -58,8 +58,8 @@ <return type="void"> </return> <description> - Method used for polling the MultiplayerAPI. You only need to worry about this if you are using [member Node.custom_multiplayer] override or you set [member SceneTree.multiplayer_poll] to [code]false[/code]. By default [SceneTree] will poll its MultiplayerAPI for you. - NOTE: This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. [code]_process[/code], [code]physics[/code], [Thread]). + Method used for polling the MultiplayerAPI. You only need to worry about this if you are using [member Node.custom_multiplayer] override or you set [member SceneTree.multiplayer_poll] to [code]false[/code]. By default, [SceneTree] will poll its MultiplayerAPI for you. + [b]Note:[/b] This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. [code]_process[/code], [code]physics[/code], [Thread]). </description> </method> <method name="send_bytes"> @@ -88,11 +88,11 @@ </methods> <members> <member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed"> - If [code]true[/code] (or if the [member network_peer] [member PacketPeer.allow_object_decoding] the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. - [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). + If [code]true[/code] (or if the [member network_peer] has [member PacketPeer.allow_object_decoding] set to [code]true[/code]), the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. + [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </member> <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> - The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with [method is_network_server]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. + The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with [method is_network_server]) and will set root node's network mode to master (see [code]NETWORK_MODE_*[/code] constants in [Node]), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. </member> <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections"> If [code]true[/code], the MultiplayerAPI's [member network_peer] refuses new incoming connections. @@ -101,26 +101,26 @@ <signals> <signal name="connected_to_server"> <description> - Emitted whenever this MultiplayerAPI's [member network_peer] successfully connected to a server. Only emitted on clients. + Emitted when this MultiplayerAPI's [member network_peer] successfully connected to a server. Only emitted on clients. </description> </signal> <signal name="connection_failed"> <description> - Emitted whenever this MultiplayerAPI's [member network_peer] fails to establish a connection to a server. Only emitted on clients. + Emitted when this MultiplayerAPI's [member network_peer] fails to establish a connection to a server. Only emitted on clients. </description> </signal> <signal name="network_peer_connected"> <argument index="0" name="id" type="int"> </argument> <description> - Emitted whenever this MultiplayerAPI's [member network_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). + Emitted when this MultiplayerAPI's [member network_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). </description> </signal> <signal name="network_peer_disconnected"> <argument index="0" name="id" type="int"> </argument> <description> - Emitted whenever this MultiplayerAPI's [member network_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. + Emitted when this MultiplayerAPI's [member network_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. </description> </signal> <signal name="network_peer_packet"> @@ -129,12 +129,12 @@ <argument index="1" name="packet" type="PoolByteArray"> </argument> <description> - Emitted whenever this MultiplayerAPI's [member network_peer] receive a [code]packet[/code] with custom data (see [method send_bytes]). ID is the peer ID of the peer that sent the packet. + Emitted when this MultiplayerAPI's [member network_peer] receive a [code]packet[/code] with custom data (see [method send_bytes]). ID is the peer ID of the peer that sent the packet. </description> </signal> <signal name="server_disconnected"> <description> - Emitted whenever this MultiplayerAPI's [member network_peer] disconnects from server. Only emitted on clients. + Emitted when this MultiplayerAPI's [member network_peer] disconnects from server. Only emitted on clients. </description> </signal> </signals> @@ -152,13 +152,13 @@ Used with [method Node.rpc_config] or [method Node.rset_config] to set a method to be called or a property to be changed only on puppets for this node. Analogous to the [code]puppet[/code] keyword. Only accepts calls or property changes from the node's network master, see [method Node.set_network_master]. </constant> <constant name="RPC_MODE_SLAVE" value="3" enum="RPCMode"> - Deprecated. Use [constant RPC_MODE_PUPPET] instead. Analogous to the [code]slave[/code] keyword. + [i]Deprecated.[/i] Use [constant RPC_MODE_PUPPET] instead. Analogous to the [code]slave[/code] keyword. </constant> <constant name="RPC_MODE_REMOTESYNC" value="4" enum="RPCMode"> Behave like [constant RPC_MODE_REMOTE] but also make the call or property change locally. Analogous to the [code]remotesync[/code] keyword. </constant> <constant name="RPC_MODE_SYNC" value="4" enum="RPCMode"> - Deprecated. Use [constant RPC_MODE_REMOTESYNC] instead. Analogous to the [code]sync[/code] keyword. + [i]Deprecated.[/i] Use [constant RPC_MODE_REMOTESYNC] instead. Analogous to the [code]sync[/code] keyword. </constant> <constant name="RPC_MODE_MASTERSYNC" value="5" enum="RPCMode"> Behave like [constant RPC_MODE_MASTER] but also make the call or property change locally. Analogous to the [code]mastersync[/code] keyword. diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index 2f41e100fc..793696321b 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Mutex" inherits="Reference" category="Core" version="3.2"> <brief_description> - A synchronization Mutex. + A synchronization mutex (mutual exclusion). </brief_description> <description> - A synchronization Mutex. Element used to synchronize multiple [Thread]s. Basically a binary [Semaphore]. Guarantees that only one thread can ever acquire this lock at a time. Can be used to protect a critical section. Be careful to avoid deadlocks. + A synchronization mutex (mutual exclusion). This is used to synchronize multiple [Thread]s, and is equivalent to a binary [Semaphore]. It guarantees that only one thread can ever acquire the lock at a time. A mutex can be used to protect a critical section; however, be careful to avoid deadlocks. </description> <tutorials> </tutorials> @@ -13,21 +13,21 @@ <return type="void"> </return> <description> - Lock this [Mutex], blocks until it is unlocked by the current owner. + Locks this [Mutex], 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 [constant OK] on success, [constant ERR_BUSY] otherwise. + Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. </description> </method> <method name="unlock"> <return type="void"> </return> <description> - Unlock this [Mutex], leaving it to other threads. + Unlocks this [Mutex], leaving it to other threads. </description> </method> </methods> diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index f0ae3fef99..83e1889efc 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -4,7 +4,7 @@ Mesh-based navigation and pathfinding node. </brief_description> <description> - Provides navigation and pathfinding within a collection of [NavigationMesh]es. By default these will be automatically collected from child [NavigationMeshInstance] nodes, but they can also be added on the fly with [method navmesh_add]. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. + Provides navigation and pathfinding within a collection of [NavigationMesh]es. By default, these will be automatically collected from child [NavigationMeshInstance] nodes, but they can also be added on the fly with [method navmesh_add]. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. </description> <tutorials> </tutorials> @@ -98,7 +98,7 @@ </methods> <members> <member name="up_vector" type="Vector3" setter="set_up_vector" getter="get_up_vector"> - Defines which direction is up. By default this is [code](0, 1, 0)[/code], which is the world up direction. + Defines which direction is up. By default, this is [code](0, 1, 0)[/code], which is the world's "up" direction. </member> </members> <constants> diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index 67b5d72182..ea1b992d79 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -4,7 +4,7 @@ 2D navigation and pathfinding node. </brief_description> <description> - Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. By default these are automatically collected from child [NavigationPolygonInstance] nodes, but they can also be added on the fly with [method navpoly_add]. + Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. By default, these are automatically collected from child [NavigationPolygonInstance] nodes, but they can also be added on the fly with [method navpoly_add]. </description> <tutorials> </tutorials> diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 2630ae1377..555f308660 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -4,7 +4,7 @@ A node that has methods to draw outlines or use indices of vertices to create navigation polygons. </brief_description> <description> - There are two ways to create polygons. Either by using the [method add_outline] method or using the [method add_polygon] method. + There are two ways to create polygons. Either by using the [method add_outline] method, or using the [method add_polygon] method. Using [method add_outline]: [codeblock] var polygon = NavigationPolygon.new() diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index ac84c32b5e..c804015659 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -96,7 +96,7 @@ Packets are not acknowledged, no resend attempts are made for lost packets. Packets are received in the order they were sent in. Potentially faster than [constant TRANSFER_MODE_RELIABLE]. Use for non-critical data or data that would be outdated if received late due to resend attempt(s) anyway, for example movement and positional data. </constant> <constant name="TRANSFER_MODE_RELIABLE" value="2" enum="TransferMode"> - Packets must be received and resend attempts should be made until the packets are acknowledged. Packets must be received in the order they were sent in. Most reliable transfer mode, but potentially slowest due to the overhead. Use for critical data that must be transmitted and arrive in order, for example an ability being triggered or a chat message. Consider carefully if the information really is critical, and use sparingly. + Packets must be received and resend attempts should be made until the packets are acknowledged. Packets must be received in the order they were sent in. Most reliable transfer mode, but potentially the slowest due to the overhead. Use for critical data that must be transmitted and arrive in order, for example an ability being triggered or a chat message. Consider carefully if the information really is critical, and use sparingly. </constant> <constant name="CONNECTION_DISCONNECTED" value="0" enum="ConnectionStatus"> The ongoing connection disconnected. diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 3095da14be..d6759d7d43 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -4,7 +4,7 @@ Scalable texture-based frame that tiles the texture's centers and sides, but keeps the corners' original size. Perfect for panels and dialog boxes. </brief_description> <description> - Better known as 9-slice panels, NinePatchRect produces clean panels of any size, based on a small texture. To do so, it splits the texture in a 3 by 3 grid. When you scale the node, it tiles the texture's sides horizontally or vertically, the center on both axes but it doesn't scale or tile the corners. + Also known as 9-slice panels, NinePatchRect produces clean panels of any size, based on a small texture. To do so, it splits the texture in a 3×3 grid. When you scale the node, it tiles the texture's sides horizontally or vertically, the center on both axes but it doesn't scale or tile the corners. </description> <tutorials> </tutorials> @@ -18,7 +18,7 @@ Doesn't do anything at the time of writing. </member> <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled"> - If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code] + If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code]. </member> <member name="patch_margin_bottom" type="int" setter="set_patch_margin" getter="get_patch_margin"> The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 6df207b2cd..5956d7a364 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -14,7 +14,7 @@ To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with the [member owner] property. 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 Object.free] or [method queue_free], it will also free all its children. [b]Groups:[/b] Nodes can be added to as many groups as you want to be easy to manage, you could create groups like "enemies" or "collectables" for example, depending on your game. See [method add_to_group], [method is_in_group] and [method remove_from_group]. You can then retrieve all nodes in these groups, iterate them and even call methods on groups via the methods on [SceneTree]. - [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 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). To identify which node receives the RPC call Godot will use its [NodePath] (make sure node names are the same on all peers). Also take a look at the high-level networking tutorial and corresponding demos. + [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 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). To identify which node receives the RPC call, Godot will use its [NodePath] (make sure node names are the same on all peers). Also, take a look at the high-level networking tutorial and corresponding demos. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/getting_started/step_by_step/scenes_and_nodes.html</link> @@ -84,7 +84,7 @@ <description> Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their [method _ready] callbacks get triggered first, and the parent node will receive the ready notification afterwards. Corresponds to the [constant NOTIFICATION_READY] notification in [method Object._notification]. See also the [code]onready[/code] keyword for variables. - Usually used for initialization. For even earlier initialization, [method Object._init] may be used. Also see [method _enter_tree]. + Usually used for initialization. For even earlier initialization, [method Object._init] may be used. See also [method _enter_tree]. </description> </method> <method name="_unhandled_input" qualifiers="virtual"> @@ -120,7 +120,7 @@ </argument> <description> Adds a child node. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. - Setting [code]legible_unique_name[/code] to [code]true[/code] creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. + If [code]legible_unique_name[/code] is [code]true[/code], the child node will have an human-readable name based on the name of the node being instanced instead of its type. </description> </method> <method name="add_child_below_node"> @@ -134,7 +134,7 @@ </argument> <description> Adds a child node. The child is placed below the given node in the list of children. - Setting [code]legible_unique_name[/code] to [code]true[/code] creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. + If [code]legible_unique_name[/code] is [code]true[/code], the child node will have an human-readable name based on the name of the node being instanced instead of its type. </description> </method> <method name="add_to_group"> @@ -176,8 +176,9 @@ <argument index="2" name="owned" type="bool" default="true"> </argument> <description> - Finds a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. - If [code]owned[/code] is [code]true[/code], this method only finds nodes whose owner is this node. This is especially important for scenes instantiated through script, because those scenes don't have an owner. + Finds a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case-sensitive, but [code]"*"[/code] matches zero or more characters and [code]"?"[/code] matches any single character except [code]"."[/code]). + [b]Note:[/b] It does not match against the full path, just against individual node names. + If [code]owned[/code] is [code]true[/code], this method only finds nodes whose owner is this node. This is especially important for scenes instantiated through a script, because those scenes don't have an owner. </description> </method> <method name="find_parent" qualifiers="const"> @@ -186,7 +187,8 @@ <argument index="0" name="mask" type="String"> </argument> <description> - Finds the first parent of the current node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. + Finds the first parent of the current node whose name matches [code]mask[/code] as in [method String.match] (i.e. case-sensitive, but [code]"*"[/code] matches zero or more characters and [code]"?"[/code] matches any single character except [code]"."[/code]). + [b]Note:[/b] It does not match against the full path, just against individual node names. </description> </method> <method name="get_child" qualifiers="const"> @@ -284,7 +286,7 @@ <argument index="0" name="path" type="NodePath"> </argument> <description> - Similar to [method get_node], but does not raise an error when [code]path[/code] does not point to a valid [Node]. + Similar to [method get_node], but does not raise an error if [code]path[/code] does not point to a valid [Node]. </description> </method> <method name="get_parent" qualifiers="const"> @@ -489,7 +491,8 @@ <return type="void"> </return> <description> - Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the [method get_node] function. Example output: + Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the [method get_node] function. + [b]Example output:[/b] [codeblock] TheGame TheGame/Menu @@ -504,7 +507,8 @@ <return type="void"> </return> <description> - Similar to [method print_tree], this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees. Example output: + Similar to [method print_tree], this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees. + [b]Example output:[/b] [codeblock] ┖╴TheGame ┠╴Menu @@ -525,7 +529,7 @@ <argument index="2" name="parent_first" type="bool" default="false"> </argument> <description> - Calls the given method (if present) with the arguments given in [code]args[/code] on this node and recursively on all its children. If the [code]parent_first[/code] argument is [code]true[/code] then the method will be called on the current node first, then on all children. If it is [code]false[/code] then the children will be called first. + Calls the given method (if present) with the arguments given in [code]args[/code] on this node and recursively on all its children. If the [code]parent_first[/code] argument is [code]true[/code], the method will be called on the current node first, then on all its children. If [code]parent_first[/code] is [code]false[/code], the children will be called first. </description> </method> <method name="propagate_notification"> @@ -600,7 +604,8 @@ <argument index="0" name="method" type="String"> </argument> <description> - Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. Also see [method rset] and [method rset_config] for properties. Returns an empty [Variant]. Note that you can only safely use RPCs on clients after you received the [code]connected_to_server[/code] signal from the [SceneTree]. You also need to keep track of the connection state, either by the [SceneTree] signals like [code]server_disconnected[/code] or by checking [code]SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED[/code]. + Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. See also [method rset] and [method rset_config] for properties. Returns an empty [Variant]. + [b]Note:[/b] You can only safely use RPCs on clients after you received the [code]connected_to_server[/code] signal from the [SceneTree]. You also need to keep track of the connection state, either by the [SceneTree] signals like [code]server_disconnected[/code] or by checking [code]SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED[/code]. </description> </method> <method name="rpc_config"> @@ -611,7 +616,7 @@ <argument index="1" name="mode" type="int" enum="MultiplayerAPI.RPCMode"> </argument> <description> - Changes the RPC mode for the given [code]method[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, methods are not exposed to networking (and RPCs). Also see [method rset] and [method rset_config] for properties. + Changes the RPC mode for the given [code]method[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, methods are not exposed to networking (and RPCs). See also [method rset] and [method rset_config] for properties. </description> </method> <method name="rpc_id" qualifiers="vararg"> @@ -653,7 +658,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> - Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see [method rset_config]. Also see [method rpc] for RPCs for methods, most information applies to this method as well. + Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see [method rset_config]. See also [method rpc] for RPCs for methods, most information applies to this method as well. </description> </method> <method name="rset_config"> @@ -664,7 +669,7 @@ <argument index="1" name="mode" type="int" enum="MultiplayerAPI.RPCMode"> </argument> <description> - Changes the RPC mode for the given [code]property[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, properties are not exposed to networking (and RPCs). Also see [method rpc] and [method rpc_config] for methods. + Changes the RPC mode for the given [code]property[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, properties are not exposed to networking (and RPCs). See also [method rpc] and [method rpc_config] for methods. </description> </method> <method name="rset_id"> @@ -739,7 +744,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal [method _physics_process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting ([method set_physics_process]). Only useful for advanced uses to manipulate built-in nodes behavior. + Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal [method _physics_process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting ([method set_physics_process]). Only useful for advanced uses to manipulate built-in nodes' behaviour. </description> </method> <method name="set_process"> @@ -766,7 +771,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal [method _process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting ([method set_process]). Only useful for advanced uses to manipulate built-in nodes behavior. + Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal [method _process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting ([method set_process]). Only useful for advanced uses to manipulate built-in nodes' behaviour. </description> </method> <method name="set_process_priority"> @@ -808,7 +813,7 @@ </methods> <members> <member name="custom_multiplayer" type="MultiplayerAPI" setter="set_custom_multiplayer" getter="get_custom_multiplayer"> - The override to the default [MultiplayerAPI]. Set to null to use the default SceneTree one. + The override to the default [MultiplayerAPI]. Set to [code]null[/code] to use the default [SceneTree] one. </member> <member name="filename" type="String" setter="set_filename" getter="get_filename"> When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. @@ -817,10 +822,10 @@ The [MultiplayerAPI] instance associated with this node. Either the [member custom_multiplayer], or the default SceneTree one (if inside tree). </member> <member name="name" type="String" setter="set_name" getter="get_name"> - The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed + The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed. </member> <member name="owner" type="Node" setter="set_owner" getter="get_owner"> - The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using [PackedScene]) all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing. + The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using [PackedScene]), all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing. </member> <member name="pause_mode" type="int" setter="set_pause_mode" getter="get_pause_mode" enum="Node.PauseMode"> Pause mode. How the node will behave if the [SceneTree] is paused. @@ -879,7 +884,8 @@ Notification received every frame when the process flag is set (see [method set_process]). </constant> <constant name="NOTIFICATION_PARENTED" value="18"> - Notification received when a node is set as a child of another node. Note that this doesn't mean that a node entered the [SceneTree]. + Notification received when a node is set as a child of another node. + [b]Note:[/b] This doesn't mean that a node entered the [SceneTree]. </constant> <constant name="NOTIFICATION_UNPARENTED" value="19"> Notification received when a node is unparented (parent removed it from the list of children). @@ -953,7 +959,7 @@ Inherits pause mode from the node's parent. For the root node, it is equivalent to [constant PAUSE_MODE_STOP]. Default. </constant> <constant name="PAUSE_MODE_STOP" value="1" enum="PauseMode"> - Stop processing when the [SceneTree] is paused. + Stops processing when the [SceneTree] is paused. </constant> <constant name="PAUSE_MODE_PROCESS" value="2" enum="PauseMode"> Continue to process regardless of the [SceneTree] pause state. diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 1b97f3267f..5fbcbc0665 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Node2D" inherits="CanvasItem" category="Core" version="3.2"> <brief_description> - A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index. + A 2D game object, parent of all 2D-related nodes. Has a position, rotation, scale and Z index. </brief_description> <description> A 2D game object, with a position, rotation and scale. All 2D physics nodes and sprites inherit from Node2D. Use Node2D as a parent node to move, scale and rotate children in a 2D project. Also gives control on the node's render order. @@ -16,7 +16,7 @@ <argument index="0" name="ratio" type="Vector2"> </argument> <description> - Multiplies the current scale by the 'ratio' vector. + Multiplies the current scale by the [code]ratio[/code] vector. </description> </method> <method name="get_angle_to" qualifiers="const"> @@ -25,7 +25,7 @@ <argument index="0" name="point" type="Vector2"> </argument> <description> - Returns the angle between the node and the 'point' in radians. + Returns the angle between the node and the [code]point[/code] in radians. </description> </method> <method name="get_relative_transform_to_parent" qualifiers="const"> @@ -43,7 +43,7 @@ <argument index="0" name="offset" type="Vector2"> </argument> <description> - Adds the 'offset' vector to the node's global position. + Adds the [code]offset[/code] vector to the node's global position. </description> </method> <method name="look_at"> @@ -52,7 +52,7 @@ <argument index="0" name="point" type="Vector2"> </argument> <description> - Rotates the node so it points towards the 'point'. + Rotates the node so it points towards the [code]point[/code]. </description> </method> <method name="move_local_x"> @@ -140,16 +140,16 @@ Rotation in degrees, relative to the node's parent. </member> <member name="scale" type="Vector2" setter="set_scale" getter="get_scale"> - The node's scale. Unscaled value: [code](1, 1)[/code] + The node's scale. Unscaled value: [code](1, 1)[/code]. </member> <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> Local [Transform2D]. </member> <member name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_relative"> - If [code]true[/code], the node's Z-index is 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. + If [code]true[/code], the node's Z index is 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. </member> <member name="z_index" type="int" setter="set_z_index" getter="get_z_index"> - Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. + Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others. </member> </members> <constants> diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 67f12813cc..5deee941da 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -17,21 +17,21 @@ <argument index="0" name="from" type="String"> </argument> <description> - Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent. + Creates a NodePath from a string, e.g. [code]"Path2D/PathFollow2D/Sprite:texture:size"[/code]. A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent. The "subnames" optionally included after the path to the target node can point to resources or properties, and can also be nested. Examples of valid NodePaths (assuming that those nodes exist and have the referenced resources or properties): [codeblock] # Points to the Sprite node "Path2D/PathFollow2D/Sprite" - # Points to the Sprite node and its 'texture' resource. + # Points to the Sprite node and its "texture" resource. # get_node() would retrieve "Sprite", while get_node_and_resource() - # would retrieve both the Sprite node and the 'texture' resource. + # would retrieve both the Sprite node and the "texture" resource. "Path2D/PathFollow2D/Sprite:texture" - # Points to the Sprite node and its 'position' property. + # Points to the Sprite node and its "position" property. "Path2D/PathFollow2D/Sprite:position" - # Points to the Sprite node and the 'x' component of its 'position' property. + # Points to the Sprite node and the "x" component of its "position" property. "Path2D/PathFollow2D/Sprite:position:x" - # Absolute path (from 'root') + # Absolute path (from "root") "/root/Level/Path2D" [/codeblock] </description> @@ -42,9 +42,9 @@ <description> Returns a node path with a colon character ([code]:[/code]) prepended, transforming it to a pure property path with no node name (defaults to resolving from the current node). [codeblock] - # This will be parsed as a node path to the 'x' property in the 'position' node + # This will be parsed as a node path to the "x" property in the "position" node var node_path = NodePath("position:x") - # This will be parsed as a node path to the 'x' component of the 'position' property in the current node + # This will be parsed as a node path to the "x" component of the "position" property in the current node var property_path = node_path.get_as_property_path() print(property_path) # :position:x [/codeblock] @@ -67,7 +67,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the node name indicated by [code]idx[/code] (0 to [method get_name_count]). + Gets the node name indicated by [code]idx[/code] (0 to [method get_name_count]). [codeblock] var node_path = NodePath("Path2D/PathFollow2D/Sprite") print(node_path.get_name(0)) # Path2D @@ -80,7 +80,7 @@ <return type="int"> </return> <description> - Get the number of node names which make up the path. Subnames (see [method get_subname_count]) are not included. + Gets the number of node names which make up the path. Subnames (see [method get_subname_count]) are not included. For example, [code]"Path2D/PathFollow2D/Sprite"[/code] has 3 names. </description> </method> @@ -90,7 +90,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the resource or property name indicated by [code]idx[/code] (0 to [method get_subname_count]). + Gets the resource or property name indicated by [code]idx[/code] (0 to [method get_subname_count]). [codeblock] var node_path = NodePath("Path2D/PathFollow2D/Sprite:texture:load_path") print(node_path.get_subname(0)) # texture @@ -102,7 +102,7 @@ <return type="int"> </return> <description> - Get the number of resource or property names ("subnames") in the path. Each subname is listed after a colon character ([code]:[/code]) in the node path. + Gets the number of resource or property names ("subnames") in the path. Each subname is listed after a colon character ([code]:[/code]) in the node path. For example, [code]"Path2D/PathFollow2D/Sprite:texture:load_path"[/code] has 2 subnames. </description> </method> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index f6e2f47a42..cd530eddfa 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -4,7 +4,7 @@ Operating System functions. </brief_description> <description> - Operating System functions. OS Wraps the most common functionality to communicate with the host Operating System, such as: clipboard, video mode, date and time, timers, environment variables, execution of binaries, command line, etc. + Operating System functions. OS wraps the most common functionality to communicate with the host operating system, such as the clipboard, video driver, date and time, timers, environment variables, execution of binaries, command line, etc. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ <argument index="1" name="title" type="String" default=""Alert!""> </argument> <description> - Displays a modal dialog box utilizing the host OS. + Displays a modal dialog box using the host OS' facilities. Execution is blocked until the dialog is closed. </description> </method> <method name="can_draw" qualifiers="const"> @@ -53,7 +53,7 @@ <argument index="0" name="msec" type="int"> </argument> <description> - Delay execution of the current thread by given milliseconds. + Delay execution of the current thread by [code]msec[/code] milliseconds. </description> </method> <method name="delay_usec" qualifiers="const"> @@ -62,7 +62,7 @@ <argument index="0" name="usec" type="int"> </argument> <description> - Delay execution of the current thread by given microseconds. + Delay execution of the current thread by [code]usec[/code] microseconds. </description> </method> <method name="dump_memory_to_file"> @@ -101,15 +101,15 @@ </argument> <description> Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. - The arguments are used in the given order and separated by a space, so [code]OS.execute('ping', ['-w', '3', 'godotengine.org'], false)[/code] will resolve to [code]ping -w 3 godotengine.org[/code] in the system's shell. + The arguments are used in the given order and separated by a space, so [code]OS.execute("ping", ["-w", "3", "godotengine.org"], false)[/code] will resolve to [code]ping -w 3 godotengine.org[/code] in the system's shell. This method has slightly different behavior based on whether the [code]blocking[/code] mode is enabled. - When [code]blocking[/code] is enabled, the Godot thread will pause its execution while waiting for the process to terminate. The shell output of the process will be written to the [code]output[/code] array as a single string. When the process terminates, the Godot thread will resume execution. - When [code]blocking[/code] is disabled, the Godot thread will continue while the new process runs. It is not possible to retrieve the shell output in non-blocking mode, so [code]output[/code] will be empty. - The return value also depends on the blocking mode. When blocking, the method will return -2 (no process ID information is available in blocking mode). When non-blocking, the method returns a process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process forking (non-blocking) or opening (blocking) fails, the method will return -1. + If [code]blocking[/code] is [code]true[/code], the Godot thread will pause its execution while waiting for the process to terminate. The shell output of the process will be written to the [code]output[/code] array as a single string. When the process terminates, the Godot thread will resume execution. + If [code]blocking[/code] is [code]false[/code], the Godot thread will continue while the new process runs. It is not possible to retrieve the shell output in non-blocking mode, so [code]output[/code] will be empty. + The return value also depends on the blocking mode. When blocking, the method will return -2 (no process ID information is available in blocking mode). When non-blocking, the method returns a process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process forking (non-blocking) or opening (blocking) fails, the method will return [code]-1[/code]. Example of blocking mode and retrieving the shell output: [codeblock] var output = [] - OS.execute('ls', ['-l', '/tmp'], true, output) + OS.execute("ls", ["-l", "/tmp"], true, output) [/codeblock] Example of non-blocking mode, running another instance of the project and storing its process ID: [codeblock] @@ -117,7 +117,7 @@ [/codeblock] If you wish to access a shell built-in or perform a composite command, a platform-specific shell can be invoked. For example: [codeblock] - OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) + OS.execute("CMD.exe", ["/C", "cd %TEMP% && dir"], true, output) [/codeblock] </description> </method> @@ -127,7 +127,7 @@ <argument index="0" name="string" type="String"> </argument> <description> - Returns the scancode of the given string (e.g. "Escape") + Returns the scancode of the given string (e.g. "Escape"). </description> </method> <method name="get_audio_driver_count" qualifiers="const"> @@ -172,7 +172,7 @@ <argument index="0" name="utc" type="bool" default="false"> </argument> <description> - Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time). + Returns current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]dst[/code] (Daylight Savings Time). </description> </method> <method name="get_datetime" qualifiers="const"> @@ -181,7 +181,7 @@ <argument index="0" name="utc" type="bool" default="false"> </argument> <description> - Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second. + Returns current datetime as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]dst[/code] (Daylight Savings Time), [code]hour[/code], [code]minute[/code], [code]second[/code]. </description> </method> <method name="get_datetime_from_unix_time" qualifiers="const"> @@ -190,8 +190,8 @@ <argument index="0" name="unix_time_val" type="int"> </argument> <description> - Get a dictionary of time values when given epoch time. - Dictionary Time values will be a union of values from [method get_time] and [method get_date] dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch). + Gets a dictionary of time values corresponding to the given UNIX epoch time (in seconds). + The returned Dictionary's values will be the same as [method get_datetime], with the exception of Daylight Savings Time as it cannot be determined from the epoch. </description> </method> <method name="get_dynamic_memory_usage" qualifiers="const"> @@ -221,7 +221,7 @@ <return type="Vector2"> </return> <description> - Returns IME cursor position (currently edited portion of the string) relative to the characters in the composition string. + Returns the IME cursor position (the currently-edited portion of the string) relative to the characters in the composition string. [constant MainLoop.NOTIFICATION_OS_IME_UPDATE] is sent to the application to notify it of changes to the IME cursor position. </description> </method> @@ -229,7 +229,7 @@ <return type="String"> </return> <description> - Returns IME intermediate composition string. + Returns the IME intermediate composition string. [constant MainLoop.NOTIFICATION_OS_IME_UPDATE] is sent to the application to notify it of changes to the IME composition string. </description> </method> @@ -238,7 +238,7 @@ </return> <description> Returns the current latin keyboard variant as a String. - Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO", "COLEMAK" or "ERROR". + Possible return values are: [code]"QWERTY"[/code], [code]"AZERTY"[/code], [code]"QZERTY"[/code], [code]"DVORAK"[/code], [code]"NEO"[/code], [code]"COLEMAK"[/code] or [code]"ERROR"[/code]. </description> </method> <method name="get_locale" qualifiers="const"> @@ -259,7 +259,7 @@ <return type="String"> </return> <description> - Returns the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11". + Returns the name of the host OS. Possible values are: [code]"Android"[/code], [code]"Haiku"[/code], [code]"iOS"[/code], [code]"HTML5"[/code], [code]"OSX"[/code], [code]"Server"[/code], [code]"Windows"[/code], [code]"UWP"[/code], [code]"X11"[/code]. </description> </method> <method name="get_power_percent_left"> @@ -273,7 +273,7 @@ <return type="int"> </return> <description> - Returns the time in seconds before the device runs out of battery. + Returns an estimate of the time left in seconds before the device runs out of battery. </description> </method> <method name="get_power_state"> @@ -287,14 +287,14 @@ <return type="int"> </return> <description> - Returns the game process ID + Returns the project's process ID. </description> </method> <method name="get_processor_count" qualifiers="const"> <return type="int"> </return> <description> - Returns the number of cores available in the host machine. + Returns the number of threads available on the host machine. </description> </method> <method name="get_real_window_size" qualifiers="const"> @@ -310,7 +310,7 @@ <argument index="0" name="code" type="int"> </argument> <description> - Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape"). + Returns the given scancode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). </description> </method> <method name="get_screen_count" qualifiers="const"> @@ -327,13 +327,15 @@ </argument> <description> Returns the dots per inch density of the specified screen. - On Android Devices, the actual screen densities are grouped into six generalized densities: - ldpi - 120 dpi - mdpi - 160 dpi - hdpi - 240 dpi - xhdpi - 320 dpi - xxhdpi - 480 dpi - xxxhdpi - 640 dpi + On Android devices, the actual screen densities are grouped into six generalized densities: + [codeblock] + ldpi - 120 dpi + mdpi - 160 dpi + hdpi - 240 dpi + xhdpi - 320 dpi + xxhdpi - 480 dpi + xxxhdpi - 640 dpi + [/codeblock] </description> </method> <method name="get_screen_position" qualifiers="const"> @@ -364,7 +366,7 @@ <return type="int"> </return> <description> - Returns the max amount of static memory used (only works in debug). + Returns the maximum amount of static memory used (only works in debug). </description> </method> <method name="get_static_memory_usage" qualifiers="const"> @@ -432,14 +434,14 @@ </return> <description> Returns a string that is unique to the device. - Returns empty string on HTML5 and UWP which are not supported yet. + [b]Note:[/b] Returns an empty string on HTML5 and UWP, as this method isn't implemented on those platforms yet. </description> </method> <method name="get_unix_time" qualifiers="const"> <return type="int"> </return> <description> - Returns the current unix epoch timestamp. + Returns the current UNIX epoch timestamp. </description> </method> <method name="get_unix_time_from_datetime" qualifiers="const"> @@ -448,9 +450,9 @@ <argument index="0" name="datetime" type="Dictionary"> </argument> <description> - Get an epoch time value from a dictionary of time values. - [code]datetime[/code] must be populated with the following keys: year, month, day, hour, minute, second. - You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored. + Gets an epoch time value from a dictionary of time values. + [code]datetime[/code] must be populated with the following keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]hour[/code], [code]minute[/code], [code]second[/code]. + You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight Savings Time ([code]dst[/code]), if present, is ignored. </description> </method> <method name="get_user_data_dir" qualifiers="const"> @@ -484,7 +486,7 @@ <return type="int"> </return> <description> - Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or it is currently hidden. + Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden. </description> </method> <method name="get_window_safe_area" qualifiers="const"> @@ -509,7 +511,7 @@ </argument> <description> Returns [code]true[/code] if the feature for the given feature tag is supported in the currently running instance, depending on platform, build etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the [url=https://docs.godotengine.org/en/latest/getting_started/workflow/export/feature_tags.html]Feature Tags[/url] documentation for more details. - Note that tag names are case-sensitive. + [b]Note:[/b] Tag names are case-sensitive. </description> </method> <method name="has_touchscreen_ui_hint" qualifiers="const"> @@ -546,7 +548,7 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if the "Okay" button should appear on the left and "Cancel" on the right. + Returns [code]true[/code] if the [b]OK[/b] button should appear on the left and [b]Cancel[/b] on the right. </description> </method> <method name="is_scancode_unicode" qualifiers="const"> @@ -555,14 +557,14 @@ <argument index="0" name="code" type="int"> </argument> <description> - Returns [code]true[/code] if the input code has a unicode character. + Returns [code]true[/code] if the input scancode corresponds to a Unicode character. </description> </method> <method name="is_stdout_verbose" qualifiers="const"> <return type="bool"> </return> <description> - Returns [code]true[/code] if the engine was executed with -v (verbose stdout). + Returns [code]true[/code] if the engine was executed with [code]-v[/code] (verbose stdout). </description> </method> <method name="is_userfs_persistent" qualifiers="const"> @@ -586,7 +588,7 @@ </argument> <description> Kill (terminate) the process identified by the given process ID ([code]pid[/code]), e.g. the one returned by [method execute] in non-blocking mode. - Note that this method can also be used to kill processes that were not spawned by the game. + [b]Note:[/b] This method can also be used to kill processes that were not spawned by the game. </description> </method> <method name="move_window_to_foreground"> @@ -623,7 +625,7 @@ </argument> <description> Plays native video from the specified path, at the given volume and with audio and subtitle tracks. - Note: This method is only implemented on Android and iOS, and the current Android implementation does not support the [code]volume[/code], [code]audio_track[/code] and [code]subtitle_track[/code] options. + [b]Note:[/b] This method is only implemented on Android and iOS, and the current Android implementation does not support the [code]volume[/code], [code]audio_track[/code] and [code]subtitle_track[/code] options. </description> </method> <method name="native_video_stop"> @@ -652,7 +654,7 @@ <argument index="0" name="tofile" type="String" default=""""> </argument> <description> - Shows all resources in the game. Optionally the list can be written to a file. + Shows all resources in the game. Optionally, the list can be written to a file by specifying a file path in [code]tofile[/code]. </description> </method> <method name="print_all_textures_by_size"> @@ -735,7 +737,7 @@ <description> Sets the game's icon using a multi-size platform-specific icon file ([code]*.ico[/code] on Windows and [code]*.icns[/code] on macOS). Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog. - Note: This method is only implemented on macOS and Windows. + [b]Note:[/b] This method is only implemented on macOS and Windows. </description> </method> <method name="set_thread_name"> @@ -791,7 +793,7 @@ <argument index="0" name="existing_text" type="String" default=""""> </argument> <description> - Shows the virtual keyboard if the platform has one. The [i]existing_text[/i] parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). + Shows the virtual keyboard if the platform has one. The [code]existing_text[/code] parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). </description> </method> </methods> @@ -825,7 +827,7 @@ </member> <member name="window_borderless" type="bool" setter="set_borderless_window" getter="get_borderless_window"> If [code]true[/code], removes the window frame. - Note: Setting [code]window_borderless[/code] to [code]false[/code] disables per-pixel transparency. + [b]Note:[/b] Setting [code]window_borderless[/code] to [code]false[/code] disables per-pixel transparency. </member> <member name="window_fullscreen" type="bool" setter="set_window_fullscreen" getter="is_window_fullscreen"> If [code]true[/code], the window is fullscreen. @@ -839,7 +841,7 @@ <member name="window_per_pixel_transparency_enabled" type="bool" setter="set_window_per_pixel_transparency_enabled" getter="get_window_per_pixel_transparency_enabled"> If [code]true[/code], the window background is transparent and window frame is removed. Use [code]get_tree().get_root().set_transparent_background(true)[/code] to disable main viewport background rendering. - Note: This property has no effect if "Project > Project Settings > Display > Window > Per-pixel transparency > Allowed" setting is disabled. + [b]Note:[/b] This property has no effect if [b]Project > Project Settings > Display > Window > Per-pixel transparency > Allowed[/b] setting is disabled. </member> <member name="window_position" type="Vector2" setter="set_window_position" getter="get_window_position"> The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 7b262d80c7..551edff7bd 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -139,7 +139,7 @@ <argument index="4" name="flags" type="int" default="0"> </argument> <description> - Connects a [code]signal[/code] to a [code]method[/code] on a [code]target[/code] object. Pass optional [code]binds[/code] to the call as an [Array] of parameters. Use [code]flags[/code] to set deferred or one shot connections. See [enum ConnectFlags] constants. + Connects a [code]signal[/code] to a [code]method[/code] on a [code]target[/code] object. Pass optional [code]binds[/code] to the call as an [Array] of parameters. Use [code]flags[/code] to set deferred or one-shot connections. See [enum ConnectFlags] constants. A [code]signal[/code] can only be connected once to a [code]method[/code]. It will throw an error if already connected, unless the signal was connected with [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] to check for existing connections. If the [code]target[/code] is destroyed in the game's lifecycle, the connection will be lost. Examples: @@ -217,7 +217,7 @@ <argument index="0" name="property" type="NodePath"> </argument> <description> - Get the object's property indexed by the given [NodePath]. The node path should be relative to the current object and can use the colon character ([code]:[/code]) to access nested properties. Examples: [code]"position:x"[/code] or [code]"material:next_pass:blend_mode"[/code]. + Gets the object's property indexed by the given [NodePath]. The node path should be relative to the current object and can use the colon character ([code]:[/code]) to access nested properties. Examples: [code]"position:x"[/code] or [code]"material:next_pass:blend_mode"[/code]. </description> </method> <method name="get_instance_id" qualifiers="const"> @@ -483,13 +483,13 @@ Called before the object is about to be deleted. </constant> <constant name="CONNECT_DEFERRED" value="1" enum="ConnectFlags"> - Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time. + Connects a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time. </constant> <constant name="CONNECT_PERSIST" value="2" enum="ConnectFlags"> Persisting connections are saved when the object is serialized to file. </constant> <constant name="CONNECT_ONESHOT" value="4" enum="ConnectFlags"> - One shot connections disconnect themselves after emission. + One-shot connections disconnect themselves after emission. </constant> <constant name="CONNECT_REFERENCE_COUNTED" value="8" enum="ConnectFlags"> Connect a signal as reference counted. This means that a given signal can be connected several times to the same target, and will only be fully disconnected once no references are left. diff --git a/doc/classes/OccluderPolygon2D.xml b/doc/classes/OccluderPolygon2D.xml index a52d51fa7d..ffab87f1a6 100644 --- a/doc/classes/OccluderPolygon2D.xml +++ b/doc/classes/OccluderPolygon2D.xml @@ -15,21 +15,22 @@ If [code]true[/code], closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value: [code]true[/code]. </member> <member name="cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="OccluderPolygon2D.CullMode"> - Set the direction of the occlusion culling or disable it. Default value: [constant CULL_DISABLED]. + The culling mode to use. Default value: [constant CULL_DISABLED]. </member> <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> - A [Vector2] array with the index for polygon's vertices positions. Note that the returned value is a copy of the underlying array, rather than a reference. + A [Vector2] array with the index for polygon's vertices positions. + [b]Note:[/b] The returned value is a copy of the underlying array, rather than a reference. </member> </members> <constants> <constant name="CULL_DISABLED" value="0" enum="CullMode"> - Culling mode for the occlusion. Disabled means no culling. See [member cull_mode]. + Culling is disabled. See [member cull_mode]. </constant> <constant name="CULL_CLOCKWISE" value="1" enum="CullMode"> - Culling mode for the occlusion. Sets the culling to be in clockwise direction. See [member cull_mode]. + Culling is performed in the clockwise direction. See [member cull_mode]. </constant> <constant name="CULL_COUNTER_CLOCKWISE" value="2" enum="CullMode"> - Culling mode for the occlusion. Sets the culling to be in counter clockwise direction. See [member cull_mode]. + Culling is performed in the counterclockwise direction. See [member cull_mode]. </constant> </constants> </class> diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml index 408018fdcb..b051f62bfb 100644 --- a/doc/classes/OmniLight.xml +++ b/doc/classes/OmniLight.xml @@ -13,10 +13,10 @@ </methods> <members> <member name="omni_attenuation" type="float" setter="set_param" getter="get_param"> - The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. + The light's attenuation (drop-off) curve. A number of presets are available in the [b]Inspector[/b] by right-clicking the curve. </member> <member name="omni_range" type="float" setter="set_param" getter="get_param"> - Maximum distance the light affects. + The light's radius. </member> <member name="omni_shadow_detail" type="int" setter="set_shadow_detail" getter="get_shadow_detail" enum="OmniLight.ShadowDetail"> See [enum ShadowDetail]. @@ -27,8 +27,10 @@ </members> <constants> <constant name="SHADOW_DUAL_PARABOLOID" value="0" enum="ShadowMode"> + Shadows are rendered to a dual-paraboloid texture. Faster than [constant SHADOW_CUBE], but lower-quality. </constant> <constant name="SHADOW_CUBE" value="1" enum="ShadowMode"> + Shadows are rendered to a cubemap. Slower than [constant SHADOW_DUAL_PARABOLOID], but higher-quality. </constant> <constant name="SHADOW_DETAIL_VERTICAL" value="0" enum="ShadowDetail"> </constant> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 1f714656de..9c8066fa61 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -19,7 +19,7 @@ <argument index="2" name="id" type="int" default="-1"> </argument> <description> - Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. + Adds an item, with a [code]texture[/code] icon, text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, [code]id[/code] becomes the item index. New items are appended at the end. </description> </method> <method name="add_item"> @@ -30,14 +30,14 @@ <argument index="1" name="id" type="int" default="-1"> </argument> <description> - Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. + Adds an item, with text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, [code]id[/code] becomes the item index. New items are appended at the end. </description> </method> <method name="add_separator"> <return type="void"> </return> <description> - Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. + Adds a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. </description> </method> <method name="clear"> @@ -60,7 +60,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the icon of the item at index "idx". + Returns the icon of the item at index [code]idx[/code]. </description> </method> <method name="get_item_id" qualifiers="const"> @@ -95,7 +95,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the text of the item at index "idx". + Returns the text of the item at index [code]idx[/code]. </description> </method> <method name="get_popup" qualifiers="const"> @@ -160,7 +160,7 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> - Set the icon of an item at index "idx". + Sets the icon of an item at index [code]idx[/code]. </description> </method> <method name="set_item_id"> @@ -171,7 +171,7 @@ <argument index="1" name="id" type="int"> </argument> <description> - Set the ID of an item at index "idx". + Sets the ID of an item at index [code]idx[/code]. </description> </method> <method name="set_item_metadata"> @@ -192,7 +192,7 @@ <argument index="1" name="text" type="String"> </argument> <description> - Set the text of an item at index "idx". + Sets the text of an item at index [code]idx[/code]. </description> </method> </methods> @@ -205,14 +205,14 @@ <argument index="0" name="id" type="int"> </argument> <description> - This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument. + Emitted the when user navigates to an item using the [code]ui_up[/code] or [code]ui_down[/code] actions. The index of the item selected is passed as argument. </description> </signal> <signal name="item_selected"> <argument index="0" name="id" type="int"> </argument> <description> - This signal is emitted when the current item was changed by the user. Index of the item selected is passed as argument. + Emitted when the current item has been changed by the user. The index of the item selected is passed as argument. </description> </signal> </signals> diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 7827571178..a5989f8494 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -5,26 +5,27 @@ </brief_description> <description> A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself. - Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see [code]owner[/code] property on [Node]). Note that the node doesn't need to own itself. - Example of saving a node with different owners: The following example creates 3 objects: [code]Node2D[/code] ([code]node[/code]), [code]RigidBody2D[/code] ([code]rigid[/code]) and [code]CollisionObject2D[/code] ([code]collision[/code]). [code]collision[/code] is a child of [code]rigid[/code] which is a child of [code]node[/code]. Only [code]rigid[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code]. + Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see [code]owner[/code] property on [Node]). + [b]Note:[/b] The node doesn't need to own itself. + [b]Example of saving a node with different owners:[/b] The following example creates 3 objects: [code]Node2D[/code] ([code]node[/code]), [code]RigidBody2D[/code] ([code]rigid[/code]) and [code]CollisionObject2D[/code] ([code]collision[/code]). [code]collision[/code] is a child of [code]rigid[/code] which is a child of [code]node[/code]. Only [code]rigid[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code]. [codeblock] - # create the objects + # Create the objects var node = Node2D.new() var rigid = RigidBody2D.new() var collision = CollisionShape2D.new() - # create the object hierarchy + # Create the object hierarchy rigid.add_child(collision) node.add_child(rigid) - # change owner of rigid, but not of collision + # Change owner of rigid, but not of collision rigid.owner = node var scene = PackedScene.new() - # only node and rigid are now packed + # Only node and rigid are now packed var result = scene.pack(node) if result == OK: - ResourceSaver.save("res://path/name.scn", scene) # or user://... + ResourceSaver.save("res://path/name.scn", scene) # Or "user://..." [/codeblock] </description> <tutorials> @@ -74,10 +75,12 @@ If passed to [method instance], blocks edits to the scene state. </constant> <constant name="GEN_EDIT_STATE_INSTANCE" value="1" enum="GenEditState"> - If passed to [method instance], provides local scene resources to the local scene. Requires tools compiled. + If passed to [method instance], provides local scene resources to the local scene. + [b]Note:[/b] Only available in editor builds. </constant> <constant name="GEN_EDIT_STATE_MAIN" value="2" enum="GenEditState"> - If passed to [method instance], provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled. + If passed to [method instance], provides local scene resources to the local scene. Only the main scene should receive the main edit state. + [b]Note:[/b] Only available in editor builds. </constant> </constants> </class> diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index 4109d9d462..34357eb835 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -4,7 +4,7 @@ Abstraction and base class for packet-based protocols. </brief_description> <description> - PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. + PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low-level bytes or having to worry about network ordering. </description> <tutorials> </tutorials> @@ -20,7 +20,7 @@ <return type="PoolByteArray"> </return> <description> - Get a raw packet. + Gets a raw packet. </description> </method> <method name="get_packet_error" qualifiers="const"> @@ -36,8 +36,8 @@ <argument index="0" name="allow_objects" type="bool" default="false"> </argument> <description> - Get a Variant. When [code]allow_objects[/code] (or [member allow_object_decoding]) is [code]true[/code] decoding objects is allowed. - [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). + Gets a Variant. If [code]allow_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], decoding objects is allowed. + [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </description> </method> <method name="put_packet"> @@ -46,7 +46,7 @@ <argument index="0" name="buffer" type="PoolByteArray"> </argument> <description> - Send a raw packet. + Sends a raw packet. </description> </method> <method name="put_var"> @@ -57,15 +57,15 @@ <argument index="1" name="full_objects" type="bool" default="false"> </argument> <description> - Send a Variant as a packet. When [code]full_objects[/code] (or [member allow_object_decoding]) is [code]true[/code] encoding objects is allowed (and can potentially include code). + Sends a [Variant] as a packet. If [code]full_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], encoding objects is allowed (and can potentially include code). </description> </method> </methods> <members> <member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed"> - Deprecated. Use [code]get_var[/code] and [code]put_var[/code] parameters instead. - If [code]true[/code] the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. - [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). + [i]Deprecated.[/i] Use [code]get_var[/code] and [code]put_var[/code] parameters instead. + If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. + [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </member> </members> <constants> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 376818fb86..260dbae8e2 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -13,7 +13,7 @@ <return type="void"> </return> <description> - Close the UDP socket the [PacketPeerUDP] is currently listening on. + Closes the UDP socket the [PacketPeerUDP] is currently listening on. </description> </method> <method name="get_packet_ip" qualifiers="const"> @@ -45,7 +45,7 @@ <argument index="1" name="interface_name" type="String"> </argument> <description> - Join the multicast group specified by [code]multicast_address[/code] using the interface identified by [code]interface_name[/code]. + Joins the multicast group specified by [code]multicast_address[/code] using the interface identified by [code]interface_name[/code]. You can join the same multicast group with multiple interfaces. Use [method IP.get_local_interfaces] to know which are available. </description> </method> @@ -57,7 +57,7 @@ <argument index="1" name="interface_name" type="String"> </argument> <description> - Remove the interface identified by [code]interface_name[/code] from the multicast group specified by [code]multicast_address[/code]. + Removes the interface identified by [code]interface_name[/code] from the multicast group specified by [code]multicast_address[/code]. </description> </method> <method name="listen"> @@ -70,10 +70,10 @@ <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". - 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). + Makes this [PacketPeerUDP] listen on the [code]port[/code] binding to [code]bind_address[/code] with a buffer size [code]recv_buf_size[/code]. + If [code]bind_address[/code] is set to [code]"*"[/code] (default), the peer will listen on all available addresses (both IPv4 and IPv6). + If [code]bind_address[/code] is set to [code]"0.0.0.0"[/code] (for IPv4) or [code]"::"[/code] (for IPv6), the peer will listen on all available addresses matching that IP type. + If [code]bind_address[/code] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). </description> </method> <method name="set_dest_address"> @@ -84,14 +84,14 @@ <argument index="1" name="port" type="int"> </argument> <description> - Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid. + Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed. </description> </method> <method name="wait"> <return type="int" enum="Error"> </return> <description> - Wait for a packet to arrive on the listening port, see [method listen]. + Waits for a packet to arrive on the listening port. See [method listen]. </description> </method> </methods> diff --git a/doc/classes/PanoramaSky.xml b/doc/classes/PanoramaSky.xml index 30d15c030a..96aefc0623 100644 --- a/doc/classes/PanoramaSky.xml +++ b/doc/classes/PanoramaSky.xml @@ -4,7 +4,7 @@ A type of [Sky] used to draw a background texture. </brief_description> <description> - A resource referenced in an [Environment] that is used to draw a background. The Panorama sky functions similar to skyboxes in other engines except it uses a equirectangular sky map instead of a cube map. + A resource referenced in an [Environment] that is used to draw a background. The Panorama sky functions similar to skyboxes in other engines, except it uses an equirectangular sky map instead of a cube map. </description> <tutorials> </tutorials> diff --git a/doc/classes/ParallaxBackground.xml b/doc/classes/ParallaxBackground.xml index 6c9d5de945..ae560f22f1 100644 --- a/doc/classes/ParallaxBackground.xml +++ b/doc/classes/ParallaxBackground.xml @@ -12,19 +12,19 @@ </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. + The base position offset for 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. + The base motion scale for 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. + 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. + Bottom-right 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. diff --git a/doc/classes/ParallaxLayer.xml b/doc/classes/ParallaxLayer.xml index 993f38c31a..4b3861ed11 100644 --- a/doc/classes/ParallaxLayer.xml +++ b/doc/classes/ParallaxLayer.xml @@ -6,7 +6,7 @@ <description> 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. - Note that any changes to this node's position and scale made after it enters the scene will be ignored. + [b]Note:[/b] Any changes to this node's position and scale made after it enters the scene will be ignored. </description> <tutorials> </tutorials> @@ -14,13 +14,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]. + 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. + 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/Particles.xml b/doc/classes/Particles.xml index d7e939ba31..a395b6c525 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -15,7 +15,7 @@ <return type="AABB"> </return> <description> - Returns the bounding box that contains all the particles that are active in the current frame. + Returns the axis-aligned bounding box that contains all the particles that are active in the current frame. </description> </method> <method name="restart"> @@ -52,7 +52,7 @@ If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. </member> <member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio"> - Time ratio between each emission. If [code]0[/code] particles are emitted continuously. If [code]1[/code] all particles are emitted simultaneously. Default value: [code]0[/code]. + Time ratio between each emission. If [code]0[/code], particles are emitted continuously. If [code]1[/code], all particles are emitted simultaneously. Default value: [code]0[/code]. </member> <member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps"> The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index a874e8f6a0..676c633fa7 100644 --- a/doc/classes/Particles2D.xml +++ b/doc/classes/Particles2D.xml @@ -43,7 +43,7 @@ The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. </member> <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta"> - If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code] + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]. </member> <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime"> Amount of time each particle will exist. Default value: [code]1[/code]. @@ -70,7 +70,7 @@ Particle system's running speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles. </member> <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> - Particle texture. If [code]null[/code] particles will be squares. + Particle texture. If [code]null[/code], particles will be squares. </member> <member name="visibility_rect" type="Rect2" setter="set_visibility_rect" getter="get_visibility_rect"> Editor visibility helper. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 00862e5672..4c85a21ff0 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -15,7 +15,7 @@ <members> <member name="angle" type="float" setter="set_param" getter="get_param"> Initial rotation applied to each particle, in degrees. - Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [code]BillboardMode.BILLBOARD_PARTICLES[/code]. + Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES]. </member> <member name="angle_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> Each particle's rotation will be animated along this [CurveTexture]. @@ -25,7 +25,7 @@ </member> <member name="angular_velocity" type="float" setter="set_param" getter="get_param"> Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. - Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [code]BillboardMode.BILLBOARD_PARTICLES[/code]. + Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES]. </member> <member name="angular_velocity_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> Each particle's angular velocity will vary along this [CurveTexture]. @@ -88,13 +88,13 @@ The sphere's radius if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_SPHERE]. </member> <member name="flag_align_y" type="bool" setter="set_flag" getter="get_flag"> - Align y-axis of particle with the direction of its velocity. + Align Y axis of particle with the direction of its velocity. </member> <member name="flag_disable_z" type="bool" setter="set_flag" getter="get_flag"> If [code]true[/code], particles will not move on the z axis. Default value: [code]true[/code] for [Particles2D], [code]false[/code] for [Particles]. </member> <member name="flag_rotate_y" type="bool" setter="set_flag" getter="get_flag"> - If [code]true[/code], particles rotate around y-axis by [member angle]. + If [code]true[/code], particles rotate around Y axis by [member angle]. </member> <member name="flatness" type="float" setter="set_flatness" getter="get_flatness"> Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane. Default [code]0[/code]. diff --git a/doc/classes/Path2D.xml b/doc/classes/Path2D.xml index a50df96bda..b49a3d928d 100644 --- a/doc/classes/Path2D.xml +++ b/doc/classes/Path2D.xml @@ -4,8 +4,8 @@ Contains a [Curve2D] path for [PathFollow2D] nodes to follow. </brief_description> <description> - Can have [PathFollow2D] child nodes moving along the [Curve2D]. See [PathFollow2D] for more information on the usage. - Note that the path is considered as relative to the moved nodes (children of [PathFollow2D]). As such, the curve should usually start with a zero vector [code](0, 0)[/code]. + Can have [PathFollow2D] child nodes moving along the [Curve2D]. See [PathFollow2D] for more information on usage. + [b]Note:[/b] The path is considered as relative to the moved nodes (children of [PathFollow2D]). As such, the curve should usually start with a zero vector ([code](0, 0)[/code]). </description> <tutorials> </tutorials> diff --git a/doc/classes/PathFollow.xml b/doc/classes/PathFollow.xml index f0b238eb1d..58f66b07d6 100644 --- a/doc/classes/PathFollow.xml +++ b/doc/classes/PathFollow.xml @@ -5,7 +5,7 @@ </brief_description> <description> This node takes its parent [Path], and returns the coordinates of a point within it, given a distance from the first vertex. - It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. + It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be children of this node. The descendant nodes will then move accordingly when setting an offset in this node. </description> <tutorials> </tutorials> @@ -15,7 +15,7 @@ <member name="cubic_interp" type="bool" setter="set_cubic_interpolation" getter="get_cubic_interpolation"> If [code]true[/code], the position between two cached points is interpolated cubically, and linearly otherwise. The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. - There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. + There are two answers to this problem: either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. </member> <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset"> The node's offset along the curve. diff --git a/doc/classes/PathFollow2D.xml b/doc/classes/PathFollow2D.xml index 6f38b9f08d..dcf19a2232 100644 --- a/doc/classes/PathFollow2D.xml +++ b/doc/classes/PathFollow2D.xml @@ -5,7 +5,7 @@ </brief_description> <description> This node takes its parent [Path2D], and returns the coordinates of a point within it, given a distance from the first vertex. - It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. + It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be children of this node. The descendant nodes will then move accordingly when setting an offset in this node. </description> <tutorials> </tutorials> @@ -15,7 +15,7 @@ <member name="cubic_interp" type="bool" setter="set_cubic_interpolation" getter="get_cubic_interpolation"> If [code]true[/code], the position between two cached points is interpolated cubically, and linearly otherwise. The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. - There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. + There are two answers to this problem: either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. </member> <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset"> The node's offset along the curve. diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index 3bcc001a2b..a2b5856624 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -4,8 +4,9 @@ Exposes performance-related data. </brief_description> <description> - This class provides access to a number of different monitors related to performance, such as memory usage, draw calls, and FPS. These are the same as the values displayed in the [i]Monitor[/i] tab in the editor's [i]Debugger[/i] panel. By using the [method get_monitor] method of this class, you can access this data from your code. Note that a few of these monitors are only available in debug mode and will always return 0 when used in a release build. - Many of these monitors are not updated in real-time, so there may be a short delay between changes. + This class provides access to a number of different monitors related to performance, such as memory usage, draw calls, and FPS. These are the same as the values displayed in the [b]Monitor[/b] tab in the editor's [b]Debugger[/b] panel. By using the [method get_monitor] method of this class, you can access this data from your code. + [b]Note:[/b] A few of these monitors are only available in debug mode and will always return 0 when used in a release build. + [b]Note:[/b] Many of these monitors are not updated in real-time, so there may be a short delay between changes. </description> <tutorials> </tutorials> @@ -67,7 +68,7 @@ Vertices drawn per frame. 3D only. </constant> <constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="14" enum="Monitor"> - Material changes per frame. 3D only + Material changes per frame. 3D only. </constant> <constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="15" enum="Monitor"> Shader changes per frame. 3D only. diff --git a/doc/classes/Physics2DDirectBodyState.xml b/doc/classes/Physics2DDirectBodyState.xml index 1fd578ecd8..af3bba9b86 100644 --- a/doc/classes/Physics2DDirectBodyState.xml +++ b/doc/classes/Physics2DDirectBodyState.xml @@ -56,7 +56,7 @@ <argument index="1" name="impulse" type="Vector2"> </argument> <description> - Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate dependent force. For this reason it should only be used when simulating one-time impacts (use the "_force" functions otherwise). The offset uses the rotation of the global coordinate system, but is centered at the object's origin. + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). The offset uses the rotation of the global coordinate system, but is centered at the object's origin. </description> </method> <method name="apply_torque_impulse"> @@ -135,7 +135,8 @@ <return type="int"> </return> <description> - Returns the number of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. See [member RigidBody2D.contact_monitor]. + Returns the number of contacts this body has with other bodies. + [b]Note:[/b] By default, this returns 0 unless bodies are configured to monitor contacts. See [member RigidBody2D.contact_monitor]. </description> </method> <method name="get_contact_local_normal" qualifiers="const"> diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml index 040d7d05c3..e11e8918cd 100644 --- a/doc/classes/Physics2DDirectSpaceState.xml +++ b/doc/classes/Physics2DDirectSpaceState.xml @@ -16,8 +16,8 @@ <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> </argument> <description> - Checks how far the shape can travel toward a point. Note that both the shape and the motion are supplied through a [Physics2DShapeQueryParameters] object. The method will return an array with two floats between 0 and 1, both representing a fraction of [code]motion[/code]. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be [code][1, 1][/code]. - If the shape can not move, the array will be empty. + Checks how far the shape can travel toward a point. If the shape can not move, the array will be empty. + [b]Note:[/b] Both the shape and the motion are supplied through a [Physics2DShapeQueryParameters] object. The method will return an array with two floats between 0 and 1, both representing a fraction of [code]motion[/code]. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be [code][1, 1][/code]. </description> </method> <method name="collide_shape"> @@ -37,7 +37,8 @@ <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> </argument> <description> - Checks the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. If it collides with more than one shape, the nearest one is selected. Note that this method does not take into account the [code]motion[/code] property of the object. The returned object is a dictionary containing the following fields: + Checks the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead. + [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The returned object is a dictionary containing the following fields: [code]collider_id[/code]: The colliding object's ID. [code]linear_velocity[/code]: The colliding object's velocity [Vector2]. If the object is an [Area2D], the result is [code](0, 0)[/code]. [code]metadata[/code]: The intersecting shape's metadata. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. @@ -45,7 +46,6 @@ [code]point[/code]: The intersection point. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. - If the shape did not intersect anything, then an empty dictionary is returned instead. </description> </method> <method name="intersect_point"> @@ -129,7 +129,8 @@ <argument index="1" name="max_results" type="int" default="32"> </argument> <description> - Checks the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. Note that this method does not take into account the [code]motion[/code] property of the object. The intersected shapes are returned in an array containing dictionaries with the following fields: + Checks the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. + [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The intersected shapes are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. [code]collider_id[/code]: The colliding object's ID. [code]metadata[/code]: The intersecting shape's metadata. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index de4a8c233e..ba00438ea1 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Physics2DServer" inherits="Object" category="Core" version="3.2"> <brief_description> - Physics 2D Server. + Server interface for low-level 2D physics access. </brief_description> <description> - Physics 2D Server is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree. + Physics2DServer is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree. </description> <tutorials> </tutorials> @@ -940,7 +940,7 @@ <argument index="0" name="joint" type="RID"> </argument> <description> - Returns the type of a joint (see [enum JointType]). + Returns a joint's type (see [enum JointType]). </description> </method> <method name="joint_set_param"> @@ -1017,7 +1017,7 @@ <argument index="0" name="shape" type="RID"> </argument> <description> - Returns the type of shape (see [enum ShapeType]). + Returns a shape's type (see [enum ShapeType]). </description> </method> <method name="shape_set_data"> @@ -1248,13 +1248,13 @@ <constant name="JOINT_PARAM_MAX_FORCE" value="2" enum="JointParam"> </constant> <constant name="DAMPED_STRING_REST_LENGTH" value="0" enum="DampedStringParam"> - Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. + Sets the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. </constant> <constant name="DAMPED_STRING_STIFFNESS" value="1" enum="DampedStringParam"> - Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. + Sets the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. </constant> <constant name="DAMPED_STRING_DAMPING" value="2" enum="DampedStringParam"> - Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). + Sets the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). </constant> <constant name="CCD_MODE_DISABLED" value="0" enum="CCDMode"> Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 43d9b71c94..7459e120f5 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -15,7 +15,7 @@ <argument index="0" name="shape" type="Resource"> </argument> <description> - Set the [Shape2D] that will be used for collision/intersection queries. + Sets the [Shape2D] that will be used for collision/intersection queries. </description> </method> </methods> @@ -37,7 +37,7 @@ The motion of the shape being queried for. </member> <member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid"> - The [RID] of the queried shape. See [method set_shape] also. + The [RID] of the queried shape. See also [method set_shape]. </member> <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> the transform matrix of the queried shape. diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml index e556e8037a..e68d280cd1 100644 --- a/doc/classes/PhysicsDirectBodyState.xml +++ b/doc/classes/PhysicsDirectBodyState.xml @@ -57,7 +57,7 @@ <argument index="1" name="j" type="Vector3"> </argument> <description> - Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate dependent force. For this reason it should only be used when simulating one-time impacts. The position uses the rotation of the global coordinate system, but is centered at the object's origin. + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason it should only be used when simulating one-time impacts. The position uses the rotation of the global coordinate system, but is centered at the object's origin. </description> </method> <method name="apply_torque_impulse"> @@ -66,7 +66,7 @@ <argument index="0" name="j" type="Vector3"> </argument> <description> - Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector. + Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the vector [code]j[/code] passed as parameter. </description> </method> <method name="get_contact_collider" qualifiers="const"> @@ -127,7 +127,8 @@ <return type="int"> </return> <description> - Returns the number of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. See [member RigidBody.contact_monitor]. + Returns the number of contacts this body has with other bodies. + [b]Note:[/b] By default, this returns 0 unless bodies are configured to monitor contacts. See [member RigidBody.contact_monitor]. </description> </method> <method name="get_contact_impulse" qualifiers="const"> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 77536e2b5b..b06b0df40d 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PhysicsServer" inherits="Object" category="Core" version="3.2"> <brief_description> - Server interface for low level physics access. + Server interface for low-level physics access. </brief_description> <description> - Everything related to physics in 3D. + PhysicsServer is the server responsible for all 3D physics. It can create many kinds of physics objects, but does not insert them on the node tree. </description> <tutorials> </tutorials> @@ -68,7 +68,7 @@ <argument index="1" name="param" type="int" enum="PhysicsServer.AreaParameter"> </argument> <description> - Returns an area parameter value. A list of available parameters is on the AREA_PARAM_* constants. + Returns an area parameter value. A list of available parameters is on the [code]AREA_PARAM_*[/code] constants. </description> </method> <method name="area_get_shape" qualifiers="const"> @@ -221,7 +221,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants. + Sets the value for an area parameter. A list of available parameters is on the [code]AREA_PARAM_*[/code] constants. </description> </method> <method name="area_set_ray_pickable"> @@ -292,7 +292,7 @@ <argument index="1" name="mode" type="int" enum="PhysicsServer.AreaSpaceOverrideMode"> </argument> <description> - Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*. + Sets the space override mode for the area. The modes are described in the constants [code]AREA_SPACE_OVERRIDE_*[/code]. </description> </method> <method name="area_set_transform"> @@ -500,7 +500,7 @@ <argument index="1" name="param" type="int" enum="PhysicsServer.BodyParameter"> </argument> <description> - Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM_* constants. + Returns the value of a body parameter. A list of available parameters is on the [code]BODY_PARAM_*[/code] constants. </description> </method> <method name="body_get_shape" qualifiers="const"> @@ -588,7 +588,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - If [code]true[/code], the body can be detected by rays + If [code]true[/code], the body can be detected by rays. </description> </method> <method name="body_remove_collision_exception"> @@ -739,7 +739,7 @@ <argument index="2" name="value" type="float"> </argument> <description> - Sets a body parameter. A list of available parameters is on the BODY_PARAM_* constants. + Sets a body parameter. A list of available parameters is on the [code]BODY_PARAM_*[/code] constants. </description> </method> <method name="body_set_ray_pickable"> @@ -1144,7 +1144,7 @@ <argument index="0" name="type" type="int" enum="PhysicsServer.ShapeType"> </argument> <description> - Creates a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. + Creates a shape of type [code]SHAPE_*[/code]. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. </description> </method> <method name="shape_get_data" qualifiers="const"> @@ -1162,7 +1162,7 @@ <argument index="0" name="shape" type="RID"> </argument> <description> - Returns the type of shape (see SHAPE_* constants). + Returns the type of shape (see [code]SHAPE_*[/code] constants). </description> </method> <method name="shape_set_data"> @@ -1257,7 +1257,7 @@ <argument index="2" name="value" type="float"> </argument> <description> - Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants. + Sets the value for a space parameter. A list of available parameters is on the [code]SPACE_PARAM_*[/code] constants. </description> </method> </methods> @@ -1318,10 +1318,10 @@ If [code]true[/code], a motor turns the Hinge </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0" enum="SliderJointParam"> - The maximum difference between the pivot points on their x-axis before damping happens. + The maximum difference between the pivot points on their X axis before damping happens. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1" enum="SliderJointParam"> - The minimum difference between the pivot points on their x-axis before damping happens. + The minimum difference between the pivot points on their X axis before damping happens. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="SliderJointParam"> A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index 4546377171..925722fd21 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PinJoint" inherits="Joint" category="Core" version="3.2"> <brief_description> - Pin Joint for 3D Shapes. + Pin joint for 3D shapes. </brief_description> <description> - Pin Joint for 3D Rigid Bodies. It pins 2 bodies (rigid or static) together. + Pin joint for 3D rigid bodies. It pins 2 bodies (rigid or static) together. </description> <tutorials> </tutorials> @@ -12,12 +12,10 @@ </methods> <members> <member name="params/bias" type="float" setter="set_param" getter="get_param"> - The force with which the pinned objects stay in positional relation to each other. - The higher, the stronger. + The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. </member> <member name="params/damping" type="float" setter="set_param" getter="get_param"> - The force with which the pinned objects stay in velocity relation to each other. - The higher, the stronger. + The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. </member> <member name="params/impulse_clamp" type="float" setter="set_param" getter="get_param"> If above 0, this value is the maximum value for an impulse that this Joint produces. @@ -25,12 +23,10 @@ </members> <constants> <constant name="PARAM_BIAS" value="0" enum="Param"> - The force with which the pinned objects stay in positional relation to each other. - The higher, the stronger. + The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. </constant> <constant name="PARAM_DAMPING" value="1" enum="Param"> - The force with which the pinned objects stay in velocity relation to each other. - The higher, the stronger. + The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. </constant> <constant name="PARAM_IMPULSE_CLAMP" value="2" enum="Param"> If above 0, this value is the maximum value for an impulse that this Joint produces. diff --git a/doc/classes/PinJoint2D.xml b/doc/classes/PinJoint2D.xml index 4a11ce30e1..bb65172365 100644 --- a/doc/classes/PinJoint2D.xml +++ b/doc/classes/PinJoint2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PinJoint2D" inherits="Joint2D" category="Core" version="3.2"> <brief_description> - Pin Joint for 2D Shapes. + Pin Joint for 2D shapes. </brief_description> <description> - Pin Joint for 2D Rigid Bodies. It pins two bodies (rigid or static) together. + Pin Joint for 2D rigid bodies. It pins two bodies (rigid or static) together. </description> <tutorials> </tutorials> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index a5e5c7022f..841f4c08d8 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -22,7 +22,7 @@ <argument index="3" name="d" type="float"> </argument> <description> - Creates a plane from the four parameters "a", "b", "c" and "d". + Creates a plane from the four parameters [code]a[/code], [code]b[/code], [code]c[/code] and [code]d[/code]. </description> </method> <method name="Plane"> @@ -62,7 +62,7 @@ <argument index="0" name="point" type="Vector3"> </argument> <description> - Returns the shortest distance from the plane to the position "point". + Returns the shortest distance from the plane to the position [code]point[/code]. </description> </method> <method name="get_any_point"> @@ -80,7 +80,7 @@ <argument index="1" name="epsilon" type="float" default="0.00001"> </argument> <description> - Returns [code]true[/code] if "point" is inside the plane (by a very minimum threshold). + Returns [code]true[/code] if [code]point[/code] is inside the plane (by a very minimum [code]epsilon[/code] threshold). </description> </method> <method name="intersect_3"> @@ -91,7 +91,7 @@ <argument index="1" name="c" type="Plane"> </argument> <description> - Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned. + Returns the intersection point of the three planes [code]b[/code], [code]c[/code] and this plane. If no intersection is found, [code]null[/code] is returned. </description> </method> <method name="intersects_ray"> @@ -102,7 +102,7 @@ <argument index="1" name="dir" type="Vector3"> </argument> <description> - Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned. + Returns the intersection point of a ray consisting of the position [code]from[/code] and the direction normal [code]dir[/code] with this plane. If no intersection is found, [code]null[/code] is returned. </description> </method> <method name="intersects_segment"> @@ -113,7 +113,7 @@ <argument index="1" name="end" type="Vector3"> </argument> <description> - Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned. + Returns the intersection point of a segment from position [code]begin[/code] to position [code]end[/code] with this plane. If no intersection is found, [code]null[/code] is returned. </description> </method> <method name="is_point_over"> @@ -122,7 +122,7 @@ <argument index="0" name="point" type="Vector3"> </argument> <description> - Returns [code]true[/code] if "point" is located above the plane. + Returns [code]true[/code] if [code]point[/code] is located above the plane. </description> </method> <method name="normalized"> @@ -138,7 +138,7 @@ <argument index="0" name="point" type="Vector3"> </argument> <description> - Returns the orthogonal projection of point "p" into a point in the plane. + Returns the orthogonal projection of point [code]p[/code] into a point in the plane. </description> </method> </methods> diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 8f434e5499..4cfffa8a25 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -97,7 +97,8 @@ The offset applied to each vertex. </member> <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> - The polygon's list of vertices. The final point will be connected to the first. Note that this returns a copy of the [PoolVector2Array] rather than a reference. + The polygon's list of vertices. The final point will be connected to the first. + [b]Note:[/b] This returns a copy of the [PoolVector2Array] rather than a reference. </member> <member name="polygons" type="Array" setter="set_polygons" getter="get_polygons"> </member> diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index cb99b660ae..08848e789b 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -4,7 +4,8 @@ A pooled [Array] of bytes. </brief_description> <description> - An [Array] specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference. + An [Array] specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory. + [b]Note:[/b] This type is passed by value and not by reference. </description> <tutorials> </tutorials> @@ -15,21 +16,21 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new [PoolByteArray]. Optionally, you can pass in a generic [Array] that will be converted. + Constructs a new [PoolByteArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> </method> <method name="append"> <argument index="0" name="byte" type="int"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="PoolByteArray"> </argument> <description> - Append a [PoolByteArray] at the end of this array. + Appends a [PoolByteArray] at the end of this array. </description> </method> <method name="compress"> @@ -74,33 +75,33 @@ <argument index="1" name="byte" type="int"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array. + Reverses the order of the elements in the array. </description> </method> <method name="push_back"> <argument index="0" name="byte" type="int"> </argument> <description> - Append an element at the end of the array. + Appends an element at the end of the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Removes an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> </method> <method name="set"> @@ -109,14 +110,14 @@ <argument index="1" name="byte" type="int"> </argument> <description> - Change the byte at the given index. + Changes the byte at the given index. </description> </method> <method name="sha256_string"> <return type="String"> </return> <description> - Returns SHA256 string of the PoolByteArray. + Returns SHA-256 string of the PoolByteArray. </description> </method> <method name="size"> diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index efc3582ba4..a1fb868ef5 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -4,7 +4,8 @@ A pooled [Array] of [Color]. </brief_description> <description> - An [Array] specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference. + An [Array] specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory. + [b]Note:[/b] This type is passed by value and not by reference. </description> <tutorials> </tutorials> @@ -15,21 +16,21 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new [PoolColorArray]. Optionally, you can pass in a generic [Array] that will be converted. + Constructs a new [PoolColorArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> </method> <method name="append"> <argument index="0" name="color" type="Color"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="PoolColorArray"> </argument> <description> - Append a [PoolColorArray] at the end of this array. + Appends a [PoolColorArray] at the end of this array. </description> </method> <method name="insert"> @@ -40,33 +41,33 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array. + Reverses the order of the elements in the array. </description> </method> <method name="push_back"> <argument index="0" name="color" type="Color"> </argument> <description> - Append a value to the array. + Appends a value to the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Removes an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> </method> <method name="set"> @@ -75,7 +76,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Change the [Color] at the given index. + Changes the [Color] at the given index. </description> </method> <method name="size"> diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index fca1083c25..730833b097 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -4,7 +4,8 @@ A pooled [Array] of integers ([int]). </brief_description> <description> - An [Array] specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference. + An [Array] specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory. + [b]Note:[/b] This type is passed by value and not by reference. </description> <tutorials> </tutorials> @@ -15,21 +16,21 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new [PoolIntArray]. Optionally, you can pass in a generic [Array] that will be converted. + Constructs a new [PoolIntArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> </method> <method name="append"> <argument index="0" name="integer" type="int"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="PoolIntArray"> </argument> <description> - Append a [PoolIntArray] at the end of this array. + Appends a [PoolIntArray] at the end of this array. </description> </method> <method name="insert"> @@ -40,33 +41,33 @@ <argument index="1" name="integer" type="int"> </argument> <description> - Insert a new int at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + Inserts a new int at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array. + Reverses the order of the elements in the array. </description> </method> <method name="push_back"> <argument index="0" name="integer" type="int"> </argument> <description> - Append a value to the array. + Appends a value to the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Removes an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> </method> <method name="set"> @@ -75,7 +76,7 @@ <argument index="1" name="integer" type="int"> </argument> <description> - Change the int at the given index. + Changes the int at the given index. </description> </method> <method name="size"> diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml index c5f6062175..7eaec82338 100644 --- a/doc/classes/PoolRealArray.xml +++ b/doc/classes/PoolRealArray.xml @@ -4,7 +4,8 @@ A pooled [Array] of reals ([float]). </brief_description> <description> - An [Array] specifically designed to hold floating point values ([float]). Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference. + An [Array] specifically designed to hold floating-point values ([float]). Optimized for memory usage, does not fragment the memory. + [b]Note:[/b] This type is passed by value and not by reference. </description> <tutorials> </tutorials> @@ -15,21 +16,21 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new [PoolRealArray]. Optionally, you can pass in a generic [Array] that will be converted. + Constructs a new [PoolRealArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> </method> <method name="append"> <argument index="0" name="value" type="float"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="PoolRealArray"> </argument> <description> - Append a [PoolRealArray] at the end of this array. + Appends a [PoolRealArray] at the end of this array. </description> </method> <method name="insert"> @@ -40,33 +41,33 @@ <argument index="1" name="value" type="float"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array. + Reverses the order of the elements in the array. </description> </method> <method name="push_back"> <argument index="0" name="value" type="float"> </argument> <description> - Append an element at the end of the array. + Appends an element at the end of the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Removes an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> </method> <method name="set"> @@ -75,7 +76,7 @@ <argument index="1" name="value" type="float"> </argument> <description> - Change the float at the given index. + Changes the float at the given index. </description> </method> <method name="size"> diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml index 01dca93be3..a408a18b19 100644 --- a/doc/classes/PoolStringArray.xml +++ b/doc/classes/PoolStringArray.xml @@ -4,7 +4,8 @@ A pooled [Array] of [String]. </brief_description> <description> - An [Array] specifically designed to hold [String]. Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference. + An [Array] specifically designed to hold [String]s. Optimized for memory usage, does not fragment the memory. + [b]Note:[/b] This type is passed by value and not by reference. </description> <tutorials> </tutorials> @@ -15,21 +16,21 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new [PoolStringArray]. Optionally, you can pass in a generic [Array] that will be converted. + Constructs a new [PoolStringArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> </method> <method name="append"> <argument index="0" name="string" type="String"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="PoolStringArray"> </argument> <description> - Append a [PoolStringArray] at the end of this array. + Appends a [PoolStringArray] at the end of this array. </description> </method> <method name="insert"> @@ -40,12 +41,12 @@ <argument index="1" name="string" type="String"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array. + Reverses the order of the elements in the array. </description> </method> <method name="join"> @@ -61,21 +62,21 @@ <argument index="0" name="string" type="String"> </argument> <description> - Append a string element at end of the array. + Appends a string element at end of the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Removes an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> </method> <method name="set"> @@ -84,7 +85,7 @@ <argument index="1" name="string" type="String"> </argument> <description> - Change the [String] at the given index. + Changes the [String] at the given index. </description> </method> <method name="size"> diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index 45f619dc5d..623247e639 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -4,7 +4,8 @@ A pooled [Array] of [Vector2]. </brief_description> <description> - An [Array] specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference. + An [Array] specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory. + [b]Note:[/b] This type is passed by value and not by reference. </description> <tutorials> </tutorials> @@ -15,21 +16,21 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new [PoolVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. + Constructs a new [PoolVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> </method> <method name="append"> <argument index="0" name="vector2" type="Vector2"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="PoolVector2Array"> </argument> <description> - Append a [PoolVector2Array] at the end of this array. + Appends a [PoolVector2Array] at the end of this array. </description> </method> <method name="insert"> @@ -40,33 +41,33 @@ <argument index="1" name="vector2" type="Vector2"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array. + Reverses the order of the elements in the array. </description> </method> <method name="push_back"> <argument index="0" name="vector2" type="Vector2"> </argument> <description> - Insert a [Vector2] at the end. + Inserts a [Vector2] at the end. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Removes an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> </method> <method name="set"> @@ -75,7 +76,7 @@ <argument index="1" name="vector2" type="Vector2"> </argument> <description> - Change the [Vector2] at the given index. + Changes the [Vector2] at the given index. </description> </method> <method name="size"> diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index 0a682e2baf..adc28b46cb 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -4,7 +4,8 @@ A pooled [Array] of [Vector3]. </brief_description> <description> - An [Array] specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference. + An [Array] specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory. + [b]Note:[/b] This type is passed by value and not by reference. </description> <tutorials> </tutorials> @@ -15,21 +16,21 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new [PoolVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. + Constructs a new [PoolVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> </method> <method name="append"> <argument index="0" name="vector3" type="Vector3"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="PoolVector3Array"> </argument> <description> - Append a [PoolVector3Array] at the end of this array. + Appends a [PoolVector3Array] at the end of this array. </description> </method> <method name="insert"> @@ -40,33 +41,33 @@ <argument index="1" name="vector3" type="Vector3"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array. + Reverses the order of the elements in the array. </description> </method> <method name="push_back"> <argument index="0" name="vector3" type="Vector3"> </argument> <description> - Insert a [Vector3] at the end. + Inserts a [Vector3] at the end. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Removes an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. </description> </method> <method name="set"> @@ -75,7 +76,7 @@ <argument index="1" name="vector3" type="Vector3"> </argument> <description> - Change the [Vector3] at the given index. + Changes the [Vector3] at the given index. </description> </method> <method name="size"> diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index e1b51463b2..ef7e3d2c11 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -24,7 +24,7 @@ <argument index="0" name="size" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by "size". + Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by [code]size[/code]. </description> </method> <method name="popup_centered_clamped"> @@ -65,12 +65,12 @@ <signals> <signal name="about_to_show"> <description> - This signal is emitted when a popup is about to be shown. (often used in [PopupMenu] for clearing the list of options and creating a new one according to the current context). + Emitted when a popup is about to be shown. This is often used in [PopupMenu] to clear the list of options then create a new one according to the current context. </description> </signal> <signal name="popup_hide"> <description> - This signal is emitted when a popup is hidden. + Emitted when a popup is hidden. </description> </signal> </signals> diff --git a/doc/classes/PopupDialog.xml b/doc/classes/PopupDialog.xml index b510208ae2..d85f568abf 100644 --- a/doc/classes/PopupDialog.xml +++ b/doc/classes/PopupDialog.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PopupDialog" inherits="Popup" category="Core" version="3.2"> <brief_description> - Base class for Popup Dialogs. + Base class for popup dialogs. </brief_description> <description> PopupDialog is a base class for popup dialogs, along with [WindowDialog]. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index d6249f73aa..0d869fc72f 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -19,7 +19,8 @@ <argument index="2" name="accel" type="int" default="0"> </argument> <description> - Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Adds a new checkable item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. + [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="add_check_shortcut"> @@ -46,8 +47,8 @@ <argument index="3" name="accel" type="int" default="0"> </argument> <description> - Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be - created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Adds a new checkable item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. + [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="add_icon_check_shortcut"> @@ -76,7 +77,7 @@ <argument index="3" name="accel" type="int" default="0"> </argument> <description> - Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. + Adds a new item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator keybinding ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. </description> </method> <method name="add_icon_shortcut"> @@ -103,7 +104,7 @@ <argument index="2" name="accel" type="int" default="0"> </argument> <description> - Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. + Adds a new item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator keybinding ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. </description> </method> <method name="add_radio_check_item"> @@ -116,7 +117,8 @@ <argument index="2" name="accel" type="int" default="0"> </argument> <description> - The same as [method add_check_item] but the inserted item will look as a radio button. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + The same as [method add_check_item], but the inserted item will look as a radio button. + [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. </description> </method> <method name="add_radio_check_shortcut"> @@ -137,7 +139,7 @@ <argument index="0" name="label" type="String" default=""""> </argument> <description> - Add a separator between items. Separators also occupy an index. + Adds a separator between items. Separators also occupy an index. </description> </method> <method name="add_shortcut"> @@ -178,7 +180,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. + Returns the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> </method> <method name="get_item_count" qualifiers="const"> @@ -194,7 +196,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the icon of the item at index "idx". + Returns the icon of the item at index [code]idx[/code]. </description> </method> <method name="get_item_id" qualifiers="const"> @@ -203,7 +205,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the id of the item at index "idx". + Returns the id of the item at index [code]idx[/code]. </description> </method> <method name="get_item_index" qualifiers="const"> @@ -212,7 +214,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Find and return the index of the item containing a given id. + Finds and return the index of the item containing a given [code]id[/code]. </description> </method> <method name="get_item_metadata" qualifiers="const"> @@ -238,7 +240,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the submenu name of the item at index "idx". + Returns the submenu name of the item at index [code]idx[/code]. </description> </method> <method name="get_item_text" qualifiers="const"> @@ -247,7 +249,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the text of the item at index "idx". + Returns the text of the item at index [code]idx[/code]. </description> </method> <method name="get_item_tooltip" qualifiers="const"> @@ -270,7 +272,8 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. + Returns [code]true[/code] if the item at index [code]idx[/code] is checkable in some way, i.e. if it has a checkbox or radio button. + [b]Note:[/b] Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="is_item_checked" qualifiers="const"> @@ -279,7 +282,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether the item at index "idx" is checked. + Returns [code]true[/code] if the item at index [code]idx[/code] is checked. </description> </method> <method name="is_item_disabled" qualifiers="const"> @@ -288,7 +291,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. + Returns [code]true[/code] if the item at index [code]idx[/code] is disabled. When it is disabled it can't be selected, or its action invoked. </description> </method> <method name="is_item_radio_checkable" qualifiers="const"> @@ -297,7 +300,8 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + Returns [code]true[/code] if the item at index [code]idx[/code] has radio-button-style checkability. + [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. </description> </method> <method name="is_item_separator" qualifiers="const"> @@ -306,7 +310,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether the item is a separator. If it is, it would be displayed as a line. + Returns [code]true[/code] if the item is a separator. If it is, it will be displayed as a line. </description> </method> <method name="is_item_shortcut_disabled" qualifiers="const"> @@ -323,7 +327,8 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. + Removes the item at index [code]idx[/code] from the menu. + [b]Note:[/b] The indices of items after the removed item will be shifted by one. </description> </method> <method name="set_hide_on_window_lose_focus"> @@ -342,7 +347,7 @@ <argument index="1" name="accel" type="int"> </argument> <description> - Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. + Sets the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> </method> <method name="set_item_as_checkable"> @@ -353,7 +358,8 @@ <argument index="1" name="enable" type="bool"> </argument> <description> - Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Sets whether the item at index [code]idx[/code] has a checkbox. + [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="set_item_as_radio_checkable"> @@ -376,7 +382,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> - Mark the item at index "idx" as a separator, which means that it would be displayed as a line. + Mark the item at index [code]idx[/code] as a separator, which means that it would be displayed as a line. </description> </method> <method name="set_item_checked"> @@ -387,7 +393,7 @@ <argument index="1" name="checked" type="bool"> </argument> <description> - Set the checkstate status of the item at index "idx". + Sets the checkstate status of the item at index [code]idx[/code]. </description> </method> <method name="set_item_disabled"> @@ -398,7 +404,7 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> - Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. + Sets whether the item at index [code]idx[/code] is disabled or not. When it is disabled, it can't be selected and its action can't be invoked. </description> </method> <method name="set_item_icon"> @@ -419,7 +425,7 @@ <argument index="1" name="id" type="int"> </argument> <description> - Set the id of the item at index "idx". + Sets the [code]id[/code] of the item at index [code]idx[/code]. </description> </method> <method name="set_item_metadata"> @@ -430,7 +436,7 @@ <argument index="1" name="metadata" type="Variant"> </argument> <description> - Sets the metadata of an item, which might be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items. + Sets the metadata of an item, which may be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items. </description> </method> <method name="set_item_multistate"> @@ -473,7 +479,7 @@ <argument index="1" name="submenu" type="String"> </argument> <description> - Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. + Sets the submenu of the item at index [code]idx[/code]. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. </description> </method> <method name="set_item_text"> @@ -484,7 +490,7 @@ <argument index="1" name="text" type="String"> </argument> <description> - Set the text of the item at index "idx". + Sets the text of the item at index [code]idx[/code]. </description> </method> <method name="set_item_tooltip"> @@ -533,21 +539,21 @@ <argument index="0" name="id" type="int"> </argument> <description> - This event is emitted when user navigated to an item of some id using [code]ui_up[/code] or [code]ui_down[/code] action. + Emitted when user navigated to an item of some [code]id[/code] using [code]ui_up[/code] or [code]ui_down[/code] action. </description> </signal> <signal name="id_pressed"> <argument index="0" name="id" type="int"> </argument> <description> - This event is emitted when an item of some id is pressed or its accelerator is activated. + Emitted when an item of some [code]id[/code] is pressed or its accelerator is activated. </description> </signal> <signal name="index_pressed"> <argument index="0" name="index" type="int"> </argument> <description> - This event is emitted when an item of some index is pressed or its accelerator is activated. + Emitted when an item of some [code]index[/code] is pressed or its accelerator is activated. </description> </signal> </signals> diff --git a/doc/classes/Position2D.xml b/doc/classes/Position2D.xml index 916bd99131..ccadee6018 100644 --- a/doc/classes/Position2D.xml +++ b/doc/classes/Position2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Position2D" inherits="Node2D" category="Core" version="3.2"> <brief_description> - Generic 2D Position hint for editing. + Generic 2D position hint for editing. </brief_description> <description> - Generic 2D Position hint for editing. It's just like a plain [Node2D] but displays as a cross in the 2D-Editor at all times. You can set visual size of the cross by changing Gizmo Extents in the inspector. + Generic 2D position hint for editing. It's just like a plain [Node2D], but it displays as a cross in the 2D editor at all times. You can set cross' visual size by using the gizmo in the 2D editor while the node is selected. </description> <tutorials> </tutorials> diff --git a/doc/classes/Position3D.xml b/doc/classes/Position3D.xml index 247f1fb6a3..4d43a6729d 100644 --- a/doc/classes/Position3D.xml +++ b/doc/classes/Position3D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Position3D" inherits="Spatial" category="Core" version="3.2"> <brief_description> - Generic 3D Position hint for editing. + Generic 3D position hint for editing. </brief_description> <description> - Generic 3D Position hint for editing. It's just like a plain [Spatial] but displays as a cross in the 3D-Editor at all times. + Generic 3D position hint for editing. It's just like a plain [Spatial], but it displays as a cross in the 3D editor at all times. </description> <tutorials> </tutorials> diff --git a/doc/classes/PrimitiveMesh.xml b/doc/classes/PrimitiveMesh.xml index 2214357308..b3be8e431a 100644 --- a/doc/classes/PrimitiveMesh.xml +++ b/doc/classes/PrimitiveMesh.xml @@ -13,7 +13,7 @@ <return type="Array"> </return> <description> - Returns mesh arrays used to constitute surface of [Mesh]. Mesh array can be used with [ArrayMesh] to create new surface. + Returns mesh arrays used to constitute surface of [Mesh]. Mesh arrays can be used with [ArrayMesh] to create new surfaces. </description> </method> </methods> diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml index 68deb5aff4..13d6a9ce19 100644 --- a/doc/classes/ProceduralSky.xml +++ b/doc/classes/ProceduralSky.xml @@ -4,8 +4,8 @@ Type of [Sky] that is generated procedurally based on user input parameters. </brief_description> <description> - ProceduralSky provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky. - The ProceduralSky is updated on the CPU after the parameters change and stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for realtime updates during gameplay. But with a small texture size it is still feasible to update relatively frequently because it is updated on a background thread when multi-threading is available. + ProceduralSky provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly, the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky. + The ProceduralSky is updated on the CPU after the parameters change. It is stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for real-time updates during gameplay. However, with a small enough texture size, it can still be updated relatively frequently, as it is updated on a background thread when multi-threading is available. </description> <tutorials> </tutorials> @@ -43,7 +43,7 @@ Distance from sun where it goes from solid to starting to fade. </member> <member name="sun_color" type="Color" setter="set_sun_color" getter="get_sun_color"> - Color of the sun. + The sun's color. </member> <member name="sun_curve" type="float" setter="set_sun_curve" getter="get_sun_curve"> How quickly the sun fades away between [member sun_angle_min] and [member sun_angle_max]. @@ -52,7 +52,7 @@ Amount of energy contribution from the sun. </member> <member name="sun_latitude" type="float" setter="set_sun_latitude" getter="get_sun_latitude"> - The suns height using polar coordinates. + The sun's height using polar coordinates. </member> <member name="sun_longitude" type="float" setter="set_sun_longitude" getter="get_sun_longitude"> The direction of the sun using polar coordinates. diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index 98d7e5c128..2064ead8f4 100644 --- a/doc/classes/ProgressBar.xml +++ b/doc/classes/ProgressBar.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ProgressBar" inherits="Range" category="Core" version="3.2"> <brief_description> - General purpose progress bar. + General-purpose progress bar. </brief_description> <description> - General purpose progress bar. Shows fill percentage from right to left. + General-purpose progress bar. Shows fill percentage from right to left. </description> <tutorials> </tutorials> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 316f948778..73d4c7b504 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -15,8 +15,8 @@ <argument index="0" name="hint" type="Dictionary"> </argument> <description> - Adds a custom property info to a property. The dictionary must contain: name:[String](the property's name) and type:[int](see TYPE_* in [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String]. - Example: + Adds a custom property info to a property. The dictionary must contain: name:[String](the property's name) and type:[int](see [code]TYPE_*[/code] in [@GlobalScope]), and optionally hint:[int](see [code]PROPERTY_HINT_*[/code] in [@GlobalScope]), hint_string:[String]. + [b]Example:[/b] [codeblock] ProjectSettings.set("category/property_name", 0) @@ -82,7 +82,7 @@ </argument> <description> Loads the contents of the .pck or .zip file specified by [code]pack[/code] into the resource filesystem ([code]res://[/code]). Returns [code]true[/code] on success. - Note: If a file from [code]pack[/code] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [code]pack[/code]. + [b]Note:[/b] If a file from [code]pack[/code] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [code]pack[/code]. </description> </method> <method name="localize_path" qualifiers="const"> @@ -359,7 +359,7 @@ Maximum call stack in visual scripting, to avoid infinite recursion. </member> <member name="display/mouse_cursor/custom_image" type="String" setter="" getter=""> - Custom image for the mouse cursor (limited to 256x256). + Custom image for the mouse cursor (limited to 256×256). </member> <member name="display/mouse_cursor/custom_image_hotspot" type="Vector2" setter="" getter=""> Hotspot for the custom mouse cursor image. @@ -380,7 +380,7 @@ If [code]true[/code], allows per-pixel transparency in a desktop window. This affects performance, so leave it on [code]false[/code] unless you need it. </member> <member name="display/window/per_pixel_transparency/enabled" type="bool" setter="" getter=""> - Set the window background to transparent when it starts. + Sets the window background to transparent when it starts. </member> <member name="display/window/size/always_on_top" type="bool" setter="" getter=""> Force the window to be always on top. @@ -389,10 +389,10 @@ Force the window to be borderless. </member> <member name="display/window/size/fullscreen" type="bool" setter="" getter=""> - Set the window to full screen when it starts. + Sets the window to full screen when it starts. </member> <member name="display/window/size/height" type="int" setter="" getter=""> - Set the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. + Sets the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. </member> <member name="display/window/size/resizable" type="bool" setter="" getter=""> Allows the window to be resizable by default. @@ -732,7 +732,7 @@ If [code]true[/code], forces snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. </member> <member name="rendering/quality/depth_prepass/disable_for_vendors" type="String" setter="" getter=""> - Disable depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. + Disables depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. </member> <member name="rendering/quality/depth_prepass/enable" type="bool" setter="" getter=""> If [code]true[/code], performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. @@ -744,11 +744,11 @@ </member> <member name="rendering/quality/driver/driver_name" type="String" setter="" getter=""> The video driver to use ("GLES2" or "GLES3"). - Note that the backend in use can be overridden at runtime via the [code]--video-driver[/code] command line argument, or by the [member rendering/quality/driver/fallback_to_gles2] option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use [method OS.get_current_video_driver] to query it at run-time. + [b]Note:[/b] The backend in use can be overridden at runtime via the [code]--video-driver[/code] command line argument, or by the [member rendering/quality/driver/fallback_to_gles2] option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use [method OS.get_current_video_driver] to query it at run-time. </member> <member name="rendering/quality/driver/fallback_to_gles2" type="bool" setter="" getter=""> If [code]true[/code], allows falling back to the GLES2 driver if the GLES3 driver is not supported. - Note that the two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the data pack's size. + [b]Note:[/b] The two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the data pack's size. </member> <member name="rendering/quality/filters/anisotropic_filter_level" type="int" setter="" getter=""> Maximum anisotropic filter level used for textures with anisotropy enabled. Higher values will result in sharper textures when viewed from oblique angles, at the cost of performance. Only power-of-two values are valid (2, 4, 8, 16). diff --git a/doc/classes/ProximityGroup.xml b/doc/classes/ProximityGroup.xml index ad4cb682cb..184ba87229 100644 --- a/doc/classes/ProximityGroup.xml +++ b/doc/classes/ProximityGroup.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ProximityGroup" inherits="Spatial" category="Core" version="3.2"> <brief_description> - General purpose proximity-detection node. + General-purpose proximity detection node. </brief_description> <description> - General purpose proximity-detection node. + General-purpose proximity detection node. </description> <tutorials> </tutorials> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index 3ef65e1edb..ea805c9136 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -5,7 +5,7 @@ </brief_description> <description> A unit quaternion used for representing 3D rotations. - It is similar to [Basis], which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. But due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating point errors. + It is similar to [Basis], which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. But due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating-point errors. Quaternions need to be (re)normalized. </description> <tutorials> @@ -27,7 +27,7 @@ <argument index="0" name="euler" type="Vector3"> </argument> <description> - Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). + Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle). </description> </method> <method name="Quat"> @@ -84,7 +84,7 @@ <return type="Vector3"> </return> <description> - Returns Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). + Returns Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). </description> </method> <method name="inverse"> @@ -128,14 +128,14 @@ <argument index="1" name="angle" type="float"> </argument> <description> - Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. + Sets the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. </description> </method> <method name="set_euler"> <argument index="0" name="euler" type="Vector3"> </argument> <description> - Set the quaternion to a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). + Sets the quaternion to a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle). </description> </method> <method name="slerp"> @@ -172,16 +172,16 @@ </methods> <members> <member name="w" type="float" setter="" getter=""> - W component of the quaternion. Default value: [code]1[/code] + 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] + 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] + 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] + Z component of the quaternion. Default value: [code]0[/code]. </member> </members> <constants> diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index 89778e1c8b..5edef100c5 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -4,7 +4,7 @@ Handle for a [Resource]'s unique ID. </brief_description> <description> - The RID type is used to access the unique integer ID of a resource. They are opaque, so they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as [VisualServer]. + The RID type is used to access the unique integer ID of a resource. They are opaque, which means they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as [VisualServer]. </description> <tutorials> </tutorials> diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index be7bcc9c35..dc96bba304 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -4,7 +4,8 @@ A class for generating pseudo-random numbers. </brief_description> <description> - RandomNumberGenerator is a class for generating pseudo-random numbers. It currently uses PCG32. The underlying algorithm is an implementation detail. As a result, it should not be depended upon for reproducible random streams across Godot versions. + RandomNumberGenerator is a class for generating pseudo-random numbers. It currently uses [url=http://www.pcg-random.org/]PCG32[/url]. + [b]Note:[/b] The underlying algorithm is an implementation detail. As a result, it should not be depended upon for reproducible random streams across Godot versions. </description> <tutorials> </tutorials> @@ -13,7 +14,7 @@ <return type="float"> </return> <description> - Generates pseudo-random float between '0.0' and '1.0', inclusive. + Generates a pseudo-random float between [code]0.0[/code] and [code]1.0[/code] (inclusive). </description> </method> <method name="randf_range"> @@ -24,7 +25,7 @@ <argument index="1" name="to" type="float"> </argument> <description> - Generates pseudo-random float between [code]from[/code] and [code]to[/code], inclusive. + Generates a pseudo-random float between [code]from[/code] and [code]to[/code] (inclusive). </description> </method> <method name="randfn"> @@ -35,14 +36,14 @@ <argument index="1" name="deviation" type="float" default="1.0"> </argument> <description> - Generates normally(gaussian) distributed pseudo-random number, using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. + Generates a [url=https://en.wikipedia.org/wiki/Normal_distribution]normally-distributed[/url] pseudo-random number, using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. This is also called Gaussian distribution. </description> </method> <method name="randi"> <return type="int"> </return> <description> - Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295', inclusive. + Generates a pseudo-random 32-bit unsigned integer between [code]0[/code] and [code]4294967295[/code] (inclusive). </description> </method> <method name="randi_range"> @@ -53,7 +54,7 @@ <argument index="1" name="to" type="int"> </argument> <description> - Generates pseudo-random 32-bit signed integer between [code]from[/code] and [code]to[/code] (inclusive). + Generates a pseudo-random 32-bit signed integer between [code]from[/code] and [code]to[/code] (inclusive). </description> </method> <method name="randomize"> diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 3c7317bf85..9f1863600b 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -4,7 +4,7 @@ Abstract base class for range-based controls. </brief_description> <description> - Range is a base class for [Control] nodes that change a floating point [i]value[/i] between a [i]minimum[/i] and a [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar]. + Range is a base class for [Control] nodes that change a floating-point [i]value[/i] between a [i]minimum[/i] and a [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar]. </description> <tutorials> </tutorials> @@ -22,7 +22,7 @@ <return type="void"> </return> <description> - Stop range from sharing its member variables with any other. + Stops range from sharing its member variables with any other. </description> </method> </methods> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index 1368143b67..a38b45e2d8 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -43,7 +43,8 @@ </return> <description> Updates the collision information for the ray. - Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work. + Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. + [b]Note:[/b] [code]enabled == true[/code] is not required for this to work. </description> </method> <method name="get_collider" qualifiers="const"> @@ -66,7 +67,8 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Returns [code]true[/code] if the bit index passed is turned on. Note that bit indexes range from 0-19. + Returns [code]true[/code] if the bit index passed is turned on. + [b]Note:[/b] Bit indices range from 0-19. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -80,7 +82,8 @@ <return type="Vector3"> </return> <description> - Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system. + Returns the collision point at which the ray intersects the closest object. + [b]Note:[/b] This point is in the [b]global[/b] coordinate system. </description> </method> <method name="is_colliding" qualifiers="const"> @@ -116,7 +119,8 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Sets the bit index passed to the [code]value[/code] passed. Note that bit indexes range from 0-19. + Sets the bit index passed to the [code]value[/code] passed. + [b]Note:[/b] Bit indexes range from 0-19. </description> </method> </methods> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 90e0178ddb..c68929d4a0 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -42,7 +42,8 @@ <return type="void"> </return> <description> - Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work. + Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. + [b]Note:[/b] [code]enabled == true[/code] is not required for this to work. </description> </method> <method name="get_collider" qualifiers="const"> @@ -79,7 +80,8 @@ <return type="Vector2"> </return> <description> - Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system. + Returns the collision point at which the ray intersects the closest object. + [b]Note:[/b] this point is in the [b]global[/b] coordinate system. </description> </method> <method name="is_colliding" qualifiers="const"> @@ -115,7 +117,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. + Sets or clears individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> </methods> diff --git a/doc/classes/RayShape.xml b/doc/classes/RayShape.xml index 69b159fa97..086654c469 100644 --- a/doc/classes/RayShape.xml +++ b/doc/classes/RayShape.xml @@ -4,7 +4,7 @@ Ray shape for 3D collisions. </brief_description> <description> - Ray shape for 3D collisions, which can be set into a [PhysicsBody] or [Area]. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. + Ray shape for 3D collisions, which can be set into a [PhysicsBody] or [Area]. A ray is not really a collision body; instead, it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. </description> <tutorials> </tutorials> diff --git a/doc/classes/RayShape2D.xml b/doc/classes/RayShape2D.xml index e0ef01bd2a..23cb06f57a 100644 --- a/doc/classes/RayShape2D.xml +++ b/doc/classes/RayShape2D.xml @@ -4,7 +4,7 @@ Ray shape for 2D collisions. </brief_description> <description> - Ray shape for 2D collisions. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. + Ray shape for 2D collisions. A ray is not really a collision body; instead, it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. </description> <tutorials> </tutorials> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index c4f7844a03..705e048e8e 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Rect2" category="Built-In Types" version="3.2"> <brief_description> - 2D Axis-aligned bounding box. + 2D axis-aligned bounding box. </brief_description> <description> Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. diff --git a/doc/classes/Reference.xml b/doc/classes/Reference.xml index 9e6c403873..70d41b665a 100644 --- a/doc/classes/Reference.xml +++ b/doc/classes/Reference.xml @@ -24,7 +24,7 @@ </return> <description> Increments the internal reference counter. Use this only if you really know what you are doing. - Returns whether the increment was successful. + Returns [code]true[/code] if the increment was successful, [code]false[/code] otherwise. </description> </method> <method name="unreference"> @@ -32,7 +32,7 @@ </return> <description> Decrements the internal reference counter. Use this only if you really know what you are doing. - Returns whether the decrement was successful. + Returns [code]true[/code] if the decrement was successful, [code]false[/code] otherwise. </description> </method> </methods> diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index d2315275b1..8f1903378c 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -37,7 +37,7 @@ <return type="RID"> </return> <description> - Returns the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high level abstractions of resources stored in a server, so this function will return the original RID. + Returns the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high-level abstractions of resources stored in a server, so this function will return the original RID. </description> </method> <method name="setup_local_to_scene"> diff --git a/doc/classes/ResourceFormatLoader.xml b/doc/classes/ResourceFormatLoader.xml index ef44a826b9..ce37691e0a 100644 --- a/doc/classes/ResourceFormatLoader.xml +++ b/doc/classes/ResourceFormatLoader.xml @@ -6,7 +6,7 @@ <description> Godot loads resources in the editor or in exported games using ResourceFormatLoaders. They are queried automatically via the [ResourceLoader] singleton, or when a resource with internal dependencies is loaded. Each file type may load as a different resource type, so multiple ResourceFormatLoaders are registered in the engine. Extending this class allows you to define your own loader. Be sure to respect the documented return types and values. You should give it a global class name with [code]class_name[/code] for it to be registered. Like built-in ResourceFormatLoaders, it will be called automatically when loading resources of its handled type(s). You may also implement a [ResourceFormatSaver]. - Note: You can also extend [EditorImportPlugin] if the resource type you need exists but Godot is unable to load its format. Choosing one way over another depends if the format is suitable or not for the final exported game. For example, it's better to import [code].png[/code] textures as [code].stex[/code] ([StreamTexture]) first, so they can be loaded with better efficiency on the graphics card. + [b]Note:[/b] You can also extend [EditorImportPlugin] if the resource type you need exists but Godot is unable to load its format. Choosing one way over another depends if the format is suitable or not for the final exported game. For example, it's better to import [code].png[/code] textures as [code].stex[/code] ([StreamTexture]) first, so they can be loaded with better efficiency on the graphics card. </description> <tutorials> </tutorials> @@ -19,7 +19,8 @@ <argument index="1" name="add_types" type="String"> </argument> <description> - If implemented, gets the dependencies of a given resource. If [code]add_types[/code] is [code]true[/code], paths should be appended [code]::TypeName[/code], where [code]TypeName[/code] is the class name of the dependency. Note that custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. + If implemented, gets the dependencies of a given resource. If [code]add_types[/code] is [code]true[/code], paths should be appended [code]::TypeName[/code], where [code]TypeName[/code] is the class name of the dependency. + [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. </description> </method> <method name="get_recognized_extensions" qualifiers="virtual"> @@ -35,7 +36,8 @@ <argument index="0" name="path" type="String"> </argument> <description> - Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return [code]""[/code]. Note that custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. + Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return [code]""[/code]. + [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. </description> </method> <method name="handles_type" qualifiers="virtual"> @@ -44,7 +46,8 @@ <argument index="0" name="typename" type="String"> </argument> <description> - Tells which resource class this loader can load. Note that custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them. + Tells which resource class this loader can load. + [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them. </description> </method> <method name="load" qualifiers="virtual"> diff --git a/doc/classes/ResourceInteractiveLoader.xml b/doc/classes/ResourceInteractiveLoader.xml index 3c09959ff7..df552d3656 100644 --- a/doc/classes/ResourceInteractiveLoader.xml +++ b/doc/classes/ResourceInteractiveLoader.xml @@ -4,7 +4,7 @@ Interactive [Resource] loader. </brief_description> <description> - Interactive [Resource] loader. This object is returned by [ResourceLoader] when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying loading bars/percentages. + Interactive [Resource] loader. This object is returned by [ResourceLoader] when performing an interactive load. It allows loading resources with high granularity, which makes it mainly useful for displaying loading bars or percentages. </description> <tutorials> </tutorials> diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 558852704e..31bba18171 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -47,7 +47,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Deprecated method. Use [method has_cached] or [method exists] instead. + [i]Deprecated method.[/i] Use [method has_cached] or [method exists] instead. </description> </method> <method name="has_cached"> @@ -95,7 +95,7 @@ <argument index="0" name="abort" type="bool"> </argument> <description> - Change the behavior on missing sub-resources. Default is to abort load. + Changes the behavior on missing sub-resources. The default behavior is to abort loading. </description> </method> </methods> diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index 57d5bfae2f..f12d26d4b9 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -43,7 +43,7 @@ Bundles external resources. </constant> <constant name="FLAG_CHANGE_PATH" value="4" enum="SaverFlags"> - Change the [member Resource.resource_path] of the saved resource to match its new location. + Changes the [member Resource.resource_path] of the saved resource to match its new location. </constant> <constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8" enum="SaverFlags"> Do not save editor-specific metadata (identified by their [code]__editor[/code] prefix). diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index a097e2076f..e1e93dbb15 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -5,7 +5,7 @@ </brief_description> <description> Rich text can contain custom text, fonts, images and some basic formatting. The label manages these as an internal tag stack. It also adapts itself to given width/heights. - Note that assignments to [member bbcode_text] clear the tag stack and reconstruct it from the property's contents. Any edits made to [member bbcode_text] will erase previous edits made from other manual sources such as [method append_bbcode] and the [code]push_*[/code] / [method pop] methods. + [b]Note:[/b] Assignments to [member bbcode_text] clear the tag stack and reconstruct it from the property's contents. Any edits made to [member bbcode_text] will erase previous edits made from other manual sources such as [method append_bbcode] and the [code]push_*[/code] / [method pop] methods. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/gui/bbcode_in_richtextlabel.html</link> @@ -26,7 +26,7 @@ <argument index="0" name="text" type="String"> </argument> <description> - Adds raw non-bbcode-parsed text to the tag stack. + Adds raw non-BBCode-parsed text to the tag stack. </description> </method> <method name="append_bbcode"> @@ -63,7 +63,7 @@ <return type="int"> </return> <description> - Returns the total number of characters from text tags. Does not include bbcodes. + Returns the total number of characters from text tags. Does not include BBCodes. </description> </method> <method name="get_v_scroll"> @@ -100,7 +100,7 @@ <return type="void"> </return> <description> - Terminates the current tag. Use after [code]push_*[/code] methods to close bbcodes manually. Does not need to follow [code]add_*[/code] methods. + Terminates the current tag. Use after [code]push_*[/code] methods to close BBCodes manually. Does not need to follow [code]add_*[/code] methods. </description> </method> <method name="push_align"> @@ -109,7 +109,7 @@ <argument index="0" name="align" type="int" enum="RichTextLabel.Align"> </argument> <description> - Adds an alignment tag based on the given [code]align[/code] value. See [enum Align] for possible values. + Adds an [code][align][/code] tag based on the given [code]align[/code] value. See [enum Align] for possible values. </description> </method> <method name="push_cell"> @@ -152,7 +152,7 @@ <argument index="0" name="type" type="int" enum="RichTextLabel.ListType"> </argument> <description> - Adds a list tag to the tag stack. Similar to the bbcodes [code][ol][/code] or [code][ul][/code], but supports more list types. Not fully implemented! + Adds a [code][list][/code] tag to the tag stack. Similar to the BBCodes [code][ol][/code] or [code][ul][/code], but supports more list types. Not fully implemented! </description> </method> <method name="push_meta"> @@ -161,7 +161,7 @@ <argument index="0" name="data" type="Variant"> </argument> <description> - Adds a meta tag to the tag stack. Similar to the bbcode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types. + Adds a [code][meta][/code] tag to the tag stack. Similar to the BBCode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types. </description> </method> <method name="push_strikethrough"> @@ -215,9 +215,9 @@ <argument index="2" name="ratio" type="int"> </argument> <description> - Edits the selected columns expansion options. If [code]expand[/code] is [code]true[/code], the column expands in proportion to its expansion ratio versus the other columns' ratios. + Edits the selected column's expansion options. If [code]expand[/code] is [code]true[/code], the column expands in proportion to its expansion ratio versus the other columns' ratios. For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively. - Columns with a [code]false[/code] expand will not contribute to the total ratio. + If [code]expand[/code] is [code]false[/code], the column will not contribute to the total ratio. </description> </method> </methods> @@ -247,14 +247,14 @@ If [code]true[/code], the label allows text selection. </member> <member name="tab_size" type="int" setter="set_tab_size" getter="get_tab_size"> - The number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags. + The number of spaces associated with a single tab length. Does not affect [code]\t[/code] in text tags, only indent tags. </member> <member name="text" type="String" setter="set_text" getter="get_text"> The raw text of the label. - When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify [member bbcode_text]. + When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse BBCodes. Does not modify [member bbcode_text]. </member> <member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters"> - The restricted number of characters to display in the label. + The restricted number of characters to display in the label. If [code]-1[/code], all characters will be displayed. </member> </members> <signals> diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index 8dadca49e1..fefa519cea 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -4,10 +4,10 @@ Physics Body whose position is determined through physics simulation in 3D space. </brief_description> <description> - This is the node that implements full 3D physics. This means that you do not control a RigidBody 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 is the node that implements full 3D physics. This means that you do not control a RigidBody directly. Instead, you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. A RigidBody has 4 behavior [member mode]s: Rigid, Static, Character, and Kinematic. - [b]Note:[/b] Don't change a RigidBody'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. 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]. + [b]Note:[/b] Don't change a RigidBody'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 may result in strange behavior. 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 function. See [member custom_integrator]. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> @@ -70,7 +70,7 @@ <argument index="1" name="impulse" type="Vector3"> </argument> <description> - Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate dependent force. For this reason it should only be used when simulating one-time impacts. The position uses the rotation of the global coordinate system, but is centered at the object's origin. + Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason it should only be used when simulating one-time impacts. The position uses the rotation of the global coordinate system, but is centered at the object's origin. </description> </method> <method name="apply_torque_impulse"> @@ -79,14 +79,15 @@ <argument index="0" name="impulse" type="Vector3"> </argument> <description> - Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the passed in vector. + Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the [code]impulse[/code] vector passed. </description> </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Returns a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the [member contacts_reported] property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. + Returns a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the [member contacts_reported] property to increase it. + [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="set_axis_velocity"> @@ -107,22 +108,22 @@ RigidBody's rotational velocity. </member> <member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's rotation in the x-axis. + Lock the body's rotation in the X axis. </member> <member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's rotation in the y-axis. + Lock the body's rotation in the Y axis. </member> <member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's rotation in the z-axis. + Lock the body's rotation in the Z axis. </member> <member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's movement in the x-axis. + Lock the body's movement in the X axis. </member> <member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's movement in the y-axis. + Lock the body's movement in the Y axis. </member> <member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's movement in the z-axis. + Lock the body's movement in the Z axis. </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> RigidBody's bounciness. @@ -138,7 +139,7 @@ </member> <member name="continuous_cd" type="bool" setter="set_use_continuous_collision_detection" getter="is_using_continuous_collision_detection"> If [code]true[/code], continuous collision detection is used. - 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 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 fewer impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. </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. @@ -147,19 +148,19 @@ The body's friction, from 0 (frictionless) to 1 (max friction). </member> <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale"> - This is multiplied by the global 3D gravity setting found in "Project > Project Settings > Physics > 3d" to produce RigidBody'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. + This is multiplied by the global 3D gravity setting found in [b]Project > Project Settings > Physics > 3d[/b] to produce RigidBody's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp"> The body's linear damp. Default value: -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. </member> <member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity"> - The body'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. Can be used sporadically, but [b]don't set this 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. </member> <member name="mass" type="float" setter="set_mass" getter="get_mass"> The body's mass. </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="RigidBody.Mode"> - The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. + The body mode. See [enum Mode] for possible values. Default value: [code]MODE_RIGID[/code]. </member> <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override"> </member> @@ -167,7 +168,7 @@ If [code]true[/code], the body is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method. </member> <member name="weight" type="float" setter="set_weight" getter="get_weight"> - The body's weight based on its mass and the global 3D gravity. Global values are set in "Project > Project Settings > Physics > 3d". + The body's weight based on its mass and the global 3D gravity. Global values are set in [b]Project > Project Settings > Physics > 3d[/b]. </member> </members> <signals> @@ -196,7 +197,7 @@ </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. + This signal not only receives the body that collided with this one, but also its [RID] ([code]body_id[/code]), the shape index from the colliding body ([code]body_shape[/code]), and the shape index from this body ([code]local_shape[/code]) the other body collided with. </description> </signal> <signal name="body_shape_exited"> @@ -210,7 +211,7 @@ </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. + This signal not only receives the body that stopped colliding with this one, but also its [RID] ([code]body_id[/code]), the shape index from the colliding body ([code]body_shape[/code]), and the shape index from this body ([code]local_shape[/code]) the other body stopped colliding with. </description> </signal> <signal name="sleeping_state_changed"> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 3fdc367cc5..f22ad9e4b2 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -68,7 +68,7 @@ <argument index="1" name="impulse" type="Vector2"> </argument> <description> - Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate dependent force. For this reason it should only be used when simulating one-time impacts (use the "_force" functions otherwise). The position uses the rotation of the global coordinate system, but is centered at the object's origin. + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason it should only be used when simulating one-time impacts (use the "_force" functions otherwise). The position uses the rotation of the global coordinate system, but is centered at the object's origin. </description> </method> <method name="apply_torque_impulse"> @@ -84,7 +84,8 @@ <return type="Array"> </return> <description> - 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]. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. + 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]. + [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="set_axis_velocity"> @@ -114,7 +115,7 @@ </methods> <members> <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp"> - 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]. + Damps the body's [member angular_velocity]. If [code]-1[/code], the body will use the [b]Default Angular Damp[/b] defined in [b]Project > Project Settings > Physics > 2d[/b]. Default value: [code]-1[/code]. </member> <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity"> The body's rotational velocity. @@ -148,13 +149,13 @@ 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"> - 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]. + Multiplies the gravity applied to the body. The body's gravity is calculated from the [b]Default Gravity[/b] value in [b]Project > Project Settings > Physics > 2d[/b] and/or any additional gravity vector applied by [Area2D]s. Default value: [code]1[/code]. </member> <member name="inertia" type="float" setter="set_inertia" getter="get_inertia"> The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp"> - 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]. + Damps the body's [member linear_velocity]. If [code]-1[/code], the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b]. Default value: [code]-1[/code]. </member> <member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity"> The body's linear velocity. @@ -163,7 +164,7 @@ 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's mode. See [code]MODE_*[/code] constants. Default value: [constant MODE_RIGID]. + The body's mode. See [enum Mode] for possible values. Default value: [constant MODE_RIGID]. </member> <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override"> </member> @@ -171,7 +172,7 @@ 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"> - The body's weight based on its mass and the "Default Gravity" value in "Project > Project Settings > Physics > 2d". + The body's weight based on its mass and the [b]Default Gravity[/b] value in [b]Project > Project Settings > Physics > 2d[/b]. </member> </members> <signals> diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index 8cbc582bf5..3bd958bfd4 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -202,10 +202,12 @@ If passed to [method PackedScene.instance], blocks edits to the scene state. </constant> <constant name="GEN_EDIT_STATE_INSTANCE" value="1" enum="GenEditState"> - If passed to [method PackedScene.instance], provides inherited scene resources to the local scene. Requires tools compiled. + If passed to [method PackedScene.instance], provides inherited scene resources to the local scene. + [b]Note:[/b] Only available in editor builds. </constant> <constant name="GEN_EDIT_STATE_MAIN" value="2" enum="GenEditState"> - If passed to [method PackedScene.instance], provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled. + If passed to [method PackedScene.instance], provides local scene resources to the local scene. Only the main scene should receive the main edit state. + [b]Note:[/b] Only available in editor builds. </constant> </constants> </class> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 25c129d1d4..5e898642d6 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -283,11 +283,11 @@ The default [MultiplayerAPI] instance for this [SceneTree]. </member> <member name="multiplayer_poll" type="bool" setter="set_multiplayer_poll_enabled" getter="is_multiplayer_poll_enabled"> - If [code]true[/code] (default value), enable the automatic polling of the [MultiplayerAPI] for this [SceneTree] during [signal idle_frame]. - When [code]false[/code] you need to manually call [method MultiplayerAPI.poll] for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protection when accessing the [MultiplayerAPI] from threads. + If [code]true[/code] (default value), enables automatic polling of the [MultiplayerAPI] for this SceneTree during [signal idle_frame]. + If [code]false[/code], you need to manually call [method MultiplayerAPI.poll] to process network packets and deliver RPCs/RSETs. This allows running RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protection when accessing the [MultiplayerAPI] from threads. </member> <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> - The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the [SceneTree] will become a network server (check with [method is_network_server]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to [SceneTree]'s signals. + The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the [SceneTree] will become a network server (check with [method is_network_server]) and will set the root node's network mode to master (see [code]NETWORK_MODE_*[/code] constants in [Node]), or it will become a regular peer with the root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to [SceneTree]'s signals. </member> <member name="paused" type="bool" setter="set_pause" getter="is_paused"> If [code]true[/code], the [SceneTree] is paused. Doing so will have the following behavior: @@ -354,7 +354,7 @@ <argument index="0" name="node" type="Node"> </argument> <description> - Emitted when a node's configuration changed. Only emitted in tool mode. + Emitted when a node's configuration changed. Only emitted in [code]tool[/code] mode. </description> </signal> <signal name="node_removed"> @@ -378,7 +378,7 @@ </signal> <signal name="screen_resized"> <description> - Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes. + Emitted when the screen resolution (fullscreen) or window size (windowed) changes. </description> </signal> <signal name="server_disconnected"> @@ -415,10 +415,10 @@ Keep the specified display resolution. No interpolation. Content may appear pixelated. </constant> <constant name="STRETCH_ASPECT_IGNORE" value="0" enum="StretchAspect"> - Fill the window with the content stretched to cover excessive space. Content may appear elongated. + Fill the window with the content stretched to cover excessive space. Content may appear stretched. </constant> <constant name="STRETCH_ASPECT_KEEP" value="1" enum="StretchAspect"> - Retain the same aspect ratio by padding with black bars in either axes. No expansion of content. + Retain the same aspect ratio by padding with black bars on either axis. This prevents distortion. </constant> <constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2" enum="StretchAspect"> Expand vertically. Left/right black bars may appear if the window is too wide. @@ -427,7 +427,7 @@ Expand horizontally. Top/bottom black bars may appear if the window is too tall. </constant> <constant name="STRETCH_ASPECT_EXPAND" value="4" enum="StretchAspect"> - Expand in both directions, retaining the same aspect ratio. No black bars. + Expand in both directions, retaining the same aspect ratio. This prevents distortion while avoiding black bars. </constant> </constants> </class> diff --git a/doc/classes/ScriptCreateDialog.xml b/doc/classes/ScriptCreateDialog.xml index b2c2d0f060..def2fa944a 100644 --- a/doc/classes/ScriptCreateDialog.xml +++ b/doc/classes/ScriptCreateDialog.xml @@ -7,8 +7,8 @@ The [ScriptCreateDialog] creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling one of the [method Popup.popup] methods. [codeblock] func _ready(): - dialog.config("Node", "res://new_node.gd") # for in-engine types - dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # for script types + dialog.config("Node", "res://new_node.gd") # For in-engine types + dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # For script types dialog.popup_centered() [/codeblock] </description> diff --git a/doc/classes/ScrollBar.xml b/doc/classes/ScrollBar.xml index 8b8314d2c8..8576fd26e2 100644 --- a/doc/classes/ScrollBar.xml +++ b/doc/classes/ScrollBar.xml @@ -4,7 +4,7 @@ Base class for scroll bars. </brief_description> <description> - Scrollbars are a [Range] based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available. + Scrollbars are a [Range]-based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ <signals> <signal name="scrolling"> <description> - Emitted whenever the scrollbar is being scrolled. + Emitted when the scrollbar is being scrolled. </description> </signal> </signals> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 7d7dfe167a..8eca55373b 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ScrollContainer" inherits="Container" category="Core" version="3.2"> <brief_description> - A helper node for displaying scrollable elements (e.g. lists). + A helper node for displaying scrollable elements such as lists. </brief_description> <description> - A ScrollContainer node meant to contain a [Control] child. ScrollContainers will automatically create a scrollbar child ([HScrollBar], [VScrollBar], or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a [Panel] control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension). + A ScrollContainer node meant to contain a [Control] child. ScrollContainers will automatically create a scrollbar child ([HScrollBar], [VScrollBar], or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the [member Control.rect_min_size] of the Control relative to the ScrollContainer. Works great with a [Panel] control. You can set [code]EXPAND[/code] on the children's size flags, so they will upscale to the ScrollContainer's size if it's larger (scroll is invisible for the chosen dimension). </description> <tutorials> </tutorials> @@ -41,12 +41,12 @@ <signals> <signal name="scroll_ended"> <description> - Emitted whenever scrolling stops. + Emitted when scrolling stops. </description> </signal> <signal name="scroll_started"> <description> - Emitted whenever scrolling is started. + Emitted when scrolling is started. </description> </signal> </signals> diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index 412913807d..7aee5c2951 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Semaphore" inherits="Reference" category="Core" version="3.2"> <brief_description> - A synchronization Semaphore. + A synchronization semaphore. </brief_description> <description> - A synchronization Semaphore. Element used to synchronize multiple [Thread]s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see [Mutex]. + A synchronization semaphore which can be used to synchronize multiple [Thread]s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see [Mutex]. </description> <tutorials> </tutorials> diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index c887e23de0..65abc35282 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Shape2D" inherits="Resource" category="Core" version="3.2"> <brief_description> - Base class for all 2D Shapes. + Base class for all 2D shapes. </brief_description> <description> - Base class for all 2D Shapes. All 2D shape types inherit from this. + Base class for all 2D shapes. All 2D shape types inherit from this. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index b693ee0a5e..a6e535bcfe 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -17,7 +17,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Add a bone, with name "name". [method get_bone_count] will become the bone index. + Adds a bone, with name [code]name[/code]. [method get_bone_count] will become the bone index. </description> </method> <method name="bind_child_node_to_bone"> @@ -28,7 +28,7 @@ <argument index="1" name="node" type="Node"> </argument> <description> - Deprecated soon. + [i]Deprecated soon.[/i] </description> </method> <method name="clear_bones"> @@ -44,7 +44,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Returns the bone index that matches "name" as its name. + Returns the bone index that matches [code]name[/code] as its name. </description> </method> <method name="get_bone_count" qualifiers="const"> @@ -78,7 +78,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Returns the name of the bone at index "index". + Returns the name of the bone at index [code]index[/code]. </description> </method> <method name="get_bone_parent" qualifiers="const"> @@ -87,7 +87,8 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Returns the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". + Returns the bone index which is the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent. + [b]Note:[/b] The parent bone returned will always be less than [code]bone_idx[/code]. </description> </method> <method name="get_bone_pose" qualifiers="const"> @@ -105,7 +106,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Returns the rest transform for a bone "bone_idx". + Returns the rest transform for a bone [code]bone_idx[/code]. </description> </method> <method name="get_bone_transform" qualifiers="const"> @@ -123,7 +124,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Deprecated soon. + [i]Deprecated soon.[/i] </description> </method> <method name="is_bone_rest_disabled" qualifiers="const"> @@ -218,7 +219,8 @@ <argument index="1" name="parent_idx" type="int"> </argument> <description> - Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". + Sets the bone index [code]parent_idx[/code] as the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent. + [b]Note:[/b] [code]parent_idx[/code] must be less than [code]bone_idx[/code]. </description> </method> <method name="set_bone_pose"> @@ -229,7 +231,7 @@ <argument index="1" name="pose" type="Transform"> </argument> <description> - Returns the pose transform for bone "bone_idx". + Returns the pose transform for bone [code]bone_idx[/code]. </description> </method> <method name="set_bone_rest"> @@ -240,7 +242,7 @@ <argument index="1" name="rest" type="Transform"> </argument> <description> - Set the rest transform for bone "bone_idx" + Sets the rest transform for bone [code]bone_idx[/code]. </description> </method> <method name="unbind_child_node_from_bone"> @@ -251,7 +253,7 @@ <argument index="1" name="node" type="Node"> </argument> <description> - Deprecated soon. + [i]Deprecated soon.[/i] </description> </method> <method name="unparent_bone_and_rest"> diff --git a/doc/classes/Sky.xml b/doc/classes/Sky.xml index a5e065203e..cc9d2dc0df 100644 --- a/doc/classes/Sky.xml +++ b/doc/classes/Sky.xml @@ -12,32 +12,31 @@ </methods> <members> <member name="radiance_size" type="int" setter="set_radiance_size" getter="get_radiance_size" enum="Sky.RadianceSize"> - The [Sky]'s radiance map size. - The higher the radiance map size, the more detailed the lighting from the [Sky] will be. + The [Sky]'s radiance map size. The higher the radiance map size, the more detailed the lighting from the [Sky] will be. See [enum RadianceSize] constants for values. Default size is [constant RADIANCE_SIZE_512]. </member> </members> <constants> <constant name="RADIANCE_SIZE_32" value="0" enum="RadianceSize"> - Radiance texture size is 32x32 pixels. + Radiance texture size is 32×32 pixels. </constant> <constant name="RADIANCE_SIZE_64" value="1" enum="RadianceSize"> - Radiance texture size is 64x64 pixels. + Radiance texture size is 64×64 pixels. </constant> <constant name="RADIANCE_SIZE_128" value="2" enum="RadianceSize"> - Radiance texture size is 128x128 pixels. + Radiance texture size is 128×128 pixels. </constant> <constant name="RADIANCE_SIZE_256" value="3" enum="RadianceSize"> - Radiance texture size is 256x256 pixels. + Radiance texture size is 256×256 pixels. </constant> <constant name="RADIANCE_SIZE_512" value="4" enum="RadianceSize"> - Radiance texture size is 512x512 pixels. + Radiance texture size is 512×512 pixels. </constant> <constant name="RADIANCE_SIZE_1024" value="5" enum="RadianceSize"> - Radiance texture size is 1024x1024 pixels. + Radiance texture size is 1024×1024 pixels. </constant> <constant name="RADIANCE_SIZE_2048" value="6" enum="RadianceSize"> - Radiance texture size is 2048x2048 pixels. + Radiance texture size is 2048×2048 pixels. </constant> <constant name="RADIANCE_SIZE_MAX" value="7" enum="RadianceSize"> Represents the size of the [enum RadianceSize] enum. diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml index 8fdf2bc848..482c83f225 100644 --- a/doc/classes/Slider.xml +++ b/doc/classes/Slider.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Slider" inherits="Range" category="Core" version="3.2"> <brief_description> - Base class for GUI Sliders. + Base class for GUI sliders. </brief_description> <description> - Base class for GUI Sliders. + Base class for GUI sliders. </description> <tutorials> </tutorials> diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index 75406df39f..6a07bd9725 100644 --- a/doc/classes/SliderJoint.xml +++ b/doc/classes/SliderJoint.xml @@ -4,7 +4,7 @@ Piston kind of slider between two bodies in 3D. </brief_description> <description> - Slides across the x-axis of the pivot object. + Slides across the X axis of the pivot object. </description> <tutorials> </tutorials> @@ -51,7 +51,7 @@ The amount of damping that happens once the limit defined by [member linear_limit/lower_distance] and [member linear_limit/upper_distance] is surpassed. </member> <member name="linear_limit/lower_distance" type="float" setter="set_param" getter="get_param"> - The minimum difference between the pivot points on their x-axis before damping happens. + The minimum difference between the pivot points on their X axis before damping happens. </member> <member name="linear_limit/restitution" type="float" setter="set_param" getter="get_param"> The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. @@ -60,7 +60,7 @@ A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. </member> <member name="linear_limit/upper_distance" type="float" setter="set_param" getter="get_param"> - The maximum difference between the pivot points on their x-axis before damping happens. + The maximum difference between the pivot points on their X axis before damping happens. </member> <member name="linear_motion/damping" type="float" setter="set_param" getter="get_param"> The amount of damping inside the slider limits. @@ -83,10 +83,10 @@ </members> <constants> <constant name="PARAM_LINEAR_LIMIT_UPPER" value="0" enum="Param"> - The maximum difference between the pivot points on their x-axis before damping happens. + The maximum difference between the pivot points on their X axis before damping happens. </constant> <constant name="PARAM_LINEAR_LIMIT_LOWER" value="1" enum="Param"> - The minimum difference between the pivot points on their x-axis before damping happens. + The minimum difference between the pivot points on their X axis before damping happens. </constant> <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2" enum="Param"> A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index f4c0134471..5614d0b899 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Spatial" inherits="Node" category="Core" version="3.2"> <brief_description> - Most basic 3D game object, parent of all 3D related nodes. + Most basic 3D game object, parent of all 3D-related nodes. </brief_description> <description> Most basic 3D game object, with a 3D [Transform] and visibility settings. All other 3D game objects inherit from Spatial. Use [Spatial] as a parent node to move, scale, rotate and show/hide children in a 3D project. - Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the [Spatial] object is set as top level. Affine operations in this coordinate system correspond to direct affine operations on the [Spatial]'s transform. The word local below refers to this coordinate system. The coordinate system that is attached to the [Spatial] object itself is referred to as object-local coordinate system. + Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the [Spatial] object is set as top-level. Affine operations in this coordinate system correspond to direct affine operations on the [Spatial]'s transform. The word local below refers to this coordinate system. The coordinate system that is attached to the [Spatial] object itself is referred to as object-local coordinate system. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/3d/introduction_to_3d.html</link> @@ -161,7 +161,7 @@ <argument index="0" name="angle" type="float"> </argument> <description> - Rotates the local transformation around the X axis by angle in radians + Rotates the local transformation around the X axis by angle in radians. </description> </method> <method name="rotate_y"> @@ -212,7 +212,7 @@ <return type="void"> </return> <description> - Reset all transformations for this node. Set its [Transform] to identity matrix. + Reset all transformations for this node (sets its [Transform] to the identity matrix). </description> </method> <method name="set_ignore_transform_notification"> @@ -221,7 +221,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether the node ignores notification that its transformation (global or local) changed. + Sets whether the node ignores notification that its transformation (global or local) changed. </description> </method> <method name="set_notify_local_transform"> @@ -230,7 +230,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether the node notifies about its local transformation changes. [Spatial] will not propagate this by default. + Sets whether the node notifies about its local transformation changes. [Spatial] will not propagate this by default. </description> </method> <method name="set_notify_transform"> @@ -239,7 +239,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether the node notifies about its global and local transformation changes. [Spatial] will not propagate this by default. + Sets whether the node notifies about its global and local transformation changes. [Spatial] will not propagate this by default. </description> </method> <method name="show"> @@ -255,7 +255,7 @@ <argument index="0" name="local_point" type="Vector3"> </argument> <description> - Transforms [Vector3] "local_point" from this node's local space to world space. + Transforms [code]local_point[/code] from this node's local space to world space. </description> </method> <method name="to_local" qualifiers="const"> @@ -264,7 +264,7 @@ <argument index="0" name="global_point" type="Vector3"> </argument> <description> - Transforms [Vector3] "global_point" from world space to this node's local space. + Transforms [code]global_point[/code] from world space to this node's local space. </description> </method> <method name="translate"> @@ -300,11 +300,11 @@ World space (global) [Transform] of this node. </member> <member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation"> - Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). - Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. + Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). + [b]Note:[/b] In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. </member> <member name="rotation_degrees" type="Vector3" setter="set_rotation_degrees" getter="get_rotation_degrees"> - Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). + Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). </member> <member name="scale" type="Vector3" setter="set_scale" getter="get_scale"> Scale part of the local transformation. diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 45d92aa0c3..6b4a34826b 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -48,7 +48,7 @@ <member name="depth_deep_parallax" type="bool" setter="set_depth_deep_parallax" getter="is_depth_deep_parallax_enabled"> </member> <member name="depth_enabled" type="bool" setter="set_feature" getter="get_feature"> - If [code]true[/code], Depth mapping is enabled. See also [member normal_enabled]. + If [code]true[/code], depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also [member normal_enabled]. </member> <member name="depth_flip_binormal" type="bool" setter="set_depth_deep_parallax_flip_binormal" getter="get_depth_deep_parallax_flip_binormal"> </member> @@ -118,7 +118,8 @@ If [code]true[/code], the object is unaffected by lighting. Default value: [code]false[/code]. </member> <member name="flags_use_point_size" type="bool" setter="set_flag" getter="get_flag"> - If [code]true[/code], render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also [member params_point_size]. + If [code]true[/code], render point size can be changed. + [b]Note:[/b] this is only effective for objects whose geometry is point-based rather than triangle-based. See also [member params_point_size]. </member> <member name="flags_use_shadow_to_opacity" type="bool" setter="set_flag" getter="get_flag"> </member> @@ -129,10 +130,11 @@ If [code]true[/code], triplanar mapping is calculated in world space rather than object local space. See also [member uv1_triplanar]. Default value: [code]false[/code]. </member> <member name="metallic" type="float" setter="set_metallic" getter="get_metallic"> - The reflectivity of the object's surface. The higher the value the more light is reflected. + The reflectivity of the object's surface. The higher the value, the more light is reflected. </member> <member name="metallic_specular" type="float" setter="set_specular" getter="get_specular"> - General reflectivity amount. Note: unlike [member metallic], this is not energy-conserving, so it should be left at [code]0.5[/code] in most cases. See also [member roughness]. + General reflectivity amount. + [b]Note:[/b] unlike [member metallic], this is not energy-conserving, so it should be left at [code]0.5[/code] in most cases. See also [member roughness]. </member> <member name="metallic_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> @@ -154,7 +156,8 @@ Controls how the object faces the camera. See [enum BillboardMode]. </member> <member name="params_blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="SpatialMaterial.BlendMode"> - The material's blend mode. Note that values other than [code]Mix[/code] force the object into the transparent pipeline. See [enum BlendMode]. + The material's blend mode. + [b]Note:[/b] Values other than [code]Mix[/code] force the object into the transparent pipeline. See [enum BlendMode]. </member> <member name="params_cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="SpatialMaterial.CullMode"> Which side of the object is not drawn when backfaces are rendered. See [enum CullMode]. @@ -182,13 +185,13 @@ <member name="params_use_alpha_scissor" type="bool" setter="set_flag" getter="get_flag"> </member> <member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames"> - The number of horizontal frames in the particle spritesheet. Only enabled when using [code]BillboardMode.BILLBOARD_PARTICLES[/code]. See [member params_billboard_mode]. + The number of horizontal frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. </member> <member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop"> - If [code]true[/code], particle animations are looped. Only enabled when using [code]BillboardMode.BILLBOARD_PARTICLES[/code]. See [member params_billboard_mode]. + If [code]true[/code], particle animations are looped. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. </member> <member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames"> - The number of vertical frames in the particle spritesheet. Only enabled when using [code]BillboardMode.BILLBOARD_PARTICLES[/code]. See [member params_billboard_mode]. + The number of vertical frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. </member> <member name="proximity_fade_distance" type="float" setter="set_proximity_fade_distance" getter="get_proximity_fade_distance"> </member> @@ -433,10 +436,10 @@ Default value. </constant> <constant name="BILLBOARD_ENABLED" value="1" enum="BillboardMode"> - The object's z-axis will always face the camera. + The object's Z axis will always face the camera. </constant> <constant name="BILLBOARD_FIXED_Y" value="2" enum="BillboardMode"> - The object's x-axis will always face the camera. + The object's X axis will always face the camera. </constant> <constant name="BILLBOARD_PARTICLES" value="3" enum="BillboardMode"> Used for particle systems. Enables particle animation options. diff --git a/doc/classes/SphereMesh.xml b/doc/classes/SphereMesh.xml index 4ebb2e919d..c33c676ea1 100644 --- a/doc/classes/SphereMesh.xml +++ b/doc/classes/SphereMesh.xml @@ -15,7 +15,8 @@ Full height of the sphere. Defaults to 2.0. </member> <member name="is_hemisphere" type="bool" setter="set_is_hemisphere" getter="get_is_hemisphere"> - Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere, the height and radius of the sphere have to equal. Defaults to [code]false[/code]. + Determines whether a full sphere or a hemisphere is created. + [b]Note:[/b] To get a regular hemisphere, the height and radius of the sphere must be equal. Defaults to [code]false[/code]. </member> <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments"> Number of radial segments on the sphere. Defaults to 64. diff --git a/doc/classes/SpotLight.xml b/doc/classes/SpotLight.xml index 7369189c72..edd578a5b0 100644 --- a/doc/classes/SpotLight.xml +++ b/doc/classes/SpotLight.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="SpotLight" inherits="Light" category="Core" version="3.2"> <brief_description> - Spotlight [Light], such as a reflector spotlight or a lantern. + A spotlight, such as a reflector spotlight or a lantern. </brief_description> <description> - A SpotLight light is a type of [Light] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. + A Spotlight is a type of [Light] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance. This attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link> @@ -13,12 +13,16 @@ </methods> <members> <member name="spot_angle" type="float" setter="set_param" getter="get_param"> + The spotlight's angle in degrees. </member> <member name="spot_angle_attenuation" type="float" setter="set_param" getter="get_param"> + The spotlight's angular attenuation curve. </member> <member name="spot_attenuation" type="float" setter="set_param" getter="get_param"> + The spotlight's light energy attenuation curve. </member> <member name="spot_range" type="float" setter="set_param" getter="get_param"> + The maximal range that can be reached by the spotlight. </member> </members> <constants> diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index 097a5f2ed2..6488931354 100644 --- a/doc/classes/Sprite.xml +++ b/doc/classes/Sprite.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Sprite" inherits="Node2D" category="Core" version="3.2"> <brief_description> - General purpose Sprite node. + General-purpose sprite node. </brief_description> <description> A node that displays a 2D texture. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. @@ -29,7 +29,7 @@ </argument> <description> Returns [code]true[/code], if the pixel at the given position is opaque and [code]false[/code] in other case. - Note: It also returns [code]false[/code], if the sprite's texture is null or if the given position is invalid. + [b]Note:[/b] It also returns [code]false[/code], if the sprite's texture is [code]null[/code] or if the given position is invalid. </description> </method> </methods> diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml index 81fe182782..0297699337 100644 --- a/doc/classes/Sprite3D.xml +++ b/doc/classes/Sprite3D.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Sprite3D" inherits="SpriteBase3D" category="Core" version="3.2"> <brief_description> - 2D Sprite node in 3D world. + 2D sprite node in a 3D world. </brief_description> <description> A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 237a8c9d12..b42ba23358 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="SpriteBase3D" inherits="GeometryInstance" category="Core" version="3.2"> <brief_description> - 2D Sprite node in 3D environment. + 2D sprite node in 3D environment. </brief_description> <description> A node that displays 2D texture information in a 3D environment. @@ -50,21 +50,21 @@ The objects visibility on a scale from [code]0[/code] fully invisible to [code]1[/code] fully visible. </member> <member name="pixel_size" type="float" setter="set_pixel_size" getter="get_pixel_size"> - The size of one pixel's width on the Sprite to scale it in 3D. + The size of one pixel's width on the sprite to scale it in 3D. </member> <member name="shaded" type="bool" setter="set_draw_flag" getter="get_draw_flag"> - If [code]true[/code], the [Light] in the [Environment] has effects on the Sprite. Default value: [code]false[/code]. + If [code]true[/code], the [Light] in the [Environment] has effects on the sprite. Default value: [code]false[/code]. </member> <member name="transparent" type="bool" setter="set_draw_flag" getter="get_draw_flag"> - If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the Sprite invisible. Default value: [code]true[/code]. + If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the sprite invisible. Default value: [code]true[/code]. </member> </members> <constants> <constant name="FLAG_TRANSPARENT" value="0" enum="DrawFlags"> - If set, the texture's transparency and the opacity are used to make those parts of the Sprite invisible. + If set, the texture's transparency and the opacity are used to make those parts of the sprite invisible. </constant> <constant name="FLAG_SHADED" value="1" enum="DrawFlags"> - If set, the Light in the Environment has effects on the Sprite. + If set, lights in the environment affect the sprite. </constant> <constant name="FLAG_DOUBLE_SIDED" value="2" enum="DrawFlags"> If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind. diff --git a/doc/classes/StaticBody.xml b/doc/classes/StaticBody.xml index d2b7abebb1..6d91f8b238 100644 --- a/doc/classes/StaticBody.xml +++ b/doc/classes/StaticBody.xml @@ -4,8 +4,8 @@ Static body for 3D physics. </brief_description> <description> - Static body for 3D physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody] so they are great for scenario collision. - A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. + Static body for 3D physics. A static body is a simple body that is not intended to move. In contrast to [RigidBody], they don't consume any CPU resources as long as they don't move. + A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active, the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels). </description> <tutorials> @@ -14,16 +14,16 @@ </methods> <members> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> - The body bounciness. + The body's bounciness. </member> <member name="constant_angular_velocity" type="Vector3" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity"> - The constant angular velocity for the body. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. + The body's constant angular velocity. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. </member> <member name="constant_linear_velocity" type="Vector3" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity"> - The constant linear velocity for the body. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. + The body's constant linear velocity. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. </member> <member name="friction" type="float" setter="set_friction" getter="get_friction"> - The body friction, from 0 (frictionless) to 1 (full friction). + The body's friction, from 0 (frictionless) to 1 (full friction). </member> <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override"> </member> diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml index 98b38e9e26..9d6ab631f9 100644 --- a/doc/classes/StaticBody2D.xml +++ b/doc/classes/StaticBody2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="StaticBody2D" inherits="PhysicsBody2D" category="Core" version="3.2"> <brief_description> - Static body for 2D Physics. + Static body for 2D physics. </brief_description> <description> - Static body for 2D Physics. A StaticBody2D is a body that is not intended to move. It is ideal for implementing objects in the environment, such as walls or platforms. + Static body for 2D physics. A StaticBody2D is a body that is not intended to move. It is ideal for implementing objects in the environment, such as walls or platforms. Additionally, a constant linear or angular velocity can be set for the static body, which will affect colliding bodies as if it were moving (for example, a conveyor belt). </description> <tutorials> @@ -16,10 +16,10 @@ The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). </member> <member name="constant_angular_velocity" type="float" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity"> - Constant angular velocity for the body. This does not rotate the body, but affects colliding bodies, as if it were rotating. + The body's constant angular velocity. This does not rotate the body, but affects colliding bodies, as if it were rotating. </member> <member name="constant_linear_velocity" type="Vector2" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity"> - Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. + The body's constant linear velocity. This does not move the body, but affects colliding bodies, as if it were moving. </member> <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body's friction. Values range from [code]0[/code] (no friction) to [code]1[/code] (full friction). diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index d278312fc3..11b4c116c4 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -4,7 +4,7 @@ Abstraction and base class for stream-based protocols. </brief_description> <description> - StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. + StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or UNIX sockets). It provides an API for sending and receiving data through streams as raw data or strings. </description> <tutorials> </tutorials> @@ -13,28 +13,28 @@ <return type="int"> </return> <description> - Get a signed 16 bit value from the stream. + Gets a signed 16-bit value from the stream. </description> </method> <method name="get_32"> <return type="int"> </return> <description> - Get a signed 32 bit value from the stream. + Gets a signed 32-bit value from the stream. </description> </method> <method name="get_64"> <return type="int"> </return> <description> - Get a signed 64 bit value from the stream. + Gets a signed 64-bit value from the stream. </description> </method> <method name="get_8"> <return type="int"> </return> <description> - Get a signed byte from the stream. + Gets a signed byte from the stream. </description> </method> <method name="get_available_bytes" qualifiers="const"> @@ -50,21 +50,21 @@ <argument index="0" name="bytes" type="int"> </argument> <description> - Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the [code]bytes[/code] argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum @GlobalScope.Error] code and a data array. </description> </method> <method name="get_double"> <return type="float"> </return> <description> - Get a double-precision float from the stream. + Gets a double-precision float from the stream. </description> </method> <method name="get_float"> <return type="float"> </return> <description> - Get a single-precision float from the stream. + Gets a single-precision float from the stream. </description> </method> <method name="get_partial_data"> @@ -73,7 +73,7 @@ <argument index="0" name="bytes" type="int"> </argument> <description> - Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [enum @GlobalScope.Error] code, and a data array. </description> </method> <method name="get_string"> @@ -82,35 +82,35 @@ <argument index="0" name="bytes" type="int" default="-1"> </argument> <description> - Get a string with byte-length [code]bytes[/code] from the stream. If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_string]. + Gets a string with byte-length [code]bytes[/code] from the stream. If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_string]. </description> </method> <method name="get_u16"> <return type="int"> </return> <description> - Get an unsigned 16 bit value from the stream. + Gets an unsigned 16-bit value from the stream. </description> </method> <method name="get_u32"> <return type="int"> </return> <description> - Get an unsigned 32 bit value from the stream. + Gets an unsigned 32-bit value from the stream. </description> </method> <method name="get_u64"> <return type="int"> </return> <description> - Get an unsigned 64 bit value from the stream. + Gets an unsigned 64-bit value from the stream. </description> </method> <method name="get_u8"> <return type="int"> </return> <description> - Get an unsigned byte from the stream. + Gets an unsigned byte from the stream. </description> </method> <method name="get_utf8_string"> @@ -119,7 +119,7 @@ <argument index="0" name="bytes" type="int" default="-1"> </argument> <description> - Get a utf8 string with byte-length [code]bytes[/code] from the stream (this decodes the string sent as utf8). If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string]. + Gets an UTF-8 string with byte-length [code]bytes[/code] from the stream (this decodes the string sent as UTF-8). If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string]. </description> </method> <method name="get_var"> @@ -128,8 +128,8 @@ <argument index="0" name="allow_objects" type="bool" default="false"> </argument> <description> - Get a Variant from the stream. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. - [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). + Gets a Variant from the stream. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. + [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </description> </method> <method name="put_16"> @@ -138,7 +138,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Put a signed 16 bit value into the stream. + Puts a signed 16-bit value into the stream. </description> </method> <method name="put_32"> @@ -147,7 +147,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Put a signed 32 bit value into the stream. + Puts a signed 32-bit value into the stream. </description> </method> <method name="put_64"> @@ -156,7 +156,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Put a signed 64 bit value into the stream. + Puts a signed 64-bit value into the stream. </description> </method> <method name="put_8"> @@ -165,7 +165,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Put a signed byte into the stream. + Puts a signed byte into the stream. </description> </method> <method name="put_data"> @@ -174,7 +174,7 @@ <argument index="0" name="data" type="PoolByteArray"> </argument> <description> - Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. + Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an [enum @GlobalScope.Error] code. </description> </method> <method name="put_double"> @@ -183,7 +183,7 @@ <argument index="0" name="value" type="float"> </argument> <description> - Put a double-precision float into the stream. + Puts a double-precision float into the stream. </description> </method> <method name="put_float"> @@ -192,7 +192,7 @@ <argument index="0" name="value" type="float"> </argument> <description> - Put a single-precision float into the stream. + Puts a single-precision float into the stream. </description> </method> <method name="put_partial_data"> @@ -201,7 +201,7 @@ <argument index="0" name="data" type="PoolByteArray"> </argument> <description> - Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. + Sends a chunk of data through the connection. If all the data could not be sent at once, only part of it will. This function returns two values, an [enum @GlobalScope.Error] code and an integer, describing how much data was actually sent. </description> </method> <method name="put_string"> @@ -210,7 +210,7 @@ <argument index="0" name="value" type="String"> </argument> <description> - Put a zero-terminated ascii string into the stream prepended by a 32 bits unsigned integer representing its size. + Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size. </description> </method> <method name="put_u16"> @@ -219,7 +219,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Put an unsigned 16 bit value into the stream. + Puts an unsigned 16-bit value into the stream. </description> </method> <method name="put_u32"> @@ -228,7 +228,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Put an unsigned 32 bit value into the stream. + Puts an unsigned 32-bit value into the stream. </description> </method> <method name="put_u64"> @@ -237,7 +237,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Put an unsigned 64 bit value into the stream. + Puts an unsigned 64-bit value into the stream. </description> </method> <method name="put_u8"> @@ -246,7 +246,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Put an unsigned byte into the stream. + Puts an unsigned byte into the stream. </description> </method> <method name="put_utf8_string"> @@ -255,7 +255,7 @@ <argument index="0" name="value" type="String"> </argument> <description> - Put a zero-terminated utf8 string into the stream prepended by a 32 bits unsigned integer representing its size. + Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. </description> </method> <method name="put_var"> @@ -266,7 +266,7 @@ <argument index="1" name="full_objects" type="bool" default="false"> </argument> <description> - Put a Variant into the stream. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). + Puts a Variant into the stream. If [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). </description> </method> </methods> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index f28e6e5544..d529b6da99 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="StreamPeerSSL" inherits="StreamPeer" category="Core" version="3.2"> <brief_description> - SSL Stream peer. + SSL stream peer. </brief_description> <description> - SSL Stream peer. This object can be used to connect to SSL servers. + SSL stream peer. This object can be used to connect to SSL servers. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/networking/ssl_certificates.html</link> @@ -28,28 +28,28 @@ <argument index="2" name="for_hostname" type="String" default=""""> </argument> <description> - Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". + Connects to a peer using an underlying [StreamPeer] [code]stream[/code]. If [code]validate_certs[/code] is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the [code]for_hostname[/code]. </description> </method> <method name="disconnect_from_stream"> <return type="void"> </return> <description> - Disconnect from host. + Disconnects from host. </description> </method> <method name="get_status" qualifiers="const"> <return type="int" enum="StreamPeerSSL.Status"> </return> <description> - Returns the status of the connection, one of STATUS_* enum. + Returns the status of the connection. See [enum Status] for values. </description> </method> <method name="poll"> <return type="void"> </return> <description> - Poll the connection to check for incoming bytes. Call this right before "get_available_bytes()" for it to work properly. + Poll the connection to check for incoming bytes. Call this right before [method StreamPeer.get_available_bytes] for it to work properly. </description> </method> </methods> diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 49c6272606..bee026c851 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="StreamPeerTCP" inherits="StreamPeer" category="Core" version="3.2"> <brief_description> - TCP Stream peer. + TCP stream peer. </brief_description> <description> - TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a TCP server. + TCP stream peer. This object can be used to connect to TCP servers, or also is returned by a TCP server. </description> <tutorials> </tutorials> @@ -17,14 +17,14 @@ <argument index="1" name="port" type="int"> </argument> <description> - Connect to the specified host:port pair. A hostname will be resolved if valid. Returns [constant OK] on success or [constant FAILED] on failure. + Connects to the specified [code]host:port[/code] pair. A hostname will be resolved if valid. Returns [constant OK] on success or [constant FAILED] on failure. </description> </method> <method name="disconnect_from_host"> <return type="void"> </return> <description> - Disconnect from host. + Disconnects from host. </description> </method> <method name="get_connected_host" qualifiers="const"> @@ -61,14 +61,14 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Disable Nagle algorithm to improve latency for small packets. - Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth. + Disables Nagle's algorithm to improve latency for small packets. + [b]Note:[/b] For applications that send large packets or need to transfer a lot of data, this can decrease the total available bandwidth. </description> </method> </methods> <constants> <constant name="STATUS_NONE" value="0" enum="Status"> - The initial status of the [StreamPeerTCP], also the status after a disconnect. + The initial status of the [StreamPeerTCP]. This is also the status after disconnecting. </constant> <constant name="STATUS_CONNECTING" value="1" enum="Status"> A status representing a [StreamPeerTCP] that is connecting to a host. diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture.xml index 1ff2500d1a..4723fec210 100644 --- a/doc/classes/StreamTexture.xml +++ b/doc/classes/StreamTexture.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="StreamTexture" inherits="Texture" category="Core" version="3.2"> <brief_description> - A .stex texture. + A [code].stex[/code] texture. </brief_description> <description> - A texture that is loaded from a .stex file. + A texture that is loaded from a [code].stex[/code] file. </description> <tutorials> </tutorials> @@ -12,7 +12,7 @@ </methods> <members> <member name="load_path" type="String" setter="load" getter="get_load_path"> - The StreamTexture's filepath to a .stex file. + The StreamTexture's file path to a [code].stex[/code] file. </member> </members> <constants> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 6395fe2ce8..2b16bd2b33 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -260,7 +260,7 @@ <return type="String"> </return> <description> - 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]. + 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"> @@ -276,7 +276,7 @@ <return type="String"> </return> <description> - Removes indentation from string. + Returns a copy of the string with indentation (leading tabs and spaces) removed. </description> </method> <method name="empty"> @@ -471,7 +471,7 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if this string contains a valid color in HTML notation. + Returns [code]true[/code] if this string contains a valid color in hexadecimal HTML notation. Other HTML notations such as named colors or [code]hsl()[/code] colors aren't considered valid by this method and will return [code]false[/code]. </description> </method> <method name="is_valid_identifier"> @@ -533,7 +533,7 @@ <argument index="0" name="expr" type="String"> </argument> <description> - Does a simple expression match, where [code]*[/code] matches zero or more arbitrary characters and [code]?[/code] matches any single character except '.'. + Does a simple case-sensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). </description> </method> <method name="matchn"> @@ -542,7 +542,7 @@ <argument index="0" name="expr" type="String"> </argument> <description> - Does a simple case insensitive expression match, using [code]?[/code] and [code]*[/code] wildcards (see [method match]). + Does a simple case-insensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). </description> </method> <method name="md5_buffer"> @@ -626,7 +626,7 @@ <argument index="1" name="forwhat" type="String"> </argument> <description> - Replaces occurrences of a substring with the given one inside the string. + Replaces occurrences of a case-sensitive substring with the given one inside the string. </description> </method> <method name="replacen"> @@ -637,7 +637,7 @@ <argument index="1" name="forwhat" type="String"> </argument> <description> - Replaces occurrences of a substring with the given one inside the string. Ignores case. + Replaces occurrences of a case-insensitive substring with the given one inside the string. </description> </method> <method name="rfind"> @@ -648,7 +648,7 @@ <argument index="1" name="from" type="int" default="-1"> </argument> <description> - Performs a search for a substring, but starts from the end of the string instead of the beginning. + Performs a case-sensitive search for a substring, but starts from the end of the string instead of the beginning. </description> </method> <method name="rfindn"> @@ -659,7 +659,7 @@ <argument index="1" name="from" type="int" default="-1"> </argument> <description> - Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case. + Performs a case-insensitive search for a substring, but starts from the end of the string instead of the beginning. </description> </method> <method name="right"> @@ -684,7 +684,7 @@ Splits the string by a [code]delimiter[/code] string and returns an array of the substrings, starting from right. The splits in the returned array are sorted in the same order as the original string, from left to right. If [code]maxsplit[/code] is specified, it defines the number of splits to do from the right up to [code]maxsplit[/code]. The default value of 0 means that all items are split, thus giving the same result as [method split]. - [b]Example:[/b] [code]"One,Two,Three,Four"[/code] will return [code]["Three","Four"][/code] if split by [code]","[/code] with [code]maxsplit[/code] of 2. + For example, [code]"One,Two,Three,Four"[/code] will return [code]["Three","Four"][/code] if split by [code]","[/code] with a [code]maxsplit[/code] value of 2. </description> </method> <method name="rstrip"> @@ -731,7 +731,7 @@ <description> Splits the string by a [code]delimiter[/code] string and returns an array of the substrings. If [code]maxsplit[/code] is specified, it defines the number of splits to do from the left up to [code]maxsplit[/code]. The default value of 0 means that all items are split. - [b]Example:[/b] [code]"One,Two,Three"[/code] will return [code]["One","Two"][/code] if split by [code]","[/code] with [code]maxsplit[/code] of 2. + For example, [code]"One,Two,Three"[/code] will return [code]["One","Two"][/code] if split by [code]","[/code] with a [code]maxsplit[/code] value of 2. </description> </method> <method name="split_floats"> @@ -743,7 +743,7 @@ </argument> <description> Splits the string in floats by using a delimiter string and returns an array of the substrings. - [b]Example:[/b] [code]"1,2.5,3"[/code] will return [code][1,2.5,3][/code] if split by [code]","[/code]. + For example, [code]"1,2.5,3"[/code] will return [code][1,2.5,3][/code] if split by [code]","[/code]. </description> </method> <method name="strip_edges"> @@ -779,7 +779,7 @@ <return type="PoolByteArray"> </return> <description> - Converts the String (which is a character array) to [PoolByteArray] (which is an array of bytes). The conversion is sped up in comparison to [method 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 faster compared to [method to_utf8], as this method assumes that all the characters in the String are ASCII characters. </description> </method> <method name="to_float"> diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index a156f134e7..832f93e0ba 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -37,7 +37,7 @@ <argument index="0" name="margin" type="int" enum="Margin"> </argument> <description> - Returns the content margin offset for the specified margin + Returns the content margin offset for the specified margin. Positive values reduce size inwards, unlike [Control]'s margin values. </description> </method> @@ -52,7 +52,7 @@ <return type="Vector2"> </return> <description> - Returns the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. + Returns the "offset" of a stylebox. This helper function returns a value equivalent to [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. </description> </method> <method name="test_mask" qualifiers="const"> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index ffee7366a3..53188d6b10 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -9,7 +9,7 @@ - Border width (individual width for each border) - Rounded corners (individual radius for each corner) - Shadow - Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example: + Setting corner radius to high values is allowed. As soon as corners would overlap, the stylebox will switch to a relative system. Example: [codeblock] height = 30 corner_radius_top_left = 50 @@ -85,7 +85,7 @@ </methods> <members> <member name="anti_aliasing" type="bool" setter="set_anti_aliased" getter="is_anti_aliased"> - Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners. + Antialiasing draws a small ring around the edges, which fades to transparency. As a result, edges look much smoother. This is only noticeable when using rounded corners. </member> <member name="anti_aliasing_size" type="int" setter="set_aa_size" getter="get_aa_size"> This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. @@ -94,7 +94,7 @@ The background color of the stylebox. </member> <member name="border_blend" type="bool" setter="set_border_blend" getter="get_border_blend"> - When set to [code]true[/code], the border will fade into the background color. + If [code]true[/code], the border will fade into the background color. </member> <member name="border_color" type="Color" setter="set_border_color" getter="get_border_color"> Sets the color of the border. @@ -112,39 +112,38 @@ Border width for the top border. </member> <member name="corner_detail" type="int" setter="set_corner_detail" getter="get_corner_detail"> - This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value you should take the corner radius ([method set_corner_radius_all]) into account. - For corner radius smaller than 10, 4-5 should be enough. - For corner radius smaller than 30, 8-12 should be enough. + This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value, you should take the corner radius ([method set_corner_radius_all]) into account. + For corner radii smaller than 10, 4-5 should be enough. For corner radii smaller than 30, 8-12 should be enough. </member> <member name="corner_radius_bottom_left" type="int" setter="set_corner_radius" getter="get_corner_radius"> - The corner radius of the bottom left corner. When set to 0 the corner is not rounded. + The bottom-left corner's radius. If [code]0[/code], the corner is not rounded. </member> <member name="corner_radius_bottom_right" type="int" setter="set_corner_radius" getter="get_corner_radius"> - The corner radius of the bottom right corner. When set to 0 the corner is not rounded. + The bottom-right corner's radius. If [code]0[/code], the corner is not rounded. </member> <member name="corner_radius_top_left" type="int" setter="set_corner_radius" getter="get_corner_radius"> - The corner radius of the top left corner. When set to 0 the corner is not rounded. + The top-left corner's radius. If [code]0[/code], the corner is not rounded. </member> <member name="corner_radius_top_right" type="int" setter="set_corner_radius" getter="get_corner_radius"> - The corner radius of the top right corner. When set to 0 the corner is not rounded. + The top-right corner's radius. If [code]0[/code], the corner is not rounded. </member> <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled"> - Toggels drawing of the inner part of the stylebox. + Toggles drawing of the inner part of the stylebox. </member> <member name="expand_margin_bottom" type="float" setter="set_expand_margin" getter="get_expand_margin"> - Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect. + Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with [member border_width_bottom] to draw a border outside the control rect. </member> <member name="expand_margin_left" type="float" setter="set_expand_margin" getter="get_expand_margin"> - Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect. + Expands the stylebox outside of the control rect on the left edge. Useful in combination with [member border_width_left] to draw a border outside the control rect. </member> <member name="expand_margin_right" type="float" setter="set_expand_margin" getter="get_expand_margin"> - Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect. + Expands the stylebox outside of the control rect on the right edge. Useful in combination with [member border_width_right] to draw a border outside the control rect. </member> <member name="expand_margin_top" type="float" setter="set_expand_margin" getter="get_expand_margin"> - Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect. + Expands the stylebox outside of the control rect on the top edge. Useful in combination with [member border_width_top] to draw a border outside the control rect. </member> <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color"> - The color of the shadow. (This has no effect when shadow_size < 1) + The color of the shadow. This has no effect if [member shadow_size] is lower than 1. </member> <member name="shadow_offset" type="Vector2" setter="set_shadow_offset" getter="get_shadow_offset"> The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox. diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index 8e55795053..b50dc74112 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.2"> <brief_description> - Texture Based 3x3 scale style. + Texture-based nine-patch [StyleBox]. </brief_description> <description> - Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles. + Texture-based nine-patch [StyleBox], in a way similar to [NinePatchRect]. This stylebox performs a 3×3 scaling of a texture, where only the center cell is fully stretched. This makes it possible to design bordered styles regardless of the stylebox's size. </description> <tutorials> </tutorials> @@ -40,35 +40,35 @@ <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled"> </member> <member name="expand_margin_bottom" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size"> - Expands the bottom margin of this style box when drawing, causing it be drawn larger than requested. + Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested. </member> <member name="expand_margin_left" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size"> - Expands the left margin of this style box when drawing, causing it be drawn larger than requested. + Expands the left margin of this style box when drawing, causing it to be drawn larger than requested. </member> <member name="expand_margin_right" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size"> - Expands the right margin of this style box when drawing, causing it be drawn larger than requested. + Expands the right margin of this style box when drawing, causing it to be drawn larger than requested. </member> <member name="expand_margin_top" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size"> - Expands the top margin of this style box when drawing, causing it be drawn larger than requested. + Expands the top margin of this style box when drawing, causing it to be drawn larger than requested. </member> <member name="margin_bottom" type="float" setter="set_margin_size" getter="get_margin_size"> - Increases the bottom margin of the 3x3 texture box. - A higher value means more of the source texture is considered to be part of the bottom border of the 3x3 box. + Increases the bottom margin of the 3×3 texture box. + A higher value means more of the source texture is considered to be part of the bottom border of the 3×3 box. This is also the value used as fallback for [member StyleBox.content_margin_bottom] if it is negative. </member> <member name="margin_left" type="float" setter="set_margin_size" getter="get_margin_size"> - Increases the left margin of the 3x3 texture box. - A higher value means more of the source texture is considered to be part of the left border of the 3x3 box. + Increases the left margin of the 3×3 texture box. + A higher value means more of the source texture is considered to be part of the left border of the 3×3 box. This is also the value used as fallback for [member StyleBox.content_margin_left] if it is negative. </member> <member name="margin_right" type="float" setter="set_margin_size" getter="get_margin_size"> - Increases the right margin of the 3x3 texture box. - A higher value means more of the source texture is considered to be part of the right border of the 3x3 box. + Increases the right margin of the 3×3 texture box. + A higher value means more of the source texture is considered to be part of the right border of the 3×3 box. This is also the value used as fallback for [member StyleBox.content_margin_right] if it is negative. </member> <member name="margin_top" type="float" setter="set_margin_size" getter="get_margin_size"> - Increases the top margin of the 3x3 texture box. - A higher value means more of the source texture is considered to be part of the top border of the 3x3 box. + Increases the top margin of the 3×3 texture box. + A higher value means more of the source texture is considered to be part of the top border of the 3×3 box. This is also the value used as fallback for [member StyleBox.content_margin_top] if it is negative. </member> <member name="modulate_color" type="Color" setter="set_modulate" getter="get_modulate"> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index ef8db3ca77..153d88f1af 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 [SurfaceTool] is used to construct a [Mesh] by specifying vertex attributes individually. It can be used to construct a [Mesh] from a script. All properties except indices need to be added before calling [method add_vertex]. For example, to add vertex colors and UVs: [codeblock] var st = SurfaceTool.new() st.begin(Mesh.PRIMITIVE_TRIANGLES) @@ -12,9 +12,9 @@ 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. - 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. - Additionally, the attributes used before the first vertex is added determine the format of the mesh. For example if you only add UVs to the first vertex, you cannot add color to any of the subsequent vertices. + The above [SurfaceTool] now contains one vertex of a triangle which has a UV coordinate and a specified [Color]. If another vertex were added without calling [method add_uv] or [method add_color], then the last values would be used. + Vertex attributes must be passed [b]before[/b] calling [method add_vertex]. Failure to do so will result in an error when committing the vertex information to a mesh. + Additionally, the attributes used before the first vertex is added determine the format of the mesh. For example, if you only add UVs to the first vertex, you cannot add color to any of the subsequent vertices. </description> <tutorials> </tutorials> @@ -25,7 +25,7 @@ <argument index="0" name="bones" type="PoolIntArray"> </argument> <description> - Add an array of bones for the next Vertex to use. Array must contain 4 integers. + Adds an array of bones for the next vertex to use. [code]bones[/code] must contain 4 integers. </description> </method> <method name="add_color"> @@ -34,7 +34,7 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Specify a [Color] for the next Vertex to use. + Specifies a [Color] for the next vertex to use. </description> </method> <method name="add_index"> @@ -43,7 +43,7 @@ <argument index="0" name="index" type="int"> </argument> <description> - Adds an index to index array if you are using indexed Vertices. Does not need to be called before adding Vertex. + Adds an index to index array if you are using indexed vertices. Does not need to be called before adding vertices. </description> </method> <method name="add_normal"> @@ -52,7 +52,7 @@ <argument index="0" name="normal" type="Vector3"> </argument> <description> - Specify a normal for the next Vertex to use. + Specifies a normal for the next vertex to use. </description> </method> <method name="add_smooth_group"> @@ -61,7 +61,7 @@ <argument index="0" name="smooth" type="bool"> </argument> <description> - Specify whether current Vertex (if using only Vertex arrays) or current index (if also using index arrays) should utilize smooth normals for normal calculation. + Specifies whether the current vertex (if using only vertex arrays) or current index (if also using index arrays) should use smooth normals for normal calculation. </description> </method> <method name="add_tangent"> @@ -70,7 +70,7 @@ <argument index="0" name="tangent" type="Plane"> </argument> <description> - Specify a Tangent for the next Vertex to use. + Specifies a tangent for the next vertex to use. </description> </method> <method name="add_triangle_fan"> @@ -89,8 +89,8 @@ <argument index="5" name="tangents" type="Array" default="[ ]"> </argument> <description> - Insert a triangle fan made of array data into [Mesh] being constructed. - Requires primitive type be set to [constant Mesh.PRIMITIVE_TRIANGLES]. + Inserts a triangle fan made of array data into [Mesh] being constructed. + Requires the primitive type be set to [constant Mesh.PRIMITIVE_TRIANGLES]. </description> </method> <method name="add_uv"> @@ -99,7 +99,7 @@ <argument index="0" name="uv" type="Vector2"> </argument> <description> - Specify UV Coordinate for next Vertex to use. + Specifies a set of UV coordinates to use for the next vertex. </description> </method> <method name="add_uv2"> @@ -108,7 +108,7 @@ <argument index="0" name="uv2" type="Vector2"> </argument> <description> - Specify an optional second set of UV coordinates for next Vertex to use. + Specifies an optional second set of UV coordinates to use for the next vertex. </description> </method> <method name="add_vertex"> @@ -117,7 +117,7 @@ <argument index="0" name="vertex" type="Vector3"> </argument> <description> - Specify position of current Vertex. Should be called after specifying other vertex properties (e.g. Color, UV). + Specifies the position of current vertex. Should be called after specifying other vertex properties (e.g. Color, UV). </description> </method> <method name="add_weights"> @@ -126,7 +126,7 @@ <argument index="0" name="weights" type="PoolRealArray"> </argument> <description> - Specify weight values for next Vertex to use. Array must contain 4 values. + Specifies weight values for next vertex to use. [code]weights[/code] must contain 4 values. </description> </method> <method name="append_from"> @@ -148,7 +148,7 @@ <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType"> </argument> <description> - Called before adding any Vertices. Takes the primitive type as an argument (e.g. [constant Mesh.PRIMITIVE_TRIANGLES]). + Called before adding any vertices. Takes the primitive type as an argument (e.g. [constant Mesh.PRIMITIVE_TRIANGLES]). </description> </method> <method name="clear"> @@ -202,7 +202,7 @@ <return type="void"> </return> <description> - Removes index array by expanding Vertex array. + Removes the index array by expanding the vertex array. </description> </method> <method name="generate_normals"> @@ -211,24 +211,22 @@ <argument index="0" name="flip" type="bool" default="false"> </argument> <description> - Generates normals from Vertices so you do not have to do it manually. - Setting [code]flip[/code] to [code]true[/code] inverts the resulting normals. - Requires primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES]. + Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. + Requires the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES]. </description> </method> <method name="generate_tangents"> <return type="void"> </return> <description> - Generates a tangent vector for each vertex. - Requires that each vertex have UVs and normals set already. + Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already. </description> </method> <method name="index"> <return type="void"> </return> <description> - Shrinks Vertex array by creating an index array. Avoids reusing Vertices. + Shrinks the vertex array by creating an index array (avoids reusing vertices). </description> </method> <method name="set_material"> diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index 663d3248e8..432d83f25b 100644 --- a/doc/classes/TCP_Server.xml +++ b/doc/classes/TCP_Server.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="TCP_Server" inherits="Reference" category="Core" version="3.2"> <brief_description> - TCP Server. + A TCP server. </brief_description> <description> - TCP Server class. Listens to connections on a port and returns a [StreamPeerTCP] when got a connection. + A TCP server. Listens to connections on a port and returns a [StreamPeerTCP] when it gets an incoming connection. </description> <tutorials> </tutorials> @@ -24,24 +24,24 @@ <argument index="1" name="bind_address" type="String" default=""*""> </argument> <description> - Listen on the "port" binding to "bind_address". - If "bind_address" is set as "*" (default), the server 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 server 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 server will only listen on the interface with that addresses (or fail if no interface with the given address exists). + Listen on the [code]port[/code] binding to [code]bind_address[/code]. + If [code]bind_address[/code] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6). + If [code]bind_address[/code] is set as [code]"0.0.0.0"[/code] (for IPv4) or [code]"::"[/code] (for IPv6), the server will listen on all available addresses matching that IP type. + If [code]bind_address[/code] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). </description> </method> <method name="stop"> <return type="void"> </return> <description> - Stop listening. + Stops listening. </description> </method> <method name="take_connection"> <return type="StreamPeerTCP"> </return> <description> - If a connection is available, return a StreamPeerTCP with the connection/ + If a connection is available, returns a StreamPeerTCP with the connection. </description> </method> </methods> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 06299d65b6..3fce590967 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="TabContainer" inherits="Container" category="Core" version="3.2"> <brief_description> - Tabbed Container. + Tabbed container. </brief_description> <description> Sets the active tab's [code]visible[/code] property to the value [code]true[/code]. Sets all other children's to [code]false[/code]. @@ -64,7 +64,7 @@ <argument index="0" name="tab_idx" type="int"> </argument> <description> - Returns the [Texture] for the tab at index [code]tab_idx[/code] or null if the tab has no [Texture]. + Returns the [Texture] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture]. </description> </method> <method name="get_tab_title" qualifiers="const"> @@ -100,7 +100,8 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> - If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code]. Note that its title text will remain, unless also removed with [method set_tab_title]. + If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code]. + [b]Note:[/b] Its title text will remain, unless also removed with [method set_tab_title]. </description> </method> <method name="set_tab_icon"> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index b1105f231d..989c079036 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Tabs" inherits="Control" category="Core" version="3.2"> <brief_description> - Tabs Control. + Tabs control. </brief_description> <description> Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interact with children. @@ -26,7 +26,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Moves the Scroll view to make the tab visible. + Moves the scroll view to make the tab visible. </description> </method> <method name="get_offset_buttons_visible" qualifiers="const"> @@ -64,7 +64,7 @@ <argument index="0" name="tab_idx" type="int"> </argument> <description> - Returns the [Texture] for the tab at index [code]tab_idx[/code] or null if the tab has no [Texture]. + Returns the [Texture] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture]. </description> </method> <method name="get_tab_offset" qualifiers="const"> @@ -95,7 +95,7 @@ <return type="int"> </return> <description> - Returns the [Tabs] rearrange group id. + Returns the [Tabs]' rearrange group ID. </description> </method> <method name="move_tab"> @@ -106,7 +106,7 @@ <argument index="1" name="to" type="int"> </argument> <description> - Rearrange tab. + Moves a tab from [code]from[/code] to [code]to[/code]. </description> </method> <method name="remove_tab"> @@ -115,7 +115,7 @@ <argument index="0" name="tab_idx" type="int"> </argument> <description> - Removes tab at index [code]tab_idx[/code] + Removes the tab at index [code]tab_idx[/code]. </description> </method> <method name="set_select_with_rmb"> @@ -124,7 +124,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - If [code]true[/code], enables selecting a tab with right mouse button. + If [code]true[/code], enables selecting a tab with the right mouse button. </description> </method> <method name="set_tab_disabled"> @@ -135,7 +135,8 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> - If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code]. Note that its title text will remain, unless also removed with [method set_tab_title]. + If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code]. + [b]Note:[/b] Its title text will remain unless it is also removed with [method set_tab_title]. </description> </method> <method name="set_tab_icon"> @@ -146,7 +147,7 @@ <argument index="1" name="icon" type="Texture"> </argument> <description> - Sets an icon for the tab at index [code]tab_idx[/code]. + Sets an [code]icon[/code] for the tab at index [code]tab_idx[/code]. </description> </method> <method name="set_tab_title"> @@ -157,7 +158,7 @@ <argument index="1" name="title" type="String"> </argument> <description> - Sets a title for the tab at index [code]tab_idx[/code]. + Sets a [code]title[/code] for the tab at index [code]tab_idx[/code]. </description> </method> <method name="set_tabs_rearrange_group"> @@ -166,7 +167,7 @@ <argument index="0" name="group_id" type="int"> </argument> <description> - Defines rearrange group id, choose for each [Tabs] the same value to enable tab drag between [Tabs]. Enable drag with [code]set_drag_to_rearrange_enabled(true)[/code]. + Defines the rearrange group ID. Choose for each [Tabs] the same value to dragging tabs between [Tabs]. Enable drag with [code]set_drag_to_rearrange_enabled(true)[/code]. </description> </method> </methods> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 00db5ef2b9..748e1c188b 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -21,7 +21,7 @@ <argument index="3" name="line_only" type="bool" default="false"> </argument> <description> - Add color region (given the delimiters) and its colors. + Adds color region (given the delimiters) and its colors. </description> </method> <method name="add_keyword_color"> @@ -32,7 +32,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Add a [code]keyword[/code] and its [Color]. + Adds a [code]keyword[/code] and its [Color]. </description> </method> <method name="can_fold" qualifiers="const"> @@ -274,7 +274,7 @@ <argument index="0" name="option" type="int"> </argument> <description> - Triggers a right click menu action by the specified index. See [enum MenuItems] for a list of available indexes. + Triggers a right-click menu action by the specified index. See [enum MenuItems] for a list of available indexes. </description> </method> <method name="paste"> @@ -295,7 +295,7 @@ <return type="void"> </return> <description> - Removes all the breakpoints (without firing "breakpoint_toggled" signal). + Removes all the breakpoints. This will not fire the [signal breakpoint_toggled] signal. </description> </method> <method name="search" qualifiers="const"> @@ -310,7 +310,7 @@ <argument index="3" name="from_column" type="int"> </argument> <description> - Perform a search inside the text. Search flags can be specified in the SEARCH_* enum. + Perform a search inside the text. Search flags can be specified in the[code]SEARCH_*[/code] enum. </description> </method> <method name="select"> @@ -394,11 +394,11 @@ If [code]false[/code], the caret displays as a bar. </member> <member name="caret_moving_by_right_click" type="bool" setter="set_right_click_moves_caret" getter="is_right_click_moving_caret"> - If [code]true[/code], a right click moves the cursor at the mouse position before displaying the context menu. + If [code]true[/code], a right-click moves the cursor at the mouse position before displaying the context menu. If [code]false[/code], the context menu disregards mouse location. </member> <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled"> - If [code]true[/code], a right click displays the context menu. + If [code]true[/code], a right-click displays the context menu. </member> <member name="draw_spaces" type="bool" setter="set_draw_spaces" getter="is_drawing_spaces"> If [code]true[/code], the "space" character will have a visible representation. diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index 4418a6ce8f..5bd07b7ecb 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -105,26 +105,26 @@ </members> <constants> <constant name="FLAGS_DEFAULT" value="7" enum="Flags"> - Default flags. Generate mipmaps, repeat, and filter are enabled. + Default flags. [constant FLAG_MIPMAPS], [constant FLAG_REPEAT] and [constant FLAG_FILTER] are are enabled. </constant> <constant name="FLAG_MIPMAPS" value="1" enum="Flags"> - Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. + Generates mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. </constant> <constant name="FLAG_REPEAT" value="2" enum="Flags"> - Repeats texture (instead of clamp to edge). + Repeats the texture (instead of clamp to edge). </constant> <constant name="FLAG_FILTER" value="4" enum="Flags"> - Magnifying filter, to enable smooth zooming in of the texture. + Uses a magnifying filter, to enable smooth zooming in of the texture. </constant> <constant name="FLAG_ANISOTROPIC_FILTER" value="8" enum="Flags"> - Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. - More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. + Uses anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. + This results in better-looking textures when viewed from oblique angles. </constant> <constant name="FLAG_CONVERT_TO_LINEAR" value="16" enum="Flags"> - Converts texture to SRGB color space. + Converts the texture to the sRGB color space. </constant> <constant name="FLAG_MIRRORED_REPEAT" value="32" enum="Flags"> - Repeats texture with alternate sections mirrored. + Repeats the texture with alternate sections mirrored. </constant> <constant name="FLAG_VIDEO_SURFACE" value="2048" enum="Flags"> Texture is a video surface. diff --git a/doc/classes/TextureButton.xml b/doc/classes/TextureButton.xml index 7b436fcf2b..6f28c3f48f 100644 --- a/doc/classes/TextureButton.xml +++ b/doc/classes/TextureButton.xml @@ -4,8 +4,8 @@ Texture-based button. Supports Pressed, Hover, Disabled and Focused states. </brief_description> <description> - [TextureButton] has the same functionality as [Button], except it uses sprites instead of Godot's [Theme] resource. It is faster to create, but it doesn't support localization like more complex Controls. - The Normal state's texture is required. Others are optional. + [TextureButton] has the same functionality as [Button], except it uses sprites instead of Godot's [Theme] resource. It is faster to create, but it doesn't support localization like more complex [Control]s. + The "normal" state must contain a texture ([member texture_normal]); other textures are optional. </description> <tutorials> </tutorials> @@ -34,7 +34,7 @@ Texture to display by default, when the node is [b]not[/b] in the disabled, focused, hover or pressed state. </member> <member name="texture_pressed" type="Texture" setter="set_pressed_texture" getter="get_pressed_texture"> - Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the enter key or if the player presses the [member BaseButton.shortcut] key. + Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the Enter key or if the player presses the [member BaseButton.shortcut] key. </member> </members> <constants> diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml index 3bbc05dfe7..5b97f3e0de 100644 --- a/doc/classes/TextureProgress.xml +++ b/doc/classes/TextureProgress.xml @@ -4,7 +4,7 @@ Texture-based progress bar. Useful for loading screens and life or stamina bars. </brief_description> <description> - TextureProgress works like [ProgressBar] but it uses up to 3 textures instead of Godot's [Theme] resource. Works horizontally, vertically, and radially. + TextureProgress works like [ProgressBar], but uses up to 3 textures instead of Godot's [Theme] resource. It can be used to create horizontal, vertical and radial progress bars. </description> <tutorials> </tutorials> @@ -12,10 +12,10 @@ </methods> <members> <member name="fill_mode" type="int" setter="set_fill_mode" getter="get_fill_mode"> - The fill direction. Uses FILL_* constants. + The fill direction. See [enum FillMode] for possible values. </member> <member name="nine_patch_stretch" type="bool" setter="set_nine_patch_stretch" getter="get_nine_patch_stretch"> - If [code]true[/code], Godot treats the bar's textures like [NinePatchRect]. Use [code]stretch_margin_*[/code], like [member stretch_margin_bottom], to set up the nine patch's 3x3 grid. Default value: [code]false[/code]. + If [code]true[/code], Godot treats the bar's textures like in [NinePatchRect]. Use the [code]stretch_margin_*[/code] properties like [member stretch_margin_bottom] to set up the nine patch's 3×3 grid. Default value: [code]false[/code]. </member> <member name="radial_center_offset" type="Vector2" setter="set_radial_center_offset" getter="get_radial_center_offset"> Offsets [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE]. @@ -76,7 +76,7 @@ Turns the node into a radial bar. The [member texture_progress] fills clockwise. See [member radial_center_offset], [member radial_initial_angle] and [member radial_fill_degrees] to control the way the bar fills up. </constant> <constant name="FILL_COUNTER_CLOCKWISE" value="5" enum="FillMode"> - Turns the node into a radial bar. The [member texture_progress] fills counter-clockwise. See [member radial_center_offset], [member radial_initial_angle] and [member radial_fill_degrees] to control the way the bar fills up. + Turns the node into a radial bar. The [member texture_progress] fills counterclockwise. See [member radial_center_offset], [member radial_initial_angle] and [member radial_fill_degrees] to control the way the bar fills up. </constant> <constant name="FILL_BILINEAR_LEFT_AND_RIGHT" value="6" enum="FillMode"> The [member texture_progress] fills from the center, expanding both towards the left and the right. @@ -85,7 +85,7 @@ The [member texture_progress] fills from the center, expanding both towards the top and the bottom. </constant> <constant name="FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE" value="8" enum="FillMode"> - Turns the node into a radial bar. The [member texture_progress] fills radially from the center, expanding both clockwise and counter-clockwise. See [member radial_center_offset], [member radial_initial_angle] and [member radial_fill_degrees] to control the way the bar fills up. + Turns the node into a radial bar. The [member texture_progress] fills radially from the center, expanding both clockwise and counterclockwise. See [member radial_center_offset], [member radial_initial_angle] and [member radial_fill_degrees] to control the way the bar fills up. </constant> </constants> </class> diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index 8fdef5540b..e4db9243ef 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -4,8 +4,8 @@ Theme for controls. </brief_description> <description> - Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any [Control], and it and its children will automatically use it. - Theme resources can be alternatively loaded by writing them in a .theme file, see docs for more info. + A theme for skinning controls. Controls can be skinned individually, but for complex applications, it's more practical to just create a global theme that defines everything. This theme can be applied to any [Control]; the Control and its children will automatically use it. + Theme resources can alternatively be loaded by writing them in a [code].theme[/code] file, see the documentation for more information. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/gui/gui_skinning.html</link> @@ -25,7 +25,7 @@ <argument index="1" name="type" type="String"> </argument> <description> - Clears theme [Color] at [code]name[/code] if Theme has [code]type[/code]. + Clears the [Color] at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="clear_constant"> @@ -36,7 +36,7 @@ <argument index="1" name="type" type="String"> </argument> <description> - Clears theme constant at [code]name[/code] if Theme has [code]type[/code]. + Clears the constant at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="clear_font"> @@ -47,7 +47,7 @@ <argument index="1" name="type" type="String"> </argument> <description> - Clears [Font] at [code]name[/code] if Theme has [code]type[/code]. + Clears the [Font] at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="clear_icon"> @@ -58,7 +58,7 @@ <argument index="1" name="type" type="String"> </argument> <description> - Clears icon at [code]name[/code] if Theme has [code]type[/code]. + Clears the icon at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="clear_stylebox"> @@ -69,14 +69,14 @@ <argument index="1" name="type" type="String"> </argument> <description> - Clears [StyleBox] at [code]name[/code] if Theme has [code]type[/code]. + Clears [StyleBox] at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="copy_default_theme"> <return type="void"> </return> <description> - Sets theme values to a copy of the default theme values. + Sets the Theme's values to a copy of the default theme values. </description> </method> <method name="copy_theme"> @@ -95,7 +95,7 @@ <argument index="1" name="type" type="String"> </argument> <description> - Returns the [Color] at [code]name[/code] if Theme has [code]type[/code]. + Returns the [Color] at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="get_color_list" qualifiers="const"> @@ -104,7 +104,7 @@ <argument index="0" name="type" type="String"> </argument> <description> - Returns all of the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if Theme has [code]type[/code]. + Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the Theme has [code]type[/code]. </description> </method> <method name="get_constant" qualifiers="const"> @@ -115,7 +115,7 @@ <argument index="1" name="type" type="String"> </argument> <description> - Returns the constant at [code]name[/code] if Theme has [code]type[/code]. + Returns the constant at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="get_constant_list" qualifiers="const"> @@ -124,7 +124,7 @@ <argument index="0" name="type" type="String"> </argument> <description> - Returns all of the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if Theme has [code]type[/code]. + Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the Theme has [code]type[/code]. </description> </method> <method name="get_font" qualifiers="const"> @@ -135,7 +135,7 @@ <argument index="1" name="type" type="String"> </argument> <description> - Returns the [Font] at [code]name[/code] if Theme has [code]type[/code]. + Returns the [Font] at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="get_font_list" qualifiers="const"> @@ -144,7 +144,7 @@ <argument index="0" name="type" type="String"> </argument> <description> - Returns all of the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if Theme has [code]type[/code]. + Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the Theme has [code]type[/code]. </description> </method> <method name="get_icon" qualifiers="const"> @@ -155,7 +155,7 @@ <argument index="1" name="type" type="String"> </argument> <description> - Returns the icon [Texture] at [code]name[/code] if Theme has [code]type[/code]. + Returns the icon [Texture] at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="get_icon_list" qualifiers="const"> @@ -164,7 +164,7 @@ <argument index="0" name="type" type="String"> </argument> <description> - Returns all of the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if Theme has [code]type[/code]. + Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the Theme has [code]type[/code]. </description> </method> <method name="get_stylebox" qualifiers="const"> @@ -175,7 +175,7 @@ <argument index="1" name="type" type="String"> </argument> <description> - Returns the icon [StyleBox] at [code]name[/code] if Theme has [code]type[/code]. + Returns the icon [StyleBox] at [code]name[/code] if the Theme has [code]type[/code]. </description> </method> <method name="get_stylebox_list" qualifiers="const"> @@ -184,14 +184,14 @@ <argument index="0" name="type" type="String"> </argument> <description> - Returns all of the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if Theme has [code]type[/code]. + Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the Theme has [code]type[/code]. </description> </method> <method name="get_stylebox_types" qualifiers="const"> <return type="PoolStringArray"> </return> <description> - Returns all of the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if Theme has [code]type[/code]. + Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the Theme has [code]type[/code]. </description> </method> <method name="get_type_list" qualifiers="const"> @@ -200,7 +200,7 @@ <argument index="0" name="type" type="String"> </argument> <description> - Returns all of the types in [code]type[/code] as a [PoolStringArray] for use in any of the get_* functions, if Theme has [code]type[/code]. + Returns all the types in [code]type[/code] as a [PoolStringArray] for use in any of the get_* functions, if the Theme has [code]type[/code]. </description> </method> <method name="has_color" qualifiers="const"> @@ -212,7 +212,7 @@ </argument> <description> Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]type[/code]. - Returns [code]false[/code] if Theme does not have [code]type[/code]. + Returns [code]false[/code] if the Theme does not have [code]type[/code]. </description> </method> <method name="has_constant" qualifiers="const"> @@ -224,7 +224,7 @@ </argument> <description> Returns [code]true[/code] if constant with [code]name[/code] is in [code]type[/code]. - Returns [code]false[/code] if Theme does not have [code]type[/code]. + Returns [code]false[/code] if the Theme does not have [code]type[/code]. </description> </method> <method name="has_font" qualifiers="const"> @@ -236,7 +236,7 @@ </argument> <description> Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]type[/code]. - Returns [code]false[/code] if Theme does not have [code]type[/code]. + Returns [code]false[/code] if the Theme does not have [code]type[/code]. </description> </method> <method name="has_icon" qualifiers="const"> @@ -248,7 +248,7 @@ </argument> <description> Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]type[/code]. - Returns [code]false[/code] if Theme does not have [code]type[/code]. + Returns [code]false[/code] if the Theme does not have [code]type[/code]. </description> </method> <method name="has_stylebox" qualifiers="const"> @@ -260,7 +260,7 @@ </argument> <description> Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]type[/code]. - Returns [code]false[/code] if Theme does not have [code]type[/code]. + Returns [code]false[/code] if the Theme does not have [code]type[/code]. </description> </method> <method name="set_color"> @@ -273,8 +273,8 @@ <argument index="2" name="color" type="Color"> </argument> <description> - Sets Theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code]. - Does nothing if Theme does not have [code]type[/code]. + Sets the Theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code]. + Does nothing if the Theme does not have [code]type[/code]. </description> </method> <method name="set_constant"> @@ -287,8 +287,8 @@ <argument index="2" name="constant" type="int"> </argument> <description> - Sets Theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code]. - Does nothing if Theme does not have [code]type[/code]. + Sets the Theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code]. + Does nothing if the Theme does not have [code]type[/code]. </description> </method> <method name="set_font"> @@ -301,8 +301,8 @@ <argument index="2" name="font" type="Font"> </argument> <description> - Sets Theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code]. - Does nothing if Theme does not have [code]type[/code]. + Sets the Theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code]. + Does nothing if the Theme does not have [code]type[/code]. </description> </method> <method name="set_icon"> @@ -315,8 +315,8 @@ <argument index="2" name="texture" type="Texture"> </argument> <description> - Sets Theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code]. - Does nothing if Theme does not have [code]type[/code]. + Sets the Theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code]. + Does nothing if the Theme does not have [code]type[/code]. </description> </method> <method name="set_stylebox"> @@ -330,7 +330,7 @@ </argument> <description> Sets Theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]type[/code]. - Does nothing if Theme does not have [code]type[/code]. + Does nothing if the Theme does not have [code]type[/code]. </description> </method> </methods> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index ff8221fed3..8f96ab0aed 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] or [Semaphore] is advised if working with shared objects. </description> <tutorials> </tutorials> @@ -13,7 +13,7 @@ <return type="String"> </return> <description> - Returns the current [Thread]s id, uniquely identifying it among all threads. + Returns the current [Thread]'s ID, uniquely identifying it among all threads. </description> </method> <method name="is_active" qualifiers="const"> @@ -35,8 +35,8 @@ <argument index="3" name="priority" type="int" enum="Thread.Priority" 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. - Returns OK on success, or ERR_CANT_CREATE on failure. + Starts a new [Thread] that runs [code]method[/code] on object [code]instance[/code] with [code]userdata[/code] passed as an argument. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum. + Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure. </description> </method> <method name="wait_to_finish"> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index ed4f914136..b4dd2379c9 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -85,7 +85,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns an array of all cells with the given tile id. + Returns an array of all cells with the given tile [code]id[/code]. </description> </method> <method name="get_used_rect"> @@ -103,7 +103,7 @@ <argument index="1" name="y" type="int"> </argument> <description> - Returns [code]true[/code] if the given cell is transposed, i.e. the x and y axes are swapped. + Returns [code]true[/code] if the given cell is transposed, i.e. the X and Y axes are swapped. </description> </method> <method name="is_cell_x_flipped" qualifiers="const"> @@ -114,7 +114,7 @@ <argument index="1" name="y" type="int"> </argument> <description> - Returns [code]true[/code] if the given cell is flipped in the x axis. + Returns [code]true[/code] if the given cell is flipped in the X axis. </description> </method> <method name="is_cell_y_flipped" qualifiers="const"> @@ -125,7 +125,7 @@ <argument index="1" name="y" type="int"> </argument> <description> - Returns [code]true[/code] if the given cell is flipped in the y axis. + Returns [code]true[/code] if the given cell is flipped in the Y axis. </description> </method> <method name="map_to_world" qualifiers="const"> @@ -161,7 +161,7 @@ Sets the tile index for the cell given by a Vector2. An index of [code]-1[/code] clears the cell. Optionally, the tile can also be flipped, transposed, or given autotile coordinates. - Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons. + [b]Note:[/b] Data such as navigation polygons and collision shapes are not immediately updated for performance reasons. If you need these to be immediately updated, you can call [method update_dirty_quadrants]. Overriding this method also overrides it internally, allowing custom logic to be implemented when tiles are placed/removed: [codeblock] @@ -189,7 +189,7 @@ Sets the tile index for the given cell. An index of [code]-1[/code] clears the cell. Optionally, the tile can also be flipped or transposed. - Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons. + [b]Note:[/b] Data such as navigation polygons and collision shapes are not immediately updated for performance reasons. If you need these to be immediately updated, you can call [method update_dirty_quadrants]. </description> </method> @@ -221,7 +221,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based x and y coordinates. + Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based X and Y coordinates. </description> </method> <method name="update_bitmask_region"> @@ -232,7 +232,7 @@ <argument index="1" name="end" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Applies autotiling rules to the cells in the given region (specified by grid-based x and y coordinates). + Applies autotiling rules to the cells in the given region (specified by grid-based X and Y coordinates). Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap. </description> </method> @@ -260,7 +260,7 @@ The custom [Transform2D] to be applied to the TileMap's cells. </member> <member name="cell_half_offset" type="int" setter="set_half_offset" getter="get_half_offset" enum="TileMap.HalfOffset"> - Amount to offset alternating tiles. Uses HALF_OFFSET_* constants. Default value: HALF_OFFSET_DISABLED. + Amount to offset alternating tiles. See [enum HalfOffset] for possible values. Default value: [code]HALF_OFFSET_DISABLED[/code]. </member> <member name="cell_quadrant_size" type="int" setter="set_quadrant_size" getter="get_quadrant_size"> The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. @@ -269,7 +269,7 @@ The TileMap's cell size. </member> <member name="cell_tile_origin" type="int" setter="set_tile_origin" getter="get_tile_origin" enum="TileMap.TileOrigin"> - Position for tile origin. Uses TILE_ORIGIN_* constants. Default value: TILE_ORIGIN_TOP_LEFT. + Position for tile origin. See [enum TileOrigin] for possible values. Default value: [code]TILE_ORIGIN_TOP_LEFT[/code]. </member> <member name="cell_y_sort" type="bool" setter="set_y_sort_mode" getter="is_y_sort_mode_enabled"> If [code]true[/code], the TileMap's children will be drawn in order of their Y coordinate. Default value: [code]false[/code]. @@ -290,7 +290,7 @@ If [code]true[/code], TileMap collisions will be handled as a kinematic body. If [code]false[/code], collisions will be handled as static body. Default value: [code]false[/code]. </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="TileMap.Mode"> - The TileMap orientation mode. Uses MODE_* constants. Default value: MODE_SQUARE. + The TileMap orientation mode. See [enum Mode] for possible values. Default value: [code]MODE_SQUARE[/code]. </member> <member name="occluder_light_mask" type="int" setter="set_occluder_light_mask" getter="get_occluder_light_mask"> The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index d5e2fd31f8..8ad62f0fcb 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -52,7 +52,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Clears all bitmask info of the autotile. + Clears all bitmask information of the autotile. </description> </method> <method name="autotile_get_bitmask"> @@ -83,7 +83,7 @@ </argument> <description> Returns the subtile that's being used as an icon in an atlas/autotile given its coordinates. - The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask info is incomplete. It will also be used to represent it in the TileSet editor. + The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor. </description> </method> <method name="autotile_get_light_occluder" qualifiers="const"> @@ -183,7 +183,7 @@ </argument> <description> Sets the subtile that will be used as an icon in an atlas/autotile given its coordinates. - The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask info is incomplete. It will also be used to represent it in the TileSet editor. + The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor. </description> </method> <method name="autotile_set_light_occluder"> @@ -512,7 +512,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns the tile's z-index (drawing layer). + Returns the tile's Z index (drawing layer). </description> </method> <method name="tile_set_light_occluder"> diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 74bd86b34b..120367f42e 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -4,7 +4,7 @@ A countdown timer. </brief_description> <description> - Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one shot" mode. + Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one-shot" mode. </description> <tutorials> </tutorials> @@ -23,7 +23,7 @@ </argument> <description> Starts the timer. Sets [code]wait_time[/code] to [code]time_sec[/code] if [code]time_sec > 0[/code]. This also resets the remaining time to [code]wait_time[/code]. - Note: this method will not resume a paused timer. See [member paused]. + [b]Note:[/b] this method will not resume a paused timer. See [member paused]. </description> </method> <method name="stop"> @@ -49,7 +49,7 @@ </member> <member name="time_left" type="float" setter="" getter="get_time_left"> The timer's remaining time in seconds. Returns 0 if the timer is inactive. - Note: You cannot set this value. To change the timer's remaining time, use [member wait_time]. + [b]Note:[/b] You cannot set this value. To change the timer's remaining time, use [member wait_time]. </member> <member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time"> Wait time in seconds. diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml index 4b5a832b05..8a15f078ba 100644 --- a/doc/classes/TouchScreenButton.xml +++ b/doc/classes/TouchScreenButton.xml @@ -28,7 +28,7 @@ The button's texture for the normal state. </member> <member name="passby_press" type="bool" setter="set_passby_press" getter="is_passby_press_enabled"> - If [code]true[/code], passby presses are enabled. + If [code]true[/code], pass-by presses are enabled. </member> <member name="pressed" type="Texture" setter="set_texture_pressed" getter="get_texture_pressed"> The button's texture for the pressed state. @@ -43,7 +43,7 @@ If [code]true[/code], the button's shape is visible. </member> <member name="visibility_mode" type="int" setter="set_visibility_mode" getter="get_visibility_mode" enum="TouchScreenButton.VisibilityMode"> - The button's visibility mode. See [code]VISIBILITY_*[/code] constants. + The button's visibility mode. See [enum VisibilityMode] for possible values. </member> </members> <signals> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index dfbb93acfc..7f7bac9bbd 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Transform" category="Built-In Types" version="3.2"> <brief_description> - 3D Transformation. 3x4 matrix. + 3D transformation (3×4 matrix). </brief_description> <description> - Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a [Basis] "basis" and an [Vector3] "origin". It is similar to a 3x4 matrix. + Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a [member basis] and an [member origin]. It is similar to a 3×4 matrix. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index bc003284ad..450768bb4d 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Transform2D" category="Built-In Types" version="3.2"> <brief_description> - 2D Transformation. 3x2 matrix. + 2D transformation (3×2 matrix). </brief_description> <description> - Represents one or many transformations in 2D space such as translation, rotation, or scaling. It consists of a two [Vector2] x, y and [Vector2] "origin". It is similar to a 3x2 matrix. + Represents one or many transformations in 2D space such as translation, rotation, or scaling. It consists of two [member x] and [member y] [Vector2]s and an [member origin]. It is similar to a 3×2 matrix. </description> <tutorials> </tutorials> @@ -164,10 +164,10 @@ The transform's translation offset. </member> <member name="x" type="Vector2" setter="" getter=""> - The X axis of 2x2 basis matrix containing 2 [Vector2]s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. + The X axis of 2×2 basis matrix containing 2 [Vector2]s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. </member> <member name="y" type="Vector2" setter="" getter=""> - The Y axis of 2x2 basis matrix containing 2 [Vector2]s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. + The Y axis of 2×2 basis matrix containing 2 [Vector2]s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. </member> </members> <constants> diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index eea4f8ed03..8d24d55998 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -4,7 +4,7 @@ Language Translation. </brief_description> <description> - Translations are resources that can be loaded/unloaded on demand. They map a string to another string. + Translations are resources that can be loaded and unloaded on demand. They map a string to another string. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html</link> diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index 268fb5b6a5..f43d3bb24e 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -47,7 +47,7 @@ <argument index="0" name="locale" type="String"> </argument> <description> - Returns a locale's language and its variant (e.g. "en_US" would return "English (United States)"). + Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]). </description> </method> <method name="remove_translation"> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index aa287b1ed0..70e85b187f 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -42,7 +42,7 @@ <argument index="1" name="idx" type="int" default="-1"> </argument> <description> - Create an item in the tree and add it as the last child of [code]parent[/code]. If parent is not given, it will be added as the root's last child, or it'll the be the root itself if the tree is empty. + Create an item in the tree and add it as the last child of [code]parent[/code]. If [code]parent[/code] is [code]null[/code], it will be added as the root's last child, or it'll be the the root itself if the tree is empty. </description> </method> <method name="ensure_cursor_is_visible"> @@ -93,7 +93,7 @@ </argument> <description> If [member drop_mode_flags] includes [constant DROP_MODE_INBETWEEN], returns -1 if [code]position[/code] is the upper part of a tree item at that position, 1 for the lower part, and additionally 0 for the middle part if [member drop_mode_flags] includes [constant DROP_MODE_ON_ITEM]. - Otherwise, returns 0. If there are no tree item at [code]position[/code], returns -100. + Otherwise, returns 0. If there are no tree items at [code]position[/code], returns -100. </description> </method> <method name="get_edited" qualifiers="const"> @@ -193,7 +193,7 @@ <argument index="1" name="min_width" type="int"> </argument> <description> - Set the minimum width of a column. + Sets the minimum width of a column. </description> </method> <method name="set_column_title"> @@ -204,7 +204,7 @@ <argument index="1" name="title" type="String"> </argument> <description> - Set the title of a column. + Sets the title of a column. </description> </method> <method name="set_column_titles_visible"> @@ -225,7 +225,7 @@ If [code]true[/code], a right mouse button click can select items. </member> <member name="columns" type="int" setter="set_columns" getter="get_columns"> - The amount of columns. + The number of columns. </member> <member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags"> The drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. Once dropping is done, reverts to [constant DROP_MODE_DISABLED]. Setting this during [method Control.can_drop_data] is recommended. @@ -237,7 +237,7 @@ If [code]true[/code], the tree's root is hidden. </member> <member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="Tree.SelectMode"> - Allow single or multiple selection. See the [code]SELECT_*[/code] constants. + Allows single or multiple selection. See the [code]SELECT_*[/code] constants. </member> </members> <signals> @@ -281,7 +281,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty. + Emitted when the right mouse button is pressed if right mouse button selection is active and the tree is empty. </description> </signal> <signal name="item_activated"> @@ -335,7 +335,7 @@ <argument index="2" name="selected" type="bool"> </argument> <description> - Emitted instead of [code]item_selected[/code] when [code]select_mode[/code] is [constant SELECT_MULTI]. + Emitted instead of [code]item_selected[/code] if [code]select_mode[/code] is [constant SELECT_MULTI]. </description> </signal> <signal name="nothing_selected"> @@ -345,12 +345,12 @@ </signals> <constants> <constant name="SELECT_SINGLE" value="0" enum="SelectMode"> - Allow selection of a single item at a time. + Allows selection of a single item at a time. </constant> <constant name="SELECT_ROW" value="1" enum="SelectMode"> </constant> <constant name="SELECT_MULTI" value="2" enum="SelectMode"> - Allow selection of multiple items at the same time. + Allows selection of multiple items at the same time. </constant> <constant name="DROP_MODE_DISABLED" value="0" enum="DropModeFlags"> </constant> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index f7887a87c8..d9c7013d34 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -90,7 +90,7 @@ <argument index="0" name="column" type="int"> </argument> <description> - Returns the column's cell mode. See [code]CELL_MODE_*[/code] constants. + Returns the column's cell mode. </description> </method> <method name="get_children"> @@ -527,7 +527,7 @@ <argument index="1" name="text_align" type="int" enum="TreeItem.TextAlign"> </argument> <description> - Sets the given column's text alignment. See [code]ALIGN_*[/code] constants. + Sets the given column's text alignment. See [enum TextAlign] for possible values. </description> </method> <method name="set_tooltip"> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index ff1413cb94..c6949e915f 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -4,7 +4,7 @@ Smoothly animates a node's properties over time. </brief_description> <description> - Tweens are useful for animations requiring a numerical property to be interpolated over a range of values. The name *tween* comes from *in-betweening*, an animation technique where you specify *keyframes* and the computer interpolates the frames that appear between them. + Tweens are useful for animations requiring a numerical property to be interpolated over a range of values. The name [i]tween[/i] comes from [i]in-betweening[/i], an animation technique where you specify [i]keyframes[/i] and the computer interpolates the frames that appear between them. Here is a brief usage example that causes a 2D node to move smoothly between two positions: [codeblock] var tween = get_node("Tween") @@ -13,7 +13,7 @@ Tween.TRANS_LINEAR, Tween.EASE_IN_OUT) tween.start() [/codeblock] - Many methods require a property name, such as "position" above. You can find the correct property name by hovering over the property in the Inspector. You can also provide the components of a property directly by using "property:component" (eg. [code]position:x[/code]), where it would only apply to that particular component. + Many methods require a property name, such as [code]"position"[/code] above. You can find the correct property name by hovering over the property in the Inspector. You can also provide the components of a property directly by using [code]"property:component"[/code] (eg. [code]position:x[/code]), where it would only apply to that particular component. Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an [enum TransitionType] constant, and refers to the way the timing of the animation is handled (see [code]http://easings.net/[/code] for some examples). The second accepts an [enum EaseType] constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different [enum TransitionType] constants with [constant EASE_IN_OUT], and use the one that looks best. </description> <tutorials> @@ -42,7 +42,7 @@ </argument> <description> Follows [code]method[/code] of [code]object[/code] and applies the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] later. Methods are called with consecutive values. - Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. </description> </method> <method name="follow_property"> @@ -68,7 +68,7 @@ </argument> <description> Follows [code]property[/code] of [code]object[/code] and applies it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. - Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. </description> </method> <method name="get_runtime" qualifiers="const"> @@ -145,7 +145,7 @@ </argument> <description> Animates [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are called with consecutive values. - Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. </description> </method> <method name="interpolate_property"> @@ -169,14 +169,15 @@ </argument> <description> Animates [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Setting the initial value to [code]null[/code] uses the current value of the property. - Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. </description> </method> <method name="is_active" qualifiers="const"> <return type="bool"> </return> <description> - Returns [code]true[/code] if any tweens are currently running. Note that this method doesn't consider tweens that have ended. + Returns [code]true[/code] if any tweens are currently running. + [b]Note:[/b] This method doesn't consider tweens that have ended. </description> </method> <method name="remove"> @@ -299,7 +300,7 @@ </argument> <description> Animates [code]method[/code] of [code]object[/code] from the value returned by [code]initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. - Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. </description> </method> <method name="targeting_property"> @@ -325,7 +326,7 @@ </argument> <description> Animates [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. - Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. </description> </method> <method name="tell" qualifiers="const"> diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 71da4c684c..7834719af6 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -4,7 +4,7 @@ Helper to manage undo/redo operations in the editor or custom tools. </brief_description> <description> - Helper to manage undo/redo operations in the editor or custom tools. It works by registering methods and property changes inside 'actions'. + Helper to manage undo/redo operations in the editor or custom tools. It works by registering methods and property changes inside "actions". Common behavior is to create an action, then add do/undo calls to functions or property changes, then committing the action. Here's an example on how to add an action to the Godot editor's own [UndoRedo], from a plugin: [codeblock] @@ -26,7 +26,7 @@ undo_redo.commit_action() [/codeblock] [method create_action], [method add_do_method], [method add_undo_method], [method add_do_property], [method add_undo_property], and [method commit_action] should be called one after the other, like in the example. Not doing so could lead to crashes. - If you don't need to register a method you can leave [method add_do_method] and [method add_undo_method] out, and so it goes for properties. You can register more than one method/property. + If you don't need to register a method, you can leave [method add_do_method] and [method add_undo_method] out; the same goes for properties. You can also register more than one method/property. </description> <tutorials> </tutorials> @@ -52,7 +52,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Register a property value change for 'do'. + Register a property value change for "do". </description> </method> <method name="add_do_reference"> @@ -61,7 +61,7 @@ <argument index="0" name="object" type="Object"> </argument> <description> - Register a reference for 'do' that will be erased if the 'do' history is lost. This is useful mostly for new nodes created for the 'do' call. Do not use for resources. + Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources. </description> </method> <method name="add_undo_method" qualifiers="vararg"> @@ -85,7 +85,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Register a property value change for 'undo'. + Register a property value change for "undo". </description> </method> <method name="add_undo_reference"> @@ -94,7 +94,7 @@ <argument index="0" name="object" type="Object"> </argument> <description> - Register a reference for 'undo' that will be erased if the 'undo' history is lost. This is useful mostly for nodes removed with the 'do' call (not the 'undo' call!). + Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!). </description> </method> <method name="clear_history"> @@ -111,7 +111,7 @@ <return type="void"> </return> <description> - Commit the action. All 'do' methods/properties are called/set when this function is called. + Commit the action. All "do" methods/properties are called/set when this function is called. </description> </method> <method name="create_action"> @@ -130,14 +130,14 @@ <return type="String"> </return> <description> - Get the name of the current action. + Gets the name of the current action. </description> </method> <method name="get_version" qualifiers="const"> <return type="int"> </return> <description> - Get the version, each time a new action is committed, the version number of the [UndoRedo] is increased automatically. + Gets the version. Every time a new action is committed, the [UndoRedo]'s version number is increased automatically. This is useful mostly to check if something changed from a saved version. </description> </method> @@ -145,21 +145,21 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if a 'redo' action is available. + Returns [code]true[/code] if a "redo" action is available. </description> </method> <method name="has_undo"> <return type="bool"> </return> <description> - Returns [code]true[/code] if an 'undo' action is available. + Returns [code]true[/code] if an "undo" action is available. </description> </method> <method name="is_commiting_action" qualifiers="const"> <return type="bool"> </return> <description> - Returns [code]true[/code] if the [UndoRedo] is currently committing the action, i.e. running its 'do' method or property change (see [method commit_action]). + Returns [code]true[/code] if the [UndoRedo] is currently committing the action, i.e. running its "do" method or property change (see [method commit_action]). </description> </method> <method name="redo"> @@ -186,10 +186,10 @@ </signals> <constants> <constant name="MERGE_DISABLE" value="0" enum="MergeMode"> - Makes 'do'/'undo' operations stay in separate actions. + Makes "do"/"undo" operations stay in separate actions. </constant> <constant name="MERGE_ENDS" value="1" enum="MergeMode"> - Makes so that the action's 'do' operation is from the first action created and the 'undo' operation is from the last subsequent action with the same name. + Makes so that the action's "do" operation is from the first action created and the "undo" operation is from the last subsequent action with the same name. </constant> <constant name="MERGE_ALL" value="2" enum="MergeMode"> Makes subsequent actions with the same name be merged into one. diff --git a/doc/classes/VSeparator.xml b/doc/classes/VSeparator.xml index ab33c24bb6..b0f0bf038e 100644 --- a/doc/classes/VSeparator.xml +++ b/doc/classes/VSeparator.xml @@ -4,7 +4,7 @@ Vertical version of [Separator]. </brief_description> <description> - Vertical version of [Separator]. It is used to separate objects horizontally, though (but it looks vertical!). + Vertical version of [Separator]. Even though it looks vertical, it is used to separate objects horizontally. </description> <tutorials> </tutorials> diff --git a/doc/classes/Variant.xml b/doc/classes/Variant.xml index ee598c39f8..eb07c70cc6 100644 --- a/doc/classes/Variant.xml +++ b/doc/classes/Variant.xml @@ -4,7 +4,7 @@ The most important data type in Godot. </brief_description> <description> - A Variant takes up only 20 bytes and can store almost any engine datatype inside of it. Variants are rarely used to hold information for long periods of time, instead they are used mainly for communication, editing, serialization and moving data around. + A Variant takes up only 20 bytes and can store almost any engine datatype inside of it. Variants are rarely used to hold information for long periods of time. Instead, they are used mainly for communication, editing, serialization and moving data around. </description> <tutorials> </tutorials> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 243dbceced..073035131d 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -18,7 +18,7 @@ <argument index="1" name="y" type="float"> </argument> <description> - Constructs a new Vector2 from the given x and y. + Constructs a new Vector2 from the given [code]x[/code] and [code]y[/code]. </description> </method> <method name="abs"> @@ -32,8 +32,8 @@ <return type="float"> </return> <description> - Returns the vector's angle in radians with respect to the x-axis, or [code](1, 0)[/code] vector. - Equivalent to the result of atan2 when called with the vector's x and y as parameters: [code]atan2(x, y)[/code]. + Returns the vector's angle in radians with respect to the X axis, or [code](1, 0)[/code] vector. + Equivalent to the result of [method @GDScript.atan2] when called with the vector's [member x] and [member y] as parameters: [code]atan2(x, y)[/code]. </description> </method> <method name="angle_to"> @@ -51,14 +51,14 @@ <argument index="0" name="to" type="Vector2"> </argument> <description> - Returns the angle in radians between the line connecting the two points and the x coordinate. + Returns the angle in radians between the line connecting the two points and the X coordinate. </description> </method> <method name="aspect"> <return type="float"> </return> <description> - Returns the ratio of x to y. + Returns the ratio of [member x] to [member y]. </description> </method> <method name="bounce"> @@ -92,7 +92,7 @@ <argument index="0" name="with" type="Vector2"> </argument> <description> - Returns the 2 dimensional analog of the cross product with the given vector. + Returns the 2-dimensional analog of the cross product with the given vector. </description> </method> <method name="cubic_interpolate"> @@ -107,7 +107,7 @@ <argument index="3" name="t" type="float"> </argument> <description> - Cubicly interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. + Cubically interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. </description> </method> <method name="direction_to"> @@ -245,8 +245,8 @@ <argument index="1" name="t" type="float"> </argument> <description> - Returns the result of SLERP between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. - Both vectors need to be normalized. + Returns the result of spherical linear interpolation between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. + [b]Note:[/b] Both vectors must be normalized. </description> </method> <method name="slide"> @@ -277,10 +277,10 @@ </methods> <members> <member name="x" type="float" setter="" getter=""> - The vector's x component. Also accessible by using the index position [code][0][/code]. + The vector's X component. Also accessible by using the index position [code][0][/code]. </member> <member name="y" type="float" setter="" getter=""> - The vector's y component. Also accessible by using the index position [code][1][/code]. + The vector's Y component. Also accessible by using the index position [code][1][/code]. </member> </members> <constants> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 99bf3d2610..ddb72f6d03 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -246,8 +246,8 @@ <argument index="1" name="t" type="float"> </argument> <description> - Returns the result of SLERP between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. - Both vectors need to be normalized. + Returns the result of spherical linear interpolation between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. + [b]Note:[/b] Both vectors must be normalized. </description> </method> <method name="slide"> @@ -265,7 +265,7 @@ <argument index="0" name="by" type="Vector3"> </argument> <description> - Returns 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"> @@ -278,13 +278,13 @@ </methods> <members> <member name="x" type="float" setter="" getter=""> - The vector's x component. Also accessible by using the index position [code][0][/code]. + The vector's X component. Also accessible by using the index position [code][0][/code]. </member> <member name="y" type="float" setter="" getter=""> - The vector's y component. Also accessible by using the index position [code][1][/code]. + The vector's Y component. Also accessible by using the index position [code][1][/code]. </member> <member name="z" type="float" setter="" getter=""> - The vector's z component. Also accessible by using the index position [code][2][/code]. + The vector's Z component. Also accessible by using the index position [code][2][/code]. </member> </members> <constants> diff --git a/doc/classes/VehicleBody.xml b/doc/classes/VehicleBody.xml index f5b26e4f11..0858b1f4dd 100644 --- a/doc/classes/VehicleBody.xml +++ b/doc/classes/VehicleBody.xml @@ -4,8 +4,8 @@ Physics body that simulates the behavior of a car. </brief_description> <description> - This nodes implements all the physics logic needed to simulate a car. It is based on the raycast vehicle system commonly found in physics engines. You will need to add a [CollisionShape] for the main body of your vehicle and add [VehicleWheel] nodes for the wheels. You should also add a [MeshInstance] to this node for the 3D model of your car but this model should not include meshes for the wheels. You should control the vehicle by using the [member brake], [member engine_force], and [member steering] properties and not change the position or orientation of this node directly. - Note that the origin point of your VehicleBody will determine the center of gravity of your vehicle so it is better to keep this low and move the [CollisionShape] and [MeshInstance] upwards. + This node implements all the physics logic needed to simulate a car. It is based on the raycast vehicle system commonly found in physics engines. You will need to add a [CollisionShape] for the main body of your vehicle and add [VehicleWheel] nodes for the wheels. You should also add a [MeshInstance] to this node for the 3D model of your car but this model should not include meshes for the wheels. You should control the vehicle by using the [member brake], [member engine_force], and [member steering] properties and not change the position or orientation of this node directly. + [b]Note:[/b] The origin point of your VehicleBody will determine the center of gravity of your vehicle so it is better to keep this low and move the [CollisionShape] and [MeshInstance] upwards. </description> <tutorials> </tutorials> @@ -16,7 +16,8 @@ Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the [member RigidBody.mass] of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. </member> <member name="engine_force" type="float" setter="set_engine_force" getter="get_engine_force"> - Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have [member VehicleWheel.use_as_traction] set to [code]true[/code] and are in contact with a surface. The [member RigidBody.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. Note that the simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. + Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have [member VehicleWheel.use_as_traction] set to [code]true[/code] and are in contact with a surface. The [member RigidBody.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. + [b]Note:[/b] The simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. A negative value will result in the vehicle reversing. </member> <member name="steering" type="float" setter="set_steering" getter="get_steering"> diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml index eee72db48e..4106ec2157 100644 --- a/doc/classes/VehicleWheel.xml +++ b/doc/classes/VehicleWheel.xml @@ -35,22 +35,22 @@ The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. </member> <member name="damping_relaxation" type="float" setter="set_damping_relaxation" getter="get_damping_relaxation"> - The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5 + The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5. </member> <member name="suspension_max_force" type="float" setter="set_suspension_max_force" getter="get_suspension_max_force"> - The maximum force the spring can resist. This value should be higher than a quarter of the [member RigidBody.mass] of the [VehicleBody] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number. + The maximum force the spring can resist. This value should be higher than a quarter of the [member RigidBody.mass] of the [VehicleBody] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3× to 4× this number. </member> <member name="suspension_stiffness" type="float" setter="set_suspension_stiffness" getter="get_suspension_stiffness"> This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. </member> <member name="suspension_travel" type="float" setter="set_suspension_travel" getter="get_suspension_travel"> - This is the distance the suspension can travel. As Godot measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car . + This is the distance the suspension can travel. As Godot units are equivalent to meters, keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car. </member> <member name="use_as_steering" type="bool" setter="set_use_as_steering" getter="is_used_as_steering"> - If [code]true[/code] this wheel will be turned when the car steers. + If [code]true[/code], this wheel will be turned when the car steers. </member> <member name="use_as_traction" type="bool" setter="set_use_as_traction" getter="is_used_as_traction"> - If [code]true[/code] this wheel transfers engine force to the ground to propel the vehicle forward. + If [code]true[/code], this wheel transfers engine force to the ground to propel the vehicle forward. </member> <member name="wheel_friction_slip" type="float" setter="set_friction_slip" getter="get_friction_slip"> This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear. @@ -63,7 +63,7 @@ This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest. </member> <member name="wheel_roll_influence" type="float" setter="set_roll_influence" getter="get_roll_influence"> - This value effects the roll of your vehicle. If set to 0.0 for all wheels your vehicle will be prone to rolling over while a value of 1.0 will resist body roll. + This value affects the roll of your vehicle. If set to 0.0 for all wheels, your vehicle will be prone to rolling over, while a value of 1.0 will resist body roll. </member> </members> <constants> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 15d1dfcf19..fcf7abd74f 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -4,7 +4,7 @@ Control for playing video streams. </brief_description> <description> - Control node for playing video streams. Supported formats are WebM and OGV Theora. + Control node for playing video streams. Supported formats are [url=https://www.webmproject.org/]WebM[/url] and [url=https://www.theora.org/]Ogg Theora[/url]. </description> <tutorials> </tutorials> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index caaaf662dc..29f6e909bc 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -78,7 +78,8 @@ <return type="ViewportTexture"> </return> <description> - Returns the viewport's texture. Note that due to the way OpenGL works, the resulting [ViewportTexture] is flipped vertically. You can use [method Image.flip_y] on the result of [method Texture.get_data] to flip it back, for example: + Returns the viewport's texture. + [b]Note:[/b] Due to the way OpenGL works, the resulting [ViewportTexture] is flipped vertically. You can use [method Image.flip_y] on the result of [method Texture.get_data] to flip it back, for example: [codeblock] var img = get_viewport().get_texture().get_data() img.flip_y() diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml index 1642f7e85f..543140544f 100644 --- a/doc/classes/ViewportContainer.xml +++ b/doc/classes/ViewportContainer.xml @@ -12,7 +12,7 @@ </methods> <members> <member name="stretch" type="bool" setter="set_stretch" getter="is_stretch_enabled"> - If [code]true[/code], the viewport will be scaled to the control's size. Default value:[code]false[/code]. + If [code]true[/code], the viewport will be scaled to the control's size. Default value: [code]false[/code]. </member> <member name="stretch_shrink" type="int" setter="set_stretch_shrink" getter="get_stretch_shrink"> </member> diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 4b33d1ebce..72d02ddd3d 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.2"> <brief_description> - Enable certain nodes only when visible. + Enables certain nodes only when visible. </brief_description> <description> The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index b3d41d1fce..d954a379ae 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.2"> <brief_description> - Enable certain nodes only when visible. + Enables certain nodes only when visible. </brief_description> <description> The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index 986d6b8b13..136f2c2845 100644 --- a/doc/classes/VisibilityNotifier.xml +++ b/doc/classes/VisibilityNotifier.xml @@ -14,7 +14,7 @@ </return> <description> If [code]true[/code], the bounding box is on the screen. - Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. + [b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. </description> </method> </methods> diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml index 787a33d752..b3387da72b 100644 --- a/doc/classes/VisibilityNotifier2D.xml +++ b/doc/classes/VisibilityNotifier2D.xml @@ -14,7 +14,7 @@ </return> <description> If [code]true[/code], the bounding rectangle is on the screen. - Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. + [b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. </description> </method> </methods> diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index 59f0a531dd..ce8f729ce7 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -49,7 +49,7 @@ </argument> <description> Sets the base of the VisualInstance, which changes how the engine handles the VisualInstance under the hood. - It is recommended to only use set_base if you know what you're doing. + It is recommended to only use [method set_base] if you know what you're doing. </description> </method> <method name="set_layer_mask_bit"> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 565d8b3ae0..230b928005 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -257,7 +257,7 @@ <argument index="3" name="normal_map" type="RID"> </argument> <description> - Adds a particles system to the [CanvasItem]'s draw commands. + Adds a particle system to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_polygon"> @@ -606,7 +606,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> - If this is enabled, the z-index of the parent will be added to the children's z-index. + If this is enabled, the Z index of the parent will be added to the children's Z index. </description> </method> <method name="canvas_item_set_z_index"> @@ -617,7 +617,7 @@ <argument index="1" name="z_index" type="int"> </argument> <description> - Sets the [CanvasItem]'s z-index, i.e. its draw order (lower indexes are drawn first). + Sets the [CanvasItem]'s Z index, i.e. its draw order (lower indexes are drawn first). </description> </method> <method name="canvas_light_attach_to_canvas"> @@ -675,7 +675,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> - The light mask. See [LightOccluder2D] for more information on light masks + The light mask. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_occluder_set_polygon"> @@ -752,7 +752,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> - The light mask. See [LightOccluder2D] for more information on light masks + The light mask. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_set_item_shadow_cull_mask"> @@ -763,7 +763,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> - The shadow mask. binary about which layers this canvas light affects which canvas item's shadows. See [LightOccluder2D] for more information on light masks. + The binary mask used to determine which layers this canvas light's shadows affects. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_set_layer_range"> @@ -787,7 +787,7 @@ <argument index="1" name="mode" type="int" enum="VisualServer.CanvasLightMode"> </argument> <description> - The mode of the light, see CANVAS_LIGHT_MODE_* constants. + The mode of the light, see [code]CANVAS_LIGHT_MODE_*[/code] constants. </description> </method> <method name="canvas_light_set_scale"> @@ -841,7 +841,7 @@ <argument index="1" name="filter" type="int" enum="VisualServer.CanvasLightShadowFilter"> </argument> <description> - Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER_* constants. + Sets the canvas light's shadow's filter, see [code]CANVAS_LIGHT_SHADOW_FILTER_*[/code] constants. </description> </method> <method name="canvas_light_set_shadow_gradient_length"> @@ -863,7 +863,7 @@ <argument index="1" name="smooth" type="float"> </argument> <description> - Smoothens the shadow. The lower, the more smooth. + Smoothens the shadow. The lower, the smoother. </description> </method> <method name="canvas_light_set_texture"> @@ -924,7 +924,7 @@ <argument index="1" name="mode" type="int" enum="VisualServer.CanvasOccluderPolygonCullMode"> </argument> <description> - Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE_* constants. + Sets an occluder polygons cull mode. See [code]CANVAS_OCCLUDER_POLYGON_CULL_MODE_*[/code] constants. </description> </method> <method name="canvas_occluder_polygon_set_shape"> @@ -1330,7 +1330,7 @@ <argument index="0" name="info" type="int" enum="VisualServer.RenderInfo"> </argument> <description> - Returns a certain information, see RENDER_INFO_* for options. + Returns a certain information, see [code]RENDER_INFO_*[/code] for options. </description> </method> <method name="get_test_cube"> @@ -1952,7 +1952,7 @@ </argument> <description> Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query. - Warning: this function is primarily intended for editor usage. For in-game use cases, prefer physics collision. + [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. </description> </method> <method name="light_directional_set_blend_splits"> @@ -2252,7 +2252,7 @@ <argument index="1" name="width" type="float"> </argument> <description> - Sets a materials line width. + Sets a material's line width. </description> </method> <method name="material_set_next_pass"> @@ -2263,7 +2263,7 @@ <argument index="1" name="next_material" type="RID"> </argument> <description> - Sets an objects next material. + Sets an object's next material. </description> </method> <method name="material_set_param"> @@ -2276,7 +2276,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Sets a materials parameter. + Sets a material's parameter. </description> </method> <method name="material_set_render_priority"> @@ -2315,7 +2315,7 @@ <argument index="4" name="compress_format" type="int" default="97280"> </argument> <description> - Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE_* constants for types. + Adds a surface generated from the Arrays to a mesh. See [code]PRIMITIVE_TYPE_*[/code] constants for types. </description> </method> <method name="mesh_clear"> @@ -2477,7 +2477,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> - Returns a mesh's surface's arrays for blend shapes + Returns a mesh's surface's arrays for blend shapes. </description> </method> <method name="mesh_surface_get_format" qualifiers="const"> @@ -3098,8 +3098,8 @@ <argument index="2" name="userdata" type="Variant"> </argument> <description> - Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn. - The callback method must use only 1 argument which will be called with 'userdata'. + Schedules a callback to the corresponding named [code]method[/code] on [code]where[/code] after a frame has been drawn. + The callback method must use only 1 argument which will be called with [code]userdata[/code]. </description> </method> <method name="scenario_create"> @@ -3527,7 +3527,7 @@ <argument index="1" name="flags" type="int"> </argument> <description> - Sets the texture's flags. See [enum TextureFlags] for options + Sets the texture's flags. See [enum TextureFlags] for options. </description> </method> <method name="texture_set_path"> @@ -3639,7 +3639,7 @@ <argument index="1" name="info" type="int" enum="VisualServer.ViewportRenderInfo"> </argument> <description> - Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO* constants. + Returns a viewport's render information. For options, see the [code]VIEWPORT_RENDER_INFO*[/code] constants. </description> </method> <method name="viewport_get_texture" qualifiers="const"> @@ -3797,7 +3797,7 @@ <argument index="1" name="msaa" type="int" enum="VisualServer.ViewportMSAA"> </argument> <description> - Sets the anti-aliasing mode. see [enum ViewportMSAA] for options. + Sets the anti-aliasing mode. See [enum ViewportMSAA] for options. </description> </method> <method name="viewport_set_parent_viewport"> @@ -3986,29 +3986,29 @@ <constant name="TEXTURE_TYPE_3D" value="3" enum="TextureType"> </constant> <constant name="TEXTURE_FLAG_MIPMAPS" value="1" enum="TextureFlags"> - Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. + Generates mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. </constant> <constant name="TEXTURE_FLAG_REPEAT" value="2" enum="TextureFlags"> - Repeat (instead of clamp to edge). + Repeats the texture (instead of clamp to edge). </constant> <constant name="TEXTURE_FLAG_FILTER" value="4" enum="TextureFlags"> - Turn on magnifying filter, to enable smooth zooming in of the texture. + Uses a magnifying filter, to enable smooth zooming in of the texture. </constant> <constant name="TEXTURE_FLAG_ANISOTROPIC_FILTER" value="8" enum="TextureFlags"> - Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. - More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. + Uses anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. + This results in better-looking textures when viewed from oblique angles. </constant> <constant name="TEXTURE_FLAG_CONVERT_TO_LINEAR" value="16" enum="TextureFlags"> - Converts texture to SRGB color space. + Converts the texture to the sRGB color space. </constant> <constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32" enum="TextureFlags"> - Repeat texture with alternate sections mirrored. + Repeats the texture with alternate sections mirrored. </constant> <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="2048" enum="TextureFlags"> Texture is a video surface. </constant> <constant name="TEXTURE_FLAGS_DEFAULT" value="7" enum="TextureFlags"> - Default flags. Generate mipmaps, repeat, and filter are enabled. + Default flags. [constant TEXTURE_FLAG_MIPMAPS], [constant TEXTURE_FLAG_REPEAT] and [constant TEXTURE_FLAG_FILTER] are are enabled. </constant> <constant name="SHADER_SPATIAL" value="0" enum="ShaderMode"> Shader is a 3D shader. @@ -4035,10 +4035,10 @@ Array is a color array. </constant> <constant name="ARRAY_TEX_UV" value="4" enum="ArrayType"> - Array is a uv coordinates array. + Array is an UV coordinates array. </constant> <constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType"> - Array is a uv coordinates array for the second uv coordinates. + Array is an UV coordinates array for the second UV coordinates. </constant> <constant name="ARRAY_BONES" value="6" enum="ArrayType"> Array contains bone information. @@ -4065,10 +4065,10 @@ Flag used to mark a color array. </constant> <constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat"> - Flag used to mark a uv coordinates array. + Flag used to mark an UV coordinates array. </constant> <constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat"> - Flag used to mark a uv coordinates array for the second uv coordinates. + Flag used to mark an UV coordinates array for the second UV coordinates. </constant> <constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat"> Flag used to mark a bone information array. @@ -4077,7 +4077,7 @@ Flag used to mark a weights array. </constant> <constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat"> - Flag used to mark a index array. + Flag used to mark an index array. </constant> <constant name="ARRAY_COMPRESS_VERTEX" value="512" enum="ArrayFormat"> Flag used to mark a compressed (half float) vertex array. @@ -4092,10 +4092,10 @@ Flag used to mark a compressed (half float) color array. </constant> <constant name="ARRAY_COMPRESS_TEX_UV" value="8192" enum="ArrayFormat"> - Flag used to mark a compressed (half float) uv coordinates array. + Flag used to mark a compressed (half float) UV coordinates array. </constant> <constant name="ARRAY_COMPRESS_TEX_UV2" value="16384" enum="ArrayFormat"> - Flag used to mark a compressed (half float) uv coordinates array for the second uv coordinates. + Flag used to mark a compressed (half float) UV coordinates array for the second UV coordinates. </constant> <constant name="ARRAY_COMPRESS_BONES" value="32768" enum="ArrayFormat"> </constant> @@ -4108,10 +4108,10 @@ Flag used to mark that the array contains 2D vertices. </constant> <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288" enum="ArrayFormat"> - Flag used to mark that the array uses 16 bit bones instead of 8 bit. + Flag used to mark that the array uses 16-bit bones instead of 8-bit. </constant> <constant name="ARRAY_COMPRESS_DEFAULT" value="97280" enum="ArrayFormat"> - Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly. + Used to set flags [constant ARRAY_COMPRESS_VERTEX], [constant ARRAY_COMPRESS_NORMAL], [constant ARRAY_COMPRESS_TANGENT], [constant ARRAY_COMPRESS_COLOR], [constant ARRAY_COMPRESS_TEX_UV], [constant ARRAY_COMPRESS_TEX_UV2] and [constant ARRAY_COMPRESS_WEIGHTS] quickly. </constant> <constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType"> Primitive to draw consists of points. @@ -4145,10 +4145,10 @@ Is a directional (sun) light. </constant> <constant name="LIGHT_OMNI" value="1" enum="LightType"> - is an omni light. + Is an omni light. </constant> <constant name="LIGHT_SPOT" value="2" enum="LightType"> - is an spot light. + Is a spot light. </constant> <constant name="LIGHT_PARAM_ENERGY" value="0" enum="LightParam"> The light's energy. @@ -4227,16 +4227,16 @@ Multisample antialiasing is disabled. </constant> <constant name="VIEWPORT_MSAA_2X" value="1" enum="ViewportMSAA"> - Multisample antialiasing is set to 2X. + Multisample antialiasing is set to 2×. </constant> <constant name="VIEWPORT_MSAA_4X" value="2" enum="ViewportMSAA"> - Multisample antialiasing is set to 4X. + Multisample antialiasing is set to 4×. </constant> <constant name="VIEWPORT_MSAA_8X" value="3" enum="ViewportMSAA"> - Multisample antialiasing is set to 8X. + Multisample antialiasing is set to 8×. </constant> <constant name="VIEWPORT_MSAA_16X" value="4" enum="ViewportMSAA"> - Multisample antialiasing is set to 16X. + Multisample antialiasing is set to 16×. </constant> <constant name="VIEWPORT_USAGE_2D" value="0" enum="ViewportUsage"> The Viewport does not render 3D but samples. diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 55dfb5d489..6989246e24 100644 --- a/doc/classes/XMLParser.xml +++ b/doc/classes/XMLParser.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="XMLParser" inherits="Reference" category="Core" version="3.2"> <brief_description> - Low-level class for creating parsers for XML files. + Low-level class for creating parsers for [url=https://en.wikipedia.org/wiki/XML]XML[/url] files. </brief_description> <description> - This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema. + This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low-level so it can be applied to any possible schema. </description> <tutorials> </tutorials> @@ -13,7 +13,7 @@ <return type="int"> </return> <description> - Get the amount of attributes in the current element. + Gets the amount of attributes in the current element. </description> </method> <method name="get_attribute_name" qualifiers="const"> @@ -22,7 +22,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the name of the attribute specified by the index in [code]idx[/code] argument. + Gets the name of the attribute specified by the index in [code]idx[/code] argument. </description> </method> <method name="get_attribute_value" qualifiers="const"> @@ -31,14 +31,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the value of the attribute specified by the index in [code]idx[/code] argument. + Gets the value of the attribute specified by the index in [code]idx[/code] argument. </description> </method> <method name="get_current_line" qualifiers="const"> <return type="int"> </return> <description> - Get the current line in the parsed file (currently not implemented). + Gets the current line in the parsed file (currently not implemented). </description> </method> <method name="get_named_attribute_value" qualifiers="const"> @@ -47,7 +47,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. + Gets the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. </description> </method> <method name="get_named_attribute_value_safe" qualifiers="const"> @@ -56,35 +56,35 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get the value of a certain attribute of the current element by name. This will return an empty [String] if the attribute is not found. + Gets the value of a certain attribute of the current element by name. This will return an empty [String] if the attribute is not found. </description> </method> <method name="get_node_data" qualifiers="const"> <return type="String"> </return> <description> - Get the contents of a text node. This will raise an error in any other type of node. + Gets the contents of a text node. This will raise an error in any other type of node. </description> </method> <method name="get_node_name" qualifiers="const"> <return type="String"> </return> <description> - Get the name of the current element node. This will raise an error if the current node type is not [constant NODE_ELEMENT] nor [constant NODE_ELEMENT_END] + Gets the name of the current element node. This will raise an error if the current node type is neither [constant NODE_ELEMENT] nor [constant NODE_ELEMENT_END]. </description> </method> <method name="get_node_offset" qualifiers="const"> <return type="int"> </return> <description> - Get the byte offset of the current node since the beginning of the file or buffer. + Gets the byte offset of the current node since the beginning of the file or buffer. </description> </method> <method name="get_node_type"> <return type="int" enum="XMLParser.NodeType"> </return> <description> - Get the type of the current node. Compare with [code]NODE_*[/code] constants. + Gets the type of the current node. Compare with [code]NODE_*[/code] constants. </description> </method> <method name="has_attribute" qualifiers="const"> @@ -93,14 +93,14 @@ <argument index="0" name="name" type="String"> </argument> <description> - Check whether or not the current element has a certain attribute. + Check whether the current element has a certain attribute. </description> </method> <method name="is_empty" qualifiers="const"> <return type="bool"> </return> <description> - Check whether the current element is empty (this only works for completely empty tags, e.g. <element \>). + Check whether the current element is empty (this only works for completely empty tags, e.g. [code]<element \>[/code]). </description> </method> <method name="open"> @@ -109,7 +109,7 @@ <argument index="0" name="file" type="String"> </argument> <description> - Open a XML file for parsing. This returns an error code. + Opens an XML file for parsing. This returns an error code. </description> </method> <method name="open_buffer"> @@ -118,14 +118,14 @@ <argument index="0" name="buffer" type="PoolByteArray"> </argument> <description> - Open a XML raw buffer for parsing. This returns an error code. + Opens an XML raw buffer for parsing. This returns an error code. </description> </method> <method name="read"> <return type="int" enum="Error"> </return> <description> - Read the next node of the file. This returns an error code. + Reads the next node of the file. This returns an error code. </description> </method> <method name="seek"> @@ -134,7 +134,7 @@ <argument index="0" name="position" type="int"> </argument> <description> - Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. + Moves the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. </description> </method> <method name="skip_section"> diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index 9ed029a500..533963b460 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="bool" category="Built-In Types" version="3.2"> <brief_description> - Boolean built-in type + Boolean built-in type. </brief_description> <description> Boolean built-in type. @@ -24,7 +24,7 @@ <argument index="0" name="from" type="float"> </argument> <description> - Cast a [float] value to a boolean value, this method will return [code]true[/code] if called with a floating point value different to 0 and [code]false[/code] in other case. + Cast a [float] value to a boolean value, this method will return [code]true[/code] if called with a floating-point value different to 0 and [code]false[/code] in other case. </description> </method> <method name="bool"> @@ -33,7 +33,7 @@ <argument index="0" name="from" type="String"> </argument> <description> - Cast a [String] value to a boolean value, this method will return [code]true[/code] if called with a non empty string and [code]false[/code] in other case. Examples: [code]bool('False')[/code] returns [code]true[/code], [code]bool('')[/code] returns [code]false[/code]. + Cast a [String] value to a boolean value, this method will return [code]true[/code] if called with a non-empty string and [code]false[/code] in other case. Examples: [code]bool("False")[/code] returns [code]true[/code], [code]bool("")[/code] returns [code]false[/code]. </description> </method> </methods> diff --git a/doc/classes/float.xml b/doc/classes/float.xml index 506fb643e1..4c4ea83157 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -15,7 +15,7 @@ <argument index="0" name="from" type="bool"> </argument> <description> - Cast a [bool] value to a floating point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. + Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. </description> </method> <method name="float"> @@ -24,7 +24,7 @@ <argument index="0" name="from" type="int"> </argument> <description> - Cast an [int] value to a floating point value, [code]float(1)[/code] will be equal to 1.0. + Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to 1.0. </description> </method> <method name="float"> @@ -33,7 +33,7 @@ <argument index="0" name="from" type="String"> </argument> <description> - Cast a [String] value to a floating point value. This method accepts float value strings like [code]"1.23"[/code] and exponential notation strings for its parameter so calling [code]float("1e3")[/code] will return 1000.0 and calling [code]float("1e-3")[/code] will return 0.001. + Cast a [String] value to a floating-point value. This method accepts float value strings like [code]"1.23"[/code] and exponential notation strings for its parameter so calling [code]float("1e3")[/code] will return 1000.0 and calling [code]float("1e-3")[/code] will return 0.001. </description> </method> </methods> diff --git a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml index 187e8d349d..8a8511c008 100644 --- a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml +++ b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="NetworkedMultiplayerENet" inherits="NetworkedMultiplayerPeer" category="Core" version="3.2"> <brief_description> - PacketPeer implementation using the ENet library. + PacketPeer implementation using the [url=http://enet.bespin.org/index.html]ENet[/url] library. </brief_description> <description> A PacketPeer implementation that should be passed to [member SceneTree.network_peer] after being initialized as either a client or server. Events can then be handled by connecting to [SceneTree] signals. @@ -34,7 +34,7 @@ <argument index="4" name="client_port" type="int" default="0"> </argument> <description> - Create client that connects to a server at [code]address[/code] using specified [code]port[/code]. The given address needs to be either a fully qualified domain name (e.g. [code]www.example.com[/code]) or an IP address in IPv4 or IPv6 format (e.g. [code]192.168.1.1[/code]). The [code]port[/code] is the port the server is listening on. The [code]in_bandwidth[/code] and [code]out_bandwidth[/code] parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns [constant OK] if a client was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the client could not be created. If [code]client_port[/code] is specified, the client will also listen to the given port, this is useful in some NAT traversal technique. + Create client that connects to a server at [code]address[/code] using specified [code]port[/code]. The given address needs to be either a fully qualified domain name (e.g. [code]"www.example.com"[/code]) or an IP address in IPv4 or IPv6 format (e.g. [code]"192.168.1.1"[/code]). The [code]port[/code] is the port the server is listening on. The [code]in_bandwidth[/code] and [code]out_bandwidth[/code] parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns [constant OK] if a client was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerENet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the client could not be created. If [code]client_port[/code] is specified, the client will also listen to the given port; this is useful for some NAT traversal techniques. </description> </method> <method name="create_server"> @@ -49,7 +49,7 @@ <argument index="3" name="out_bandwidth" type="int" default="0"> </argument> <description> - Create server that listens to connections via [code]port[/code]. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use [method set_bind_ip]. The default IP is the wildcard [code]*[/code], which listens on all available interfaces. [code]max_clients[/code] is the maximum number of clients that are allowed at once, any number up to 4096 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see [method create_client]. Returns [constant OK] if a server was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the server could not be created. + Create server that listens to connections via [code]port[/code]. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use [method set_bind_ip]. The default IP is the wildcard [code]"*"[/code], which listens on all available interfaces. [code]max_clients[/code] is the maximum number of clients that are allowed at once, any number up to 4096 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see [method create_client]. Returns [constant OK] if a server was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerENet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the server could not be created. </description> </method> <method name="disconnect_peer"> @@ -101,7 +101,7 @@ <argument index="0" name="ip" type="String"> </argument> <description> - The IP used when creating a server. This is set to the wildcard [code]*[/code] by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: [code]192.168.1.1[/code]. + The IP used when creating a server. This is set to the wildcard [code]"*"[/code] by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: [code]"192.168.1.1"[/code]. </description> </method> </methods> @@ -113,27 +113,27 @@ The number of channels to be used by ENet. Default: [code]3[/code]. Channels are used to separate different kinds of data. In reliable or ordered mode, for example, the packet delivery order is ensured on a per channel basis. </member> <member name="compression_mode" type="int" setter="set_compression_mode" getter="get_compression_mode" enum="NetworkedMultiplayerENet.CompressionMode"> - The compression method used for network packets. Default is no compression. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. + The compression method used for network packets. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. Default value: [constant COMPRESS_NONE]. </member> <member name="transfer_channel" type="int" setter="set_transfer_channel" getter="get_transfer_channel"> - Set the default channel to be used to transfer data. By default this value is [code]-1[/code] which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel [code]0[/code] is reserved, and cannot be used. Setting this member to any value between [code]0[/code] and [member channel_count] (excluded) will force ENet to use that channel for sending data. + Set the default channel to be used to transfer data. By default, this value is [code]-1[/code] which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel [code]0[/code] is reserved, and cannot be used. Setting this member to any value between [code]0[/code] and [member channel_count] (excluded) will force ENet to use that channel for sending data. </member> </members> <constants> <constant name="COMPRESS_NONE" value="0" enum="CompressionMode"> - No compression. + No compression. This uses the most bandwidth, but has the upside of requiring the fewest CPU resources. </constant> <constant name="COMPRESS_RANGE_CODER" value="1" enum="CompressionMode"> - ENet's buildin range encoding. + ENet's built-in range encoding. </constant> <constant name="COMPRESS_FASTLZ" value="2" enum="CompressionMode"> - FastLZ compression. + [url=http://fastlz.org/]FastLZ[/url] compression. This option uses less CPU resources compared to [constant COMPRESS_ZLIB], at the expense of using more bandwidth. </constant> <constant name="COMPRESS_ZLIB" value="3" enum="CompressionMode"> - zlib compression. + [url=https://www.zlib.net/]Zlib[/url] compression. This option uses less bandwidth compared to [constant COMPRESS_FASTLZ], at the expense of using more CPU resources. </constant> <constant name="COMPRESS_ZSTD" value="4" enum="CompressionMode"> - ZStandard compression. + [url=https://facebook.github.io/zstd/]Zstandard[/url] compression. </constant> </constants> </class> diff --git a/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml b/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml index efdb948660..47c2ee3358 100644 --- a/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml +++ b/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ARVRInterfaceGDNative" inherits="ARVRInterface" category="Core" version="3.2"> <brief_description> - GDNative wrapper for an ARVR interface + GDNative wrapper for an ARVR interface. </brief_description> <description> - This is a wrapper class for GDNative implementations of the ARVR interface. To use a GDNative ARVR interface simply instantiate this object and set your GDNative library containing the ARVR interface implementation. + This is a wrapper class for GDNative implementations of the ARVR interface. To use a GDNative ARVR interface, simply instantiate this object and set your GDNative library containing the ARVR interface implementation. </description> <tutorials> </tutorials> diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index 3eaee53789..3870a5ea7d 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -149,7 +149,7 @@ <argument index="1" name="y" type="float"> </argument> <description> - Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). + Converts a 2D point expressed in the cartesian coordinate system (X and Y axis) to the polar coordinate system (a distance from the origin and an angle). </description> </method> <method name="ceil"> @@ -173,10 +173,8 @@ <description> Returns a character as a String of the given ASCII code. [codeblock] - # a is 'A' - a = char(65) - # a is 'a' - a = char(65 + 32) + a = char(65) # a is "A" + a = char(65 + 32) # a is "a" [/codeblock] </description> </method> @@ -210,14 +208,13 @@ <argument index="1" name="type" type="int"> </argument> <description> - Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the enum TYPE_* in [@GlobalScope]. + Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the enum [code]TYPE_*[/code] in [@GlobalScope]. [codeblock] a = Vector2(1, 0) - # prints 1 + # Prints 1 print(a.length()) a = convert(a, TYPE_STRING) - # prints 6 - # (1, 0) is 6 characters + # Prints 6 as "(1, 0)" is 6 characters print(a.length()) [/codeblock] </description> @@ -230,7 +227,7 @@ <description> Returns the cosine of angle [code]s[/code] in radians. [codeblock] - # prints 1 and -1 + # Prints 1 then -1 print(cos(PI * 2)) print(cos(PI)) [/codeblock] @@ -244,7 +241,7 @@ <description> Returns the hyperbolic cosine of [code]s[/code] in radians. [codeblock] - # prints 1.543081 + # Prints 1.543081 print(cosh(1)) [/codeblock] </description> @@ -264,7 +261,7 @@ <argument index="0" name="step" type="float"> </argument> <description> - Deprecated alias for "[method step_decimals]". + Deprecated alias for [method step_decimals]. </description> </method> <method name="dectime"> @@ -326,7 +323,7 @@ The natural exponential function. It raises the mathematical constant [b]e[/b] to the power of [code]s[/code] and returns it. [b]e[/b] has an approximate value of 2.71828. [codeblock] - a = exp(2) # approximately 7.39 + a = exp(2) # Approximately 7.39 [/codeblock] </description> </method> @@ -355,7 +352,7 @@ <description> Returns the floating-point remainder of [code]x/y[/code]. [codeblock] - # remainder is 1.5 + # Remainder is 1.5 var remainder = fmod(7, 5.5) [/codeblock] </description> @@ -404,7 +401,7 @@ return("bar") a = funcref(self, "foo") - print(a.call_func()) # prints bar + print(a.call_func()) # Prints bar [/codeblock] </description> </method> @@ -437,7 +434,7 @@ <description> Returns the integer hash of the variable passed. [codeblock] - print(hash("a")) # prints 177670 + print(hash("a")) # Prints 177670 [/codeblock] </description> </method> @@ -474,7 +471,7 @@ func _ready(): var id = get_instance_id() var inst = instance_from_id(id) - print(inst.foo) # prints bar + print(inst.foo) # Prints bar [/codeblock] </description> </method> @@ -490,7 +487,7 @@ <description> Returns a normalized value considering the given range. [codeblock] - inverse_lerp(3, 5, 4) # returns 0.5 + inverse_lerp(3, 5, 4) # Returns 0.5 [/codeblock] </description> </method> @@ -551,7 +548,7 @@ [b]Note:[/b] Generates a fatal error if Variant can not provide a length. [codeblock] a = [1, 2, 3, 4] - len(a) # returns 4 + len(a) # Returns 4 [/codeblock] </description> </method> @@ -569,8 +566,8 @@ If the [code]from[/code] and [code]to[/code] arguments are of type [int] or [float], the return value is a [float]. If both are of the same vector type ([Vector2], [Vector3] or [Color]), the return value will be of the same type ([code]lerp[/code] then calls the vector type's [code]linear_interpolate[/code] method). [codeblock] - lerp(0, 4, 0.75) # returns 3.0 - lerp(Vector2(1, 5), Vector2(3, 2), 0.5) # returns Vector2(2, 3.5) + lerp(0, 4, 0.75) # Returns 3.0 + lerp(Vector2(1, 5), Vector2(3, 2), 0.5) # Returns Vector2(2, 3.5) [/codeblock] </description> </method> @@ -590,9 +587,9 @@ </argument> <description> Loads a resource from the filesystem located at [code]path[/code]. - [b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". + [b]Note:[/b] Resource paths can be obtained by right-clicking on a resource in the FileSystem dock and choosing [b]Copy Path[/b]. [codeblock] - # load a scene called main located in the root of the project directory + # Load a scene called main located in the root of the project directory var main = load("res://main.tscn") [/codeblock] </description> @@ -604,9 +601,9 @@ </argument> <description> Natural logarithm. The amount of time needed to reach a certain level of continuous growth. - [b]Note:[/b] This is not the same as the log function on your calculator which is a base 10 logarithm. + [b]Note:[/b] This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. [codeblock] - log(10) # returns 2.302585 + log(10) # Returns 2.302585 [/codeblock] </description> </method> @@ -620,8 +617,8 @@ <description> Returns the maximum of two values. [codeblock] - max(1, 2) # returns 2 - max(-3.99, -4) # returns -3.99 + max(1, 2) # Returns 2 + max(-3.99, -4) # Returns -3.99 [/codeblock] </description> </method> @@ -635,8 +632,8 @@ <description> Returns the minimum of two values. [codeblock] - min(1, 2) # returns 1 - min(-3.99, -4) # returns -4 + min(1, 2) # Returns 1 + min(-3.99, -4) # Returns -4 [/codeblock] </description> </method> @@ -653,7 +650,7 @@ Moves [code]from[/code] toward [code]to[/code] by the [code]delta[/code] value. Use a negative [code]delta[/code] value to move away. [codeblock] - move_toward(10, 5, 4) # returns 6 + move_toward(10, 5, 4) # Returns 6 [/codeblock] </description> </method> @@ -665,9 +662,9 @@ <description> Returns the nearest larger power of 2 for integer [code]value[/code]. [codeblock] - nearest_po2(3) # returns 4 - nearest_po2(4) # returns 4 - nearest_po2(5) # returns 8 + nearest_po2(3) # Returns 4 + nearest_po2(4) # Returns 4 + nearest_po2(5) # Returns 8 [/codeblock] </description> </method> @@ -683,7 +680,7 @@ [codeblock] p = parse_json('["a", "b", "c"]') if typeof(p) == TYPE_ARRAY: - print(p[0]) # prints a + print(p[0]) # Prints a else: print("unexpected results") [/codeblock] @@ -697,7 +694,7 @@ <argument index="1" name="th" type="float"> </argument> <description> - Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (x and y axis). + Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (X and Y axis). </description> </method> <method name="pow"> @@ -710,7 +707,7 @@ <description> Returns the result of [code]x[/code] raised to the power of [code]y[/code]. [codeblock] - pow(2, 5) # returns 32 + pow(2, 5) # Returns 32 [/codeblock] </description> </method> @@ -723,7 +720,7 @@ Returns a resource from the filesystem that is loaded during script parsing. [b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". [codeblock] - # load a scene called main located in the root of the project directory + # Load a scene called main located in the root of the project directory var main = preload("res://main.tscn") [/codeblock] </description> @@ -735,7 +732,7 @@ Converts one or more arguments to strings in the best way possible and prints them to the console. [codeblock] a = [1, 2, 3] - print("a", "b", a) # prints ab[1, 2, 3] + print("a", "b", a) # Prints ab[1, 2, 3] [/codeblock] </description> </method> @@ -775,7 +772,7 @@ [codeblock] printraw("A") printraw("B") - # prints AB + # Prints AB [/codeblock] </description> </method> @@ -785,7 +782,7 @@ <description> Prints one or more arguments to the console with a space between each argument. [codeblock] - prints("A", "B", "C") # prints A B C + prints("A", "B", "C") # Prints A B C [/codeblock] </description> </method> @@ -795,7 +792,7 @@ <description> Prints one or more arguments to the console with a tab between each argument. [codeblock] - printt("A", "B", "C") # prints A B C + printt("A", "B", "C") # Prints A B C [/codeblock] </description> </method> @@ -807,7 +804,7 @@ <description> Pushes an error message to Godot's built-in debugger and to the OS terminal. [codeblock] - push_error("test error") # prints "test error" to debugger and terminal as error call + push_error("test error") # Prints "test error" to debugger and terminal as error call [/codeblock] </description> </method> @@ -819,7 +816,7 @@ <description> Pushes a warning message to Godot's built-in debugger and to the OS terminal. [codeblock] - push_warning("test warning") # prints "test warning" to debugger and terminal as warning call + push_warning("test warning") # Prints "test warning" to debugger and terminal as warning call [/codeblock] </description> </method> @@ -831,7 +828,7 @@ <description> Converts from radians to degrees. [codeblock] - rad2deg(0.523599) # returns 30 + rad2deg(0.523599) # Returns 30 [/codeblock] </description> </method> @@ -845,7 +842,7 @@ <description> Random range, any floating point value between [code]from[/code] and [code]to[/code]. [codeblock] - prints(rand_range(0, 1), rand_range(0, 1)) # prints e.g. 0.135591 0.405263 + prints(rand_range(0, 1), rand_range(0, 1)) # Prints e.g. 0.135591 0.405263 [/codeblock] </description> </method> @@ -864,7 +861,7 @@ <description> Returns a random floating point value on the interval [code][0, 1][/code]. [codeblock] - randf() # returns e.g. 0.375671 + randf() # Returns e.g. 0.375671 [/codeblock] </description> </method> @@ -874,10 +871,10 @@ <description> Returns a random unsigned 32 bit integer. Use remainder to obtain a random value in the interval [code][0, N][/code] (where N is smaller than 2^32 -1). [codeblock] - randi() # returns random integer between 0 and 2^32 - 1 - randi() % 20 # returns random integer between 0 and 19 - randi() % 100 # returns random integer between 0 and 99 - randi() % 100 + 1 # returns random integer between 1 and 100 + randi() # Returns random integer between 0 and 2^32 - 1 + randi() % 20 # Returns random integer between 0 and 19 + randi() % 100 # Returns random integer between 0 and 99 + randi() % 100 + 1 # Returns random integer between 1 and 100 [/codeblock] </description> </method> @@ -938,7 +935,7 @@ <description> Maps a [code]value[/code] from range [code][istart, istop][/code] to [code][ostart, ostop][/code]. [codeblock] - range_lerp(75, 0, 100, -1, 1) # returns 0.5 + range_lerp(75, 0, 100, -1, 1) # Returns 0.5 [/codeblock] </description> </method> @@ -950,7 +947,7 @@ <description> Returns the integral value that is nearest to [code]s[/code], with halfway cases rounded away from zero. [codeblock] - round(2.6) # returns 3 + round(2.6) # Returns 3 [/codeblock] </description> </method> @@ -975,9 +972,9 @@ <description> Returns the sign of [code]s[/code]: -1 or 1. Returns 0 if [code]s[/code] is 0. [codeblock] - sign(-6) # returns -1 - sign(0) # returns 0 - sign(6) # returns 1 + sign(-6) # Returns -1 + sign(0) # Returns 0 + sign(6) # Returns 1 [/codeblock] </description> </method> @@ -989,7 +986,7 @@ <description> Returns the sine of angle [code]s[/code] in radians. [codeblock] - sin(0.523599) # returns 0.5 + sin(0.523599) # Returns 0.5 [/codeblock] </description> </method> @@ -1001,8 +998,8 @@ <description> Returns the hyperbolic sine of [code]s[/code]. [codeblock] - a = log(2.0) # returns 0.693147 - sinh(a) # returns 0.75 + a = log(2.0) # Returns 0.693147 + sinh(a) # Returns 0.75 [/codeblock] </description> </method> @@ -1018,9 +1015,9 @@ <description> Returns a number smoothly interpolated between the [code]from[/code] and [code]to[/code], based on the [code]weight[/code]. Similar to [method lerp], but interpolates faster at the beginning and slower at the end. [codeblock] - smoothstep(0, 2, 0.5) # returns 0.15 - smoothstep(0, 2, 1.0) # returns 0.5 - smoothstep(0, 2, 2.0) # returns 1.0 + smoothstep(0, 2, 0.5) # Returns 0.15 + smoothstep(0, 2, 1.0) # Returns 0.5 + smoothstep(0, 2, 2.0) # Returns 1.0 [/codeblock] </description> </method> @@ -1032,7 +1029,7 @@ <description> Returns the square root of [code]s[/code]. [codeblock] - sqrt(9) # returns 3 + sqrt(9) # Returns 3 [/codeblock] </description> </method> @@ -1072,8 +1069,8 @@ [codeblock] var a = [10, 20, 30] var b = str(a); - len(a) # returns 3 - len(b) # returns 12 + len(a) # Returns 3 + len(b) # Returns 12 [/codeblock] </description> </method> @@ -1087,7 +1084,7 @@ [codeblock] a = '{ "a": 1, "b": 2 }' b = str2var(a) - print(b['a']) # prints 1 + print(b["a"]) # Prints 1 [/codeblock] </description> </method> @@ -1099,7 +1096,7 @@ <description> Returns the tangent of angle [code]s[/code] in radians. [codeblock] - tan(deg2rad(45)) # returns 1 + tan(deg2rad(45)) # Returns 1 [/codeblock] </description> </method> @@ -1111,8 +1108,8 @@ <description> Returns the hyperbolic tangent of [code]s[/code]. [codeblock] - a = log(2.0) # returns 0.693147 - tanh(a) # returns 0.6 + a = log(2.0) # Returns 0.693147 + tanh(a) # Returns 0.6 [/codeblock] </description> </method> @@ -1124,7 +1121,7 @@ <description> Converts a Variant [code]var[/code] to JSON text and return the result. Useful for serializing data to store or send over the network. [codeblock] - a = { 'a': 1, 'b': 2 } + a = { "a": 1, "b": 2 } b = to_json(a) print(b) # {"a":1, "b":2} [/codeblock] @@ -1138,8 +1135,8 @@ <description> Returns whether the given class exists in [ClassDB]. [codeblock] - type_exists("Sprite") # returns true - type_exists("Variant") # returns false + type_exists("Sprite") # Returns true + type_exists("Variant") # Returns false [/codeblock] </description> </method> @@ -1149,11 +1146,11 @@ <argument index="0" name="what" type="Variant"> </argument> <description> - Returns the internal type of the given Variant object, using the TYPE_* enum in [@GlobalScope]. + Returns the internal type of the given Variant object, using the [code]TYPE_*[/code] enum in [@GlobalScope]. [codeblock] p = parse_json('["a", "b", "c"]') if typeof(p) == TYPE_ARRAY: - print(p[0]) # prints a + print(p[0]) # Prints a else: print("unexpected results") [/codeblock] @@ -1195,7 +1192,7 @@ <description> Converts a Variant [code]var[/code] to a formatted string that can later be parsed using [method str2var]. [codeblock] - a = { 'a': 1, 'b': 2 } + a = { "a": 1, "b": 2 } print(var2str(a)) [/codeblock] prints @@ -1238,17 +1235,17 @@ a = wrapf(-0.5, 0.0, 10.0) [/codeblock] [codeblock] - # infinite loop between 0.0 and 0.99 + # Infinite loop between 0.0 and 0.99 f = wrapf(f + 0.1, 0.0, 1.0) [/codeblock] [codeblock] - # infinite rotation (in radians) + # Infinite rotation (in radians) angle = wrapf(angle + 0.1, 0.0, TAU) [/codeblock] - Note: If you just want to wrap between 0.0 and [code]n[/code] (where [code]n[/code] is a positive float value) then it's better for performance to use [method fmod] method like [code]fmod(number, n)[/code]. - The usage of [code]wrapf[/code] is more flexible than using the [method fmod] approach by giving the user a simple control over the minimum value. It also fully supports negative numbers, e.g. + [b]Note:[/b] If you just want to wrap between 0.0 and [code]n[/code] (where [code]n[/code] is a positive floating-point value), it is better for performance to use the [method fmod] method like [code]fmod(number, n)[/code]. + [code]wrapf[/code] is more flexible than using the [method fmod] approach by giving the user a simple control over the minimum value. It also fully supports negative numbers, e.g. [codeblock] - # infinite rotation (in radians) + # Infinite rotation (in radians) angle = wrapf(angle + 0.1, -PI, PI) [/codeblock] </description> @@ -1274,11 +1271,11 @@ a = wrapi(-1, 0, 10) [/codeblock] [codeblock] - # infinite loop between 0 and 9 + # Infinite loop between 0 and 9 frame = wrapi(frame + 1, 0, 10) [/codeblock] - Note: If you just want to wrap between 0 and [code]n[/code] (where [code]n[/code] is a positive integer value) then it's better for performance to use modulo operator like [code]number % n[/code]. - The usage of [code]wrapi[/code] is more flexible than using the modulo approach by giving the user a simple control over the minimum value. It also fully supports negative numbers, e.g. + [b]Note:[/b] If you just want to wrap between 0 and [code]n[/code] (where [code]n[/code] is a positive integer value), it is better for performance to use the modulo operator like [code]number % n[/code]. + [code]wrapi[/code] is more flexible than using the modulo approach by giving the user a simple control over the minimum value. It also fully supports negative numbers, e.g. [codeblock] # result is -2 var result = wrapi(-6, -5, -1) diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index f8f9fc1af9..951a49e0c1 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -86,14 +86,14 @@ <return type="Array"> </return> <description> - Array of [Transform] and [Mesh] references corresponding to the non empty cells in the grid. The transforms are specified in world space. + Array of [Transform] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in world space. </description> </method> <method name="get_used_cells" qualifiers="const"> <return type="Array"> </return> <description> - Array of [Vector3] with the non empty cell coordinates in the grid map. + Array of [Vector3] with the non-empty cell coordinates in the grid map. </description> </method> <method name="make_baked_meshes"> diff --git a/modules/mobile_vr/doc_classes/MobileVRInterface.xml b/modules/mobile_vr/doc_classes/MobileVRInterface.xml index 8876bcbe9d..8cd63b304a 100644 --- a/modules/mobile_vr/doc_classes/MobileVRInterface.xml +++ b/modules/mobile_vr/doc_classes/MobileVRInterface.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="MobileVRInterface" inherits="ARVRInterface" category="Core" version="3.2"> <brief_description> - Generic mobile VR implementation + Generic mobile VR implementation. </brief_description> <description> - This is a generic mobile VR implementation where you need to provide details about the phone and HMD used. It does not rely on any existing framework. This is the most basic interface we have. For the best effect you do need a mobile phone with a gyroscope and accelerometer. - Note that even though there is no positional tracking the camera will assume the headset is at a height of 1.85 meters, you can change this by setting [member eye_height]. + This is a generic mobile VR implementation where you need to provide details about the phone and HMD used. It does not rely on any existing framework. This is the most basic interface we have. For the best effect, you need a mobile phone with a gyroscope and accelerometer. + Note that even though there is no positional tracking, the camera will assume the headset is at a height of 1.85 meters. You can change this by setting [member eye_height]. You can initialise this interface as follows: [codeblock] var interface = ARVRServer.find_interface("Native mobile") diff --git a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml index 894a1b3ced..86acd4eaea 100644 --- a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml +++ b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml @@ -42,7 +42,7 @@ </argument> <description> Returns the 1D noise value [code][-1,1][/code] at the given x-coordinate. - Note: This method actually returns the 2D noise value [code][-1,1][/code] with fixed y-coordinate value 0.0. + [b]Note:[/b] This method actually returns the 2D noise value [code][-1,1][/code] with fixed y-coordinate value 0.0. </description> </method> <method name="get_noise_2d"> @@ -108,7 +108,7 @@ <argument index="0" name="size" type="int"> </argument> <description> - Generate a tileable noise image, based on the current noise parameters. Generated seamless images are always square ([code]size[/code] x [code]size[/code]). + Generate a tileable noise image, based on the current noise parameters. Generated seamless images are always square ([code]size[/code] × [code]size[/code]). </description> </method> </methods> diff --git a/modules/regex/doc_classes/RegEx.xml b/modules/regex/doc_classes/RegEx.xml index cc8205e400..74b06039d4 100644 --- a/modules/regex/doc_classes/RegEx.xml +++ b/modules/regex/doc_classes/RegEx.xml @@ -4,7 +4,7 @@ Class for searching text for patterns using regular expressions. </brief_description> <description> - Regular Expression (or regex) is a compact programming language that can be used to recognise strings that follow a specific pattern, such as URLs, email addresses, complete sentences, etc. For instance, a regex of [code]ab[0-9][/code] would find any string that is [code]ab[/code] followed by any number from [code]0[/code] to [code]9[/code]. For a more in-depth look, you can easily find various tutorials and detailed explanations on the Internet. + A regular expression (or regex) is a compact language that can be used to recognise strings that follow a specific pattern, such as URLs, email addresses, complete sentences, etc. For instance, a regex of [code]ab[0-9][/code] would find any string that is [code]ab[/code] followed by any number from [code]0[/code] to [code]9[/code]. For a more in-depth look, you can easily find various tutorials and detailed explanations on the Internet. To begin, the RegEx object needs to be compiled with the search pattern using [method compile] before it can be used. [codeblock] var regex = RegEx.new() @@ -19,7 +19,7 @@ if result: print(result.get_string()) # Would print n-0123 [/codeblock] - The results of capturing groups [code]()[/code] can be retrieved by passing the group number to the various functions in [RegExMatch]. Group 0 is the default and would always refer to the entire pattern. In the above example, calling [code]result.get_string(1)[/code] would give you [code]0123[/code]. + The results of capturing groups [code]()[/code] can be retrieved by passing the group number to the various functions in [RegExMatch]. Group 0 is the default and will always refer to the entire pattern. In the above example, calling [code]result.get_string(1)[/code] would give you [code]0123[/code]. This version of RegEx also supports named capturing groups, and the names can be used to retrieve the results. If two or more groups have the same name, the name would only refer to the first one with a match. [codeblock] var regex = RegEx.new() @@ -28,7 +28,7 @@ if result: print(result.get_string("digit")) # Would print 2f [/codeblock] - If you need to process multiple results, [method search_all] generates a list of all non-overlapping results. This can be combined with a for-loop for convenience. + If you need to process multiple results, [method search_all] generates a list of all non-overlapping results. This can be combined with a [code]for[/code] loop for convenience. [codeblock] for result in regex.search_all("d01, d03, d0c, x3f and x42"): print(result.get_string("digit")) @@ -43,7 +43,7 @@ <return type="void"> </return> <description> - This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object. + This method resets the state of the object, as if it was freshly created. Namely, it unassigns the regular expression of this object. </description> </method> <method name="compile"> @@ -52,7 +52,7 @@ <argument index="0" name="pattern" type="String"> </argument> <description> - Compiles and assign the search pattern to use. Returns OK if the compilation is successful. If an error is encountered the details are printed to STDOUT and FAILED is returned. + Compiles and assign the search pattern to use. Returns [constant OK] if the compilation is successful. If an error is encountered, details are printed to standard output and an error is returned. </description> </method> <method name="get_group_count" qualifiers="const"> @@ -93,7 +93,7 @@ <argument index="2" name="end" type="int" default="-1"> </argument> <description> - Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching result if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. + Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching result if found, otherwise [code]null[/code]. The region to search within can be specified without modifying where the start and end anchor would be. </description> </method> <method name="search_all" qualifiers="const"> @@ -106,7 +106,7 @@ <argument index="2" name="end" type="int" default="-1"> </argument> <description> - Searches the text for the compiled pattern. Returns an array of [RegExMatch] containers for each non-overlapping result. If no results were found an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. + Searches the text for the compiled pattern. Returns an array of [RegExMatch] containers for each non-overlapping result. If no results were found, an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. </description> </method> <method name="sub" qualifiers="const"> @@ -123,7 +123,7 @@ <argument index="4" name="end" type="int" default="-1"> </argument> <description> - Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]$1[/code] and [code]$name[/code] are expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. + Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]$1[/code] and [code]$name[/code] are expanded and resolved. By default, only the first instance is replaced, but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. </description> </method> </methods> diff --git a/modules/regex/doc_classes/RegExMatch.xml b/modules/regex/doc_classes/RegExMatch.xml index 245201006d..398d2ee3b6 100644 --- a/modules/regex/doc_classes/RegExMatch.xml +++ b/modules/regex/doc_classes/RegExMatch.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="RegExMatch" inherits="Reference" category="Core" version="3.2"> <brief_description> - Contains the results of a regex search. + Contains the results of a [RegEx] search. </brief_description> <description> - Contains the results of a single regex match returned by [method RegEx.search] and [method RegEx.search_all]. It can be used to find the position and range of the match and its capturing groups, and it can extract its sub-string for you. + Contains the results of a single [RegEx] match returned by [method RegEx.search] and [method RegEx.search_all]. It can be used to find the position and range of the match and its capturing groups, and it can extract its substring for you. </description> <tutorials> </tutorials> diff --git a/modules/visual_script/doc_classes/VisualScript.xml b/modules/visual_script/doc_classes/VisualScript.xml index 8f0d881f30..0d95075152 100644 --- a/modules/visual_script/doc_classes/VisualScript.xml +++ b/modules/visual_script/doc_classes/VisualScript.xml @@ -252,7 +252,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Returns the info for a given variable as a dictionary. The information includes its name, type, hint and usage. + Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage. </description> </method> <method name="has_custom_signal" qualifiers="const"> diff --git a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml index b88d2890e1..7add0bc2ba 100644 --- a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml +++ b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml @@ -106,7 +106,7 @@ Moves the number toward a value, based on the third input. </constant> <constant name="MATH_DECTIME" value="30" enum="BuiltinFunc"> - Return the result of 'value' decreased by 'step' * 'amount'. + Return the result of [code]value[/code] decreased by [code]step[/code] * [code]amount[/code]. </constant> <constant name="MATH_RANDOMIZE" value="31" enum="BuiltinFunc"> Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. @@ -139,10 +139,10 @@ Convert the input from decibel volume to linear volume. </constant> <constant name="MATH_POLAR2CARTESIAN" value="41" enum="BuiltinFunc"> - Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (x and y axis). + Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (X and Y axis). </constant> <constant name="MATH_CARTESIAN2POLAR" value="42" enum="BuiltinFunc"> - Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). + Converts a 2D point expressed in the cartesian coordinate system (X and Y axis) to the polar coordinate system (a distance from the origin and an angle). </constant> <constant name="MATH_WRAP" value="43" enum="BuiltinFunc"> </constant> @@ -203,7 +203,8 @@ Deserialize a [Variant] from a [PoolByteArray] serialized using [constant VAR_TO_BYTES]. </constant> <constant name="COLORN" value="63" enum="BuiltinFunc"> - Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. + Return the [Color] with the given name and alpha ranging from 0 to 1 + [b]Note:[/b] Names are defined in [code]color_names.inc[/code]. </constant> <constant name="MATH_SMOOTHSTEP" value="64" enum="BuiltinFunc"> Return a number smoothly interpolated between the first two inputs, based on the third input. Similar to [constant MATH_LERP], but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula: diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml index cd3a663e81..b079653591 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml @@ -45,7 +45,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the specified input port's type. See the TYPE_* enum in [@GlobalScope]. + Return the specified input port's type. See the [code]TYPE_*[/code] enum in [@GlobalScope]. </description> </method> <method name="_get_output_sequence_port_count" qualifiers="virtual"> @@ -86,7 +86,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the specified output's type. See the TYPE_* enum in [@GlobalScope]. + Return the specified output's type. See the [code]TYPE_*[/code] enum in [@GlobalScope]. </description> </method> <method name="_get_text" qualifiers="virtual"> @@ -125,9 +125,9 @@ Execute the custom node's logic, returning the index of the output sequence port to use or a [String] when there is an error. The [code]inputs[/code] array contains the values of the input ports. [code]outputs[/code] is an array whose indices should be set to the respective outputs. - The [code]start_mode[/code] is usually [constant START_MODE_BEGIN_SEQUENCE], unless you have used the STEP_* constants. + The [code]start_mode[/code] is usually [constant START_MODE_BEGIN_SEQUENCE], unless you have used the [code]STEP_*[/code] constants. [code]working_mem[/code] is an array which can be used to persist information between runs of the custom node. - When returning, you can mask the returned value with one of the STEP_* constants. + When returning, you can mask the returned value with one of the [code]STEP_*[/code] constants. </description> </method> </methods> diff --git a/modules/visual_script/doc_classes/VisualScriptSwitch.xml b/modules/visual_script/doc_classes/VisualScriptSwitch.xml index 35929b16ac..3e3b88ebe0 100644 --- a/modules/visual_script/doc_classes/VisualScriptSwitch.xml +++ b/modules/visual_script/doc_classes/VisualScriptSwitch.xml @@ -4,7 +4,7 @@ Branches program flow based on a given input's value. </brief_description> <description> - Branches the flow based on an input's value. Use "Case Count" in the Inspector to set the number of branches and each comparison's optional type. + Branches the flow based on an input's value. Use [b]Case Count[/b] in the Inspector to set the number of branches and each comparison's optional type. [b]Input Ports:[/b] - Sequence: [code]'input' is[/code] - Data (variant): [code]=[/code] diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml index 4c2938d0db..26082d73a8 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml @@ -60,7 +60,7 @@ "protocol": "my-custom-protocol", # A custom sub-protocol string for this channel. } [/codeblock] - NOTE: You must keep a reference to channels created this way, or it will be closed. + [b]Note:[/b] You must keep a reference to channels created this way, or it will be closed. </description> </method> <method name="create_offer"> @@ -172,7 +172,7 @@ The connection is new, data channels and an offer can be created in this state. </constant> <constant name="STATE_CONNECTING" value="1" enum="ConnectionState"> - The peer is connecting, ICE is in progress, non of the transports has failed. + The peer is connecting, ICE is in progress, none of the transports has failed. </constant> <constant name="STATE_CONNECTED" value="2" enum="ConnectionState"> The peer is connected, all ICE transports are connected. diff --git a/modules/websocket/doc_classes/WebSocketClient.xml b/modules/websocket/doc_classes/WebSocketClient.xml index 26122dfad4..0d425ad1dd 100644 --- a/modules/websocket/doc_classes/WebSocketClient.xml +++ b/modules/websocket/doc_classes/WebSocketClient.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="WebSocketClient" inherits="WebSocketMultiplayerPeer" category="Core" version="3.2"> <brief_description> - A WebSocket client implementation + A WebSocket client implementation. </brief_description> <description> - This class implements a WebSocket client compatible with any RFC 6455 complaint WebSocket server. + This class implements a WebSocket client compatible with any RFC 6455-compliant WebSocket server. This client can be optionally used as a network peer for the [MultiplayerAPI]. After starting the client ([method connect_to_url]), you will need to [method NetworkedMultiplayerPeer.poll] it at regular intervals (e.g. inside [method Node._process]). - You will received appropriate signals when connecting, disconnecting, or when new data is available. + You will receive appropriate signals when connecting, disconnecting, or when new data is available. </description> <tutorials> </tutorials> @@ -22,8 +22,8 @@ <argument index="2" name="gd_mp_api" type="bool" default="false"> </argument> <description> - Connect to the given URL requesting one of the given [code]protocols[/code] as sub-protocol. - If [code]true[/code] is passed as [code]gd_mp_api[/code], the client will behave like a network peer for the [MultiplayerAPI], connections to non Godot servers will not work, and [signal data_received] will not be emitted. + Connects to the given URL requesting one of the given [code]protocols[/code] as sub-protocol. + If [code]true[/code] is passed as [code]gd_mp_api[/code], the client will behave like a network peer for the [MultiplayerAPI], connections to non-Godot servers will not work, and [signal data_received] will not be emitted. If [code]false[/code] is passed instead (default), you must call [PacketPeer] functions ([code]put_packet[/code], [code]get_packet[/code], etc.) on the [WebSocketPeer] returned via [code]get_peer(1)[/code] and not on this object directly (e.g. [code]get_peer(1).put_packet(data)[/code]). </description> </method> @@ -35,13 +35,14 @@ <argument index="1" name="reason" type="String" default=""""> </argument> <description> - Disconnect this client from the connected host. See [method WebSocketPeer.close] for more info. + Disconnects this client from the connected host. See [method WebSocketPeer.close] for more information. </description> </method> </methods> <members> <member name="verify_ssl" type="bool" setter="set_verify_ssl_enabled" getter="is_verify_ssl_enabled"> - Enable or disable SSL certificate verification. Note: You must specify the certificates to be used in the project settings for it to work when exported. + If [code]true[/code], SSL certificate verification is enabled. + [b]Note:[/b] You must specify the certificates to be used in the Project Settings for it to work when exported. </member> </members> <signals> @@ -66,7 +67,8 @@ </signal> <signal name="data_received"> <description> - Emitted when a WebSocket message is received. Note: This signal is NOT emitted when used as high level multiplayer peer. + Emitted when a WebSocket message is received. + [b]Note:[/b] This signal is [i]not[/i] emitted when used as high-level multiplayer peer. </description> </signal> <signal name="server_close_request"> diff --git a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml index 103dbd771b..b80a28e648 100644 --- a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml +++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml @@ -30,10 +30,10 @@ <argument index="3" name="output_max_packets" type="int"> </argument> <description> - Configure the buffers sizes for this WebSocket peer. Default values can be specified in project settings under [code]network/limits[/code]. For server, values are meant per connected peer. + Configures the buffer sizes for this WebSocket peer. Default values can be specified in the Project Settings under [code]network/limits[/code]. For server, values are meant per connected peer. The first two parameters define the size and queued packets limits of the input buffer, the last two of the output buffer. Buffer sizes are expressed in KiB, so [code]4 = 2^12 = 4096 bytes[/code]. All parameters will be rounded up to the nearest power of two. - NOTE: HTML5 exports only use the input buffer since the output one is managed by browsers. + [b]Note:[/b] HTML5 exports only use the input buffer since the output one is managed by browsers. </description> </method> </methods> @@ -42,7 +42,8 @@ <argument index="0" name="peer_source" type="int"> </argument> <description> - Emitted when a packet is received from a peer. Note: this signal is only emitted when the client or server is configured to use Godot multiplayer API. + Emitted when a packet is received from a peer. + [b]Note:[/b] This signal is only emitted when the client or server is configured to use Godot multiplayer API. </description> </signal> </signals> diff --git a/modules/websocket/doc_classes/WebSocketPeer.xml b/modules/websocket/doc_classes/WebSocketPeer.xml index 8a6868d311..dd95f7432e 100644 --- a/modules/websocket/doc_classes/WebSocketPeer.xml +++ b/modules/websocket/doc_classes/WebSocketPeer.xml @@ -18,30 +18,32 @@ <argument index="1" name="reason" type="String" default=""""> </argument> <description> - Close this WebSocket connection. [code]code[/code] is the status code for the closure (see RFC6455 section 7.4 for a list of valid status codes). [code]reason[/code] is the human readable reason for closing the connection (can be any UTF8 string, must be less than 123 bytes). - Note: To achieve a clean close, you will need to keep polling until either [signal WebSocketClient.connection_closed] or [signal WebSocketServer.client_disconnected] is received. - Note: HTML5 export might not support all status codes. Please refer to browsers-specific documentation for more details. + Closes this WebSocket connection. [code]code[/code] is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). [code]reason[/code] is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes). + [b]Note:[/b] To achieve a clean close, you will need to keep polling until either [signal WebSocketClient.connection_closed] or [signal WebSocketServer.client_disconnected] is received. + [b]Note:[/b] The HTML5 export might not support all status codes. Please refer to browser-specific documentation for more details. </description> </method> <method name="get_connected_host" qualifiers="const"> <return type="String"> </return> <description> - Returns the IP Address of the connected peer. (Not available in HTML5 export) + Returns the IP address of the connected peer. + [b]Note:[/b] Not available in the HTML5 export. </description> </method> <method name="get_connected_port" qualifiers="const"> <return type="int"> </return> <description> - Returns the remote port of the connected peer. (Not available in HTML5 export) + Returns the remote port of the connected peer. + [b]Note:[/b] Not available in the HTML5 export. </description> </method> <method name="get_write_mode" qualifiers="const"> <return type="int" enum="WebSocketPeer.WriteMode"> </return> <description> - Get the current selected write mode. See [enum WriteMode]. + Gets the current selected write mode. See [enum WriteMode]. </description> </method> <method name="is_connected_to_host" qualifiers="const"> @@ -70,10 +72,10 @@ </methods> <constants> <constant name="WRITE_MODE_TEXT" value="0" enum="WriteMode"> - Specify that WebSockets messages should be transferred as text payload (only valid UTF-8 is allowed). + Specifies that WebSockets messages should be transferred as text payload (only valid UTF-8 is allowed). </constant> <constant name="WRITE_MODE_BINARY" value="1" enum="WriteMode"> - Specify that WebSockets messages should be transferred as binary payload (any byte combination is allowed). + Specifies that WebSockets messages should be transferred as binary payload (any byte combination is allowed). </constant> </constants> </class> diff --git a/modules/websocket/doc_classes/WebSocketServer.xml b/modules/websocket/doc_classes/WebSocketServer.xml index 5c4647b1ce..1af5e403e6 100644 --- a/modules/websocket/doc_classes/WebSocketServer.xml +++ b/modules/websocket/doc_classes/WebSocketServer.xml @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="WebSocketServer" inherits="WebSocketMultiplayerPeer" category="Core" version="3.2"> <brief_description> - A WebSocket server implementation + A WebSocket server implementation. </brief_description> <description> - This class implements a WebSocket server that can also support the high level multiplayer API. + This class implements a WebSocket server that can also support the high-level multiplayer API. After starting the server ([method listen]), you will need to [method NetworkedMultiplayerPeer.poll] it at regular intervals (e.g. inside [method Node._process]). When clients connect, disconnect, or send data, you will receive the appropriate signal. - Note: This class will not work in HTML5 exports due to browser restrictions. + [b]Note:[/b] This class will not work in HTML5 exports due to browser restrictions. </description> <tutorials> </tutorials> @@ -21,7 +21,7 @@ <argument index="2" name="reason" type="String" default=""""> </argument> <description> - Disconnects the peer identified by [code]id[/code] from the server. See [method WebSocketPeer.close] for more info. + Disconnects the peer identified by [code]id[/code] from the server. See [method WebSocketPeer.close] for more information. </description> </method> <method name="get_peer_address" qualifiers="const"> @@ -68,9 +68,9 @@ <argument index="2" name="gd_mp_api" type="bool" default="false"> </argument> <description> - Start listening on the given port. + Starts listening on the given port. You can specify the desired subprotocols via the "protocols" array. If the list empty (default), "binary" will be used. - If [code]true[/code] is passed as [code]gd_mp_api[/code], the server will behave like a network peer for the [MultiplayerAPI], connections from non Godot clients will not work, and [signal data_received] will not be emitted. + If [code]true[/code] is passed as [code]gd_mp_api[/code], the server will behave like a network peer for the [MultiplayerAPI], connections from non-Godot clients will not work, and [signal data_received] will not be emitted. If [code]false[/code] is passed instead (default), you must call [PacketPeer] functions ([code]put_packet[/code], [code]get_packet[/code], etc.), on the [WebSocketPeer] returned via [code]get_peer(id)[/code] to communicate with the peer with given [code]id[/code] (e.g. [code]get_peer(id).get_available_packet_count[/code]). </description> </method> @@ -78,7 +78,7 @@ <return type="void"> </return> <description> - Stop the server and clear its state. + Stops the server and clear its state. </description> </method> </methods> @@ -116,7 +116,8 @@ <argument index="0" name="id" type="int"> </argument> <description> - Emitted when a new message is received. Note: This signal is NOT emitted when used as high level multiplayer peer. + Emitted when a new message is received. + [b]Note:[/b] This signal is [i]not[/i] emitted when used as high-level multiplayer peer. </description> </signal> </signals> |