diff options
Diffstat (limited to 'doc')
418 files changed, 4259 insertions, 19009 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index 49ec412ba0..bee2cdf387 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="@GDScript" category="Core" version="3.0-alpha"> +<class name="@GDScript" category="Core" version="3.0-beta"> <brief_description> Built-in GDScript functions. </brief_description> @@ -138,6 +138,17 @@ Decodes a byte array back to a value. </description> </method> + <method name="cartesian2polar"> + <return type="Vector2"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <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). + </description> + </method> <method name="ceil"> <return type="float"> </return> @@ -604,6 +615,17 @@ [/codeblock] </description> </method> + <method name="polar2cartesian"> + <return type="Vector2"> + </return> + <argument index="0" name="r" type="float"> + </argument> + <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). + </description> + </method> <method name="pow"> <return type="float"> </return> @@ -1116,16 +1138,16 @@ </method> </methods> <constants> - <constant name="PI" value="3.141593" enum=""> + <constant name="PI" value="3.141593"> Constant that represents how many times the diameter of a circle fits around its perimeter. </constant> - <constant name="TAU" value="6.283185" enum=""> + <constant name="TAU" value="6.283185"> The circle constant, the circumference of the unit circle. </constant> - <constant name="INF" value="inf" enum=""> + <constant name="INF" value="inf"> A positive infinity. (For negative infinity, use -INF). </constant> - <constant name="NAN" value="nan" enum=""> + <constant name="NAN" value="nan"> Macro constant that expands to an expression of type float that represents a NaN. The NaN values are used to identify undefined or non-representable values for floating-point elements, such as the square root of negative numbers or the result of 0/0. </constant> diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 258b06f320..de5dc18702 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="@GlobalScope" category="Core" version="3.0-alpha"> +<class name="@GlobalScope" category="Core" version="3.0-beta"> <brief_description> Global scope constants and variables. </brief_description> @@ -44,6 +44,8 @@ <member name="JSON" type="JSON" setter="" getter=""> [JSON] singleton </member> + <member name="JavaScript" type="JavaScript" setter="" getter=""> + </member> <member name="Marshalls" type="Reference" setter="" getter=""> [Marshalls] singleton </member> @@ -71,1316 +73,1316 @@ <member name="TranslationServer" type="TranslationServer" setter="" getter=""> [TranslationServer] singleton </member> + <member name="VisualScriptEditor" type="VisualScriptEditor" setter="" getter=""> + [VisualScriptEditor] singleton + </member> <member name="VisualServer" type="VisualServer" setter="" getter=""> [VisualServer] singleton </member> </members> <constants> - <constant name="MARGIN_LEFT" value="0"> + <constant name="MARGIN_LEFT" value="0" enum="Margin"> Left margin, used usually for [Control] or [StyleBox] derived classes. </constant> - <constant name="MARGIN_TOP" value="1"> + <constant name="MARGIN_TOP" value="1" enum="Margin"> Top margin, used usually for [Control] or [StyleBox] derived classes. </constant> - <constant name="MARGIN_RIGHT" value="2"> + <constant name="MARGIN_RIGHT" value="2" enum="Margin"> Right margin, used usually for [Control] or [StyleBox] derived classes. </constant> - <constant name="MARGIN_BOTTOM" value="3"> + <constant name="MARGIN_BOTTOM" value="3" enum="Margin"> Bottom margin, used usually for [Control] or [StyleBox] derived classes. </constant> - <constant name="VERTICAL" value="1"> + <constant name="VERTICAL" value="1" enum="Orientation"> General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc. </constant> - <constant name="HORIZONTAL" value="0"> + <constant name="HORIZONTAL" value="0" enum="Orientation"> General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc. </constant> - <constant name="HALIGN_LEFT" value="0"> + <constant name="HALIGN_LEFT" value="0" enum="HAlign"> Horizontal left alignment, usually for text-derived classes. </constant> - <constant name="HALIGN_CENTER" value="1"> + <constant name="HALIGN_CENTER" value="1" enum="HAlign"> Horizontal center alignment, usually for text-derived classes. </constant> - <constant name="HALIGN_RIGHT" value="2"> + <constant name="HALIGN_RIGHT" value="2" enum="HAlign"> Horizontal right alignment, usually for text-derived classes. </constant> - <constant name="VALIGN_TOP" value="0"> + <constant name="VALIGN_TOP" value="0" enum="VAlign"> Vertical top alignment, usually for text-derived classes. </constant> - <constant name="VALIGN_CENTER" value="1"> + <constant name="VALIGN_CENTER" value="1" enum="VAlign"> Vertical center alignment, usually for text-derived classes. </constant> - <constant name="VALIGN_BOTTOM" value="2"> + <constant name="VALIGN_BOTTOM" value="2" enum="VAlign"> Vertical bottom alignment, usually for text-derived classes. </constant> - <constant name="SPKEY" value="16777216" enum=""> + <constant name="SPKEY" value="16777216"> Scancodes with this bit applied are non printable. </constant> - <constant name="KEY_ESCAPE" value="16777217"> + <constant name="KEY_ESCAPE" value="16777217" enum="KeyList"> Escape Key </constant> - <constant name="KEY_TAB" value="16777218"> + <constant name="KEY_TAB" value="16777218" enum="KeyList"> Tab Key </constant> - <constant name="KEY_BACKTAB" value="16777219"> + <constant name="KEY_BACKTAB" value="16777219" enum="KeyList"> Shift-Tab Key </constant> - <constant name="KEY_BACKSPACE" value="16777220"> + <constant name="KEY_BACKSPACE" value="16777220" enum="KeyList"> Backspace Key </constant> - <constant name="KEY_ENTER" value="16777221"> + <constant name="KEY_ENTER" value="16777221" enum="KeyList"> Return Key (On Main Keyboard) </constant> - <constant name="KEY_KP_ENTER" value="16777222"> + <constant name="KEY_KP_ENTER" value="16777222" enum="KeyList"> Enter Key (On Numpad) </constant> - <constant name="KEY_INSERT" value="16777223"> + <constant name="KEY_INSERT" value="16777223" enum="KeyList"> Insert Key </constant> - <constant name="KEY_DELETE" value="16777224"> + <constant name="KEY_DELETE" value="16777224" enum="KeyList"> Delete Key </constant> - <constant name="KEY_PAUSE" value="16777225"> + <constant name="KEY_PAUSE" value="16777225" enum="KeyList"> Pause Key </constant> - <constant name="KEY_PRINT" value="16777226"> + <constant name="KEY_PRINT" value="16777226" enum="KeyList"> Printscreen Key </constant> - <constant name="KEY_SYSREQ" value="16777227"> + <constant name="KEY_SYSREQ" value="16777227" enum="KeyList"> System Request Key </constant> - <constant name="KEY_CLEAR" value="16777228"> + <constant name="KEY_CLEAR" value="16777228" enum="KeyList"> Clear Key </constant> - <constant name="KEY_HOME" value="16777229"> + <constant name="KEY_HOME" value="16777229" enum="KeyList"> Home Key </constant> - <constant name="KEY_END" value="16777230"> + <constant name="KEY_END" value="16777230" enum="KeyList"> End Key </constant> - <constant name="KEY_LEFT" value="16777231"> + <constant name="KEY_LEFT" value="16777231" enum="KeyList"> Left Arrow Key </constant> - <constant name="KEY_UP" value="16777232"> + <constant name="KEY_UP" value="16777232" enum="KeyList"> Up Arrow Key </constant> - <constant name="KEY_RIGHT" value="16777233"> + <constant name="KEY_RIGHT" value="16777233" enum="KeyList"> Right Arrow Key </constant> - <constant name="KEY_DOWN" value="16777234"> + <constant name="KEY_DOWN" value="16777234" enum="KeyList"> Down Arrow Key </constant> - <constant name="KEY_PAGEUP" value="16777235"> + <constant name="KEY_PAGEUP" value="16777235" enum="KeyList"> Pageup Key </constant> - <constant name="KEY_PAGEDOWN" value="16777236"> + <constant name="KEY_PAGEDOWN" value="16777236" enum="KeyList"> Pagedown Key </constant> - <constant name="KEY_SHIFT" value="16777237"> + <constant name="KEY_SHIFT" value="16777237" enum="KeyList"> Shift Key </constant> - <constant name="KEY_CONTROL" value="16777238"> + <constant name="KEY_CONTROL" value="16777238" enum="KeyList"> Control Key </constant> - <constant name="KEY_META" value="16777239"> + <constant name="KEY_META" value="16777239" enum="KeyList"> Meta Key </constant> - <constant name="KEY_ALT" value="16777240"> + <constant name="KEY_ALT" value="16777240" enum="KeyList"> Alt Key </constant> - <constant name="KEY_CAPSLOCK" value="16777241"> + <constant name="KEY_CAPSLOCK" value="16777241" enum="KeyList"> Capslock Key </constant> - <constant name="KEY_NUMLOCK" value="16777242"> + <constant name="KEY_NUMLOCK" value="16777242" enum="KeyList"> Numlock Key </constant> - <constant name="KEY_SCROLLLOCK" value="16777243"> + <constant name="KEY_SCROLLLOCK" value="16777243" enum="KeyList"> Scrolllock Key </constant> - <constant name="KEY_F1" value="16777244"> + <constant name="KEY_F1" value="16777244" enum="KeyList"> F1 Key </constant> - <constant name="KEY_F2" value="16777245"> + <constant name="KEY_F2" value="16777245" enum="KeyList"> F2 Key </constant> - <constant name="KEY_F3" value="16777246"> + <constant name="KEY_F3" value="16777246" enum="KeyList"> F3 Key </constant> - <constant name="KEY_F4" value="16777247"> + <constant name="KEY_F4" value="16777247" enum="KeyList"> F4 Key </constant> - <constant name="KEY_F5" value="16777248"> + <constant name="KEY_F5" value="16777248" enum="KeyList"> F5 Key </constant> - <constant name="KEY_F6" value="16777249"> + <constant name="KEY_F6" value="16777249" enum="KeyList"> F6 Key </constant> - <constant name="KEY_F7" value="16777250"> + <constant name="KEY_F7" value="16777250" enum="KeyList"> F7 Key </constant> - <constant name="KEY_F8" value="16777251"> + <constant name="KEY_F8" value="16777251" enum="KeyList"> F8 Key </constant> - <constant name="KEY_F9" value="16777252"> + <constant name="KEY_F9" value="16777252" enum="KeyList"> F9 Key </constant> - <constant name="KEY_F10" value="16777253"> + <constant name="KEY_F10" value="16777253" enum="KeyList"> F10 Key </constant> - <constant name="KEY_F11" value="16777254"> + <constant name="KEY_F11" value="16777254" enum="KeyList"> F11 Key </constant> - <constant name="KEY_F12" value="16777255"> + <constant name="KEY_F12" value="16777255" enum="KeyList"> F12 Key </constant> - <constant name="KEY_F13" value="16777256"> + <constant name="KEY_F13" value="16777256" enum="KeyList"> F13 Key </constant> - <constant name="KEY_F14" value="16777257"> + <constant name="KEY_F14" value="16777257" enum="KeyList"> F14 Key </constant> - <constant name="KEY_F15" value="16777258"> + <constant name="KEY_F15" value="16777258" enum="KeyList"> F15 Key </constant> - <constant name="KEY_F16" value="16777259"> + <constant name="KEY_F16" value="16777259" enum="KeyList"> F16 Key </constant> - <constant name="KEY_KP_MULTIPLY" value="16777345"> + <constant name="KEY_KP_MULTIPLY" value="16777345" enum="KeyList"> Multiply Key on Numpad </constant> - <constant name="KEY_KP_DIVIDE" value="16777346"> + <constant name="KEY_KP_DIVIDE" value="16777346" enum="KeyList"> Divide Key on Numpad </constant> - <constant name="KEY_KP_SUBTRACT" value="16777347"> + <constant name="KEY_KP_SUBTRACT" value="16777347" enum="KeyList"> Subtract Key on Numpad </constant> - <constant name="KEY_KP_PERIOD" value="16777348"> + <constant name="KEY_KP_PERIOD" value="16777348" enum="KeyList"> Period Key on Numpad </constant> - <constant name="KEY_KP_ADD" value="16777349"> + <constant name="KEY_KP_ADD" value="16777349" enum="KeyList"> Add Key on Numpad </constant> - <constant name="KEY_KP_0" value="16777350"> + <constant name="KEY_KP_0" value="16777350" enum="KeyList"> Number 0 on Numpad </constant> - <constant name="KEY_KP_1" value="16777351"> + <constant name="KEY_KP_1" value="16777351" enum="KeyList"> Number 1 on Numpad </constant> - <constant name="KEY_KP_2" value="16777352"> + <constant name="KEY_KP_2" value="16777352" enum="KeyList"> Number 2 on Numpad </constant> - <constant name="KEY_KP_3" value="16777353"> + <constant name="KEY_KP_3" value="16777353" enum="KeyList"> Number 3 on Numpad </constant> - <constant name="KEY_KP_4" value="16777354"> + <constant name="KEY_KP_4" value="16777354" enum="KeyList"> Number 4 on Numpad </constant> - <constant name="KEY_KP_5" value="16777355"> + <constant name="KEY_KP_5" value="16777355" enum="KeyList"> Number 5 on Numpad </constant> - <constant name="KEY_KP_6" value="16777356"> + <constant name="KEY_KP_6" value="16777356" enum="KeyList"> Number 6 on Numpad </constant> - <constant name="KEY_KP_7" value="16777357"> + <constant name="KEY_KP_7" value="16777357" enum="KeyList"> Number 7 on Numpad </constant> - <constant name="KEY_KP_8" value="16777358"> + <constant name="KEY_KP_8" value="16777358" enum="KeyList"> Number 8 on Numpad </constant> - <constant name="KEY_KP_9" value="16777359"> + <constant name="KEY_KP_9" value="16777359" enum="KeyList"> Number 9 on Numpad </constant> - <constant name="KEY_SUPER_L" value="16777260"> + <constant name="KEY_SUPER_L" value="16777260" enum="KeyList"> Left Super Key (Windows Key) </constant> - <constant name="KEY_SUPER_R" value="16777261"> + <constant name="KEY_SUPER_R" value="16777261" enum="KeyList"> Right Super Key (Windows Key) </constant> - <constant name="KEY_MENU" value="16777262"> + <constant name="KEY_MENU" value="16777262" enum="KeyList"> Context menu key </constant> - <constant name="KEY_HYPER_L" value="16777263"> + <constant name="KEY_HYPER_L" value="16777263" enum="KeyList"> Left Hyper Key </constant> - <constant name="KEY_HYPER_R" value="16777264"> + <constant name="KEY_HYPER_R" value="16777264" enum="KeyList"> Right Hyper Key </constant> - <constant name="KEY_HELP" value="16777265"> + <constant name="KEY_HELP" value="16777265" enum="KeyList"> Help key </constant> - <constant name="KEY_DIRECTION_L" value="16777266"> + <constant name="KEY_DIRECTION_L" value="16777266" enum="KeyList"> Left Direction Key </constant> - <constant name="KEY_DIRECTION_R" value="16777267"> + <constant name="KEY_DIRECTION_R" value="16777267" enum="KeyList"> Right Direction Key </constant> - <constant name="KEY_BACK" value="16777280"> + <constant name="KEY_BACK" value="16777280" enum="KeyList"> Back key </constant> - <constant name="KEY_FORWARD" value="16777281"> + <constant name="KEY_FORWARD" value="16777281" enum="KeyList"> Forward key </constant> - <constant name="KEY_STOP" value="16777282"> + <constant name="KEY_STOP" value="16777282" enum="KeyList"> Stop key </constant> - <constant name="KEY_REFRESH" value="16777283"> + <constant name="KEY_REFRESH" value="16777283" enum="KeyList"> Refresh key </constant> - <constant name="KEY_VOLUMEDOWN" value="16777284"> + <constant name="KEY_VOLUMEDOWN" value="16777284" enum="KeyList"> Volume down key </constant> - <constant name="KEY_VOLUMEMUTE" value="16777285"> + <constant name="KEY_VOLUMEMUTE" value="16777285" enum="KeyList"> Mute volume key </constant> - <constant name="KEY_VOLUMEUP" value="16777286"> + <constant name="KEY_VOLUMEUP" value="16777286" enum="KeyList"> Volume up key </constant> - <constant name="KEY_BASSBOOST" value="16777287"> + <constant name="KEY_BASSBOOST" value="16777287" enum="KeyList"> Bass Boost Key </constant> - <constant name="KEY_BASSUP" value="16777288"> + <constant name="KEY_BASSUP" value="16777288" enum="KeyList"> Bass Up Key </constant> - <constant name="KEY_BASSDOWN" value="16777289"> + <constant name="KEY_BASSDOWN" value="16777289" enum="KeyList"> Bass Down Key </constant> - <constant name="KEY_TREBLEUP" value="16777290"> + <constant name="KEY_TREBLEUP" value="16777290" enum="KeyList"> Treble Up Key </constant> - <constant name="KEY_TREBLEDOWN" value="16777291"> + <constant name="KEY_TREBLEDOWN" value="16777291" enum="KeyList"> Treble Down Key </constant> - <constant name="KEY_MEDIAPLAY" value="16777292"> + <constant name="KEY_MEDIAPLAY" value="16777292" enum="KeyList"> Media play key </constant> - <constant name="KEY_MEDIASTOP" value="16777293"> + <constant name="KEY_MEDIASTOP" value="16777293" enum="KeyList"> Media stop key </constant> - <constant name="KEY_MEDIAPREVIOUS" value="16777294"> + <constant name="KEY_MEDIAPREVIOUS" value="16777294" enum="KeyList"> Previous song key </constant> - <constant name="KEY_MEDIANEXT" value="16777295"> + <constant name="KEY_MEDIANEXT" value="16777295" enum="KeyList"> Next song key </constant> - <constant name="KEY_MEDIARECORD" value="16777296"> + <constant name="KEY_MEDIARECORD" value="16777296" enum="KeyList"> Media record key </constant> - <constant name="KEY_HOMEPAGE" value="16777297"> + <constant name="KEY_HOMEPAGE" value="16777297" enum="KeyList"> Home page key </constant> - <constant name="KEY_FAVORITES" value="16777298"> + <constant name="KEY_FAVORITES" value="16777298" enum="KeyList"> Favorites key </constant> - <constant name="KEY_SEARCH" value="16777299"> + <constant name="KEY_SEARCH" value="16777299" enum="KeyList"> Search key </constant> - <constant name="KEY_STANDBY" value="16777300"> + <constant name="KEY_STANDBY" value="16777300" enum="KeyList"> Standby Key </constant> - <constant name="KEY_OPENURL" value="16777301"> + <constant name="KEY_OPENURL" value="16777301" enum="KeyList"> Open URL / Launch Browser Key </constant> - <constant name="KEY_LAUNCHMAIL" value="16777302"> + <constant name="KEY_LAUNCHMAIL" value="16777302" enum="KeyList"> Launch Mail Key </constant> - <constant name="KEY_LAUNCHMEDIA" value="16777303"> + <constant name="KEY_LAUNCHMEDIA" value="16777303" enum="KeyList"> Launch Media Key </constant> - <constant name="KEY_LAUNCH0" value="16777304"> + <constant name="KEY_LAUNCH0" value="16777304" enum="KeyList"> Launch Shortcut 0 Key </constant> - <constant name="KEY_LAUNCH1" value="16777305"> + <constant name="KEY_LAUNCH1" value="16777305" enum="KeyList"> Launch Shortcut 1 Key </constant> - <constant name="KEY_LAUNCH2" value="16777306"> + <constant name="KEY_LAUNCH2" value="16777306" enum="KeyList"> Launch Shortcut 2 Key </constant> - <constant name="KEY_LAUNCH3" value="16777307"> + <constant name="KEY_LAUNCH3" value="16777307" enum="KeyList"> Launch Shortcut 3 Key </constant> - <constant name="KEY_LAUNCH4" value="16777308"> + <constant name="KEY_LAUNCH4" value="16777308" enum="KeyList"> Launch Shortcut 4 Key </constant> - <constant name="KEY_LAUNCH5" value="16777309"> + <constant name="KEY_LAUNCH5" value="16777309" enum="KeyList"> Launch Shortcut 5 Key </constant> - <constant name="KEY_LAUNCH6" value="16777310"> + <constant name="KEY_LAUNCH6" value="16777310" enum="KeyList"> Launch Shortcut 6 Key </constant> - <constant name="KEY_LAUNCH7" value="16777311"> + <constant name="KEY_LAUNCH7" value="16777311" enum="KeyList"> Launch Shortcut 7 Key </constant> - <constant name="KEY_LAUNCH8" value="16777312"> + <constant name="KEY_LAUNCH8" value="16777312" enum="KeyList"> Launch Shortcut 8 Key </constant> - <constant name="KEY_LAUNCH9" value="16777313"> + <constant name="KEY_LAUNCH9" value="16777313" enum="KeyList"> Launch Shortcut 9 Key </constant> - <constant name="KEY_LAUNCHA" value="16777314"> + <constant name="KEY_LAUNCHA" value="16777314" enum="KeyList"> Launch Shortcut A Key </constant> - <constant name="KEY_LAUNCHB" value="16777315"> + <constant name="KEY_LAUNCHB" value="16777315" enum="KeyList"> Launch Shortcut B Key </constant> - <constant name="KEY_LAUNCHC" value="16777316"> + <constant name="KEY_LAUNCHC" value="16777316" enum="KeyList"> Launch Shortcut C Key </constant> - <constant name="KEY_LAUNCHD" value="16777317"> + <constant name="KEY_LAUNCHD" value="16777317" enum="KeyList"> Launch Shortcut D Key </constant> - <constant name="KEY_LAUNCHE" value="16777318"> + <constant name="KEY_LAUNCHE" value="16777318" enum="KeyList"> Launch Shortcut E Key </constant> - <constant name="KEY_LAUNCHF" value="16777319"> + <constant name="KEY_LAUNCHF" value="16777319" enum="KeyList"> Launch Shortcut F Key </constant> - <constant name="KEY_UNKNOWN" value="33554431"> + <constant name="KEY_UNKNOWN" value="33554431" enum="KeyList"> Unknown Key </constant> - <constant name="KEY_SPACE" value="32"> + <constant name="KEY_SPACE" value="32" enum="KeyList"> Space Key </constant> - <constant name="KEY_EXCLAM" value="33"> + <constant name="KEY_EXCLAM" value="33" enum="KeyList"> ! key </constant> - <constant name="KEY_QUOTEDBL" value="34"> + <constant name="KEY_QUOTEDBL" value="34" enum="KeyList"> " key </constant> - <constant name="KEY_NUMBERSIGN" value="35"> + <constant name="KEY_NUMBERSIGN" value="35" enum="KeyList"> # key </constant> - <constant name="KEY_DOLLAR" value="36"> + <constant name="KEY_DOLLAR" value="36" enum="KeyList"> $ key </constant> - <constant name="KEY_PERCENT" value="37"> + <constant name="KEY_PERCENT" value="37" enum="KeyList"> % key </constant> - <constant name="KEY_AMPERSAND" value="38"> + <constant name="KEY_AMPERSAND" value="38" enum="KeyList"> & key </constant> - <constant name="KEY_APOSTROPHE" value="39"> + <constant name="KEY_APOSTROPHE" value="39" enum="KeyList"> ' key </constant> - <constant name="KEY_PARENLEFT" value="40"> + <constant name="KEY_PARENLEFT" value="40" enum="KeyList"> ( key </constant> - <constant name="KEY_PARENRIGHT" value="41"> + <constant name="KEY_PARENRIGHT" value="41" enum="KeyList"> ) key </constant> - <constant name="KEY_ASTERISK" value="42"> + <constant name="KEY_ASTERISK" value="42" enum="KeyList"> * key </constant> - <constant name="KEY_PLUS" value="43"> + <constant name="KEY_PLUS" value="43" enum="KeyList"> + key </constant> - <constant name="KEY_COMMA" value="44"> + <constant name="KEY_COMMA" value="44" enum="KeyList"> , key </constant> - <constant name="KEY_MINUS" value="45"> + <constant name="KEY_MINUS" value="45" enum="KeyList"> - key </constant> - <constant name="KEY_PERIOD" value="46"> + <constant name="KEY_PERIOD" value="46" enum="KeyList"> . key </constant> - <constant name="KEY_SLASH" value="47"> + <constant name="KEY_SLASH" value="47" enum="KeyList"> / key </constant> - <constant name="KEY_0" value="48"> + <constant name="KEY_0" value="48" enum="KeyList"> Number 0 </constant> - <constant name="KEY_1" value="49"> + <constant name="KEY_1" value="49" enum="KeyList"> Number 1 </constant> - <constant name="KEY_2" value="50"> + <constant name="KEY_2" value="50" enum="KeyList"> Number 2 </constant> - <constant name="KEY_3" value="51"> + <constant name="KEY_3" value="51" enum="KeyList"> Number 3 </constant> - <constant name="KEY_4" value="52"> + <constant name="KEY_4" value="52" enum="KeyList"> Number 4 </constant> - <constant name="KEY_5" value="53"> + <constant name="KEY_5" value="53" enum="KeyList"> Number 5 </constant> - <constant name="KEY_6" value="54"> + <constant name="KEY_6" value="54" enum="KeyList"> Number 6 </constant> - <constant name="KEY_7" value="55"> + <constant name="KEY_7" value="55" enum="KeyList"> Number 7 </constant> - <constant name="KEY_8" value="56"> + <constant name="KEY_8" value="56" enum="KeyList"> Number 8 </constant> - <constant name="KEY_9" value="57"> + <constant name="KEY_9" value="57" enum="KeyList"> Number 9 </constant> - <constant name="KEY_COLON" value="58"> + <constant name="KEY_COLON" value="58" enum="KeyList"> : key </constant> - <constant name="KEY_SEMICOLON" value="59"> + <constant name="KEY_SEMICOLON" value="59" enum="KeyList"> ; key </constant> - <constant name="KEY_LESS" value="60"> + <constant name="KEY_LESS" value="60" enum="KeyList"> Lower than key </constant> - <constant name="KEY_EQUAL" value="61"> + <constant name="KEY_EQUAL" value="61" enum="KeyList"> = key </constant> - <constant name="KEY_GREATER" value="62"> + <constant name="KEY_GREATER" value="62" enum="KeyList"> Greater than key </constant> - <constant name="KEY_QUESTION" value="63"> + <constant name="KEY_QUESTION" value="63" enum="KeyList"> ? key </constant> - <constant name="KEY_AT" value="64"> + <constant name="KEY_AT" value="64" enum="KeyList"> @ key </constant> - <constant name="KEY_A" value="65"> + <constant name="KEY_A" value="65" enum="KeyList"> A Key </constant> - <constant name="KEY_B" value="66"> + <constant name="KEY_B" value="66" enum="KeyList"> B Key </constant> - <constant name="KEY_C" value="67"> + <constant name="KEY_C" value="67" enum="KeyList"> C Key </constant> - <constant name="KEY_D" value="68"> + <constant name="KEY_D" value="68" enum="KeyList"> D Key </constant> - <constant name="KEY_E" value="69"> + <constant name="KEY_E" value="69" enum="KeyList"> E Key </constant> - <constant name="KEY_F" value="70"> + <constant name="KEY_F" value="70" enum="KeyList"> F Key </constant> - <constant name="KEY_G" value="71"> + <constant name="KEY_G" value="71" enum="KeyList"> G Key </constant> - <constant name="KEY_H" value="72"> + <constant name="KEY_H" value="72" enum="KeyList"> H Key </constant> - <constant name="KEY_I" value="73"> + <constant name="KEY_I" value="73" enum="KeyList"> I Key </constant> - <constant name="KEY_J" value="74"> + <constant name="KEY_J" value="74" enum="KeyList"> J Key </constant> - <constant name="KEY_K" value="75"> + <constant name="KEY_K" value="75" enum="KeyList"> K Key </constant> - <constant name="KEY_L" value="76"> + <constant name="KEY_L" value="76" enum="KeyList"> L Key </constant> - <constant name="KEY_M" value="77"> + <constant name="KEY_M" value="77" enum="KeyList"> M Key </constant> - <constant name="KEY_N" value="78"> + <constant name="KEY_N" value="78" enum="KeyList"> N Key </constant> - <constant name="KEY_O" value="79"> + <constant name="KEY_O" value="79" enum="KeyList"> O Key </constant> - <constant name="KEY_P" value="80"> + <constant name="KEY_P" value="80" enum="KeyList"> P Key </constant> - <constant name="KEY_Q" value="81"> + <constant name="KEY_Q" value="81" enum="KeyList"> Q Key </constant> - <constant name="KEY_R" value="82"> + <constant name="KEY_R" value="82" enum="KeyList"> R Key </constant> - <constant name="KEY_S" value="83"> + <constant name="KEY_S" value="83" enum="KeyList"> S Key </constant> - <constant name="KEY_T" value="84"> + <constant name="KEY_T" value="84" enum="KeyList"> T Key </constant> - <constant name="KEY_U" value="85"> + <constant name="KEY_U" value="85" enum="KeyList"> U Key </constant> - <constant name="KEY_V" value="86"> + <constant name="KEY_V" value="86" enum="KeyList"> V Key </constant> - <constant name="KEY_W" value="87"> + <constant name="KEY_W" value="87" enum="KeyList"> W Key </constant> - <constant name="KEY_X" value="88"> + <constant name="KEY_X" value="88" enum="KeyList"> X Key </constant> - <constant name="KEY_Y" value="89"> + <constant name="KEY_Y" value="89" enum="KeyList"> Y Key </constant> - <constant name="KEY_Z" value="90"> + <constant name="KEY_Z" value="90" enum="KeyList"> Z Key </constant> - <constant name="KEY_BRACKETLEFT" value="91"> + <constant name="KEY_BRACKETLEFT" value="91" enum="KeyList"> [ key </constant> - <constant name="KEY_BACKSLASH" value="92"> + <constant name="KEY_BACKSLASH" value="92" enum="KeyList"> \ key </constant> - <constant name="KEY_BRACKETRIGHT" value="93"> + <constant name="KEY_BRACKETRIGHT" value="93" enum="KeyList"> ] key </constant> - <constant name="KEY_ASCIICIRCUM" value="94"> + <constant name="KEY_ASCIICIRCUM" value="94" enum="KeyList"> ^ key </constant> - <constant name="KEY_UNDERSCORE" value="95"> + <constant name="KEY_UNDERSCORE" value="95" enum="KeyList"> _ key </constant> - <constant name="KEY_QUOTELEFT" value="96"> + <constant name="KEY_QUOTELEFT" value="96" enum="KeyList"> Left Quote Key </constant> - <constant name="KEY_BRACELEFT" value="123"> + <constant name="KEY_BRACELEFT" value="123" enum="KeyList"> { key </constant> - <constant name="KEY_BAR" value="124"> + <constant name="KEY_BAR" value="124" enum="KeyList"> | key </constant> - <constant name="KEY_BRACERIGHT" value="125"> + <constant name="KEY_BRACERIGHT" value="125" enum="KeyList"> } key </constant> - <constant name="KEY_ASCIITILDE" value="126"> + <constant name="KEY_ASCIITILDE" value="126" enum="KeyList"> ~ key </constant> - <constant name="KEY_NOBREAKSPACE" value="160"> + <constant name="KEY_NOBREAKSPACE" value="160" enum="KeyList"> </constant> - <constant name="KEY_EXCLAMDOWN" value="161"> + <constant name="KEY_EXCLAMDOWN" value="161" enum="KeyList"> </constant> - <constant name="KEY_CENT" value="162"> + <constant name="KEY_CENT" value="162" enum="KeyList"> ¢ key </constant> - <constant name="KEY_STERLING" value="163"> + <constant name="KEY_STERLING" value="163" enum="KeyList"> </constant> - <constant name="KEY_CURRENCY" value="164"> + <constant name="KEY_CURRENCY" value="164" enum="KeyList"> </constant> - <constant name="KEY_YEN" value="165"> + <constant name="KEY_YEN" value="165" enum="KeyList"> Yen Key </constant> - <constant name="KEY_BROKENBAR" value="166"> + <constant name="KEY_BROKENBAR" value="166" enum="KeyList"> ¦ key </constant> - <constant name="KEY_SECTION" value="167"> + <constant name="KEY_SECTION" value="167" enum="KeyList"> § key </constant> - <constant name="KEY_DIAERESIS" value="168"> + <constant name="KEY_DIAERESIS" value="168" enum="KeyList"> ¨ key </constant> - <constant name="KEY_COPYRIGHT" value="169"> + <constant name="KEY_COPYRIGHT" value="169" enum="KeyList"> © key </constant> - <constant name="KEY_ORDFEMININE" value="170"> + <constant name="KEY_ORDFEMININE" value="170" enum="KeyList"> </constant> - <constant name="KEY_GUILLEMOTLEFT" value="171"> + <constant name="KEY_GUILLEMOTLEFT" value="171" enum="KeyList"> « key </constant> - <constant name="KEY_NOTSIGN" value="172"> + <constant name="KEY_NOTSIGN" value="172" enum="KeyList"> » key </constant> - <constant name="KEY_HYPHEN" value="173"> + <constant name="KEY_HYPHEN" value="173" enum="KeyList"> ‐ key </constant> - <constant name="KEY_REGISTERED" value="174"> + <constant name="KEY_REGISTERED" value="174" enum="KeyList"> ® key </constant> - <constant name="KEY_MACRON" value="175"> + <constant name="KEY_MACRON" value="175" enum="KeyList"> Macron Key </constant> - <constant name="KEY_DEGREE" value="176"> + <constant name="KEY_DEGREE" value="176" enum="KeyList"> ° key </constant> - <constant name="KEY_PLUSMINUS" value="177"> + <constant name="KEY_PLUSMINUS" value="177" enum="KeyList"> ± key </constant> - <constant name="KEY_TWOSUPERIOR" value="178"> + <constant name="KEY_TWOSUPERIOR" value="178" enum="KeyList"> ² key </constant> - <constant name="KEY_THREESUPERIOR" value="179"> + <constant name="KEY_THREESUPERIOR" value="179" enum="KeyList"> ³ key </constant> - <constant name="KEY_ACUTE" value="180"> + <constant name="KEY_ACUTE" value="180" enum="KeyList"> ´ key </constant> - <constant name="KEY_MU" value="181"> + <constant name="KEY_MU" value="181" enum="KeyList"> µ key </constant> - <constant name="KEY_PARAGRAPH" value="182"> + <constant name="KEY_PARAGRAPH" value="182" enum="KeyList"> Paragraph Key </constant> - <constant name="KEY_PERIODCENTERED" value="183"> + <constant name="KEY_PERIODCENTERED" value="183" enum="KeyList"> · key </constant> - <constant name="KEY_CEDILLA" value="184"> + <constant name="KEY_CEDILLA" value="184" enum="KeyList"> ¬ key </constant> - <constant name="KEY_ONESUPERIOR" value="185"> + <constant name="KEY_ONESUPERIOR" value="185" enum="KeyList"> ¹ key </constant> - <constant name="KEY_MASCULINE" value="186"> + <constant name="KEY_MASCULINE" value="186" enum="KeyList"> ♂ key </constant> - <constant name="KEY_GUILLEMOTRIGHT" value="187"> + <constant name="KEY_GUILLEMOTRIGHT" value="187" enum="KeyList"> » key </constant> - <constant name="KEY_ONEQUARTER" value="188"> + <constant name="KEY_ONEQUARTER" value="188" enum="KeyList"> ¼ key </constant> - <constant name="KEY_ONEHALF" value="189"> + <constant name="KEY_ONEHALF" value="189" enum="KeyList"> ½ key </constant> - <constant name="KEY_THREEQUARTERS" value="190"> + <constant name="KEY_THREEQUARTERS" value="190" enum="KeyList"> ¾ key </constant> - <constant name="KEY_QUESTIONDOWN" value="191"> + <constant name="KEY_QUESTIONDOWN" value="191" enum="KeyList"> ¿ key </constant> - <constant name="KEY_AGRAVE" value="192"> + <constant name="KEY_AGRAVE" value="192" enum="KeyList"> à key </constant> - <constant name="KEY_AACUTE" value="193"> + <constant name="KEY_AACUTE" value="193" enum="KeyList"> á key </constant> - <constant name="KEY_ACIRCUMFLEX" value="194"> + <constant name="KEY_ACIRCUMFLEX" value="194" enum="KeyList"> â key </constant> - <constant name="KEY_ATILDE" value="195"> + <constant name="KEY_ATILDE" value="195" enum="KeyList"> ã key </constant> - <constant name="KEY_ADIAERESIS" value="196"> + <constant name="KEY_ADIAERESIS" value="196" enum="KeyList"> ä key </constant> - <constant name="KEY_ARING" value="197"> + <constant name="KEY_ARING" value="197" enum="KeyList"> å key </constant> - <constant name="KEY_AE" value="198"> + <constant name="KEY_AE" value="198" enum="KeyList"> æ key </constant> - <constant name="KEY_CCEDILLA" value="199"> + <constant name="KEY_CCEDILLA" value="199" enum="KeyList"> ç key </constant> - <constant name="KEY_EGRAVE" value="200"> + <constant name="KEY_EGRAVE" value="200" enum="KeyList"> è key </constant> - <constant name="KEY_EACUTE" value="201"> + <constant name="KEY_EACUTE" value="201" enum="KeyList"> é key </constant> - <constant name="KEY_ECIRCUMFLEX" value="202"> + <constant name="KEY_ECIRCUMFLEX" value="202" enum="KeyList"> ê key </constant> - <constant name="KEY_EDIAERESIS" value="203"> + <constant name="KEY_EDIAERESIS" value="203" enum="KeyList"> ë key </constant> - <constant name="KEY_IGRAVE" value="204"> + <constant name="KEY_IGRAVE" value="204" enum="KeyList"> ì key </constant> - <constant name="KEY_IACUTE" value="205"> + <constant name="KEY_IACUTE" value="205" enum="KeyList"> í key </constant> - <constant name="KEY_ICIRCUMFLEX" value="206"> + <constant name="KEY_ICIRCUMFLEX" value="206" enum="KeyList"> î key </constant> - <constant name="KEY_IDIAERESIS" value="207"> + <constant name="KEY_IDIAERESIS" value="207" enum="KeyList"> ë key </constant> - <constant name="KEY_ETH" value="208"> + <constant name="KEY_ETH" value="208" enum="KeyList"> ð key </constant> - <constant name="KEY_NTILDE" value="209"> + <constant name="KEY_NTILDE" value="209" enum="KeyList"> ñ key </constant> - <constant name="KEY_OGRAVE" value="210"> + <constant name="KEY_OGRAVE" value="210" enum="KeyList"> ò key </constant> - <constant name="KEY_OACUTE" value="211"> + <constant name="KEY_OACUTE" value="211" enum="KeyList"> ó key </constant> - <constant name="KEY_OCIRCUMFLEX" value="212"> + <constant name="KEY_OCIRCUMFLEX" value="212" enum="KeyList"> ô key </constant> - <constant name="KEY_OTILDE" value="213"> + <constant name="KEY_OTILDE" value="213" enum="KeyList"> õ key </constant> - <constant name="KEY_ODIAERESIS" value="214"> + <constant name="KEY_ODIAERESIS" value="214" enum="KeyList"> ö key </constant> - <constant name="KEY_MULTIPLY" value="215"> + <constant name="KEY_MULTIPLY" value="215" enum="KeyList"> × key </constant> - <constant name="KEY_OOBLIQUE" value="216"> + <constant name="KEY_OOBLIQUE" value="216" enum="KeyList"> ø key </constant> - <constant name="KEY_UGRAVE" value="217"> + <constant name="KEY_UGRAVE" value="217" enum="KeyList"> ù key </constant> - <constant name="KEY_UACUTE" value="218"> + <constant name="KEY_UACUTE" value="218" enum="KeyList"> ú key </constant> - <constant name="KEY_UCIRCUMFLEX" value="219"> + <constant name="KEY_UCIRCUMFLEX" value="219" enum="KeyList"> û key </constant> - <constant name="KEY_UDIAERESIS" value="220"> + <constant name="KEY_UDIAERESIS" value="220" enum="KeyList"> ü key </constant> - <constant name="KEY_YACUTE" value="221"> + <constant name="KEY_YACUTE" value="221" enum="KeyList"> ý key </constant> - <constant name="KEY_THORN" value="222"> + <constant name="KEY_THORN" value="222" enum="KeyList"> þ key </constant> - <constant name="KEY_SSHARP" value="223"> + <constant name="KEY_SSHARP" value="223" enum="KeyList"> ß key </constant> - <constant name="KEY_DIVISION" value="247"> + <constant name="KEY_DIVISION" value="247" enum="KeyList"> ÷ key </constant> - <constant name="KEY_YDIAERESIS" value="255"> + <constant name="KEY_YDIAERESIS" value="255" enum="KeyList"> ÿ key </constant> - <constant name="KEY_CODE_MASK" value="33554431"> + <constant name="KEY_CODE_MASK" value="33554431" enum="KeyModifierMask"> Key Code Mask </constant> - <constant name="KEY_MODIFIER_MASK" value="-16777216"> + <constant name="KEY_MODIFIER_MASK" value="-16777216" enum="KeyModifierMask"> Modifier Key Mask </constant> - <constant name="KEY_MASK_SHIFT" value="33554432"> + <constant name="KEY_MASK_SHIFT" value="33554432" enum="KeyModifierMask"> Shift Key Mask </constant> - <constant name="KEY_MASK_ALT" value="67108864"> + <constant name="KEY_MASK_ALT" value="67108864" enum="KeyModifierMask"> Alt Key Mask </constant> - <constant name="KEY_MASK_META" value="134217728"> + <constant name="KEY_MASK_META" value="134217728" enum="KeyModifierMask"> Meta Key Mask </constant> - <constant name="KEY_MASK_CTRL" value="268435456"> + <constant name="KEY_MASK_CTRL" value="268435456" enum="KeyModifierMask"> CTRL Key Mask </constant> - <constant name="KEY_MASK_CMD" value="268435456"> + <constant name="KEY_MASK_CMD" value="268435456" enum="KeyModifierMask"> CMD Key Mask </constant> - <constant name="KEY_MASK_KPAD" value="536870912"> + <constant name="KEY_MASK_KPAD" value="536870912" enum="KeyModifierMask"> Keypad Key Mask </constant> - <constant name="KEY_MASK_GROUP_SWITCH" value="1073741824"> + <constant name="KEY_MASK_GROUP_SWITCH" value="1073741824" enum="KeyModifierMask"> Group Switch Key Mask </constant> - <constant name="BUTTON_LEFT" value="1"> + <constant name="BUTTON_LEFT" value="1" enum="ButtonList"> Left Mouse Button </constant> - <constant name="BUTTON_RIGHT" value="2"> + <constant name="BUTTON_RIGHT" value="2" enum="ButtonList"> Right Mouse Button </constant> - <constant name="BUTTON_MIDDLE" value="3"> + <constant name="BUTTON_MIDDLE" value="3" enum="ButtonList"> Middle Mouse Button </constant> - <constant name="BUTTON_WHEEL_UP" value="4"> + <constant name="BUTTON_WHEEL_UP" value="4" enum="ButtonList"> Mouse wheel up </constant> - <constant name="BUTTON_WHEEL_DOWN" value="5"> + <constant name="BUTTON_WHEEL_DOWN" value="5" enum="ButtonList"> Mouse wheel down </constant> - <constant name="BUTTON_WHEEL_LEFT" value="6"> + <constant name="BUTTON_WHEEL_LEFT" value="6" enum="ButtonList"> Mouse wheel left button </constant> - <constant name="BUTTON_WHEEL_RIGHT" value="7"> + <constant name="BUTTON_WHEEL_RIGHT" value="7" enum="ButtonList"> Mouse wheel right button </constant> - <constant name="BUTTON_MASK_LEFT" value="1"> + <constant name="BUTTON_MASK_LEFT" value="1" enum="ButtonList"> Left Mouse Button Mask </constant> - <constant name="BUTTON_MASK_RIGHT" value="2"> + <constant name="BUTTON_MASK_RIGHT" value="2" enum="ButtonList"> Right Mouse Button Mask </constant> - <constant name="BUTTON_MASK_MIDDLE" value="4"> + <constant name="BUTTON_MASK_MIDDLE" value="4" enum="ButtonList"> Middle Mouse Button Mask </constant> - <constant name="JOY_BUTTON_0" value="0"> + <constant name="JOY_BUTTON_0" value="0" enum="JoystickList"> Joypad Button 0 </constant> - <constant name="JOY_BUTTON_1" value="1"> + <constant name="JOY_BUTTON_1" value="1" enum="JoystickList"> Joypad Button 1 </constant> - <constant name="JOY_BUTTON_2" value="2"> + <constant name="JOY_BUTTON_2" value="2" enum="JoystickList"> Joypad Button 2 </constant> - <constant name="JOY_BUTTON_3" value="3"> + <constant name="JOY_BUTTON_3" value="3" enum="JoystickList"> Joypad Button 3 </constant> - <constant name="JOY_BUTTON_4" value="4"> + <constant name="JOY_BUTTON_4" value="4" enum="JoystickList"> Joypad Button 4 </constant> - <constant name="JOY_BUTTON_5" value="5"> + <constant name="JOY_BUTTON_5" value="5" enum="JoystickList"> Joypad Button 5 </constant> - <constant name="JOY_BUTTON_6" value="6"> + <constant name="JOY_BUTTON_6" value="6" enum="JoystickList"> Joypad Button 6 </constant> - <constant name="JOY_BUTTON_7" value="7"> + <constant name="JOY_BUTTON_7" value="7" enum="JoystickList"> Joypad Button 7 </constant> - <constant name="JOY_BUTTON_8" value="8"> + <constant name="JOY_BUTTON_8" value="8" enum="JoystickList"> Joypad Button 8 </constant> - <constant name="JOY_BUTTON_9" value="9"> + <constant name="JOY_BUTTON_9" value="9" enum="JoystickList"> Joypad Button 9 </constant> - <constant name="JOY_BUTTON_10" value="10"> + <constant name="JOY_BUTTON_10" value="10" enum="JoystickList"> Joypad Button 10 </constant> - <constant name="JOY_BUTTON_11" value="11"> + <constant name="JOY_BUTTON_11" value="11" enum="JoystickList"> Joypad Button 11 </constant> - <constant name="JOY_BUTTON_12" value="12"> + <constant name="JOY_BUTTON_12" value="12" enum="JoystickList"> Joypad Button 12 </constant> - <constant name="JOY_BUTTON_13" value="13"> + <constant name="JOY_BUTTON_13" value="13" enum="JoystickList"> Joypad Button 13 </constant> - <constant name="JOY_BUTTON_14" value="14"> + <constant name="JOY_BUTTON_14" value="14" enum="JoystickList"> Joypad Button 14 </constant> - <constant name="JOY_BUTTON_15" value="15"> + <constant name="JOY_BUTTON_15" value="15" enum="JoystickList"> Joypad Button 15 </constant> - <constant name="JOY_BUTTON_MAX" value="16"> + <constant name="JOY_BUTTON_MAX" value="16" enum="JoystickList"> Joypad Button 16 </constant> - <constant name="JOY_SONY_CIRCLE" value="1"> + <constant name="JOY_SONY_CIRCLE" value="1" enum="JoystickList"> DUALSHOCK circle button </constant> - <constant name="JOY_SONY_X" value="0"> + <constant name="JOY_SONY_X" value="0" enum="JoystickList"> DUALSHOCK X button </constant> - <constant name="JOY_SONY_SQUARE" value="2"> + <constant name="JOY_SONY_SQUARE" value="2" enum="JoystickList"> DUALSHOCK square button </constant> - <constant name="JOY_SONY_TRIANGLE" value="3"> + <constant name="JOY_SONY_TRIANGLE" value="3" enum="JoystickList"> DUALSHOCK triangle button </constant> - <constant name="JOY_XBOX_B" value="1"> + <constant name="JOY_XBOX_B" value="1" enum="JoystickList"> XBOX controller B button </constant> - <constant name="JOY_XBOX_A" value="0"> + <constant name="JOY_XBOX_A" value="0" enum="JoystickList"> XBOX controller A button </constant> - <constant name="JOY_XBOX_X" value="2"> + <constant name="JOY_XBOX_X" value="2" enum="JoystickList"> XBOX controller X button </constant> - <constant name="JOY_XBOX_Y" value="3"> + <constant name="JOY_XBOX_Y" value="3" enum="JoystickList"> XBOX controller Y button </constant> - <constant name="JOY_DS_A" value="1"> + <constant name="JOY_DS_A" value="1" enum="JoystickList"> DualShock controller A button </constant> - <constant name="JOY_DS_B" value="0"> + <constant name="JOY_DS_B" value="0" enum="JoystickList"> DualShock controller B button </constant> - <constant name="JOY_DS_X" value="3"> + <constant name="JOY_DS_X" value="3" enum="JoystickList"> DualShock controller X button </constant> - <constant name="JOY_DS_Y" value="2"> + <constant name="JOY_DS_Y" value="2" enum="JoystickList"> DualShock controller Y button </constant> - <constant name="JOY_SELECT" value="10"> + <constant name="JOY_SELECT" value="10" enum="JoystickList"> Joypad Button Select </constant> - <constant name="JOY_START" value="11"> + <constant name="JOY_START" value="11" enum="JoystickList"> Joypad Button Start </constant> - <constant name="JOY_DPAD_UP" value="12"> + <constant name="JOY_DPAD_UP" value="12" enum="JoystickList"> Joypad DPad Up </constant> - <constant name="JOY_DPAD_DOWN" value="13"> + <constant name="JOY_DPAD_DOWN" value="13" enum="JoystickList"> Joypad DPad Down </constant> - <constant name="JOY_DPAD_LEFT" value="14"> + <constant name="JOY_DPAD_LEFT" value="14" enum="JoystickList"> Joypad DPad Left </constant> - <constant name="JOY_DPAD_RIGHT" value="15"> + <constant name="JOY_DPAD_RIGHT" value="15" enum="JoystickList"> Joypad DPad Right </constant> - <constant name="JOY_L" value="4"> + <constant name="JOY_L" value="4" enum="JoystickList"> Joypad Left Shoulder Button </constant> - <constant name="JOY_L2" value="6"> + <constant name="JOY_L2" value="6" enum="JoystickList"> Joypad Left Trigger </constant> - <constant name="JOY_L3" value="8"> + <constant name="JOY_L3" value="8" enum="JoystickList"> Joypad Left Stick Click </constant> - <constant name="JOY_R" value="5"> + <constant name="JOY_R" value="5" enum="JoystickList"> Joypad Right Shoulder Button </constant> - <constant name="JOY_R2" value="7"> + <constant name="JOY_R2" value="7" enum="JoystickList"> Joypad Right Trigger </constant> - <constant name="JOY_R3" value="9"> + <constant name="JOY_R3" value="9" enum="JoystickList"> Joypad Right Stick Click </constant> - <constant name="JOY_AXIS_0" value="0"> + <constant name="JOY_AXIS_0" value="0" enum="JoystickList"> Joypad Left Stick Horizontal Axis </constant> - <constant name="JOY_AXIS_1" value="1"> + <constant name="JOY_AXIS_1" value="1" enum="JoystickList"> Joypad Left Stick Vertical Axis </constant> - <constant name="JOY_AXIS_2" value="2"> + <constant name="JOY_AXIS_2" value="2" enum="JoystickList"> Joypad Right Stick Horizontal Axis </constant> - <constant name="JOY_AXIS_3" value="3"> + <constant name="JOY_AXIS_3" value="3" enum="JoystickList"> Joypad Right Stick Vertical Axis </constant> - <constant name="JOY_AXIS_4" value="4"> + <constant name="JOY_AXIS_4" value="4" enum="JoystickList"> </constant> - <constant name="JOY_AXIS_5" value="5"> + <constant name="JOY_AXIS_5" value="5" enum="JoystickList"> </constant> - <constant name="JOY_AXIS_6" value="6"> + <constant name="JOY_AXIS_6" value="6" enum="JoystickList"> Joypad Left Trigger Analog Axis </constant> - <constant name="JOY_AXIS_7" value="7"> + <constant name="JOY_AXIS_7" value="7" enum="JoystickList"> Joypad Right Trigger Analog Axis </constant> - <constant name="JOY_AXIS_8" value="8"> + <constant name="JOY_AXIS_8" value="8" enum="JoystickList"> </constant> - <constant name="JOY_AXIS_9" value="9"> + <constant name="JOY_AXIS_9" value="9" enum="JoystickList"> </constant> - <constant name="JOY_AXIS_MAX" value="10"> + <constant name="JOY_AXIS_MAX" value="10" enum="JoystickList"> </constant> - <constant name="JOY_ANALOG_LX" value="0"> + <constant name="JOY_ANALOG_LX" value="0" enum="JoystickList"> Joypad Left Stick Horizontal Axis </constant> - <constant name="JOY_ANALOG_LY" value="1"> + <constant name="JOY_ANALOG_LY" value="1" enum="JoystickList"> Joypad Left Stick Vertical Axis </constant> - <constant name="JOY_ANALOG_RX" value="2"> + <constant name="JOY_ANALOG_RX" value="2" enum="JoystickList"> Joypad Right Stick Horizontal Axis </constant> - <constant name="JOY_ANALOG_RY" value="3"> + <constant name="JOY_ANALOG_RY" value="3" enum="JoystickList"> Joypad Right Stick Vertical Axis </constant> - <constant name="JOY_ANALOG_L2" value="6"> + <constant name="JOY_ANALOG_L2" value="6" enum="JoystickList"> Joypad Left Analog Trigger </constant> - <constant name="JOY_ANALOG_R2" value="7"> + <constant name="JOY_ANALOG_R2" value="7" enum="JoystickList"> Joypad Right Analog Trigger </constant> - <constant name="OK" value="0"> + <constant name="OK" value="0" enum="Error"> Functions that return Error return OK when no error occured. Most functions don't return errors and/or just print errors to STDOUT. </constant> - <constant name="FAILED" value="1"> + <constant name="FAILED" value="1" enum="Error"> Generic error. </constant> - <constant name="ERR_UNAVAILABLE" value="2"> + <constant name="ERR_UNAVAILABLE" value="2" enum="Error"> Unavailable error </constant> - <constant name="ERR_UNCONFIGURED" value="3"> + <constant name="ERR_UNCONFIGURED" value="3" enum="Error"> Unconfigured error </constant> - <constant name="ERR_UNAUTHORIZED" value="4"> + <constant name="ERR_UNAUTHORIZED" value="4" enum="Error"> Unauthorized error </constant> - <constant name="ERR_PARAMETER_RANGE_ERROR" value="5"> + <constant name="ERR_PARAMETER_RANGE_ERROR" value="5" enum="Error"> Parameter range error </constant> - <constant name="ERR_OUT_OF_MEMORY" value="6"> + <constant name="ERR_OUT_OF_MEMORY" value="6" enum="Error"> Out of memory (OOM) error </constant> - <constant name="ERR_FILE_NOT_FOUND" value="7"> + <constant name="ERR_FILE_NOT_FOUND" value="7" enum="Error"> File: Not found error </constant> - <constant name="ERR_FILE_BAD_DRIVE" value="8"> + <constant name="ERR_FILE_BAD_DRIVE" value="8" enum="Error"> File: Bad drive error </constant> - <constant name="ERR_FILE_BAD_PATH" value="9"> + <constant name="ERR_FILE_BAD_PATH" value="9" enum="Error"> File: Bad path error </constant> - <constant name="ERR_FILE_NO_PERMISSION" value="10"> + <constant name="ERR_FILE_NO_PERMISSION" value="10" enum="Error"> File: No permission error </constant> - <constant name="ERR_FILE_ALREADY_IN_USE" value="11"> + <constant name="ERR_FILE_ALREADY_IN_USE" value="11" enum="Error"> File: Already in use error </constant> - <constant name="ERR_FILE_CANT_OPEN" value="12"> + <constant name="ERR_FILE_CANT_OPEN" value="12" enum="Error"> File: Can't open error </constant> - <constant name="ERR_FILE_CANT_WRITE" value="13"> + <constant name="ERR_FILE_CANT_WRITE" value="13" enum="Error"> File: Can't write error </constant> - <constant name="ERR_FILE_CANT_READ" value="14"> + <constant name="ERR_FILE_CANT_READ" value="14" enum="Error"> File: Can't read error </constant> - <constant name="ERR_FILE_UNRECOGNIZED" value="15"> + <constant name="ERR_FILE_UNRECOGNIZED" value="15" enum="Error"> File: Unrecognized error </constant> - <constant name="ERR_FILE_CORRUPT" value="16"> + <constant name="ERR_FILE_CORRUPT" value="16" enum="Error"> File: Corrupt error </constant> - <constant name="ERR_FILE_MISSING_DEPENDENCIES" value="17"> + <constant name="ERR_FILE_MISSING_DEPENDENCIES" value="17" enum="Error"> File: Missing dependencies error </constant> - <constant name="ERR_FILE_EOF" value="18"> + <constant name="ERR_FILE_EOF" value="18" enum="Error"> File: End of file (EOF) error </constant> - <constant name="ERR_CANT_OPEN" value="19"> + <constant name="ERR_CANT_OPEN" value="19" enum="Error"> Can't open error </constant> - <constant name="ERR_CANT_CREATE" value="20"> + <constant name="ERR_CANT_CREATE" value="20" enum="Error"> Can't create error </constant> - <constant name="ERR_PARSE_ERROR" value="43"> + <constant name="ERR_PARSE_ERROR" value="43" enum="Error"> Parse error </constant> - <constant name="ERR_QUERY_FAILED" value="21"> + <constant name="ERR_QUERY_FAILED" value="21" enum="Error"> Query failed error </constant> - <constant name="ERR_ALREADY_IN_USE" value="22"> + <constant name="ERR_ALREADY_IN_USE" value="22" enum="Error"> Already in use error </constant> - <constant name="ERR_LOCKED" value="23"> + <constant name="ERR_LOCKED" value="23" enum="Error"> Locked error </constant> - <constant name="ERR_TIMEOUT" value="24"> + <constant name="ERR_TIMEOUT" value="24" enum="Error"> Timeout error </constant> - <constant name="ERR_CANT_ACQUIRE_RESOURCE" value="28"> + <constant name="ERR_CANT_ACQUIRE_RESOURCE" value="28" enum="Error"> Can't acquire resource error </constant> - <constant name="ERR_INVALID_DATA" value="30"> + <constant name="ERR_INVALID_DATA" value="30" enum="Error"> Invalid data error </constant> - <constant name="ERR_INVALID_PARAMETER" value="31"> + <constant name="ERR_INVALID_PARAMETER" value="31" enum="Error"> Invalid parameter error </constant> - <constant name="ERR_ALREADY_EXISTS" value="32"> + <constant name="ERR_ALREADY_EXISTS" value="32" enum="Error"> Already exists error </constant> - <constant name="ERR_DOES_NOT_EXIST" value="33"> + <constant name="ERR_DOES_NOT_EXIST" value="33" enum="Error"> Does not exist error </constant> - <constant name="ERR_DATABASE_CANT_READ" value="34"> + <constant name="ERR_DATABASE_CANT_READ" value="34" enum="Error"> Database: Read error </constant> - <constant name="ERR_DATABASE_CANT_WRITE" value="35"> + <constant name="ERR_DATABASE_CANT_WRITE" value="35" enum="Error"> Database: Write error </constant> - <constant name="ERR_COMPILATION_FAILED" value="36"> + <constant name="ERR_COMPILATION_FAILED" value="36" enum="Error"> Compilation failed error </constant> - <constant name="ERR_METHOD_NOT_FOUND" value="37"> + <constant name="ERR_METHOD_NOT_FOUND" value="37" enum="Error"> Method not found error </constant> - <constant name="ERR_LINK_FAILED" value="38"> + <constant name="ERR_LINK_FAILED" value="38" enum="Error"> Linking failed error </constant> - <constant name="ERR_SCRIPT_FAILED" value="39"> + <constant name="ERR_SCRIPT_FAILED" value="39" enum="Error"> Script failed error </constant> - <constant name="ERR_CYCLIC_LINK" value="40"> + <constant name="ERR_CYCLIC_LINK" value="40" enum="Error"> Cycling link (import cycle) error </constant> - <constant name="ERR_BUSY" value="44"> + <constant name="ERR_BUSY" value="44" enum="Error"> Busy error </constant> - <constant name="ERR_HELP" value="46"> + <constant name="ERR_HELP" value="46" enum="Error"> Help error </constant> - <constant name="ERR_BUG" value="47"> + <constant name="ERR_BUG" value="47" enum="Error"> Bug error </constant> - <constant name="ERR_WTF" value="49"> - WTF error (something probably went really wrong) - </constant> - <constant name="PROPERTY_HINT_NONE" value="0"> + <constant name="PROPERTY_HINT_NONE" value="0" enum="PropertyHint"> No hint for edited property. </constant> - <constant name="PROPERTY_HINT_RANGE" value="1"> + <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. </constant> - <constant name="PROPERTY_HINT_EXP_RANGE" value="2"> + <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. </constant> - <constant name="PROPERTY_HINT_ENUM" value="3"> + <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. </constant> - <constant name="PROPERTY_HINT_EXP_EASING" value="4"> + <constant name="PROPERTY_HINT_EXP_EASING" value="4" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_LENGTH" value="5"> + <constant name="PROPERTY_HINT_LENGTH" value="5" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_KEY_ACCEL" value="7"> + <constant name="PROPERTY_HINT_KEY_ACCEL" value="7" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_FLAGS" value="8"> + <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. </constant> - <constant name="PROPERTY_HINT_LAYERS_2D_RENDER" value="9"> + <constant name="PROPERTY_HINT_LAYERS_2D_RENDER" value="9" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_LAYERS_2D_PHYSICS" value="10"> + <constant name="PROPERTY_HINT_LAYERS_2D_PHYSICS" value="10" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_LAYERS_3D_RENDER" value="11"> + <constant name="PROPERTY_HINT_LAYERS_3D_RENDER" value="11" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_LAYERS_3D_PHYSICS" value="12"> + <constant name="PROPERTY_HINT_LAYERS_3D_PHYSICS" value="12" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_FILE" value="13"> + <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". </constant> - <constant name="PROPERTY_HINT_DIR" value="14"> + <constant name="PROPERTY_HINT_DIR" value="14" enum="PropertyHint"> String property is a directory (so pop up a file dialog when edited). </constant> - <constant name="PROPERTY_HINT_GLOBAL_FILE" value="15"> + <constant name="PROPERTY_HINT_GLOBAL_FILE" value="15" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_GLOBAL_DIR" value="16"> + <constant name="PROPERTY_HINT_GLOBAL_DIR" value="16" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_RESOURCE_TYPE" value="17"> + <constant name="PROPERTY_HINT_RESOURCE_TYPE" value="17" enum="PropertyHint"> String property is a resource, so open the resource popup menu when edited. </constant> - <constant name="PROPERTY_HINT_MULTILINE_TEXT" value="18"> + <constant name="PROPERTY_HINT_MULTILINE_TEXT" value="18" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="19"> + <constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="19" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="20"> + <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="20" enum="PropertyHint"> Hints that the image is compressed using lossy compression. </constant> - <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="21"> + <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="21" enum="PropertyHint"> Hints that the image is compressed using lossless compression. </constant> - <constant name="PROPERTY_USAGE_STORAGE" value="1"> + <constant name="PROPERTY_USAGE_STORAGE" value="1" enum="PropertyUsageFlags"> Property will be used as storage (default). </constant> - <constant name="PROPERTY_USAGE_EDITOR" value="2"> + <constant name="PROPERTY_USAGE_EDITOR" value="2" enum="PropertyUsageFlags"> Property will be visible in editor (default). </constant> - <constant name="PROPERTY_USAGE_NETWORK" value="4"> + <constant name="PROPERTY_USAGE_NETWORK" value="4" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_EDITOR_HELPER" value="8"> + <constant name="PROPERTY_USAGE_EDITOR_HELPER" value="8" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_CHECKABLE" value="16"> + <constant name="PROPERTY_USAGE_CHECKABLE" value="16" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_CHECKED" value="32"> + <constant name="PROPERTY_USAGE_CHECKED" value="32" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_INTERNATIONALIZED" value="64"> + <constant name="PROPERTY_USAGE_INTERNATIONALIZED" value="64" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_GROUP" value="128"> + <constant name="PROPERTY_USAGE_GROUP" value="128" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_CATEGORY" value="256"> + <constant name="PROPERTY_USAGE_CATEGORY" value="256" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_STORE_IF_NONZERO" value="512"> + <constant name="PROPERTY_USAGE_STORE_IF_NONZERO" value="512" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_STORE_IF_NONONE" value="1024"> + <constant name="PROPERTY_USAGE_STORE_IF_NONONE" value="1024" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_NO_INSTANCE_STATE" value="2048"> + <constant name="PROPERTY_USAGE_NO_INSTANCE_STATE" value="2048" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_RESTART_IF_CHANGED" value="4096"> + <constant name="PROPERTY_USAGE_RESTART_IF_CHANGED" value="4096" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_SCRIPT_VARIABLE" value="8192"> + <constant name="PROPERTY_USAGE_SCRIPT_VARIABLE" value="8192" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_DEFAULT" value="7"> + <constant name="PROPERTY_USAGE_DEFAULT" value="7" enum="PropertyUsageFlags"> Default usage (storage and editor). </constant> - <constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71"> + <constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_NOEDITOR" value="5"> + <constant name="PROPERTY_USAGE_NOEDITOR" value="1048581" enum="PropertyUsageFlags"> </constant> - <constant name="METHOD_FLAG_NORMAL" value="1"> + <constant name="METHOD_FLAG_NORMAL" value="1" enum="MethodFlags"> Flag for normal method </constant> - <constant name="METHOD_FLAG_EDITOR" value="2"> + <constant name="METHOD_FLAG_EDITOR" value="2" enum="MethodFlags"> Flag for editor method </constant> - <constant name="METHOD_FLAG_NOSCRIPT" value="4"> + <constant name="METHOD_FLAG_NOSCRIPT" value="4" enum="MethodFlags"> </constant> - <constant name="METHOD_FLAG_CONST" value="8"> + <constant name="METHOD_FLAG_CONST" value="8" enum="MethodFlags"> Flag for constant method </constant> - <constant name="METHOD_FLAG_REVERSE" value="16"> + <constant name="METHOD_FLAG_REVERSE" value="16" enum="MethodFlags"> </constant> - <constant name="METHOD_FLAG_VIRTUAL" value="32"> + <constant name="METHOD_FLAG_VIRTUAL" value="32" enum="MethodFlags"> Flag for virtual method </constant> - <constant name="METHOD_FLAG_FROM_SCRIPT" value="64"> + <constant name="METHOD_FLAG_FROM_SCRIPT" value="64" enum="MethodFlags"> Flag for method from script </constant> - <constant name="METHOD_FLAGS_DEFAULT" value="1"> + <constant name="METHOD_FLAGS_DEFAULT" value="1" enum="MethodFlags"> Default method flags </constant> - <constant name="TYPE_NIL" value="0"> + <constant name="TYPE_NIL" value="0" enum="Variant.Type"> Variable is of type nil (only applied for null). </constant> - <constant name="TYPE_BOOL" value="1"> + <constant name="TYPE_BOOL" value="1" enum="Variant.Type"> Variable is of type [bool]. </constant> - <constant name="TYPE_INT" value="2"> + <constant name="TYPE_INT" value="2" enum="Variant.Type"> Variable is of type [int]. </constant> - <constant name="TYPE_REAL" value="3"> + <constant name="TYPE_REAL" value="3" enum="Variant.Type"> Variable is of type [float]/real. </constant> - <constant name="TYPE_STRING" value="4"> + <constant name="TYPE_STRING" value="4" enum="Variant.Type"> Variable is of type [String]. </constant> - <constant name="TYPE_VECTOR2" value="5"> + <constant name="TYPE_VECTOR2" value="5" enum="Variant.Type"> Variable is of type [Vector2]. </constant> - <constant name="TYPE_RECT2" value="6"> + <constant name="TYPE_RECT2" value="6" enum="Variant.Type"> Variable is of type [Rect2]. </constant> - <constant name="TYPE_VECTOR3" value="7"> + <constant name="TYPE_VECTOR3" value="7" enum="Variant.Type"> Variable is of type [Vector3]. </constant> - <constant name="TYPE_TRANSFORM2D" value="8"> + <constant name="TYPE_TRANSFORM2D" value="8" enum="Variant.Type"> Variable is of type [Transform2D]. </constant> - <constant name="TYPE_PLANE" value="9"> + <constant name="TYPE_PLANE" value="9" enum="Variant.Type"> Variable is of type [Plane]. </constant> - <constant name="TYPE_QUAT" value="10"> + <constant name="TYPE_QUAT" value="10" enum="Variant.Type"> Variable is of type [Quat]. </constant> - <constant name="TYPE_RECT3" value="11"> - Variable is of type [Rect3]. + <constant name="TYPE_AABB" value="11" enum="Variant.Type"> + Variable is of type [AABB]. </constant> - <constant name="TYPE_BASIS" value="12"> + <constant name="TYPE_BASIS" value="12" enum="Variant.Type"> Variable is of type [Basis]. </constant> - <constant name="TYPE_TRANSFORM" value="13"> + <constant name="TYPE_TRANSFORM" value="13" enum="Variant.Type"> Variable is of type [Transform]. </constant> - <constant name="TYPE_COLOR" value="14"> + <constant name="TYPE_COLOR" value="14" enum="Variant.Type"> Variable is of type [Color]. </constant> - <constant name="TYPE_NODE_PATH" value="15"> + <constant name="TYPE_NODE_PATH" value="15" enum="Variant.Type"> Variable is of type [NodePath]. </constant> - <constant name="TYPE_RID" value="16"> + <constant name="TYPE_RID" value="16" enum="Variant.Type"> Variable is of type [RID]. </constant> - <constant name="TYPE_OBJECT" value="17"> + <constant name="TYPE_OBJECT" value="17" enum="Variant.Type"> Variable is of type [Object]. </constant> - <constant name="TYPE_DICTIONARY" value="18"> + <constant name="TYPE_DICTIONARY" value="18" enum="Variant.Type"> Variable is of type [Dictionary]. </constant> - <constant name="TYPE_ARRAY" value="19"> + <constant name="TYPE_ARRAY" value="19" enum="Variant.Type"> Variable is of type [Array]. </constant> - <constant name="TYPE_RAW_ARRAY" value="20"> + <constant name="TYPE_RAW_ARRAY" value="20" enum="Variant.Type"> Variable is of type [PoolByteArray]. </constant> - <constant name="TYPE_INT_ARRAY" value="21"> + <constant name="TYPE_INT_ARRAY" value="21" enum="Variant.Type"> Variable is of type [PoolIntArray]. </constant> - <constant name="TYPE_REAL_ARRAY" value="22"> + <constant name="TYPE_REAL_ARRAY" value="22" enum="Variant.Type"> Variable is of type [PoolRealArray]. </constant> - <constant name="TYPE_STRING_ARRAY" value="23"> + <constant name="TYPE_STRING_ARRAY" value="23" enum="Variant.Type"> Variable is of type [PoolStringArray]. </constant> - <constant name="TYPE_VECTOR2_ARRAY" value="24"> + <constant name="TYPE_VECTOR2_ARRAY" value="24" enum="Variant.Type"> Variable is of type [PoolVector2Array]. </constant> - <constant name="TYPE_VECTOR3_ARRAY" value="25"> + <constant name="TYPE_VECTOR3_ARRAY" value="25" enum="Variant.Type"> Variable is of type [PoolVector3Array]. </constant> - <constant name="TYPE_COLOR_ARRAY" value="26"> + <constant name="TYPE_COLOR_ARRAY" value="26" enum="Variant.Type"> Variable is of type [PoolColorArray]. </constant> - <constant name="TYPE_MAX" value="27"> + <constant name="TYPE_MAX" value="27" enum="Variant.Type"> Marker for end of type constants. </constant> </constants> diff --git a/doc/classes/@NativeScript.xml b/doc/classes/@NativeScript.xml index a9dfc4538a..898c30431f 100644 --- a/doc/classes/@NativeScript.xml +++ b/doc/classes/@NativeScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="@NativeScript" category="Core" version="3.0-alpha"> +<class name="@NativeScript" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/@VisualScript.xml b/doc/classes/@VisualScript.xml index 0e6205c040..0d105b4274 100644 --- a/doc/classes/@VisualScript.xml +++ b/doc/classes/@VisualScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="@VisualScript" category="Core" version="3.0-alpha"> +<class name="@VisualScript" category="Core" version="3.0-beta"> <brief_description> Built-in visual script functions. </brief_description> diff --git a/doc/classes/Rect3.xml b/doc/classes/AABB.xml index 88be5fa419..4aef151fbd 100644 --- a/doc/classes/Rect3.xml +++ b/doc/classes/AABB.xml @@ -1,18 +1,18 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Rect3" category="Built-In Types" version="3.0-alpha"> +<class name="AABB" category="Built-In Types" version="3.0-beta"> <brief_description> Axis-Aligned Bounding Box. </brief_description> <description> - Rect3 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + AABB consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. </description> <tutorials> </tutorials> <demos> </demos> <methods> - <method name="Rect3"> - <return type="Rect3"> + <method name="AABB"> + <return type="AABB"> </return> <argument index="0" name="position" type="Vector3"> </argument> @@ -25,26 +25,26 @@ <method name="encloses"> <return type="bool"> </return> - <argument index="0" name="with" type="Rect3"> + <argument index="0" name="with" type="AABB"> </argument> <description> - Returns [code]true[/code] if this [code]Rect3[/code] completely encloses another one. + Returns [code]true[/code] if this [code]AABB[/code] completely encloses another one. </description> </method> <method name="expand"> - <return type="Rect3"> + <return type="AABB"> </return> <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns this [code]Rect3[/code] expanded to include a given point. + Returns this [code]AABB[/code] expanded to include a given point. </description> </method> <method name="get_area"> <return type="float"> </return> <description> - Gets the area of the [code]Rect3[/code]. + Gets the area of the [code]AABB[/code]. </description> </method> <method name="get_endpoint"> @@ -53,49 +53,49 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Gets the position of the 8 endpoints of the [code]Rect3[/code] in space. + Gets the position of the 8 endpoints of the [code]AABB[/code] in space. </description> </method> <method name="get_longest_axis"> <return type="Vector3"> </return> <description> - Returns the normalized longest axis of the [code]Rect3[/code]. + Returns the normalized longest axis of the [code]AABB[/code]. </description> </method> <method name="get_longest_axis_index"> <return type="int"> </return> <description> - Returns the index of the longest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum). + Returns the index of the longest axis of the [code]AABB[/code] (according to [Vector3]::AXIS* enum). </description> </method> <method name="get_longest_axis_size"> <return type="float"> </return> <description> - Returns the scalar length of the longest axis of the [code]Rect3[/code]. + Returns the scalar length of the longest axis of the [code]AABB[/code]. </description> </method> <method name="get_shortest_axis"> <return type="Vector3"> </return> <description> - Returns the normalized shortest axis of the [code]Rect3[/code]. + Returns the normalized shortest axis of the [code]AABB[/code]. </description> </method> <method name="get_shortest_axis_index"> <return type="int"> </return> <description> - Returns the index of the shortest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum). + Returns the index of the shortest axis of the [code]AABB[/code] (according to [Vector3]::AXIS* enum). </description> </method> <method name="get_shortest_axis_size"> <return type="float"> </return> <description> - Returns the scalar length of the shortest axis of the [code]Rect3[/code]. + Returns the scalar length of the shortest axis of the [code]AABB[/code]. </description> </method> <method name="get_support"> @@ -108,26 +108,26 @@ </description> </method> <method name="grow"> - <return type="Rect3"> + <return type="AABB"> </return> <argument index="0" name="by" type="float"> </argument> <description> - Returns a copy of the [code]Rect3[/code] grown a given amount of units towards all the sides. + Returns a copy of the [code]AABB[/code] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> <return type="bool"> </return> <description> - Returns [code]true[/code] if the [code]Rect3[/code] is flat or empty. + Returns [code]true[/code] if the [code]AABB[/code] is flat or empty. </description> </method> <method name="has_no_surface"> <return type="bool"> </return> <description> - Returns [code]true[/code] if the [code]Rect3[/code] is empty. + Returns [code]true[/code] if the [code]AABB[/code] is empty. </description> </method> <method name="has_point"> @@ -136,25 +136,25 @@ <argument index="0" name="point" type="Vector3"> </argument> <description> - Returns [code]true[/code] if the [code]Rect3[/code] contains a point. + Returns [code]true[/code] if the [code]AABB[/code] contains a point. </description> </method> <method name="intersection"> - <return type="Rect3"> + <return type="AABB"> </return> - <argument index="0" name="with" type="Rect3"> + <argument index="0" name="with" type="AABB"> </argument> <description> - Returns the intersection between two [code]Rect3[/code]. An empty Rect3 (size 0,0,0) is returned on failure. + Returns the intersection between two [code]AABB[/code]. An empty AABB (size 0,0,0) is returned on failure. </description> </method> <method name="intersects"> <return type="bool"> </return> - <argument index="0" name="with" type="Rect3"> + <argument index="0" name="with" type="AABB"> </argument> <description> - Returns [code]true[/code] if the [code]Rect3[/code] overlaps with another. + Returns [code]true[/code] if the [code]AABB[/code] overlaps with another. </description> </method> <method name="intersects_plane"> @@ -163,7 +163,7 @@ <argument index="0" name="plane" type="Plane"> </argument> <description> - Returns [code]true[/code] if the [code]Rect3[/code] is on both sides of a plane. + Returns [code]true[/code] if the [code]AABB[/code] is on both sides of a plane. </description> </method> <method name="intersects_segment"> @@ -174,16 +174,16 @@ <argument index="1" name="to" type="Vector3"> </argument> <description> - Returns [code]true[/code] if the [code]Rect3[/code] intersects the line segment between [code]from[/code] and [code]to[/code]. + Returns [code]true[/code] if the [code]AABB[/code] intersects the line segment between [code]from[/code] and [code]to[/code]. </description> </method> <method name="merge"> - <return type="Rect3"> + <return type="AABB"> </return> - <argument index="0" name="with" type="Rect3"> + <argument index="0" name="with" type="AABB"> </argument> <description> - Returns a larger Rect3 that contains this Rect3 and [code]with[/code]. + Returns a larger AABB that contains this AABB and [code]with[/code]. </description> </method> </methods> diff --git a/doc/classes/ARVRAnchor.xml b/doc/classes/ARVRAnchor.xml index 8bb12609b0..88862ec5f1 100644 --- a/doc/classes/ARVRAnchor.xml +++ b/doc/classes/ARVRAnchor.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRAnchor" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="ARVRAnchor" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Anchor point in AR Space </brief_description> @@ -13,13 +13,6 @@ <demos> </demos> <methods> - <method name="get_anchor_id" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the anchor id for this anchor. - </description> - </method> <method name="get_anchor_name" qualifiers="const"> <return type="String"> </return> @@ -48,15 +41,6 @@ Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table. </description> </method> - <method name="set_anchor_id"> - <return type="void"> - </return> - <argument index="0" name="anchor_id" type="int"> - </argument> - <description> - Binds this anchor node to an anchor with this id. You can set this before the anchor itself exists. The first anchor that is identified gets id 1, the second id 2, etc. When anchors get removed that slot remains free and can be assigned to the next anchor that is identified. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merge them. - </description> - </method> </methods> <members> <member name="anchor_id" type="int" setter="set_anchor_id" getter="get_anchor_id"> diff --git a/doc/classes/ARVRCamera.xml b/doc/classes/ARVRCamera.xml index 0d9886618d..5195568e67 100644 --- a/doc/classes/ARVRCamera.xml +++ b/doc/classes/ARVRCamera.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRCamera" inherits="Camera" category="Core" version="3.0-alpha"> +<class name="ARVRCamera" inherits="Camera" category="Core" version="3.0-beta"> <brief_description> A camera node with a few overrules for AR/VR applied such as location tracking. </brief_description> diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index 8af483132b..47a9341643 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRController" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="ARVRController" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> A spatial node representing a spatially tracked controller. </brief_description> @@ -13,13 +13,6 @@ <demos> </demos> <methods> - <method name="get_controller_id" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the controller id currently assigned to this node. - </description> - </method> <method name="get_controller_name" qualifiers="const"> <return type="String"> </return> @@ -38,7 +31,7 @@ <return type="bool"> </return> <description> - Returns true if the controller bound to this node is currently active and being tracked. + Returns [code]true[/code] if the bound controller is active. ARVR systems attempt to track active controllers. </description> </method> <method name="get_joystick_axis" qualifiers="const"> @@ -57,36 +50,13 @@ 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. </description> </method> - <method name="get_rumble" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="is_button_pressed" qualifiers="const"> <return type="int"> </return> <argument index="0" name="button" type="int"> </argument> <description> - Is the given button currently pressed? - </description> - </method> - <method name="set_controller_id"> - <return type="void"> - </return> - <argument index="0" name="controller_id" type="int"> - </argument> - <description> - Changes the id that identifies the controller bound to this node. The first controller that the ARVR Server detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off that slot is freed ensuring that controllers will keep the same id while it is turned on even when controllers with lower ids are turned off. - </description> - </method> - <method name="set_rumble"> - <return type="void"> - </return> - <argument index="0" name="rumble" type="float"> - </argument> - <description> + Returns [code]true[/code] if the button at index [code]button[/code] is pressed. </description> </method> </methods> @@ -95,6 +65,7 @@ The controller's id. The first controller that the [ARVRServer] detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off, it's slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. </member> <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. </member> </members> <signals> @@ -102,14 +73,14 @@ <argument index="0" name="button" type="int"> </argument> <description> - When a button on this controller is pressed, this signal is given. + Emitted when a button on this controller is pressed. </description> </signal> <signal name="button_release"> <argument index="0" name="button" type="int"> </argument> <description> - When a button on this controller is released, this signal is given. + Emitted when a button on this controller is released. </description> </signal> </signals> diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml index e9f8857ec8..d00b5eeaf4 100644 --- a/doc/classes/ARVRInterface.xml +++ b/doc/classes/ARVRInterface.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRInterface" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="ARVRInterface" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Base class for ARVR interface implementation. </brief_description> @@ -12,13 +12,6 @@ <demos> </demos> <methods> - <method name="get_anchor_detection_is_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns true if achor detection is enabled (AR only). - </description> - </method> <method name="get_capabilities" qualifiers="const"> <return type="int"> </return> @@ -58,20 +51,6 @@ 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_initialized"> - <return type="bool"> - </return> - <description> - Returns true if this interface is active. - </description> - </method> - <method name="is_primary"> - <return type="bool"> - </return> - <description> - Returns true if this interface is currently the primary interface (the interface responsible for showing the output). - </description> - </method> <method name="is_stereo"> <return type="bool"> </return> @@ -79,33 +58,6 @@ Returns true if the current output of this interface is in stereo. </description> </method> - <method name="set_anchor_detection_is_enabled"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Enables anchor detection, this is used on AR interfaces and enables the extra logic that will detect planes, features, objects, etc. and adds/modifies anchor points. - </description> - </method> - <method name="set_is_initialized"> - <return type="void"> - </return> - <argument index="0" name="initialized" type="bool"> - </argument> - <description> - Initialize/uninitialize this interface (same effect as calling initialize/uninitialize). - </description> - </method> - <method name="set_is_primary"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set this interface to the primary interface (unset the old one). - </description> - </method> <method name="uninitialize"> <return type="void"> </return> @@ -126,43 +78,43 @@ </member> </members> <constants> - <constant name="ARVR_NONE" value="0"> + <constant name="ARVR_NONE" value="0" enum="Capabilities"> No ARVR capabilities. </constant> - <constant name="ARVR_MONO" value="1"> + <constant name="ARVR_MONO" value="1" enum="Capabilities"> This interface can work with normal rendering output (non-HMD based AR). </constant> - <constant name="ARVR_STEREO" value="2"> + <constant name="ARVR_STEREO" value="2" enum="Capabilities"> This interface supports stereoscopic rendering. </constant> - <constant name="ARVR_AR" value="4"> + <constant name="ARVR_AR" value="4" enum="Capabilities"> This interface support AR (video background and real world tracking). </constant> - <constant name="ARVR_EXTERNAL" value="8"> + <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 seperate viewport node frees up the main viewport for other purposes. </constant> - <constant name="EYE_MONO" value="0"> + <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. </constant> - <constant name="EYE_LEFT" value="1"> + <constant name="EYE_LEFT" value="1" enum="Eyes"> Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information. </constant> - <constant name="EYE_RIGHT" value="2"> + <constant name="EYE_RIGHT" value="2" enum="Eyes"> Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information. </constant> - <constant name="ARVR_NORMAL_TRACKING" value="0"> + <constant name="ARVR_NORMAL_TRACKING" value="0" enum="Tracking_status"> Tracking is behaving as expected. </constant> - <constant name="ARVR_EXCESSIVE_MOTION" value="1"> + <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. </constant> - <constant name="ARVR_INSUFFICIENT_FEATURES" value="2"> + <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. </constant> - <constant name="ARVR_UNKNOWN_TRACKING" value="3"> + <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. </constant> - <constant name="ARVR_NOT_TRACKING" value="4"> + <constant name="ARVR_NOT_TRACKING" value="4" enum="Tracking_status"> Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.) </constant> </constants> diff --git a/doc/classes/ARVROrigin.xml b/doc/classes/ARVROrigin.xml index 8ad3793c80..6e0999a1f9 100644 --- a/doc/classes/ARVROrigin.xml +++ b/doc/classes/ARVROrigin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVROrigin" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="ARVROrigin" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Our origin point in AR/VR. </brief_description> @@ -14,24 +14,6 @@ <demos> </demos> <methods> - <method name="get_world_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the world scale applied to our positioning. - </description> - </method> - <method name="set_world_scale"> - <return type="void"> - </return> - <argument index="0" name="world_scale" type="float"> - </argument> - <description> - Changes the world scaling factor. - Most AR/VR platforms will assume a unit size of 1 unit in your game world = 1 meter in the real world. This scale allows you to adjust this to the unit system you use in your game. - Note that this method is a passthrough to the ARVRServer itself. - </description> - </method> </methods> <members> <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale"> diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml index 2a2c6aa843..88740f5dc1 100644 --- a/doc/classes/ARVRPositionalTracker.xml +++ b/doc/classes/ARVRPositionalTracker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRPositionalTracker" inherits="Object" category="Core" version="3.0-alpha"> +<class name="ARVRPositionalTracker" inherits="Object" category="Core" version="3.0-beta"> <brief_description> A tracked object </brief_description> @@ -31,41 +31,35 @@ <return type="String"> </return> <description> - If available this returns the name of the controller or anchor point. + Returns the controller or anchor point's name if available. </description> </method> <method name="get_orientation" qualifiers="const"> <return type="Basis"> </return> <description> - Returns the orientation matrix of the controller. + Returns the controller's orientation matrix. </description> </method> <method name="get_position" qualifiers="const"> <return type="Vector3"> </return> <description> - Returns the position of the controller adjusted by world scale. - </description> - </method> - <method name="get_rumble" qualifiers="const"> - <return type="float"> - </return> - <description> + Returns the world-space controller position. </description> </method> <method name="get_tracks_orientation" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if the orientation of this device is being tracked. + Returns [code]true[/code] if this device tracks orientation. </description> </method> <method name="get_tracks_position" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if the position of this device is being tracked. + Returns [code]true[/code] if this device tracks position. </description> </method> <method name="get_transform" qualifiers="const"> @@ -74,37 +68,30 @@ <argument index="0" name="adjust_by_reference_frame" type="bool"> </argument> <description> - Returns the transform combining the orientation and position of this device. + Returns the transform combining this device's orientation and position. </description> </method> <method name="get_type" qualifiers="const"> <return type="int" enum="ARVRServer.TrackerType"> </return> <description> - Type of tracker. - </description> - </method> - <method name="set_rumble"> - <return type="void"> - </return> - <argument index="0" name="rumble" type="float"> - </argument> - <description> + Returns the tracker's type. </description> </method> </methods> <members> <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]. </member> </members> <constants> - <constant name="TRACKER_HAND_UNKNOWN" value="0"> + <constant name="TRACKER_HAND_UNKNOWN" value="0" enum="TrackerHand"> The hand this tracker is held in is unknown or not applicable. </constant> - <constant name="TRACKER_LEFT_HAND" value="1"> + <constant name="TRACKER_LEFT_HAND" value="1" enum="TrackerHand"> This tracker is the left hand controller. </constant> - <constant name="TRACKER_RIGHT_HAND" value="2"> + <constant name="TRACKER_RIGHT_HAND" value="2" enum="TrackerHand"> This tracker is the right hand controller. </constant> </constants> diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index bee95ea072..17202c8c2c 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRServer" inherits="Object" category="Core" version="3.0-alpha"> +<class name="ARVRServer" inherits="Object" category="Core" version="3.0-beta"> <brief_description> This is our AR/VR Server. </brief_description> @@ -82,13 +82,6 @@ Get the number of trackers currently registered. </description> </method> - <method name="get_world_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns our world scale (see ARVROrigin for more information). - </description> - </method> <method name="set_primary_interface"> <return type="void"> </return> @@ -98,15 +91,6 @@ Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces. </description> </method> - <method name="set_world_scale"> - <return type="void"> - </return> - <argument index="0" name="arg0" type="float"> - </argument> - <description> - Changing the world scale, see the ARVROrigin documentation for more information. - </description> - </method> </methods> <members> <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale"> @@ -152,22 +136,22 @@ </signal> </signals> <constants> - <constant name="TRACKER_CONTROLLER" value="1"> + <constant name="TRACKER_CONTROLLER" value="1" enum="TrackerType"> Our tracker tracks the location of a controller. </constant> - <constant name="TRACKER_BASESTATION" value="2"> + <constant name="TRACKER_BASESTATION" value="2" enum="TrackerType"> Our tracker tracks the location of a base station. </constant> - <constant name="TRACKER_ANCHOR" value="4"> + <constant name="TRACKER_ANCHOR" value="4" enum="TrackerType"> Our tracker tracks the location and size of an AR anchor. </constant> - <constant name="TRACKER_ANY_KNOWN" value="127"> + <constant name="TRACKER_ANY_KNOWN" value="127" enum="TrackerType"> Used internally to filter trackers of any known type. </constant> - <constant name="TRACKER_UNKNOWN" value="128"> + <constant name="TRACKER_UNKNOWN" value="128" enum="TrackerType"> Used internally if we haven't set the tracker type yet. </constant> - <constant name="TRACKER_ANY" value="255"> + <constant name="TRACKER_ANY" value="255" enum="TrackerType"> Used internally to select all trackers. </constant> </constants> diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index ceb3c907a6..e0e3261edf 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AStar" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="AStar" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> AStar class representation that uses vectors as edges. </brief_description> @@ -13,7 +13,7 @@ </demos> <methods> <method name="_compute_cost" qualifiers="virtual"> - <return type="void"> + <return type="float"> </return> <argument index="0" name="from_id" type="int"> </argument> @@ -24,7 +24,7 @@ </description> </method> <method name="_estimate_cost" qualifiers="virtual"> - <return type="void"> + <return type="float"> </return> <argument index="0" name="from_id" type="int"> </argument> @@ -47,7 +47,7 @@ Adds a new point at the given position with the given identifier. The algorithm prefers points with lower [code]weight_scale[/code] to form a path. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. [codeblock] 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. @@ -84,10 +84,10 @@ Creates a segment between the given points. [codeblock] var as = AStar.new() - + as.add_point(1, Vector3(1,1,0)) as.add_point(2, Vector3(0,5,0)) - + as.connect_points(1, 2, false) # If bidirectional=false it's only possible to go from point 1 to point 2 # and not from point 2 to point 1. [/codeblock] @@ -129,12 +129,12 @@ Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. [codeblock] var as = AStar.new() - + 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) [/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. @@ -151,18 +151,18 @@ 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(3, Vector3(1,1,0)) as.add_point(4, Vector3(2,0,0)) - + as.connect_points(1, 2, false) as.connect_points(2, 3, false) as.connect_points(4, 3, false) as.connect_points(1, 4, false) as.connect_points(5, 4, false) - + 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. @@ -223,6 +223,7 @@ <return type="Array"> </return> <description> + Returns an array of all points. </description> </method> <method name="has_point" qualifiers="const"> diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 2292d54756..219995023e 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AcceptDialog" inherits="WindowDialog" category="Core" version="3.0-alpha"> +<class name="AcceptDialog" inherits="WindowDialog" category="Core" version="3.0-beta"> <brief_description> Base dialog for user notification. </brief_description> @@ -34,13 +34,6 @@ Adds a button with label [i]name[/i] and a cancel action to the dialog and returns the created button. </description> </method> - <method name="get_hide_on_ok" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the dialog will be hidden when accepted (default true). - </description> - </method> <method name="get_label"> <return type="Label"> </return> @@ -55,13 +48,6 @@ Return the OK Button. </description> </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the built-in label text. - </description> - </method> <method name="register_text_enter"> <return type="void"> </return> @@ -71,24 +57,6 @@ Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. </description> </method> - <method name="set_hide_on_ok"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set whether the dialog is hidden when accepted (default true). - </description> - </method> - <method name="set_text"> - <return type="void"> - </return> - <argument index="0" name="text" type="String"> - </argument> - <description> - Set the built-in label text. - </description> - </method> </methods> <members> <member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok"> diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index 984eb47f12..9645758ea0 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimatedSprite" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="AnimatedSprite" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Sprite node that can use multiple textures for animation. </brief_description> @@ -11,55 +11,6 @@ <demos> </demos> <methods> - <method name="get_animation" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the name of the current animation set to the node. - </description> - </method> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the visible frame index. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the offset of the sprite in the node origin. - </description> - </method> - <method name="get_sprite_frames" qualifiers="const"> - <return type="SpriteFrames"> - </return> - <description> - Get the [SpriteFrames] resource, which contains all frames. - </description> - </method> - <method name="is_centered" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true when centered. See [method set_centered]. - </description> - </method> - <method name="is_flipped_h" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if sprite is flipped horizontally. - </description> - </method> - <method name="is_flipped_v" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if sprite is flipped vertically. - </description> - </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> @@ -76,69 +27,6 @@ Play the animation set in parameter. If no parameter is provided, the current animation is played. </description> </method> - <method name="set_animation"> - <return type="void"> - </return> - <argument index="0" name="animation" type="String"> - </argument> - <description> - Set the current animation of the node and reinits the frame counter of the animation. - </description> - </method> - <method name="set_centered"> - <return type="void"> - </return> - <argument index="0" name="centered" type="bool"> - </argument> - <description> - When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is. - </description> - </method> - <method name="set_flip_h"> - <return type="void"> - </return> - <argument index="0" name="flip_h" type="bool"> - </argument> - <description> - If true, sprite is flipped horizontally. - </description> - </method> - <method name="set_flip_v"> - <return type="void"> - </return> - <argument index="0" name="flip_v" type="bool"> - </argument> - <description> - If true, sprite is flipped vertically. - </description> - </method> - <method name="set_frame"> - <return type="void"> - </return> - <argument index="0" name="frame" type="int"> - </argument> - <description> - Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource). - </description> - </method> - <method name="set_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not. - </description> - </method> - <method name="set_sprite_frames"> - <return type="void"> - </return> - <argument index="0" name="sprite_frames" type="SpriteFrames"> - </argument> - <description> - Set the [SpriteFrames] resource, which contains all frames. - </description> - </method> <method name="stop"> <return type="void"> </return> diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 0d8e2fc433..beb65d4d28 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimatedSprite3D" inherits="SpriteBase3D" category="Core" version="3.0-alpha"> +<class name="AnimatedSprite3D" inherits="SpriteBase3D" category="Core" version="3.0-beta"> <brief_description> 2D sprite node in 3D world, that can use multiple 2D textures for animation. </brief_description> @@ -11,27 +11,6 @@ <demos> </demos> <methods> - <method name="get_animation" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the name of the current animation set to the node. - </description> - </method> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the visible frame index. - </description> - </method> - <method name="get_sprite_frames" qualifiers="const"> - <return type="SpriteFrames"> - </return> - <description> - Get the [SpriteFrames] resource, which contains all frames. - </description> - </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> @@ -48,33 +27,6 @@ Play the animation set in parameter. If no parameter is provided, the current animation is played. </description> </method> - <method name="set_animation"> - <return type="void"> - </return> - <argument index="0" name="animation" type="String"> - </argument> - <description> - Set the current animation of the node and reinits the frame counter of the animation. - </description> - </method> - <method name="set_frame"> - <return type="void"> - </return> - <argument index="0" name="frame" type="int"> - </argument> - <description> - Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource). - </description> - </method> - <method name="set_sprite_frames"> - <return type="void"> - </return> - <argument index="0" name="sprite_frames" type="SpriteFrames"> - </argument> - <description> - Set the [SpriteFrames] resource, which contains all frames. - </description> - </method> <method name="stop"> <return type="void"> </return> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 677976f1d3..dd248d18f7 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Animation" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Animation" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Contains data used to animate everything in the engine. </brief_description> @@ -30,6 +30,17 @@ Clear the animation (clear all tracks and reset all). </description> </method> + <method name="copy_track"> + <return type="void"> + </return> + <argument index="0" name="track" type="int"> + </argument> + <argument index="1" name="to_animation" type="Animation"> + </argument> + <description> + Adds a new track that is a copy of the given track from [code]to_animation[/code]. + </description> + </method> <method name="find_track" qualifiers="const"> <return type="int"> </return> @@ -157,6 +168,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. Default value: [code]true[/code]. </description> </method> <method name="track_get_interpolation_type" qualifiers="const"> @@ -243,6 +255,15 @@ Insert a generic key in a given track. </description> </method> + <method name="track_is_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns [code]true[/code] if the track at index [code]idx[/code] is enabled. + </description> + </method> <method name="track_is_imported" qualifiers="const"> <return type="bool"> </return> @@ -292,6 +313,17 @@ Remove a key by position (seconds) in a given track. </description> </method> + <method name="track_set_enabled"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + Enables/disables the given track. Tracks are enabled by default. + </description> + </method> <method name="track_set_imported"> <return type="void"> </return> @@ -311,6 +343,7 @@ <argument index="1" name="interpolation" type="bool"> </argument> <description> + If [code]true[/code] the track at [code]idx[/code] wraps the interpolation loop. </description> </method> <method name="track_set_interpolation_type"> @@ -424,31 +457,31 @@ </method> </methods> <constants> - <constant name="TYPE_VALUE" value="0"> + <constant name="TYPE_VALUE" value="0" enum="TrackType"> Value tracks set values in node properties, but only those which can be Interpolated. </constant> - <constant name="TYPE_TRANSFORM" value="1"> + <constant name="TYPE_TRANSFORM" value="1" enum="TrackType"> Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated. </constant> - <constant name="TYPE_METHOD" value="2"> + <constant name="TYPE_METHOD" value="2" enum="TrackType"> Method tracks call functions with given arguments per key. </constant> - <constant name="INTERPOLATION_NEAREST" value="0"> + <constant name="INTERPOLATION_NEAREST" value="0" enum="InterpolationType"> No interpolation (nearest value). </constant> - <constant name="INTERPOLATION_LINEAR" value="1"> + <constant name="INTERPOLATION_LINEAR" value="1" enum="InterpolationType"> Linear interpolation. </constant> - <constant name="INTERPOLATION_CUBIC" value="2"> + <constant name="INTERPOLATION_CUBIC" value="2" enum="InterpolationType"> Cubic interpolation. </constant> - <constant name="UPDATE_CONTINUOUS" value="0"> + <constant name="UPDATE_CONTINUOUS" value="0" enum="UpdateMode"> Update between keyframes. </constant> - <constant name="UPDATE_DISCRETE" value="1"> + <constant name="UPDATE_DISCRETE" value="1" enum="UpdateMode"> Update at the keyframes and hold the value. </constant> - <constant name="UPDATE_TRIGGER" value="2"> + <constant name="UPDATE_TRIGGER" value="2" enum="UpdateMode"> Update at the keyframes. </constant> </constants> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index f0a1f7f634..570f5e9741 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimationPlayer" inherits="Node" category="Core" version="3.0-alpha"> +<class name="AnimationPlayer" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Container and player of [Animation] resources. </brief_description> @@ -19,7 +19,7 @@ <argument index="1" name="animation" type="Animation"> </argument> <description> - Add an animation resource to the player, which will be later referenced by the "name" argument. + Adds [code]animation[/code] to the player accessible with the key [code]name[/code]. </description> </method> <method name="advance"> @@ -28,7 +28,7 @@ <argument index="0" name="delta" type="float"> </argument> <description> - Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip. + Shifts position in the animation timeline. Delta is the time in seconds to shift. </description> </method> <method name="animation_get_next" qualifiers="const"> @@ -37,7 +37,7 @@ <argument index="0" name="anim_from" type="String"> </argument> <description> - Return the name of the next animation in the queue. + Returns the name of the next animation in the queue. </description> </method> <method name="animation_set_next"> @@ -48,21 +48,21 @@ <argument index="1" name="anim_to" type="String"> </argument> <description> - Set the name of an animation that will be played after. + Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes. </description> </method> <method name="clear_caches"> <return type="void"> </return> <description> - The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again. + [code]AnimationPlayer[/code] caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again. </description> </method> <method name="clear_queue"> <return type="void"> </return> <description> - If animations are queued to play, clear them. + Clears all queued, unplayed animations. </description> </method> <method name="find_animation" qualifiers="const"> @@ -71,7 +71,7 @@ <argument index="0" name="animation" type="Animation"> </argument> <description> - Find an animation name by resource. + Returns the name of [code]animation[/code] or empty string if not found. </description> </method> <method name="get_animation" qualifiers="const"> @@ -80,28 +80,21 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get an [Animation] resource by requesting a name. + Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found. </description> </method> <method name="get_animation_list" qualifiers="const"> <return type="PoolStringArray"> </return> <description> - Get the list of names of the animations stored in the player. - </description> - </method> - <method name="get_animation_process_mode" qualifiers="const"> - <return type="int" enum="AnimationPlayer.AnimationProcessMode"> - </return> - <description> - Return the mode in which the animation player processes. See [method set_animation_process_mode]. + Returns the list of stored animation names. </description> </method> <method name="get_autoplay" qualifiers="const"> <return type="String"> </return> <description> - Return the name of the animation that will be automatically played when the scene is loaded. + Returns the name of the animation that will be automatically played when the scene is loaded. </description> </method> <method name="get_blend_time" qualifiers="const"> @@ -112,14 +105,14 @@ <argument index="1" name="anim_to" type="String"> </argument> <description> - Get the blend time between two animations, referenced by their names. + Get the blend time (in seconds) between two animations, referenced by their names. </description> </method> <method name="get_current_animation" qualifiers="const"> <return type="String"> </return> <description> - Return the name of the animation being played. + Returns the name of the animation being played. </description> </method> <method name="get_current_animation_length" qualifiers="const"> @@ -133,35 +126,13 @@ <return type="float"> </return> <description> - Get the position (in seconds) of the currently being played animation. - </description> - </method> - <method name="get_default_blend_time" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the default blend time between animations. - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). - </description> - </method> - <method name="get_root" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - Return path to root node (see [method set_root]). + Get the position (in seconds) of the currently playing animation. </description> </method> <method name="get_speed_scale" qualifiers="const"> <return type="float"> </return> <description> - Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). </description> </method> <method name="has_animation" qualifiers="const"> @@ -170,21 +141,21 @@ <argument index="0" name="name" type="String"> </argument> <description> - Request whether an [Animation] name exist within the player. + Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code]. </description> </method> <method name="is_active" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the player is active. + Returns [code]true[/code] if the player is active. </description> </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> <description> - Return whether an animation is playing. + Returns [code]true[/code] if playing an animation. </description> </method> <method name="play"> @@ -199,7 +170,8 @@ <argument index="3" name="from_end" type="bool" default="false"> </argument> <description> - Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. + 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 true can play the + animation backwards. </description> </method> <method name="play_backwards"> @@ -210,7 +182,7 @@ <argument index="1" name="custom_blend" type="float" default="-1"> </argument> <description> - Play a given animation by the animation name in reverse. + Play the animation with key [code]name[/code] in reverse. </description> </method> <method name="queue"> @@ -228,7 +200,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Remove an animation from the player (by supplying the same name used to add it). + Remove the animation with key [code]name[/code]. </description> </method> <method name="rename_animation"> @@ -239,7 +211,7 @@ <argument index="1" name="newname" type="String"> </argument> <description> - Rename an existing animation. + Rename an existing animation with key [code]name[/code] to [code]newname[/code]. </description> </method> <method name="seek"> @@ -250,7 +222,7 @@ <argument index="1" name="update" type="bool" default="false"> </argument> <description> - Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time. + 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. </description> </method> <method name="set_active"> @@ -259,16 +231,7 @@ <argument index="0" name="active" type="bool"> </argument> <description> - Set the player as active (playing). If false, it will do nothing. - </description> - </method> - <method name="set_animation_process_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="AnimationPlayer.AnimationProcessMode"> - </argument> - <description> - Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*. + Sets the player as active (playing). If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code]. </description> </method> <method name="set_autoplay"> @@ -277,7 +240,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Set the name of the animation that will be automatically played when the scene is loaded. + Defines the name of the animation to play when the scene loads. Default value: [code]""[/code]. </description> </method> <method name="set_blend_time"> @@ -299,25 +262,7 @@ <argument index="0" name="anim" type="String"> </argument> <description> - Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). - </description> - </method> - <method name="set_default_blend_time"> - <return type="void"> - </return> - <argument index="0" name="sec" type="float"> - </argument> - <description> - Set the default blend time between animations. - </description> - </method> - <method name="set_root"> - <return type="void"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed. + Sets the name of the current animation. If already playing, restarts the animation. Ensure [member active] is [code]true[/code] to simulate [method play]. Default value: [code]""[/code]. </description> </method> <method name="set_speed_scale"> @@ -326,7 +271,7 @@ <argument index="0" name="speed" type="float"> </argument> <description> - Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). + Sets the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code]. </description> </method> <method name="stop"> @@ -335,23 +280,19 @@ <argument index="0" name="reset" type="bool" default="true"> </argument> <description> - Stop the currently playing animation. - </description> - </method> - <method name="stop_all"> - <return type="void"> - </return> - <description> - Stop playback of animations (deprecated). + Stop the currently playing animation. If [code]reset[/code] is [code]true[/code], the anim position is reset to [code]0[/code]. </description> </method> </methods> <members> <member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time"> + The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code]. </member> <member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode"> + The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. </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]. </member> </members> <signals> @@ -380,10 +321,10 @@ </signal> </signals> <constants> - <constant name="ANIMATION_PROCESS_PHYSICS" value="0"> + <constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessMode"> Process animation during the physics process. This is especially useful when animating physics bodies. </constant> - <constant name="ANIMATION_PROCESS_IDLE" value="1"> + <constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessMode"> Process animation during the idle process. </constant> </constants> diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index 413606dbaa..ecd1f81951 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimationTreePlayer" inherits="Node" category="Core" version="3.0-alpha"> +<class name="AnimationTreePlayer" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Animation Player that uses a node graph for the blending. </brief_description> <description> - Animation Player that uses a node graph for the blending. This kind of player is very useful when animating character or other skeleton based rigs, because it can combine several animations to form a desired pose. + A node graph tool for blending multiple animations bound to an [AnimationPlayer]. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose. </description> <tutorials> </tutorials> @@ -19,7 +19,7 @@ <argument index="1" name="id" type="String"> </argument> <description> - Add a node of a given type in the graph with given id. + Adds a [code]type[/code] node to the graph with name [code]id[/code]. </description> </method> <method name="advance"> @@ -28,6 +28,7 @@ <argument index="0" name="delta" type="float"> </argument> <description> + Shifts position in the animation timeline. Delta is the time in seconds to shift. </description> </method> <method name="animation_node_get_animation" qualifiers="const"> @@ -36,7 +37,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Returns an animation given its name. + Returns the [AnimationPlayer]'s animation bound to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code]. </description> </method> <method name="animation_node_get_master_animation" qualifiers="const"> @@ -45,6 +46,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the name of the [member master_player]'s animation bound to this animation node. </description> </method> <method name="animation_node_set_animation"> @@ -55,7 +57,7 @@ <argument index="1" name="animation" type="Animation"> </argument> <description> - Set the animation for an animation node. + Binds a new animation from the [member master_player] to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code]. </description> </method> <method name="animation_node_set_filter_path"> @@ -68,6 +70,7 @@ <argument index="2" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], the animation node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. </description> </method> <method name="animation_node_set_master_animation"> @@ -78,6 +81,7 @@ <argument index="1" name="source" type="String"> </argument> <description> + Binds the animation named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches. </description> </method> <method name="are_nodes_connected" qualifiers="const"> @@ -123,6 +127,7 @@ <argument index="2" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], the blend2 node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. </description> </method> <method name="blend3_node_get_amount" qualifiers="const"> @@ -189,25 +194,6 @@ Disconnects nodes connected to [code]id[/code] at the specified input slot. </description> </method> - <method name="get_animation_process_mode" qualifiers="const"> - <return type="int" enum="AnimationTreePlayer.AnimationProcessMode"> - </return> - <description> - Returns playback process mode of this AnimationTreePlayer. - </description> - </method> - <method name="get_base_path" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="get_master_player" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> <method name="get_node_list"> <return type="PoolStringArray"> </return> @@ -215,13 +201,6 @@ Returns a PoolStringArray containing the name of all nodes. </description> </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether this AnimationTreePlayer is active. - </description> - </method> <method name="mix_node_get_amount" qualifiers="const"> <return type="float"> </return> @@ -430,6 +409,7 @@ <argument index="2" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], the oneshot node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. </description> </method> <method name="oneshot_node_start"> @@ -447,13 +427,14 @@ <argument index="0" name="id" type="String"> </argument> <description> - Stops a OneShot node given its name. + Stops the OneShot node with name [code]id[/code]. </description> </method> <method name="recompute_caches"> <return type="void"> </return> <description> + Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state. </description> </method> <method name="remove_node"> @@ -462,6 +443,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Removes the animation node with name [code]id[/code]. </description> </method> <method name="reset"> @@ -471,48 +453,13 @@ Resets this AnimationTreePlayer. </description> </method> - <method name="set_active"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active. - </description> - </method> - <method name="set_animation_process_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="AnimationTreePlayer.AnimationProcessMode"> - </argument> - <description> - Sets process mode (ANIMATION_PROCESS_*) of this AnimationTreePlayer. - </description> - </method> - <method name="set_base_path"> - <return type="void"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - Sets base path of this AnimationTreePlayer. - </description> - </method> - <method name="set_master_player"> - <return type="void"> - </return> - <argument index="0" name="nodepath" type="NodePath"> - </argument> - <description> - </description> - </method> <method name="timescale_node_get_scale" qualifiers="const"> <return type="float"> </return> <argument index="0" name="id" type="String"> </argument> <description> - Returns time scale value of a TimeScale node given its name. + Returns time scale value of the TimeScale node with name [code]id[/code]. </description> </method> <method name="timescale_node_set_scale"> @@ -523,7 +470,7 @@ <argument index="1" name="scale" type="float"> </argument> <description> - Sets time scale value of a TimeScale node given its name and value. + Sets the time scale of the TimeScale node with name [code]id[/code] to [code]scale[/code]. </description> </method> <method name="timeseek_node_seek"> @@ -534,7 +481,7 @@ <argument index="1" name="seconds" type="float"> </argument> <description> - Sets time seek value of a TimeSeek node given its name and value. + Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code] </description> </method> <method name="transition_node_delete_input"> @@ -545,6 +492,7 @@ <argument index="1" name="input_idx" type="int"> </argument> <description> + Deletes the input at [code]input_idx[/code] for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_get_current" qualifiers="const"> @@ -553,6 +501,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the index of the currently evaluated input for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_get_input_count" qualifiers="const"> @@ -561,6 +510,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the number of inputs for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_get_xfade_time" qualifiers="const"> @@ -569,6 +519,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the cross fade time for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_has_input_auto_advance" qualifiers="const"> @@ -579,6 +530,7 @@ <argument index="1" name="input_idx" type="int"> </argument> <description> + Returns [code]true[/code] if the input at [code]input_idx[/code] on transition node with name [code]id[/code] is set to automatically advance to the next input upon completion. </description> </method> <method name="transition_node_set_current"> @@ -589,6 +541,7 @@ <argument index="1" name="input_idx" type="int"> </argument> <description> + The transition node with name [code]id[/code] sets its current input at [code]input_idx[/code]. </description> </method> <method name="transition_node_set_input_auto_advance"> @@ -601,6 +554,7 @@ <argument index="2" name="enable" type="bool"> </argument> <description> + The transition node with name [code]id[/code] advances to its next input automatically when the input at [code]input_idx[/code] completes. </description> </method> <method name="transition_node_set_input_count"> @@ -611,6 +565,7 @@ <argument index="1" name="count" type="int"> </argument> <description> + Resizes the number of inputs available for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_set_xfade_time"> @@ -621,47 +576,60 @@ <argument index="1" name="time_sec" type="float"> </argument> <description> + The transition node with name [code]id[/code] sets its cross fade time to [code]time_sec[/code]. </description> </method> </methods> <members> + <member name="active" type="bool" setter="set_active" getter="is_active"> + If [code]true[/code] the [code]AnimationTreePlayer[/code] is able to play animations. Default value: [code]false[/code]. + </member> + <member name="base_path" type="NodePath" setter="set_base_path" getter="get_base_path"> + The node from which to relatively access other nodes. Default value: [code]".."[/code]. + </member> + <member name="master_player" type="NodePath" setter="set_master_player" getter="get_master_player"> + The path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes. + </member> <member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationTreePlayer.AnimationProcessMode"> + The thread in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. </member> </members> <constants> - <constant name="NODE_OUTPUT" value="0"> + <constant name="NODE_OUTPUT" value="0" enum="NodeType"> Output node. </constant> - <constant name="NODE_ANIMATION" value="1"> + <constant name="NODE_ANIMATION" value="1" enum="NodeType"> Animation node. </constant> - <constant name="NODE_ONESHOT" value="2"> + <constant name="NODE_ONESHOT" value="2" enum="NodeType"> OneShot node. </constant> - <constant name="NODE_MIX" value="3"> + <constant name="NODE_MIX" value="3" enum="NodeType"> Mix node. </constant> - <constant name="NODE_BLEND2" value="4"> + <constant name="NODE_BLEND2" value="4" enum="NodeType"> Blend2 node. </constant> - <constant name="NODE_BLEND3" value="5"> + <constant name="NODE_BLEND3" value="5" enum="NodeType"> Blend3 node. </constant> - <constant name="NODE_BLEND4" value="6"> + <constant name="NODE_BLEND4" value="6" enum="NodeType"> Blend4 node. </constant> - <constant name="NODE_TIMESCALE" value="7"> + <constant name="NODE_TIMESCALE" value="7" enum="NodeType"> TimeScale node. </constant> - <constant name="NODE_TIMESEEK" value="8"> + <constant name="NODE_TIMESEEK" value="8" enum="NodeType"> TimeSeek node. </constant> - <constant name="NODE_TRANSITION" value="9"> + <constant name="NODE_TRANSITION" value="9" enum="NodeType"> Transition node. </constant> - <constant name="ANIMATION_PROCESS_PHYSICS" value="0"> + <constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessMode"> + Process animation during the physics process. This is especially useful when animating physics bodies. </constant> - <constant name="ANIMATION_PROCESS_IDLE" value="1"> + <constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessMode"> + Process animation during the idle process. </constant> </constants> </class> diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index 85afa24214..b74e767fd2 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Area" inherits="CollisionObject" category="Core" version="3.0-alpha"> +<class name="Area" inherits="CollisionObject" category="Core" version="3.0-beta"> <brief_description> General purpose area node for detection and 3D physics influence. </brief_description> @@ -11,40 +11,13 @@ <demos> </demos> <methods> - <method name="get_angular_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the angular damp rate. - </description> - </method> - <method name="get_audio_bus" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_collision_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layer this area is in. - </description> - </method> <method name="get_collision_layer_bit" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the layer mask. - </description> - </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layers this area can scan for collisions. + Returns an individual bit on the layer mask. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -53,35 +26,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the collision mask. - </description> - </method> - <method name="get_gravity" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the gravity intensity. - </description> - </method> - <method name="get_gravity_distance_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the falloff factor for point gravity. - </description> - </method> - <method name="get_gravity_vector" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. - </description> - </method> - <method name="get_linear_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the linear damp rate. + Returns an individual bit on the collision mask. </description> </method> <method name="get_overlapping_areas" qualifiers="const"> @@ -98,71 +43,6 @@ Returns a list of intersecting [PhysicsBody]s. </description> </method> - <method name="get_priority" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the processing order of this area. - </description> - </method> - <method name="get_reverb_amount" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_reverb_bus" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_reverb_uniformity" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_space_override_mode" qualifiers="const"> - <return type="int" enum="Area.SpaceOverride"> - </return> - <description> - Return the space override mode. - </description> - </method> - <method name="is_gravity_a_point" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. - </description> - </method> - <method name="is_monitorable" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this area can be detected by other, monitoring, areas. - </description> - </method> - <method name="is_monitoring" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this area detects bodies/areas entering/exiting it. - </description> - </method> - <method name="is_overriding_audio_bus" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_using_reverb_bus" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="overlaps_area" qualifiers="const"> <return type="bool"> </return> @@ -181,43 +61,6 @@ If [code]true[/code] the given body overlaps the Area. </description> </method> - <method name="set_angular_damp"> - <return type="void"> - </return> - <argument index="0" name="angular_damp" type="float"> - </argument> - <description> - Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. - In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. - </description> - </method> - <method name="set_audio_bus"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_audio_bus_override"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_collision_layer"> - <return type="void"> - </return> - <argument index="0" name="collision_layer" type="int"> - </argument> - <description> - Set the physics layers this area is in. - Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - </description> - </method> <method name="set_collision_layer_bit"> <return type="void"> </return> @@ -226,16 +69,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. - </description> - </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="collision_mask" type="int"> - </argument> - <description> - Set the physics layers this area can scan for collisions. + Set/clear individual bits on the layer mask. This simplifies editing this [code]Area[code]'s layers. </description> </method> <method name="set_collision_mask_bit"> @@ -246,129 +80,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. - </description> - </method> - <method name="set_gravity"> - <return type="void"> - </return> - <argument index="0" name="gravity" type="float"> - </argument> - <description> - Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. - This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity). - </description> - </method> - <method name="set_gravity_distance_scale"> - <return type="void"> - </return> - <argument index="0" name="distance_scale" type="float"> - </argument> - <description> - Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. - </description> - </method> - <method name="set_gravity_is_point"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. - </description> - </method> - <method name="set_gravity_vector"> - <return type="void"> - </return> - <argument index="0" name="vector" type="Vector3"> - </argument> - <description> - Set the gravity vector. This vector does not have to be normalized. - If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. - </description> - </method> - <method name="set_linear_damp"> - <return type="void"> - </return> - <argument index="0" name="linear_damp" type="float"> - </argument> - <description> - Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. - In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. - </description> - </method> - <method name="set_monitorable"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. - </description> - </method> - <method name="set_monitoring"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set whether this area can detect bodies/areas entering/exiting it. - </description> - </method> - <method name="set_priority"> - <return type="void"> - </return> - <argument index="0" name="priority" type="float"> - </argument> - <description> - Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. - Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. - </description> - </method> - <method name="set_reverb_amount"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_reverb_bus"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_reverb_uniformity"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_space_override_mode"> - <return type="void"> - </return> - <argument index="0" name="enable" type="int" enum="Area.SpaceOverride"> - </argument> - <description> - Set the space override mode. This mode controls how an area affects gravity and damp. - AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. - AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. - AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. - AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. - AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. - </description> - </method> - <method name="set_use_reverb_bus"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> + Set/clear individual bits on the collision mask. This simplifies editing which [code]Area[/code] layers this [code]Area[/code] scans. </description> </method> </methods> @@ -413,12 +125,16 @@ The area's priority. Higher priority areas are processed first. Default value: 0. </member> <member name="reverb_bus_amount" type="float" setter="set_reverb_amount" getter="get_reverb_amount"> + The degree to which this area applies reverb to its associated audio. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. </member> <member name="reverb_bus_enable" type="bool" setter="set_use_reverb_bus" getter="is_using_reverb_bus"> + If [code]true[/code] the area applies reverb to its associated audio. </member> <member name="reverb_bus_name" type="String" setter="set_reverb_bus" getter="get_reverb_bus"> + The reverb bus name to use for this area's associated audio. </member> <member name="reverb_bus_uniformity" type="float" setter="set_reverb_uniformity" getter="get_reverb_uniformity"> + The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. </member> <member name="space_override" type="int" setter="set_space_override_mode" getter="get_space_override_mode" enum="Area.SpaceOverride"> Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE_* constants for values. @@ -507,19 +223,19 @@ </signal> </signals> <constants> - <constant name="SPACE_OVERRIDE_DISABLED" value="0"> + <constant name="SPACE_OVERRIDE_DISABLED" value="0" enum="SpaceOverride"> This area does not affect gravity/damping. </constant> - <constant name="SPACE_OVERRIDE_COMBINE" value="1"> + <constant name="SPACE_OVERRIDE_COMBINE" value="1" enum="SpaceOverride"> This area adds its gravity/damping values to whatever has been calculated so far (in [code]priority[/code] order). </constant> - <constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + <constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2" enum="SpaceOverride"> This area adds its gravity/damping values to whatever has been calculated so far (in [code]priority[/code] order), ignoring any lower priority areas. </constant> - <constant name="SPACE_OVERRIDE_REPLACE" value="3"> + <constant name="SPACE_OVERRIDE_REPLACE" value="3" enum="SpaceOverride"> This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. </constant> - <constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + <constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4" enum="SpaceOverride"> This area replaces any gravity/damping calculated so far (in [code]priority[/code] order), but keeps calculating the rest of the areas. </constant> </constants> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 5869e2238e..6a3f0e7645 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Area2D" inherits="CollisionObject2D" category="Core" version="3.0-alpha"> +<class name="Area2D" inherits="CollisionObject2D" category="Core" version="3.0-beta"> <brief_description> 2D area for detection and 2D physics influence. </brief_description> @@ -11,26 +11,6 @@ <demos> </demos> <methods> - <method name="get_angular_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the angular damp rate. - </description> - </method> - <method name="get_audio_bus_name" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_collision_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layer this area is in. - </description> - </method> <method name="get_collision_layer_bit" qualifiers="const"> <return type="bool"> </return> @@ -40,13 +20,6 @@ Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layers this area will scan to determine collisions. - </description> - </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> @@ -56,34 +29,6 @@ Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. </description> </method> - <method name="get_gravity" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the gravity intensity. - </description> - </method> - <method name="get_gravity_distance_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the falloff factor for point gravity. - </description> - </method> - <method name="get_gravity_vector" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. - </description> - </method> - <method name="get_linear_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the linear damp rate. - </description> - </method> <method name="get_overlapping_areas" qualifiers="const"> <return type="Array"> </return> @@ -98,47 +43,6 @@ Returns a list of intersecting [PhysicsBody2D]s. </description> </method> - <method name="get_priority" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the processing order of this area. - </description> - </method> - <method name="get_space_override_mode" qualifiers="const"> - <return type="int" enum="Area2D.SpaceOverride"> - </return> - <description> - Return the space override mode. - </description> - </method> - <method name="is_gravity_a_point" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. - </description> - </method> - <method name="is_monitorable" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this area can be detected by other, monitoring, areas. - </description> - </method> - <method name="is_monitoring" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this area detects bodies/areas entering/exiting it. - </description> - </method> - <method name="is_overriding_audio_bus" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="overlaps_area" qualifiers="const"> <return type="bool"> </return> @@ -157,43 +61,6 @@ If [code]true[/code] the given body overlaps the Area2D. </description> </method> - <method name="set_angular_damp"> - <return type="void"> - </return> - <argument index="0" name="angular_damp" type="float"> - </argument> - <description> - Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. - In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. - </description> - </method> - <method name="set_audio_bus_name"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_audio_bus_override"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_collision_layer"> - <return type="void"> - </return> - <argument index="0" name="collision_layer" type="int"> - </argument> - <description> - Set the physics layers this area is in. - Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - </description> - </method> <method name="set_collision_layer_bit"> <return type="void"> </return> @@ -205,15 +72,6 @@ Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. </description> </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="collision_mask" type="int"> - </argument> - <description> - Set the physics layers this area can scan for collisions. - </description> - </method> <method name="set_collision_mask_bit"> <return type="void"> </return> @@ -225,96 +83,6 @@ Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> - <method name="set_gravity"> - <return type="void"> - </return> - <argument index="0" name="gravity" type="float"> - </argument> - <description> - Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. - This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity). - </description> - </method> - <method name="set_gravity_distance_scale"> - <return type="void"> - </return> - <argument index="0" name="distance_scale" type="float"> - </argument> - <description> - Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. - </description> - </method> - <method name="set_gravity_is_point"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. - </description> - </method> - <method name="set_gravity_vector"> - <return type="void"> - </return> - <argument index="0" name="vector" type="Vector2"> - </argument> - <description> - Set the gravity vector. This vector does not have to be normalized. - If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. - </description> - </method> - <method name="set_linear_damp"> - <return type="void"> - </return> - <argument index="0" name="linear_damp" type="float"> - </argument> - <description> - Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. - In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. - </description> - </method> - <method name="set_monitorable"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. - </description> - </method> - <method name="set_monitoring"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set whether this area can detect bodies/areas entering/exiting it. - </description> - </method> - <method name="set_priority"> - <return type="void"> - </return> - <argument index="0" name="priority" type="float"> - </argument> - <description> - Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. - Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. - </description> - </method> - <method name="set_space_override_mode"> - <return type="void"> - </return> - <argument index="0" name="space_override_mode" type="int" enum="Area2D.SpaceOverride"> - </argument> - <description> - Set the space override mode. This mode controls how an area affects gravity and damp. - AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. - AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. - AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. - AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. - AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. - </description> - </method> </methods> <members> <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp"> @@ -443,19 +211,19 @@ </signal> </signals> <constants> - <constant name="SPACE_OVERRIDE_DISABLED" value="0"> + <constant name="SPACE_OVERRIDE_DISABLED" value="0" enum="SpaceOverride"> This area does not affect gravity/damping. </constant> - <constant name="SPACE_OVERRIDE_COMBINE" value="1"> + <constant name="SPACE_OVERRIDE_COMBINE" value="1" enum="SpaceOverride"> This area adds its gravity/damping values to whatever has been calculated so far (in [code]priority[/code] order). </constant> - <constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + <constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2" enum="SpaceOverride"> This area adds its gravity/damping values to whatever has been calculated so far (in [code]priority[/code] order), ignoring any lower priority areas. </constant> - <constant name="SPACE_OVERRIDE_REPLACE" value="3"> + <constant name="SPACE_OVERRIDE_REPLACE" value="3" enum="SpaceOverride"> This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. </constant> - <constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + <constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4" enum="SpaceOverride"> This area replaces any gravity/damping calculated so far (in [code]priority[/code] order), but keeps calculating the rest of the areas. </constant> </constants> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 203c60e644..9445a1732e 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Array" category="Built-In Types" version="3.0-alpha"> +<class name="Array" category="Built-In Types" version="3.0-beta"> <brief_description> Generic array datatype. </brief_description> @@ -88,6 +88,32 @@ Returns the last element of the array if the array is not empty (size>0). </description> </method> + <method name="bsearch"> + <return type="int"> + </return> + <argument index="0" name="value" type="var"> + </argument> + <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 false, 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. + </description> + </method> + <method name="bsearch_custom"> + <return type="int"> + </return> + <argument index="0" name="value" type="var"> + </argument> + <argument index="1" name="obj" type="Object"> + </argument> + <argument index="2" name="func" type="String"> + </argument> + <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 false, 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 true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. + </description> + </method> <method name="clear"> <description> Clear the array (resize to 0). @@ -258,6 +284,16 @@ </argument> <description> Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. + [codeblock] + class MyCustomSorter: + static func sort(a, b): + if a[0] < b[0]: + return true + return false + + var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]] + my_items.sort_custom(MyCustomSorter, "sort") + [/codeblock] </description> </method> </methods> diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 10456f805d..92c4fe2fe7 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ArrayMesh" inherits="Mesh" category="Core" version="3.0-alpha"> +<class name="ArrayMesh" inherits="Mesh" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -66,7 +66,7 @@ </description> </method> <method name="get_custom_aabb" qualifiers="const"> - <return type="Rect3"> + <return type="AABB"> </return> <description> </description> @@ -95,7 +95,7 @@ <method name="set_custom_aabb"> <return type="void"> </return> - <argument index="0" name="aabb" type="Rect3"> + <argument index="0" name="aabb" type="AABB"> </argument> <description> </description> @@ -213,66 +213,66 @@ </method> </methods> <constants> - <constant name="NO_INDEX_ARRAY" value="-1" enum=""> + <constant name="NO_INDEX_ARRAY" value="-1"> Default value used for index_array_len when no indices are present. </constant> - <constant name="ARRAY_WEIGHTS_SIZE" value="4" enum=""> + <constant name="ARRAY_WEIGHTS_SIZE" value="4"> Amount of weights/bone indices per vertex (always 4). </constant> - <constant name="ARRAY_VERTEX" value="0"> + <constant name="ARRAY_VERTEX" value="0" enum="ArrayType"> Vertex array (array of [Vector3] vertices). </constant> - <constant name="ARRAY_NORMAL" value="1"> + <constant name="ARRAY_NORMAL" value="1" enum="ArrayType"> Normal array (array of [Vector3] normals). </constant> - <constant name="ARRAY_TANGENT" value="2"> + <constant name="ARRAY_TANGENT" value="2" enum="ArrayType"> Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. </constant> - <constant name="ARRAY_COLOR" value="3"> + <constant name="ARRAY_COLOR" value="3" enum="ArrayType"> Vertex array (array of [Color] colors). </constant> - <constant name="ARRAY_TEX_UV" value="4"> + <constant name="ARRAY_TEX_UV" value="4" enum="ArrayType"> UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). </constant> - <constant name="ARRAY_TEX_UV2" value="5"> + <constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType"> Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). </constant> - <constant name="ARRAY_BONES" value="6"> + <constant name="ARRAY_BONES" value="6" enum="ArrayType"> Array of bone indices, as a float array. Each element in groups of 4 floats. </constant> - <constant name="ARRAY_WEIGHTS" value="7"> + <constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType"> Array of bone weights, as a float array. Each element in groups of 4 floats. </constant> - <constant name="ARRAY_INDEX" value="8"> + <constant name="ARRAY_INDEX" value="8" enum="ArrayType"> Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. </constant> - <constant name="ARRAY_MAX" value="9"> + <constant name="ARRAY_MAX" value="9" enum="ArrayType"> </constant> - <constant name="ARRAY_FORMAT_VERTEX" value="1"> + <constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat"> Array format will include vertices (mandatory). </constant> - <constant name="ARRAY_FORMAT_NORMAL" value="2"> + <constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat"> Array format will include normals </constant> - <constant name="ARRAY_FORMAT_TANGENT" value="4"> + <constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat"> Array format will include tangents </constant> - <constant name="ARRAY_FORMAT_COLOR" value="8"> + <constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat"> Array format will include a color array. </constant> - <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + <constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat"> Array format will include UVs. </constant> - <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> + <constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat"> Array format will include another set of UVs. </constant> - <constant name="ARRAY_FORMAT_BONES" value="64"> + <constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat"> Array format will include bone indices. </constant> - <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128" enum="ArrayFormat"> Array format will include bone weights. </constant> - <constant name="ARRAY_FORMAT_INDEX" value="256"> + <constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat"> Index array will be used. </constant> </constants> diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 7cb934889e..f1a79bc312 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AtlasTexture" inherits="Texture" category="Core" version="3.0-alpha"> +<class name="AtlasTexture" inherits="Texture" category="Core" version="3.0-beta"> <brief_description> Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. </brief_description> @@ -12,68 +12,13 @@ <demos> </demos> <methods> - <method name="get_atlas" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_margin" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="get_region" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="has_filter_clip" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_atlas"> - <return type="void"> - </return> - <argument index="0" name="atlas" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_filter_clip"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="set_region"> - <return type="void"> - </return> - <argument index="0" name="region" type="Rect2"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas"> The texture that contains the atlas. Can be any [Texture] subtype. </member> <member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip"> + 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. diff --git a/doc/classes/AudioBusLayout.xml b/doc/classes/AudioBusLayout.xml index c539c7500b..a70a3e1702 100644 --- a/doc/classes/AudioBusLayout.xml +++ b/doc/classes/AudioBusLayout.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioBusLayout" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="AudioBusLayout" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Stores information about the audiobusses. </brief_description> diff --git a/doc/classes/AudioEffect.xml b/doc/classes/AudioEffect.xml index 804cba82fe..0122f727d0 100644 --- a/doc/classes/AudioEffect.xml +++ b/doc/classes/AudioEffect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffect" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="AudioEffect" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Audio Effect For Audio. </brief_description> diff --git a/doc/classes/AudioEffectAmplify.xml b/doc/classes/AudioEffectAmplify.xml index 0149e03de4..efdf6c3b9b 100644 --- a/doc/classes/AudioEffectAmplify.xml +++ b/doc/classes/AudioEffectAmplify.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Adds a Amplify audio effect to an Audio bus. Increases or decreases the volume of the selected audio bus. @@ -12,20 +12,6 @@ <demos> </demos> <methods> - <method name="get_volume_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_volume_db"> - <return type="void"> - </return> - <argument index="0" name="volume" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> diff --git a/doc/classes/AudioEffectBandLimitFilter.xml b/doc/classes/AudioEffectBandLimitFilter.xml index f83cf8ba72..64542e8b92 100644 --- a/doc/classes/AudioEffectBandLimitFilter.xml +++ b/doc/classes/AudioEffectBandLimitFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.0-alpha"> +<class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> <brief_description> Adds a band limit filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectBandPassFilter.xml b/doc/classes/AudioEffectBandPassFilter.xml index e922d3e821..dbc8b2c85a 100644 --- a/doc/classes/AudioEffectBandPassFilter.xml +++ b/doc/classes/AudioEffectBandPassFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-alpha"> +<class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> <brief_description> Adds a band pass filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index 40bac419d6..465fda28da 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Adds a chorus audio effect. </brief_description> @@ -11,174 +11,6 @@ <demos> </demos> <methods> - <method name="get_dry" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the set dry ratio. - </description> - </method> - <method name="get_voice_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the set voice count. - </description> - </method> - <method name="get_voice_cutoff_hz" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <description> - Returns the voice's set cutoff frequency. - </description> - </method> - <method name="get_voice_delay_ms" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <description> - Returns the voice's set delay. - </description> - </method> - <method name="get_voice_depth_ms" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <description> - Returns the voice's set filter depth. - </description> - </method> - <method name="get_voice_level_db" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <description> - Returns the voice's set maximum volume. - </description> - </method> - <method name="get_voice_pan" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <description> - Returns the voice's set pan. - </description> - </method> - <method name="get_voice_rate_hz" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <description> - Returns the voice filter's set rate in cycles. - </description> - </method> - <method name="get_wet" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the set applied wetness of the effect. - </description> - </method> - <method name="set_dry"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - Returns the set applied dryness of the effect. - </description> - </method> - <method name="set_voice_count"> - <return type="void"> - </return> - <argument index="0" name="voices" type="int"> - </argument> - <description> - Set the number of voices in the effect's filter. - </description> - </method> - <method name="set_voice_cutoff_hz"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="cutoff_hz" type="float"> - </argument> - <description> - Set the cutoff frequency of the voice. The maximum frequency the voice may affect. - </description> - </method> - <method name="set_voice_delay_ms"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="delay_ms" type="float"> - </argument> - <description> - Set the delay of the voice's signal. - </description> - </method> - <method name="set_voice_depth_ms"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="depth_ms" type="float"> - </argument> - <description> - Set the filter depth of the voice's signal. - </description> - </method> - <method name="set_voice_level_db"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="level_db" type="float"> - </argument> - <description> - Set the volume level of the voice. - </description> - </method> - <method name="set_voice_pan"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="pan" type="float"> - </argument> - <description> - Set the pan level of the voice. - </description> - </method> - <method name="set_voice_rate_hz"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="rate_hz" type="float"> - </argument> - <description> - Set the voice filter's rate. - </description> - </method> - <method name="set_wet"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - Set the amount of effect. - </description> - </method> </methods> <members> <member name="dry" type="float" setter="set_dry" getter="get_dry"> diff --git a/doc/classes/AudioEffectCompressor.xml b/doc/classes/AudioEffectCompressor.xml index ae877f145a..dd9d6481e2 100644 --- a/doc/classes/AudioEffectCompressor.xml +++ b/doc/classes/AudioEffectCompressor.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectCompressor" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectCompressor" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> 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. @@ -17,104 +17,6 @@ <demos> </demos> <methods> - <method name="get_attack_us" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_gain" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_mix" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ratio" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_release_ms" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sidechain" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_threshold" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_attack_us"> - <return type="void"> - </return> - <argument index="0" name="attack_us" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_gain"> - <return type="void"> - </return> - <argument index="0" name="gain" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_mix"> - <return type="void"> - </return> - <argument index="0" name="mix" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ratio"> - <return type="void"> - </return> - <argument index="0" name="ratio" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_release_ms"> - <return type="void"> - </return> - <argument index="0" name="release_ms" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sidechain"> - <return type="void"> - </return> - <argument index="0" name="sidechain" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_threshold"> - <return type="void"> - </return> - <argument index="0" name="threshold" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="attack_us" type="float" setter="set_attack_us" getter="get_attack_us"> diff --git a/doc/classes/AudioEffectDelay.xml b/doc/classes/AudioEffectDelay.xml index a9251b6cf0..c961f1f582 100644 --- a/doc/classes/AudioEffectDelay.xml +++ b/doc/classes/AudioEffectDelay.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectDelay" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectDelay" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Adds a Delay audio effect to an Audio bus. Plays input signal back after a period of time. Two tap delay and feedback options. @@ -12,188 +12,6 @@ <demos> </demos> <methods> - <method name="get_dry"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_feedback_delay_ms" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_feedback_level_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_feedback_lowpass" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tap1_delay_ms" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tap1_level_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tap1_pan" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tap2_delay_ms" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tap2_level_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tap2_pan" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="is_feedback_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_tap1_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_tap2_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_dry"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_feedback_active"> - <return type="void"> - </return> - <argument index="0" name="amount" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_feedback_delay_ms"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_feedback_level_db"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_feedback_lowpass"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tap1_active"> - <return type="void"> - </return> - <argument index="0" name="amount" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_tap1_delay_ms"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tap1_level_db"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tap1_pan"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tap2_active"> - <return type="void"> - </return> - <argument index="0" name="amount" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_tap2_delay_ms"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tap2_level_db"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tap2_pan"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="dry" type="float" setter="set_dry" getter="get_dry"> diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml index 25df71d5f5..fd77a91570 100644 --- a/doc/classes/AudioEffectDistortion.xml +++ b/doc/classes/AudioEffectDistortion.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectDistortion" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectDistortion" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Adds a Distortion audio effect to an Audio bus. Modify the sound to make it dirty. @@ -13,76 +13,6 @@ <demos> </demos> <methods> - <method name="get_drive" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_keep_hf_hz" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int" enum="AudioEffectDistortion.Mode"> - </return> - <description> - </description> - </method> - <method name="get_post_gain" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_pre_gain" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_drive"> - <return type="void"> - </return> - <argument index="0" name="drive" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_keep_hf_hz"> - <return type="void"> - </return> - <argument index="0" name="keep_hf_hz" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="AudioEffectDistortion.Mode"> - </argument> - <description> - </description> - </method> - <method name="set_post_gain"> - <return type="void"> - </return> - <argument index="0" name="post_gain" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_pre_gain"> - <return type="void"> - </return> - <argument index="0" name="pre_gain" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="drive" type="float" setter="set_drive" getter="get_drive"> @@ -102,18 +32,18 @@ </member> </members> <constants> - <constant name="MODE_CLIP" value="0"> + <constant name="MODE_CLIP" value="0" enum="Mode"> Digital distortion effect which cuts off peaks at the top and bottom of the waveform. </constant> - <constant name="MODE_ATAN" value="1"> + <constant name="MODE_ATAN" value="1" enum="Mode"> </constant> - <constant name="MODE_LOFI" value="2"> + <constant name="MODE_LOFI" value="2" enum="Mode"> Low-resolution digital distortion effect. You can use it to emulate the sound of early digital audio devices. </constant> - <constant name="MODE_OVERDRIVE" value="3"> + <constant name="MODE_OVERDRIVE" value="3" enum="Mode"> Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. </constant> - <constant name="MODE_WAVESHAPE" value="4"> + <constant name="MODE_WAVESHAPE" value="4" enum="Mode"> Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound. </constant> </constants> diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml index f8b4d426f4..a78b9e4bb1 100644 --- a/doc/classes/AudioEffectEQ.xml +++ b/doc/classes/AudioEffectEQ.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectEQ" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectEQ" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Base class for audio equalizers. Gives you control over frequencies. Use it to create a custom equalizer if [AudioEffectEQ6], [AudioEffectEQ10] or [AudioEffectEQ21] don't fit your needs. diff --git a/doc/classes/AudioEffectEQ10.xml b/doc/classes/AudioEffectEQ10.xml index 95801ef40c..9a007f80b1 100644 --- a/doc/classes/AudioEffectEQ10.xml +++ b/doc/classes/AudioEffectEQ10.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectEQ10" inherits="AudioEffectEQ" category="Core" version="3.0-alpha"> +<class name="AudioEffectEQ10" inherits="AudioEffectEQ" category="Core" version="3.0-beta"> <brief_description> Adds a 10-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 31 Hz to 16000 Hz. Each frequency can be modulated between -60/+24 dB. diff --git a/doc/classes/AudioEffectEQ21.xml b/doc/classes/AudioEffectEQ21.xml index b62e0458f7..6e13291895 100644 --- a/doc/classes/AudioEffectEQ21.xml +++ b/doc/classes/AudioEffectEQ21.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectEQ21" inherits="AudioEffectEQ" category="Core" version="3.0-alpha"> +<class name="AudioEffectEQ21" inherits="AudioEffectEQ" category="Core" version="3.0-beta"> <brief_description> Adds a 21-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 22 Hz to 22000 Hz. Each frequency can be modulated between -60/+24 dB. diff --git a/doc/classes/AudioEffectEQ6.xml b/doc/classes/AudioEffectEQ6.xml index f679ccede4..ecfc7afeed 100644 --- a/doc/classes/AudioEffectEQ6.xml +++ b/doc/classes/AudioEffectEQ6.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectEQ6" inherits="AudioEffectEQ" category="Core" version="3.0-alpha"> +<class name="AudioEffectEQ6" inherits="AudioEffectEQ" category="Core" version="3.0-beta"> <brief_description> Adds a 6-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 32 Hz to 10000 Hz. Each frequency can be modulated between -60/+24 dB. diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 244c07a6da..3e1848f314 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Adds a filter to the Audio Bus. </brief_description> @@ -11,62 +11,6 @@ <demos> </demos> <methods> - <method name="get_cutoff" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_db" qualifiers="const"> - <return type="int" enum="AudioEffectFilter.FilterDB"> - </return> - <description> - </description> - </method> - <method name="get_gain" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_resonance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_cutoff"> - <return type="void"> - </return> - <argument index="0" name="freq" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_db"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int" enum="AudioEffectFilter.FilterDB"> - </argument> - <description> - </description> - </method> - <method name="set_gain"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_resonance"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff"> @@ -82,13 +26,13 @@ </member> </members> <constants> - <constant name="FILTER_6DB" value="0"> + <constant name="FILTER_6DB" value="0" enum="FilterDB"> </constant> - <constant name="FILTER_12DB" value="1"> + <constant name="FILTER_12DB" value="1" enum="FilterDB"> </constant> - <constant name="FILTER_18DB" value="2"> + <constant name="FILTER_18DB" value="2" enum="FilterDB"> </constant> - <constant name="FILTER_24DB" value="3"> + <constant name="FILTER_24DB" value="3" enum="FilterDB"> </constant> </constants> </class> diff --git a/doc/classes/AudioEffectHighPassFilter.xml b/doc/classes/AudioEffectHighPassFilter.xml index 4718d4d4a5..ac57ec0d2f 100644 --- a/doc/classes/AudioEffectHighPassFilter.xml +++ b/doc/classes/AudioEffectHighPassFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-alpha"> +<class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> <brief_description> Adds a high pass filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectHighShelfFilter.xml b/doc/classes/AudioEffectHighShelfFilter.xml index 62ff3d9366..9496fcbffe 100644 --- a/doc/classes/AudioEffectHighShelfFilter.xml +++ b/doc/classes/AudioEffectHighShelfFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0-alpha"> +<class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/AudioEffectLimiter.xml b/doc/classes/AudioEffectLimiter.xml index ebed589829..e641be782d 100644 --- a/doc/classes/AudioEffectLimiter.xml +++ b/doc/classes/AudioEffectLimiter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectLimiter" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectLimiter" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Adds a soft clip Limiter audio effect to an Audio bus. </brief_description> @@ -12,62 +12,6 @@ <demos> </demos> <methods> - <method name="get_ceiling_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_soft_clip_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_soft_clip_ratio" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_threshold_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_ceiling_db"> - <return type="void"> - </return> - <argument index="0" name="ceiling" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_soft_clip_db"> - <return type="void"> - </return> - <argument index="0" name="soft_clip" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_soft_clip_ratio"> - <return type="void"> - </return> - <argument index="0" name="soft_clip" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_threshold_db"> - <return type="void"> - </return> - <argument index="0" name="threshold" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="ceiling_db" type="float" setter="set_ceiling_db" getter="get_ceiling_db"> diff --git a/doc/classes/AudioEffectLowPassFilter.xml b/doc/classes/AudioEffectLowPassFilter.xml index 9f9ecc98b1..50d66e874e 100644 --- a/doc/classes/AudioEffectLowPassFilter.xml +++ b/doc/classes/AudioEffectLowPassFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-alpha"> +<class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> <brief_description> Adds a low pass filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectLowShelfFilter.xml b/doc/classes/AudioEffectLowShelfFilter.xml index c74d1bc479..689faba672 100644 --- a/doc/classes/AudioEffectLowShelfFilter.xml +++ b/doc/classes/AudioEffectLowShelfFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0-alpha"> +<class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/AudioEffectNotchFilter.xml b/doc/classes/AudioEffectNotchFilter.xml index 6407fc8431..dc160ae3e6 100644 --- a/doc/classes/AudioEffectNotchFilter.xml +++ b/doc/classes/AudioEffectNotchFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.0-alpha"> +<class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> <brief_description> Adds a notch filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectPanner.xml b/doc/classes/AudioEffectPanner.xml index 46be7c1696..05a6444a1e 100644 --- a/doc/classes/AudioEffectPanner.xml +++ b/doc/classes/AudioEffectPanner.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectPanner" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectPanner" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Adds a Panner audio effect to an Audio bus. Pans sound left or right. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_pan" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_pan"> - <return type="void"> - </return> - <argument index="0" name="cpanume" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="pan" type="float" setter="set_pan" getter="get_pan"> diff --git a/doc/classes/AudioEffectPhaser.xml b/doc/classes/AudioEffectPhaser.xml index f413366fc7..6b82a4d32a 100644 --- a/doc/classes/AudioEffectPhaser.xml +++ b/doc/classes/AudioEffectPhaser.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectPhaser" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectPhaser" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> 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. @@ -12,76 +12,6 @@ <demos> </demos> <methods> - <method name="get_depth" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_feedback" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_range_max_hz" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_range_min_hz" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_rate_hz" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_depth"> - <return type="void"> - </return> - <argument index="0" name="depth" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_feedback"> - <return type="void"> - </return> - <argument index="0" name="fbk" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_range_max_hz"> - <return type="void"> - </return> - <argument index="0" name="hz" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_range_min_hz"> - <return type="void"> - </return> - <argument index="0" name="hz" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_rate_hz"> - <return type="void"> - </return> - <argument index="0" name="hz" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="depth" type="float" setter="set_depth" getter="get_depth"> diff --git a/doc/classes/AudioEffectPitchShift.xml b/doc/classes/AudioEffectPitchShift.xml index 490aacbc8e..a6d2bef9ff 100644 --- a/doc/classes/AudioEffectPitchShift.xml +++ b/doc/classes/AudioEffectPitchShift.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectPitchShift" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectPitchShift" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Adds a Pitch shift audio effect to an Audio bus. Raises or lowers the pitch of original sound. @@ -12,20 +12,6 @@ <demos> </demos> <methods> - <method name="get_pitch_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_pitch_scale"> - <return type="void"> - </return> - <argument index="0" name="rate" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale"> diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml index e0567a48c7..13bc66f6f3 100644 --- a/doc/classes/AudioEffectReverb.xml +++ b/doc/classes/AudioEffectReverb.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> Adds a Reverb audio effect to an Audio bus. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces. @@ -12,78 +12,12 @@ <demos> </demos> <methods> - <method name="get_damping" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_dry" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_hpf" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_predelay_feedback" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="get_predelay_msec" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_room_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_spread" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_wet" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_damping"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_dry"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_hpf"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> <method name="set_predelay_feedback"> <return type="void"> </return> @@ -92,38 +26,6 @@ <description> </description> </method> - <method name="set_predelay_msec"> - <return type="void"> - </return> - <argument index="0" name="msec" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_room_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_spread"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_wet"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="damping" type="float" setter="set_damping" getter="get_damping"> diff --git a/doc/classes/AudioEffectStereoEnhance.xml b/doc/classes/AudioEffectStereoEnhance.xml index eb17056813..006145c0f1 100644 --- a/doc/classes/AudioEffectStereoEnhance.xml +++ b/doc/classes/AudioEffectStereoEnhance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectStereoEnhance" inherits="AudioEffect" category="Core" version="3.0-alpha"> +<class name="AudioEffectStereoEnhance" inherits="AudioEffect" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,48 +9,6 @@ <demos> </demos> <methods> - <method name="get_pan_pullout" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_surround" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_time_pullout" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_pan_pullout"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_surround"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_time_pullout"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="pan_pullout" type="float" setter="set_pan_pullout" getter="get_pan_pullout"> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index ee334e26a2..1d861d5a4f 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioServer" inherits="Object" category="Core" version="3.0-alpha"> +<class name="AudioServer" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Server interface for low level audio access. </brief_description> @@ -287,7 +287,7 @@ <argument index="1" name="send" type="String"> </argument> <description> - Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/send]. + Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code]. </description> </method> <method name="set_bus_solo"> @@ -341,13 +341,13 @@ </signal> </signals> <constants> - <constant name="SPEAKER_MODE_STEREO" value="0"> + <constant name="SPEAKER_MODE_STEREO" value="0" enum="SpeakerMode"> Two or fewer speakers are detected. </constant> - <constant name="SPEAKER_SURROUND_51" value="2"> + <constant name="SPEAKER_SURROUND_51" value="2" enum="SpeakerMode"> A 5.1 channel surround setup detected. </constant> - <constant name="SPEAKER_SURROUND_71" value="3"> + <constant name="SPEAKER_SURROUND_71" value="3" enum="SpeakerMode"> A 7.1 channel surround setup detected. </constant> </constants> diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml index 67323c59c5..342382ca05 100644 --- a/doc/classes/AudioStream.xml +++ b/doc/classes/AudioStream.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStream" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="AudioStream" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Base class for audio streams. </brief_description> diff --git a/doc/classes/AudioStreamPlayback.xml b/doc/classes/AudioStreamPlayback.xml index 61393fbe29..663b2b57a4 100644 --- a/doc/classes/AudioStreamPlayback.xml +++ b/doc/classes/AudioStreamPlayback.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayback" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="AudioStreamPlayback" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Meta class for playing back audio. </brief_description> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 55edbfb438..032473113c 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.0-alpha"> +<class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Plays back audio. </brief_description> @@ -12,18 +12,6 @@ <demos> </demos> <methods> - <method name="get_bus" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_mix_target" qualifiers="const"> - <return type="int" enum="AudioStreamPlayer.MixTarget"> - </return> - <description> - </description> - </method> <method name="get_playback_position"> <return type="float"> </return> @@ -31,30 +19,6 @@ Returns the position in the [AudioStream]. </description> </method> - <method name="get_stream" qualifiers="const"> - <return type="AudioStream"> - </return> - <description> - </description> - </method> - <method name="get_volume_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="is_autoplay_enabled"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="play"> <return type="void"> </return> @@ -73,46 +37,6 @@ Sets the position from which audio will be played, in seconds. </description> </method> - <method name="set_autoplay"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_bus"> - <return type="void"> - </return> - <argument index="0" name="bus" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_mix_target"> - <return type="void"> - </return> - <argument index="0" name="mix_target" type="int" enum="AudioStreamPlayer.MixTarget"> - </argument> - <description> - </description> - </method> - <method name="set_stream"> - <return type="void"> - </return> - <argument index="0" name="stream" type="AudioStream"> - </argument> - <description> - </description> - </method> - <method name="set_volume_db"> - <return type="void"> - </return> - <argument index="0" name="volume_db" type="float"> - </argument> - <description> - </description> - </method> <method name="stop"> <return type="void"> </return> @@ -149,13 +73,13 @@ </signal> </signals> <constants> - <constant name="MIX_TARGET_STEREO" value="0"> + <constant name="MIX_TARGET_STEREO" value="0" enum="MixTarget"> The audio will be played only on the first channel. </constant> - <constant name="MIX_TARGET_SURROUND" value="1"> + <constant name="MIX_TARGET_SURROUND" value="1" enum="MixTarget"> The audio will be played on all surround channels. </constant> - <constant name="MIX_TARGET_CENTER" value="2"> + <constant name="MIX_TARGET_CENTER" value="2" enum="MixTarget"> The audio will be played on the second channel, which is usually the center. </constant> </constants> diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 98ebeacc5f..63e569ee39 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Plays audio in 2D. </brief_description> @@ -12,30 +12,6 @@ <demos> </demos> <methods> - <method name="get_area_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_attenuation" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_bus" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_max_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_playback_position"> <return type="float"> </return> @@ -43,30 +19,6 @@ Returns the position in the [AudioStream]. </description> </method> - <method name="get_stream" qualifiers="const"> - <return type="AudioStream"> - </return> - <description> - </description> - </method> - <method name="get_volume_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="is_autoplay_enabled"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="play"> <return type="void"> </return> @@ -85,62 +37,6 @@ Sets the position from which audio will be played, in seconds. </description> </method> - <method name="set_area_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_attenuation"> - <return type="void"> - </return> - <argument index="0" name="curve" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_autoplay"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_bus"> - <return type="void"> - </return> - <argument index="0" name="bus" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_max_distance"> - <return type="void"> - </return> - <argument index="0" name="pixels" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_stream"> - <return type="void"> - </return> - <argument index="0" name="stream" type="AudioStream"> - </argument> - <description> - </description> - </method> - <method name="set_volume_db"> - <return type="void"> - </return> - <argument index="0" name="volume_db" type="float"> - </argument> - <description> - </description> - </method> <method name="stop"> <return type="void"> </return> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 9c016a0173..21edfd12d5 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Plays 3D sound in 3D space </brief_description> @@ -12,72 +12,6 @@ <demos> </demos> <methods> - <method name="get_area_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_attenuation_filter_cutoff_hz" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_attenuation_filter_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_attenuation_model" qualifiers="const"> - <return type="int" enum="AudioStreamPlayer3D.AttenuationModel"> - </return> - <description> - </description> - </method> - <method name="get_bus" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_doppler_tracking" qualifiers="const"> - <return type="int" enum="AudioStreamPlayer3D.DopplerTracking"> - </return> - <description> - </description> - </method> - <method name="get_emission_angle" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_emission_angle_filter_attenuation_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_max_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_max_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_out_of_range_mode" qualifiers="const"> - <return type="int" enum="AudioStreamPlayer3D.OutOfRangeMode"> - </return> - <description> - </description> - </method> <method name="get_playback_position"> <return type="float"> </return> @@ -85,42 +19,6 @@ Returns the position in the [AudioStream]. </description> </method> - <method name="get_stream" qualifiers="const"> - <return type="AudioStream"> - </return> - <description> - </description> - </method> - <method name="get_unit_db" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_unit_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="is_autoplay_enabled"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_emission_angle_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="play"> <return type="void"> </return> @@ -139,134 +37,6 @@ Sets the position from which audio will be played, in seconds. </description> </method> - <method name="set_area_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_attenuation_filter_cutoff_hz"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_attenuation_filter_db"> - <return type="void"> - </return> - <argument index="0" name="db" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_attenuation_model"> - <return type="void"> - </return> - <argument index="0" name="model" type="int" enum="AudioStreamPlayer3D.AttenuationModel"> - </argument> - <description> - </description> - </method> - <method name="set_autoplay"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_bus"> - <return type="void"> - </return> - <argument index="0" name="bus" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_doppler_tracking"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="AudioStreamPlayer3D.DopplerTracking"> - </argument> - <description> - </description> - </method> - <method name="set_emission_angle"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_emission_angle_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_emission_angle_filter_attenuation_db"> - <return type="void"> - </return> - <argument index="0" name="db" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_max_db"> - <return type="void"> - </return> - <argument index="0" name="max_db" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_max_distance"> - <return type="void"> - </return> - <argument index="0" name="metres" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_out_of_range_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="AudioStreamPlayer3D.OutOfRangeMode"> - </argument> - <description> - </description> - </method> - <method name="set_stream"> - <return type="void"> - </return> - <argument index="0" name="stream" type="AudioStream"> - </argument> - <description> - </description> - </method> - <method name="set_unit_db"> - <return type="void"> - </return> - <argument index="0" name="unit_db" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_unit_size"> - <return type="void"> - </return> - <argument index="0" name="unit_size" type="float"> - </argument> - <description> - </description> - </method> <method name="stop"> <return type="void"> </return> @@ -336,28 +106,28 @@ </signal> </signals> <constants> - <constant name="ATTENUATION_INVERSE_DISTANCE" value="0"> + <constant name="ATTENUATION_INVERSE_DISTANCE" value="0" enum="AttenuationModel"> Linear dampening of loudness according to distance. </constant> - <constant name="ATTENUATION_INVERSE_SQUARE_DISTANCE" value="1"> + <constant name="ATTENUATION_INVERSE_SQUARE_DISTANCE" value="1" enum="AttenuationModel"> Squared dampening of loudness according to distance. </constant> - <constant name="ATTENUATION_LOGARITHMIC" value="2"> + <constant name="ATTENUATION_LOGARITHMIC" value="2" enum="AttenuationModel"> Logarithmic dampening of loudness according to distance. </constant> - <constant name="OUT_OF_RANGE_MIX" value="0"> + <constant name="OUT_OF_RANGE_MIX" value="0" enum="OutOfRangeMode"> Mix this audio in, even when it's out of range. </constant> - <constant name="OUT_OF_RANGE_PAUSE" value="1"> + <constant name="OUT_OF_RANGE_PAUSE" value="1" enum="OutOfRangeMode"> Pause this audio when it gets out of range. </constant> - <constant name="DOPPLER_TRACKING_DISABLED" value="0"> + <constant name="DOPPLER_TRACKING_DISABLED" value="0" enum="DopplerTracking"> Disables doppler tracking. </constant> - <constant name="DOPPLER_TRACKING_IDLE_STEP" value="1"> + <constant name="DOPPLER_TRACKING_IDLE_STEP" value="1" enum="DopplerTracking"> Executes doppler tracking in idle step. </constant> - <constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2"> + <constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2" enum="DopplerTracking"> Executes doppler tracking in physics step. </constant> </constants> diff --git a/doc/classes/AudioStreamRandomPitch.xml b/doc/classes/AudioStreamRandomPitch.xml index 56c7ee1998..24d6f8965a 100644 --- a/doc/classes/AudioStreamRandomPitch.xml +++ b/doc/classes/AudioStreamRandomPitch.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamRandomPitch" inherits="AudioStream" category="Core" version="3.0-alpha"> +<class name="AudioStreamRandomPitch" inherits="AudioStream" category="Core" version="3.0-beta"> <brief_description> Plays audio with random pitch tweaking. </brief_description> @@ -11,34 +11,6 @@ <demos> </demos> <methods> - <method name="get_audio_stream" qualifiers="const"> - <return type="AudioStream"> - </return> - <description> - </description> - </method> - <method name="get_random_pitch" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_audio_stream"> - <return type="void"> - </return> - <argument index="0" name="stream" type="AudioStream"> - </argument> - <description> - </description> - </method> - <method name="set_random_pitch"> - <return type="void"> - </return> - <argument index="0" name="scale" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="audio_stream" type="AudioStream" setter="set_audio_stream" getter="get_audio_stream"> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 3a0a171480..83e9729bc1 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.0-alpha"> +<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.0-beta"> <brief_description> Plays audio. </brief_description> @@ -17,42 +17,6 @@ <description> </description> </method> - <method name="get_format" qualifiers="const"> - <return type="int" enum="AudioStreamSample.Format"> - </return> - <description> - </description> - </method> - <method name="get_loop_begin" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_loop_end" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_loop_mode" qualifiers="const"> - <return type="int" enum="AudioStreamSample.LoopMode"> - </return> - <description> - </description> - </method> - <method name="get_mix_rate" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="is_stereo" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="set_data"> <return type="void"> </return> @@ -61,59 +25,8 @@ <description> </description> </method> - <method name="set_format"> - <return type="void"> - </return> - <argument index="0" name="format" type="int" enum="AudioStreamSample.Format"> - </argument> - <description> - </description> - </method> - <method name="set_loop_begin"> - <return type="void"> - </return> - <argument index="0" name="loop_begin" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_loop_end"> - <return type="void"> - </return> - <argument index="0" name="loop_end" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_loop_mode"> - <return type="void"> - </return> - <argument index="0" name="loop_mode" type="int" enum="AudioStreamSample.LoopMode"> - </argument> - <description> - </description> - </method> - <method name="set_mix_rate"> - <return type="void"> - </return> - <argument index="0" name="mix_rate" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_stereo"> - <return type="void"> - </return> - <argument index="0" name="stereo" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> - <member name="data" type="PoolByteArray" setter="set_data" getter="get_data"> - Raw audio data. - </member> <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format"> Audio format. See FORMAT_* constants for values. </member> @@ -134,22 +47,22 @@ </member> </members> <constants> - <constant name="FORMAT_8_BITS" value="0"> + <constant name="FORMAT_8_BITS" value="0" enum="Format"> Audio codec 8 bit. </constant> - <constant name="FORMAT_16_BITS" value="1"> + <constant name="FORMAT_16_BITS" value="1" enum="Format"> Audio codec 16 bit. </constant> - <constant name="FORMAT_IMA_ADPCM" value="2"> + <constant name="FORMAT_IMA_ADPCM" value="2" enum="Format"> Audio codec IMA ADPCM. </constant> - <constant name="LOOP_DISABLED" value="0"> + <constant name="LOOP_DISABLED" value="0" enum="LoopMode"> Audio does not loop. </constant> - <constant name="LOOP_FORWARD" value="1"> + <constant name="LOOP_FORWARD" value="1" enum="LoopMode"> Audio loops the data between loop_begin and loop_end playing forward only. </constant> - <constant name="LOOP_PING_PONG" value="2"> + <constant name="LOOP_PING_PONG" value="2" enum="LoopMode"> Audio loops the data between loop_begin and loop_end playing back and forth. </constant> </constants> diff --git a/doc/classes/BackBufferCopy.xml b/doc/classes/BackBufferCopy.xml index 2b5a9aac20..122e0c7fae 100644 --- a/doc/classes/BackBufferCopy.xml +++ b/doc/classes/BackBufferCopy.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BackBufferCopy" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="BackBufferCopy" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction. </brief_description> @@ -11,38 +11,6 @@ <demos> </demos> <methods> - <method name="get_copy_mode" qualifiers="const"> - <return type="int" enum="BackBufferCopy.CopyMode"> - </return> - <description> - Return the copy mode currently applied to the BackBufferCopy. See [code]COPY_MODE_*[/code] constants. - </description> - </method> - <method name="get_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - Return the area covered by the BackBufferCopy. - </description> - </method> - <method name="set_copy_mode"> - <return type="void"> - </return> - <argument index="0" name="copy_mode" type="int" enum="BackBufferCopy.CopyMode"> - </argument> - <description> - Set the copy mode of the BackBufferCopy. See [code]COPY_MODE_*[/code] constants. - </description> - </method> - <method name="set_rect"> - <return type="void"> - </return> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - Defines the area covered by the BackBufferCopy. - </description> - </method> </methods> <members> <member name="copy_mode" type="int" setter="set_copy_mode" getter="get_copy_mode" enum="BackBufferCopy.CopyMode"> @@ -53,13 +21,13 @@ </member> </members> <constants> - <constant name="COPY_MODE_DISABLED" value="0"> + <constant name="COPY_MODE_DISABLED" value="0" enum="CopyMode"> Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers. </constant> - <constant name="COPY_MODE_RECT" value="1"> + <constant name="COPY_MODE_RECT" value="1" enum="CopyMode"> BackBufferCopy buffers a rectangular region. </constant> - <constant name="COPY_MODE_VIEWPORT" value="2"> + <constant name="COPY_MODE_VIEWPORT" value="2" enum="CopyMode"> BackBufferCopy buffers the entire screen. </constant> </constants> diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 26939143b6..7f1aaa6822 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BaseButton" inherits="Control" category="Core" version="3.0-alpha"> +<class name="BaseButton" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Base class for different kinds of buttons. </brief_description> @@ -27,19 +27,6 @@ Called when button is toggled (only if toggle_mode is active). </description> </method> - <method name="get_action_mode" qualifiers="const"> - <return type="int" enum="BaseButton.ActionMode"> - </return> - <description> - Return the current mode of action (see [method set_action_mode]) (one of the ACTION_MODE_* constants). - </description> - </method> - <method name="get_button_group" qualifiers="const"> - <return type="ButtonGroup"> - </return> - <description> - </description> - </method> <method name="get_draw_mode" qualifiers="const"> <return type="int" enum="BaseButton.DrawMode"> </return> @@ -47,26 +34,6 @@ Return 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. </description> </method> - <method name="get_enabled_focus_mode" qualifiers="const"> - <return type="int" enum="Control.FocusMode"> - </return> - <description> - Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). - </description> - </method> - <method name="get_shortcut" qualifiers="const"> - <return type="ShortCut"> - </return> - <description> - </description> - </method> - <method name="is_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the button is in disabled state (see [method set_disabled]). - </description> - </method> <method name="is_hovered" qualifiers="const"> <return type="bool"> </return> @@ -74,81 +41,6 @@ Return true if mouse entered the button before it exit. </description> </method> - <method name="is_pressed" qualifiers="const"> - <return type="bool"> - </return> - <description> - If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down. - </description> - </method> - <method name="is_toggle_mode" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return the toggle_mode property (see [method set_toggle_mode]). - </description> - </method> - <method name="set_action_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="BaseButton.ActionMode"> - </argument> - <description> - Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE_* constants). - </description> - </method> - <method name="set_button_group"> - <return type="void"> - </return> - <argument index="0" name="button_group" type="ButtonGroup"> - </argument> - <description> - </description> - </method> - <method name="set_disabled"> - <return type="void"> - </return> - <argument index="0" name="disabled" type="bool"> - </argument> - <description> - Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. - </description> - </method> - <method name="set_enabled_focus_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Control.FocusMode"> - </argument> - <description> - Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). - </description> - </method> - <method name="set_pressed"> - <return type="void"> - </return> - <argument index="0" name="pressed" type="bool"> - </argument> - <description> - Set the button to pressed state (only if toggle_mode is active). - </description> - </method> - <method name="set_shortcut"> - <return type="void"> - </return> - <argument index="0" name="shortcut" type="ShortCut"> - </argument> - <description> - </description> - </method> - <method name="set_toggle_mode"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. - </description> - </method> </methods> <members> <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode"> @@ -198,22 +90,22 @@ </signal> </signals> <constants> - <constant name="DRAW_NORMAL" value="0"> + <constant name="DRAW_NORMAL" value="0" enum="DrawMode"> The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons. </constant> - <constant name="DRAW_PRESSED" value="1"> + <constant name="DRAW_PRESSED" value="1" enum="DrawMode"> The state of buttons are pressed. </constant> - <constant name="DRAW_HOVER" value="2"> + <constant name="DRAW_HOVER" value="2" enum="DrawMode"> The state of buttons are hovered. </constant> - <constant name="DRAW_DISABLED" value="3"> + <constant name="DRAW_DISABLED" value="3" enum="DrawMode"> The state of buttons are disabled. </constant> - <constant name="ACTION_MODE_BUTTON_PRESS" value="0"> + <constant name="ACTION_MODE_BUTTON_PRESS" value="0" enum="ActionMode"> Require just a press to consider the button clicked. </constant> - <constant name="ACTION_MODE_BUTTON_RELEASE" value="1"> + <constant name="ACTION_MODE_BUTTON_RELEASE" value="1" enum="ActionMode"> Require a press and a subsequent release before considering the button clicked. </constant> </constants> diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index c8a28621ea..a873bd9a27 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Basis" category="Built-In Types" version="3.0-alpha"> +<class name="Basis" category="Built-In Types" version="3.0-beta"> <brief_description> 3x3 matrix datatype. </brief_description> @@ -24,7 +24,7 @@ <method name="Basis"> <return type="Basis"> </return> - <argument index="0" name="euler" type="Vector3"> + <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). @@ -171,10 +171,13 @@ </methods> <members> <member name="x" type="Vector3" setter="" getter=""> + The basis matrix's x vector. </member> <member name="y" type="Vector3" setter="" getter=""> + The basis matrix's y vector. </member> <member name="z" type="Vector3" setter="" getter=""> + The basis matrix's z vector. </member> </members> <constants> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 4de059d908..39bf46ac3d 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BitMap" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="BitMap" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Boolean matrix. </brief_description> @@ -75,13 +75,6 @@ </description> </method> </methods> - <members> - <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> - Returns a [Dictionary] with two keys : - [code]data[/code] : [PoolByteArray] with [code]true[/code]/[code]false[/code] [code]BitMap[/code] data. - [code]size[/code] : The [code]Bitmap[/code]'s size. - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index c013a474b2..2fb7d7d87a 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BitmapFont" inherits="Font" category="Core" version="3.0-alpha"> +<class name="BitmapFont" inherits="Font" category="Core" version="3.0-beta"> <brief_description> Renders text using [code]*.fnt[/code] fonts. </brief_description> @@ -77,13 +77,6 @@ Returns the size of a character, optionally taking kerning into account if the next character is provided. </description> </method> - <method name="get_fallback" qualifiers="const"> - <return type="BitmapFont"> - </return> - <description> - Returns the fallback BitmapFont. - </description> - </method> <method name="get_kerning_pair" qualifiers="const"> <return type="int"> </return> @@ -111,50 +104,11 @@ Returns the number of textures in the BitmapFont atlas. </description> </method> - <method name="set_ascent"> - <return type="void"> - </return> - <argument index="0" name="px" type="float"> - </argument> - <description> - Sets the font ascent (number of pixels above the baseline). - </description> - </method> - <method name="set_distance_field_hint"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - If [code]true[/code] distance field hint is enabled. - </description> - </method> - <method name="set_fallback"> - <return type="void"> - </return> - <argument index="0" name="fallback" type="BitmapFont"> - </argument> - <description> - Sets the fallback BitmapFont. - </description> - </method> - <method name="set_height"> - <return type="void"> - </return> - <argument index="0" name="px" type="float"> - </argument> - <description> - Sets the total font height (ascent plus descent) in pixels. - </description> - </method> </methods> <members> <member name="ascent" type="float" setter="set_ascent" getter="get_ascent"> Ascent (number of pixels above the baseline). </member> - <member name="chars" type="PoolIntArray" setter="_set_chars" getter="_get_chars"> - The characters in the BitmapFont. - </member> <member name="distance_field" type="bool" setter="set_distance_field_hint" getter="is_distance_field_hint"> If [code]true[/code] distance field hint is enabled. </member> @@ -164,12 +118,6 @@ <member name="height" type="float" setter="set_height" getter="get_height"> Total font height (ascent plus descent) in pixels. </member> - <member name="kernings" type="PoolIntArray" setter="_set_kernings" getter="_get_kernings"> - The font's kernings as [PoolIntArray]. - </member> - <member name="textures" type="Array" setter="_set_textures" getter="_get_textures"> - The font's [Texture]s. - </member> </members> <constants> </constants> diff --git a/doc/classes/BoneAttachment.xml b/doc/classes/BoneAttachment.xml index 8f33d7a73c..b7f21ebf0c 100644 --- a/doc/classes/BoneAttachment.xml +++ b/doc/classes/BoneAttachment.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BoneAttachment" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="BoneAttachment" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> A node that will attach to a bone. </brief_description> diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml index a7465a959a..7003158387 100644 --- a/doc/classes/BoxContainer.xml +++ b/doc/classes/BoxContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BoxContainer" inherits="Container" category="Core" version="3.0-alpha"> +<class name="BoxContainer" inherits="Container" category="Core" version="3.0-beta"> <brief_description> Base class for box containers. </brief_description> @@ -20,22 +20,6 @@ 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. </description> </method> - <method name="get_alignment" qualifiers="const"> - <return type="int" enum="BoxContainer.AlignMode"> - </return> - <description> - Return the alignment of children in the container. - </description> - </method> - <method name="set_alignment"> - <return type="void"> - </return> - <argument index="0" name="alignment" type="int" enum="BoxContainer.AlignMode"> - </argument> - <description> - Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END). - </description> - </method> </methods> <members> <member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode"> @@ -43,13 +27,13 @@ </member> </members> <constants> - <constant name="ALIGN_BEGIN" value="0"> + <constant name="ALIGN_BEGIN" value="0" enum="AlignMode"> Aligns children with the beginning of the container. </constant> - <constant name="ALIGN_CENTER" value="1"> + <constant name="ALIGN_CENTER" value="1" enum="AlignMode"> Aligns children with the center of the container. </constant> - <constant name="ALIGN_END" value="2"> + <constant name="ALIGN_END" value="2" enum="AlignMode"> Aligns children with the end of the container. </constant> </constants> diff --git a/doc/classes/BoxShape.xml b/doc/classes/BoxShape.xml index 0f46442550..4a4b528449 100644 --- a/doc/classes/BoxShape.xml +++ b/doc/classes/BoxShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BoxShape" inherits="Shape" category="Core" version="3.0-alpha"> +<class name="BoxShape" inherits="Shape" category="Core" version="3.0-beta"> <brief_description> Box shape resource. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_extents" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Return the half extents of the shape. - </description> - </method> - <method name="set_extents"> - <return type="void"> - </return> - <argument index="0" name="extents" type="Vector3"> - </argument> - <description> - Set the half extents for the shape. - </description> - </method> </methods> <members> <member name="extents" type="Vector3" setter="set_extents" getter="get_extents"> diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index 2964cc9efc..854f1cc7c3 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Button" inherits="BaseButton" category="Core" version="3.0-alpha"> +<class name="Button" inherits="BaseButton" category="Core" version="3.0-beta"> <brief_description> Standard themed Button. </brief_description> @@ -11,76 +11,6 @@ <demos> </demos> <methods> - <method name="get_button_icon" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_clip_text" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_text_align" qualifiers="const"> - <return type="int" enum="Button.TextAlign"> - </return> - <description> - </description> - </method> - <method name="is_flat" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_button_icon"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_clip_text"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_flat"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_text"> - <return type="void"> - </return> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_text_align"> - <return type="void"> - </return> - <argument index="0" name="align" type="int" enum="Button.TextAlign"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="align" type="int" setter="set_text_align" getter="get_text_align" enum="Button.TextAlign"> @@ -100,13 +30,13 @@ </member> </members> <constants> - <constant name="ALIGN_LEFT" value="0"> + <constant name="ALIGN_LEFT" value="0" enum="TextAlign"> Align the text to the left. </constant> - <constant name="ALIGN_CENTER" value="1"> + <constant name="ALIGN_CENTER" value="1" enum="TextAlign"> Align the text to the center. </constant> - <constant name="ALIGN_RIGHT" value="2"> + <constant name="ALIGN_RIGHT" value="2" enum="TextAlign"> Align the text to the right. </constant> </constants> diff --git a/doc/classes/ButtonGroup.xml b/doc/classes/ButtonGroup.xml index ccc457f9e6..2c857371f9 100644 --- a/doc/classes/ButtonGroup.xml +++ b/doc/classes/ButtonGroup.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ButtonGroup" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="ButtonGroup" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Group of Buttons. </brief_description> diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index c840da9266..91c9ecc774 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Camera" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="Camera" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Camera node, displays from a point of view. </brief_description> @@ -25,88 +25,6 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. </description> </method> - <method name="get_cull_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the culling mask, describing which 3D render layers are rendered by this Camera. - </description> - </method> - <method name="get_doppler_tracking" qualifiers="const"> - <return type="int" enum="Camera.DopplerTracking"> - </return> - <description> - </description> - </method> - <method name="get_environment" qualifiers="const"> - <return type="Environment"> - </return> - <description> - Returns the [Environment] used by this Camera. - </description> - </method> - <method name="get_fov" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the [i]FOV[/i] Y angle in degrees (FOV means Field of View). - </description> - </method> - <method name="get_h_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the horizontal (X) offset of the Camera viewport. - </description> - </method> - <method name="get_keep_aspect_mode" qualifiers="const"> - <return type="int" enum="Camera.KeepAspect"> - </return> - <description> - Returns the current mode for keeping the aspect ratio. See [code]KEEP_*[/code] constants. - </description> - </method> - <method name="get_projection" qualifiers="const"> - <return type="int" enum="Camera.Projection"> - </return> - <description> - Returns the Camera's projection. See PROJECTION_* constants. - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_v_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the vertical (Y) offset of the Camera viewport. - </description> - </method> - <method name="get_zfar" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the far clip plane in world space units. - </description> - </method> - <method name="get_znear" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the near clip plane in world space units. - </description> - </method> - <method name="is_current" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). - </description> - </method> <method name="is_position_behind" qualifiers="const"> <return type="bool"> </return> @@ -129,6 +47,7 @@ <argument index="0" name="screen_point" type="Vector2"> </argument> <description> + Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. </description> </method> <method name="project_position" qualifiers="const"> @@ -158,51 +77,6 @@ Returns a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. </description> </method> - <method name="set_cull_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Sets the cull mask, describing which 3D render layers are rendered by this Camera. - </description> - </method> - <method name="set_doppler_tracking"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Camera.DopplerTracking"> - </argument> - <description> - Changes Doppler effect tracking. See [code]DOPPLER_*[/code] constants. - </description> - </method> - <method name="set_environment"> - <return type="void"> - </return> - <argument index="0" name="env" type="Environment"> - </argument> - <description> - Sets the [Environment] to use for this Camera. - </description> - </method> - <method name="set_h_offset"> - <return type="void"> - </return> - <argument index="0" name="ofs" type="float"> - </argument> - <description> - Sets the horizontal (X) offset of the Camera viewport. - </description> - </method> - <method name="set_keep_aspect_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Camera.KeepAspect"> - </argument> - <description> - Sets the mode for keeping the aspect ratio. See [code]KEEP_*[/code] constants. - </description> - </method> <method name="set_orthogonal"> <return type="void"> </return> @@ -229,15 +103,6 @@ Set 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. </description> </method> - <method name="set_v_offset"> - <return type="void"> - </return> - <argument index="0" name="ofs" type="float"> - </argument> - <description> - Sets the vertical (Y) offset of the Camera viewport. - </description> - </method> <method name="unproject_position" qualifiers="const"> <return type="Vector2"> </return> @@ -248,26 +113,67 @@ </description> </method> </methods> + <members> + <member name="cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask"> + 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]. + </member> + <member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="Camera.DopplerTracking"> + If not [code]DOPPLER_TRACKING_DISABLED[/code] this Camera will simulate the Doppler effect for objects changed in particular [code]_process[/code] methods. Default value: [code]DOPPLER_TRACKING_DISABLED[/code]. + </member> + <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> + Set 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. + </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. + </member> + <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset"> + The horizontal (X) offset of the Camear 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. + </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. + </member> + <member name="projection" type="int" setter="set_projection" getter="get_projection" enum="Camera.Projection"> + The camera's projection mode. In [code]PROJECTION_PERSPECTIVE[/code] 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 horizontal (Y) offset of the Camear viewport. + </member> + <member name="vaspect" type="bool" setter="set_vaspect" getter="get_vaspect"> + A boolean representation of [member keep_aspect] in which [code]true[/code] is equivalent to [code]KEEP_WIDTH[/code]. + </member> + </members> <constants> - <constant name="PROJECTION_PERSPECTIVE" value="0"> + <constant name="PROJECTION_PERSPECTIVE" value="0" enum="Projection"> Perspective Projection (object's size on the screen becomes smaller when far away). </constant> - <constant name="PROJECTION_ORTHOGONAL" value="1"> + <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). </constant> - <constant name="KEEP_WIDTH" value="0"> - Try to keep the aspect ratio when scaling the Camera's viewport to the screen. If not possible, preserve the viewport's width by changing the height. Height is [code]sizey[/code] for orthographic projection, [code]fovy[/code] for perspective projection. + <constant name="KEEP_WIDTH" value="0" enum="KeepAspect"> + Preserves the horizontal aspect ratio. </constant> - <constant name="KEEP_HEIGHT" value="1"> - Try to keep the aspect ratio when scaling the Camera's viewport to the screen. If not possible, preserve the viewport's height by changing the width. Width is [code]sizex[/code] for orthographic projection, [code]fovx[/code] for perspective projection. + <constant name="KEEP_HEIGHT" value="1" enum="KeepAspect"> + Preserves the vertical aspect ratio. </constant> - <constant name="DOPPLER_TRACKING_DISABLED" value="0"> + <constant name="DOPPLER_TRACKING_DISABLED" value="0" enum="DopplerTracking"> Disable Doppler effect simulation (default). </constant> - <constant name="DOPPLER_TRACKING_IDLE_STEP" value="1"> + <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]). </constant> - <constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2"> + <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]). </constant> </constants> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 8704624b2d..c95691d07f 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Camera2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Camera2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Camera node for 2D scenes. </brief_description> @@ -23,6 +23,7 @@ <return type="void"> </return> <description> + Removes any [code]Camera2D[/code] from the ancestor [Viewport]'s internal currently-assigned camera. </description> </method> <method name="force_update_scroll"> @@ -32,12 +33,6 @@ Force the camera to update scroll immediately. </description> </method> - <method name="get_anchor_mode" qualifiers="const"> - <return type="int" enum="Camera2D.AnchorMode"> - </return> - <description> - </description> - </method> <method name="get_camera_position" qualifiers="const"> <return type="Vector2"> </return> @@ -49,116 +44,28 @@ <return type="Vector2"> </return> <description> + Returns the location of the [code]Camera2D[/code]'s screen-center, relative to the origin. </description> </method> <method name="get_custom_viewport" qualifiers="const"> <return type="Node"> </return> <description> - </description> - </method> - <method name="get_drag_margin" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return the margins needed to drag the camera (see [method set_drag_margin]). - </description> - </method> - <method name="get_follow_smoothing" qualifiers="const"> - <return type="float"> - </return> - <description> + Returns the [Viewport] used by the camera if it is not using the default viewport. </description> </method> <method name="get_h_offset" qualifiers="const"> <return type="float"> </return> <description> - </description> - </method> - <method name="get_limit" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return the scrolling limit in pixels. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the scroll offset. + Returns the horizontal offset of the camera. </description> </method> <method name="get_v_offset" qualifiers="const"> <return type="float"> </return> <description> - </description> - </method> - <method name="get_zoom" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="is_current" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true of this is the current camera (see [method make_current]). - </description> - </method> - <method name="is_follow_smoothing_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_h_drag_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_limit_drawing_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_limit_smoothing_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_margin_drawing_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_rotating" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_screen_drawing_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_v_drag_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> + Returns the vertical offset of the camera. </description> </method> <method name="make_current"> @@ -176,55 +83,13 @@ This has no effect if smoothing is disabled. </description> </method> - <method name="set_anchor_mode"> - <return type="void"> - </return> - <argument index="0" name="anchor_mode" type="int" enum="Camera2D.AnchorMode"> - </argument> - <description> - </description> - </method> <method name="set_custom_viewport"> <return type="void"> </return> <argument index="0" name="viewport" type="Node"> </argument> <description> - </description> - </method> - <method name="set_drag_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="drag_margin" type="float"> - </argument> - <description> - Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges. - </description> - </method> - <method name="set_enable_follow_smoothing"> - <return type="void"> - </return> - <argument index="0" name="follow_smoothing" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_follow_smoothing"> - <return type="void"> - </return> - <argument index="0" name="follow_smoothing" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_h_drag_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> + Assigns a custom [Viewport] node to the [code]Camera2D[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead. </description> </method> <method name="set_h_offset"> @@ -233,76 +98,7 @@ <argument index="0" name="ofs" type="float"> </argument> <description> - </description> - </method> - <method name="set_limit"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="limit" type="int"> - </argument> - <description> - Set the scrolling limit in pixels. - </description> - </method> - <method name="set_limit_drawing_enabled"> - <return type="void"> - </return> - <argument index="0" name="limit_drawing_enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_limit_smoothing_enabled"> - <return type="void"> - </return> - <argument index="0" name="limit_smoothing_enabled" type="bool"> - </argument> - <description> - Smooth camera when reaching camera limits. - This requires camera smoothing being enabled to have a noticeable effect. - </description> - </method> - <method name="set_margin_drawing_enabled"> - <return type="void"> - </return> - <argument index="0" name="margin_drawing_enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - Set the scroll offset. Useful for looking around or camera shake animations. - </description> - </method> - <method name="set_rotating"> - <return type="void"> - </return> - <argument index="0" name="rotating" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_screen_drawing_enabled"> - <return type="void"> - </return> - <argument index="0" name="screen_drawing_enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_v_drag_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> + The camera's horizontal offset is set to [code]ofs[/code]. </description> </method> <method name="set_v_offset"> @@ -311,14 +107,7 @@ <argument index="0" name="ofs" type="float"> </argument> <description> - </description> - </method> - <method name="set_zoom"> - <return type="void"> - </return> - <argument index="0" name="zoom" type="Vector2"> - </argument> - <description> + The camera's vertical offset is set to [code]ofs[/code]. </description> </method> </methods> @@ -388,9 +177,11 @@ </member> </members> <constants> - <constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0"> + <constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0" enum="AnchorMode"> + The camera's position is fixed so that the top-left corner is always at the origin. </constant> - <constant name="ANCHOR_MODE_DRAG_CENTER" value="1"> + <constant name="ANCHOR_MODE_DRAG_CENTER" value="1" enum="AnchorMode"> + The camera's position takes into account vertical/horizontal offsets and the screen size. </constant> </constants> </class> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index dd192e2166..bd20cfcf5d 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CanvasItem" inherits="Node" category="Core" version="3.0-alpha"> +<class name="CanvasItem" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Base class of anything 2D. </brief_description> @@ -36,7 +36,7 @@ <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> <description> - Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. + Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. </description> </method> <method name="draw_circle"> @@ -49,7 +49,7 @@ <argument index="2" name="color" type="Color"> </argument> <description> - Draw a colored circle. + Draws a colored circle. </description> </method> <method name="draw_colored_polygon"> @@ -68,7 +68,7 @@ <argument index="5" name="antialiased" type="bool" default="false"> </argument> <description> - Draw a colored polygon of any amount of points, convex or concave. + Draws a colored polygon of any amount of points, convex or concave. </description> </method> <method name="draw_line"> @@ -85,7 +85,37 @@ <argument index="4" name="antialiased" type="bool" default="false"> </argument> <description> - Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased. + Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. + </description> + </method> + <method name="draw_multiline"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <argument index="2" name="width" type="float" default="1.0"> + </argument> + <argument index="3" name="antialiased" type="bool" default="false"> + </argument> + <description> + Draws multiple, parallel lines with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. + </description> + </method> + <method name="draw_multiline_colors"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <argument index="1" name="colors" type="PoolColorArray"> + </argument> + <argument index="2" name="width" type="float" default="1.0"> + </argument> + <argument index="3" name="antialiased" type="bool" default="false"> + </argument> + <description> + Draws multiple, parallel lines with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. </description> </method> <method name="draw_polygon"> @@ -104,7 +134,7 @@ <argument index="5" name="antialiased" type="bool" default="false"> </argument> <description> - Draw a polygon of any amount of points, convex or concave. + Draws a polygon of any amount of points, convex or concave. </description> </method> <method name="draw_polyline"> @@ -119,6 +149,7 @@ <argument index="3" name="antialiased" type="bool" default="false"> </argument> <description> + Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. </description> </method> <method name="draw_polyline_colors"> @@ -133,6 +164,7 @@ <argument index="3" name="antialiased" type="bool" default="false"> </argument> <description> + Draws interconnected line segments with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. </description> </method> <method name="draw_primitive"> @@ -151,7 +183,7 @@ <argument index="5" name="normal_map" type="Texture" default="null"> </argument> <description> - Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. + Draws a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. </description> </method> <method name="draw_rect"> @@ -164,7 +196,7 @@ <argument index="2" name="filled" type="bool" default="true"> </argument> <description> - Draw a colored rectangle. + Draws a colored rectangle. </description> </method> <method name="draw_set_transform"> @@ -177,7 +209,7 @@ <argument index="2" name="scale" type="Vector2"> </argument> <description> - Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. + Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. </description> </method> <method name="draw_set_transform_matrix"> @@ -186,6 +218,7 @@ <argument index="0" name="xform" type="Transform2D"> </argument> <description> + Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. </description> </method> <method name="draw_string"> @@ -202,7 +235,7 @@ <argument index="4" name="clip_w" type="int" default="-1"> </argument> <description> - Draw a string using a custom font. + Draws a string using a custom font. </description> </method> <method name="draw_style_box"> @@ -213,7 +246,7 @@ <argument index="1" name="rect" type="Rect2"> </argument> <description> - Draw a styled rectangle. + Draws a styled rectangle. </description> </method> <method name="draw_texture"> @@ -228,7 +261,7 @@ <argument index="3" name="normal_map" type="Texture" default="null"> </argument> <description> - Draw a texture at a given position. + Draws a texture at a given position. </description> </method> <method name="draw_texture_rect"> @@ -247,7 +280,7 @@ <argument index="5" name="normal_map" type="Texture" default="null"> </argument> <description> - Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. + Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. </description> </method> <method name="draw_texture_rect_region"> @@ -268,40 +301,7 @@ <argument index="6" name="clip_uv" type="bool" default="true"> </argument> <description> - Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. - </description> - </method> - <method name="edit_get_state" qualifiers="const"> - <return type="Variant"> - </return> - <description> - Used for editing, returns an opaque value representing the transform state. - </description> - </method> - <method name="edit_rotate"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - Used for editing, handle rotation. - </description> - </method> - <method name="edit_set_rect"> - <return type="void"> - </return> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="edit_set_state"> - <return type="void"> - </return> - <argument index="0" name="state" type="Variant"> - </argument> - <description> - Set the transform state of this CanvasItem. For [Node2D], this is an [Array] with (in order) a [Vector2] for position, a float for rotation (radians) and another [Vector2] for scale. For [Control] this is a [Rect2] with the position and size. + Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. </description> </method> <method name="get_canvas" qualifiers="const"> @@ -346,27 +346,6 @@ Get the global transform matrix of this item in relation to the canvas. </description> </method> - <method name="get_item_and_children_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - Get a [Rect2] with the boundaries of this item and its children. - </description> - </method> - <method name="get_item_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - Return a rect containing the editable boundaries of the item. - </description> - </method> - <method name="get_light_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Get this item's light mask number. - </description> - </method> <method name="get_local_mouse_position" qualifiers="const"> <return type="Vector2"> </return> @@ -374,27 +353,6 @@ Get the mouse position relative to this item's position. </description> </method> - <method name="get_material" qualifiers="const"> - <return type="Material"> - </return> - <description> - Get the material of this item. - </description> - </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> - </return> - <description> - Get the modulate of the CanvasItem, which affects children items too. - </description> - </method> - <method name="get_self_modulate" qualifiers="const"> - <return type="Color"> - </return> - <description> - Get the self-modulate of the CanvasItem. - </description> - </method> <method name="get_transform" qualifiers="const"> <return type="Transform2D"> </return> @@ -402,13 +360,6 @@ Get the transform matrix of this item. </description> </method> - <method name="get_use_parent_material" qualifiers="const"> - <return type="bool"> - </return> - <description> - Get whether this item uses its parent's material. - </description> - </method> <method name="get_viewport_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -437,17 +388,11 @@ Hide the CanvasItem currently visible. </description> </method> - <method name="is_draw_behind_parent_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the item is drawn behind its parent. - </description> - </method> <method name="is_local_transform_notification_enabled" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if local transform notifications are communicated to children. </description> </method> <method name="is_set_as_toplevel" qualifiers="const"> @@ -461,19 +406,14 @@ <return type="bool"> </return> <description> - </description> - </method> - <method name="is_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. + Returns [code]true[/code] if global transform notifications are communicated to children. </description> </method> <method name="is_visible_in_tree" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the node is in the [SceneTree] and is visible on-screen. </description> </method> <method name="make_canvas_position_local" qualifiers="const"> @@ -482,6 +422,7 @@ <argument index="0" name="screen_point" type="Vector2"> </argument> <description> + Assigns [code]screen_point[/code] as this node's new local transform. </description> </method> <method name="make_input_local" qualifiers="const"> @@ -490,6 +431,7 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> + Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space. </description> </method> <method name="set_as_toplevel"> @@ -498,43 +440,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Set as top level. This means that it will not inherit transform from parent canvas items. - </description> - </method> - <method name="set_draw_behind_parent"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set whether the canvas item is drawn behind its parent. - </description> - </method> - <method name="set_light_mask"> - <return type="void"> - </return> - <argument index="0" name="light_mask" type="int"> - </argument> - <description> - Set the ligtht mask number of this item. - </description> - </method> - <method name="set_material"> - <return type="void"> - </return> - <argument index="0" name="material" type="Material"> - </argument> - <description> - Set the material of this item. - </description> - </method> - <method name="set_modulate"> - <return type="void"> - </return> - <argument index="0" name="modulate" type="Color"> - </argument> - <description> - Set the modulate of the CanvasItem. This [i]affects[/i] the modulation of children items. + Sets as top level. This means that it will not inherit transform from parent canvas items. </description> </method> <method name="set_notify_local_transform"> @@ -543,6 +449,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], children will be updated with local transform data. </description> </method> <method name="set_notify_transform"> @@ -551,34 +458,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - </description> - </method> - <method name="set_self_modulate"> - <return type="void"> - </return> - <argument index="0" name="self_modulate" type="Color"> - </argument> - <description> - Set the self-modulate of the CanvasItem. This does not affect the modulation of children items. - </description> - </method> - <method name="set_use_parent_material"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set whether or not this item should use its parent's material. - </description> - </method> - <method name="set_visible"> - <return type="void"> - </return> - <argument index="0" name="visible" type="bool"> - </argument> - <description> - Set whether this item should be visible or not. - Note that a hidden CanvasItem will make all children hidden too, so no matter what is set here this item won't be shown if its parent or grandparents nodes are hidden. + If [code]enable[/code] is [code]true[/code], children will be updated with global transform data. </description> </method> <method name="show"> @@ -598,20 +478,28 @@ </methods> <members> <member name="light_mask" type="int" setter="set_light_mask" getter="get_light_mask"> + The rendering layers in which this [code]CanvasItem[/code] responds to [Light2D] nodes. Default value: [code]1[/code]. </member> <member name="material" type="Material" setter="set_material" getter="get_material"> + The material applied to textures on this [code]CanvasItem[/code]. Default value: [code]null[/code]. </member> <member name="modulate" type="Color" setter="set_modulate" getter="get_modulate"> + The color applied to textures on this [code]CanvasItem[/code]. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white"). </member> <member name="self_modulate" type="Color" setter="set_self_modulate" getter="get_self_modulate"> + The color applied to textures on this [code]CanvasItem[/code]. This is not inherited by children [code]CanvasItem[/code]s. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white").. </member> <member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled"> + If [code]true[/code] the object draws behind its parent. Default value: [code]false[/code]. </member> <member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top"> + If [code]true[/code] the object draws on top of its parent. Default value: [code]true[/code]. </member> <member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material"> + If [code]true[/code] the parent [code]CanvasItem[/code]'s [member material] property is used as this one's material. Default value: [code]false[/code]. </member> <member name="visible" type="bool" setter="set_visible" getter="is_visible"> + If [code]true[/code] this [code]CanvasItem[/code] is drawn. Default value: [code]true[/code]. </member> </members> <signals> @@ -637,34 +525,34 @@ </signal> </signals> <constants> - <constant name="BLEND_MODE_MIX" value="0"> + <constant name="BLEND_MODE_MIX" value="0" enum="BlendMode"> Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. </constant> - <constant name="BLEND_MODE_ADD" value="1"> + <constant name="BLEND_MODE_ADD" value="1" enum="BlendMode"> Additive blending mode. </constant> - <constant name="BLEND_MODE_SUB" value="2"> + <constant name="BLEND_MODE_SUB" value="2" enum="BlendMode"> Subtractive blending mode. </constant> - <constant name="BLEND_MODE_MUL" value="3"> + <constant name="BLEND_MODE_MUL" value="3" enum="BlendMode"> Multiplicative blending mode. </constant> - <constant name="BLEND_MODE_PREMULT_ALPHA" value="4"> + <constant name="BLEND_MODE_PREMULT_ALPHA" value="4" enum="BlendMode"> Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. </constant> - <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum=""> + <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29"> Canvas item transform has changed. Only received if requested. </constant> - <constant name="NOTIFICATION_DRAW" value="30" enum=""> + <constant name="NOTIFICATION_DRAW" value="30"> CanvasItem is requested to draw. </constant> - <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31" enum=""> + <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31"> Canvas item visibility has changed. </constant> - <constant name="NOTIFICATION_ENTER_CANVAS" value="32" enum=""> + <constant name="NOTIFICATION_ENTER_CANVAS" value="32"> Canvas item has entered the canvas. </constant> - <constant name="NOTIFICATION_EXIT_CANVAS" value="33" enum=""> + <constant name="NOTIFICATION_EXIT_CANVAS" value="33"> Canvas item has exited the canvas. </constant> </constants> diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml index b9d2653a2f..81709227ad 100644 --- a/doc/classes/CanvasItemMaterial.xml +++ b/doc/classes/CanvasItemMaterial.xml @@ -1,65 +1,49 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.0-alpha"> +<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.0-beta"> <brief_description> + A material for [CanvasItem]s. </brief_description> <description> + [code]CanvasItemMaterial[/code]s provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a [ShaderMaterial] to more fully customize a material's interactions with a [CanvasItem]. </description> <tutorials> </tutorials> <demos> </demos> <methods> - <method name="get_blend_mode" qualifiers="const"> - <return type="int" enum="CanvasItemMaterial.BlendMode"> - </return> - <description> - </description> - </method> - <method name="get_light_mode" qualifiers="const"> - <return type="int" enum="CanvasItemMaterial.LightMode"> - </return> - <description> - </description> - </method> - <method name="set_blend_mode"> - <return type="void"> - </return> - <argument index="0" name="blend_mode" type="int" enum="CanvasItemMaterial.BlendMode"> - </argument> - <description> - </description> - </method> - <method name="set_light_mode"> - <return type="void"> - </return> - <argument index="0" name="light_mode" type="int" enum="CanvasItemMaterial.LightMode"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="CanvasItemMaterial.BlendMode"> + The manner in which a material's rendering is applied to underlying textures. </member> <member name="light_mode" type="int" setter="set_light_mode" getter="get_light_mode" enum="CanvasItemMaterial.LightMode"> + The manner in which material reacts to lighting. </member> </members> <constants> - <constant name="BLEND_MODE_MIX" value="0"> + <constant name="BLEND_MODE_MIX" value="0" enum="BlendMode"> + Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. </constant> - <constant name="BLEND_MODE_ADD" value="1"> + <constant name="BLEND_MODE_ADD" value="1" enum="BlendMode"> + Additive blending mode. </constant> - <constant name="BLEND_MODE_SUB" value="2"> + <constant name="BLEND_MODE_SUB" value="2" enum="BlendMode"> + Subtractive blending mode. </constant> - <constant name="BLEND_MODE_MUL" value="3"> + <constant name="BLEND_MODE_MUL" value="3" enum="BlendMode"> + Multiplicative blending mode. </constant> - <constant name="BLEND_MODE_PREMULT_ALPHA" value="4"> + <constant name="BLEND_MODE_PREMULT_ALPHA" value="4" enum="BlendMode"> + Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. </constant> - <constant name="LIGHT_MODE_NORMAL" value="0"> + <constant name="LIGHT_MODE_NORMAL" value="0" enum="LightMode"> + Render the material using both light and non-light sensitive material properties. </constant> - <constant name="LIGHT_MODE_UNSHADED" value="1"> + <constant name="LIGHT_MODE_UNSHADED" value="1" enum="LightMode"> + Render the material as if there were no light. </constant> - <constant name="LIGHT_MODE_LIGHT_ONLY" value="2"> + <constant name="LIGHT_MODE_LIGHT_ONLY" value="2" enum="LightMode"> + Render the material as if there were only light. </constant> </constants> </class> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 139624bb1d..01c2dd6ba9 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CanvasLayer" inherits="Node" category="Core" version="3.0-alpha"> +<class name="CanvasLayer" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Canvas drawing layer. </brief_description> @@ -15,20 +15,7 @@ <return type="Node"> </return> <description> - </description> - </method> - <method name="get_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the layer index, determines the draw order, a lower value will be below a higher one. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the base offset for this layer (helper). + Returns the [Viewport] used by the camera if it is not using the default viewport. </description> </method> <method name="get_rotation" qualifiers="const"> @@ -38,20 +25,6 @@ Return the base rotation for this layer in radians (helper). </description> </method> - <method name="get_rotation_degrees" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the base rotation for this layer in degrees. - </description> - </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the base scale for this layer (helper). - </description> - </method> <method name="get_transform" qualifiers="const"> <return type="Transform2D"> </return> @@ -72,24 +45,7 @@ <argument index="0" name="viewport" type="Node"> </argument> <description> - </description> - </method> - <method name="set_layer"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - Set the layer index, determines the draw order, a lower value will be below a higher one. - </description> - </method> - <method name="set_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - Set the base offset for this layer (helper). + Assigns a custom [Viewport] node to the [code]CanvasLayer[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead. </description> </method> <method name="set_rotation"> @@ -101,24 +57,6 @@ Set the base rotation for this layer in radians (helper). </description> </method> - <method name="set_rotation_degrees"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - Set the base rotation for this layer in degrees (helper). - </description> - </method> - <method name="set_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - Set the base scale for this layer (helper). - </description> - </method> <method name="set_transform"> <return type="void"> </return> diff --git a/doc/classes/CanvasModulate.xml b/doc/classes/CanvasModulate.xml index 3872d80236..117230db1c 100644 --- a/doc/classes/CanvasModulate.xml +++ b/doc/classes/CanvasModulate.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CanvasModulate" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="CanvasModulate" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Tint the entire canvas. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - Gets the canvas tint color - </description> - </method> - <method name="set_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - Sets the canvas tint color - </description> - </method> </methods> <members> <member name="color" type="Color" setter="set_color" getter="get_color"> diff --git a/doc/classes/CapsuleMesh.xml b/doc/classes/CapsuleMesh.xml index 497e795253..715bd7ac5a 100644 --- a/doc/classes/CapsuleMesh.xml +++ b/doc/classes/CapsuleMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CapsuleMesh" inherits="PrimitiveMesh" category="Core" version="3.0-alpha"> +<class name="CapsuleMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> <brief_description> Class representing a capsule-shaped [PrimitiveMesh]. </brief_description> @@ -11,62 +11,6 @@ <demos> </demos> <methods> - <method name="get_mid_height" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_radial_segments" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_rings" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_mid_height"> - <return type="void"> - </return> - <argument index="0" name="mid_height" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_radial_segments"> - <return type="void"> - </return> - <argument index="0" name="segments" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_rings"> - <return type="void"> - </return> - <argument index="0" name="rings" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="mid_height" type="float" setter="set_mid_height" getter="get_mid_height"> diff --git a/doc/classes/CapsuleShape.xml b/doc/classes/CapsuleShape.xml index f2d3528e4f..25f5b8eb35 100644 --- a/doc/classes/CapsuleShape.xml +++ b/doc/classes/CapsuleShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CapsuleShape" inherits="Shape" category="Core" version="3.0-alpha"> +<class name="CapsuleShape" inherits="Shape" category="Core" version="3.0-beta"> <brief_description> Capsule shape for collisions. </brief_description> @@ -11,38 +11,6 @@ <demos> </demos> <methods> - <method name="get_height" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the capsule height. - </description> - </method> - <method name="get_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the capsule radius. - </description> - </method> - <method name="set_height"> - <return type="void"> - </return> - <argument index="0" name="height" type="float"> - </argument> - <description> - Set the capsule height. - </description> - </method> - <method name="set_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - Set the capsule radius. - </description> - </method> </methods> <members> <member name="height" type="float" setter="set_height" getter="get_height"> diff --git a/doc/classes/CapsuleShape2D.xml b/doc/classes/CapsuleShape2D.xml index b700388303..75a69546aa 100644 --- a/doc/classes/CapsuleShape2D.xml +++ b/doc/classes/CapsuleShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CapsuleShape2D" inherits="Shape2D" category="Core" version="3.0-alpha"> +<class name="CapsuleShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> <brief_description> Capsule shape for 2D collisions. </brief_description> @@ -11,38 +11,6 @@ <demos> </demos> <methods> - <method name="get_height" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the height of the [code]CapsuleShape2D[/code]. - </description> - </method> - <method name="get_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the radius of the [code]CapsuleShape2D[/code]. - </description> - </method> - <method name="set_height"> - <return type="void"> - </return> - <argument index="0" name="height" type="float"> - </argument> - <description> - Set the height of the [code]CapsuleShape2D[/code]. - </description> - </method> - <method name="set_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - Set the radius of the [code]CapsuleShape2D[/code]. - </description> - </method> </methods> <members> <member name="height" type="float" setter="set_height" getter="get_height"> diff --git a/doc/classes/CenterContainer.xml b/doc/classes/CenterContainer.xml index 9e88448e32..6235a3fec4 100644 --- a/doc/classes/CenterContainer.xml +++ b/doc/classes/CenterContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CenterContainer" inherits="Container" category="Core" version="3.0-alpha"> +<class name="CenterContainer" inherits="Container" category="Core" version="3.0-beta"> <brief_description> Keeps children controls centered. </brief_description> @@ -11,25 +11,10 @@ <demos> </demos> <methods> - <method name="is_using_top_left" qualifiers="const"> - <return type="bool"> - </return> - <description> - Should put children to the top left corner instead of center of the container. - </description> - </method> - <method name="set_use_top_left"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container). - </description> - </method> </methods> <members> <member name="use_top_left" type="bool" setter="set_use_top_left" getter="is_using_top_left"> + If [code]true[/code] centers children relative to the [code]CenterContainer[/code]'s top left corner. Default value: [code]false[/code]. </member> </members> <constants> diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index fb9a67323b..f38b43cf8c 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CheckBox" inherits="Button" category="Core" version="3.0-alpha"> +<class name="CheckBox" inherits="Button" category="Core" version="3.0-beta"> <brief_description> Binary choice user interface widget </brief_description> diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index 996b4238a1..77de3c17fc 100644 --- a/doc/classes/CheckButton.xml +++ b/doc/classes/CheckButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CheckButton" inherits="Button" category="Core" version="3.0-alpha"> +<class name="CheckButton" inherits="Button" category="Core" version="3.0-beta"> <brief_description> Checkable button. </brief_description> diff --git a/doc/classes/CircleShape2D.xml b/doc/classes/CircleShape2D.xml index e5158755fe..1018790803 100644 --- a/doc/classes/CircleShape2D.xml +++ b/doc/classes/CircleShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CircleShape2D" inherits="Shape2D" category="Core" version="3.0-alpha"> +<class name="CircleShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> <brief_description> Circular shape for 2D collisions. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the radius of the circle shape. - </description> - </method> - <method name="set_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - Set the radius of the circle shape. - </description> - </method> </methods> <members> <member name="radius" type="float" setter="set_radius" getter="get_radius"> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 2fed2f8676..b4d4d0b448 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ClassDB" inherits="Object" category="Core" version="3.0-alpha"> +<class name="ClassDB" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Class information repository. </brief_description> @@ -35,6 +35,7 @@ <argument index="0" name="class" type="String"> </argument> <description> + Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. </description> </method> <method name="class_get_integer_constant" qualifiers="const"> diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index be047ad699..5d0984bcdf 100644 --- a/doc/classes/CollisionObject.xml +++ b/doc/classes/CollisionObject.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionObject" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="CollisionObject" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Base node for collision objects. </brief_description> @@ -25,6 +25,7 @@ <argument index="4" name="shape_idx" type="int"> </argument> <description> + Accepts unhandled [InputEvent]s. [code]click_position[/code] is the clicked location in world space and [code]click_normal[/code] is the normal vector extending from the clicked surface of the [Shape] at [code]shape_idx[/code]. Connect to the [code]input_event[/code] signal to easily pick up these events. </description> </method> <method name="create_shape_owner"> @@ -36,12 +37,6 @@ Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. </description> </method> - <method name="get_capture_input_on_drag" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="get_rid" qualifiers="const"> <return type="RID"> </return> @@ -56,12 +51,6 @@ Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument. </description> </method> - <method name="is_ray_pickable" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_shape_owner_disabled" qualifiers="const"> <return type="bool"> </return> @@ -80,22 +69,6 @@ Removes the given shape owner. </description> </method> - <method name="set_capture_input_on_drag"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_ray_pickable"> - <return type="void"> - </return> - <argument index="0" name="ray_pickable" type="bool"> - </argument> - <description> - </description> - </method> <method name="shape_find_owner" qualifiers="const"> <return type="int"> </return> @@ -162,6 +135,7 @@ <argument index="1" name="shape_id" type="int"> </argument> <description> + Returns the child index of the [Shape] with the given id from the given shape owner. </description> </method> <method name="shape_owner_get_transform" qualifiers="const"> @@ -209,8 +183,10 @@ </methods> <members> <member name="input_capture_on_drag" type="bool" setter="set_capture_input_on_drag" getter="get_capture_input_on_drag"> + If [code]true[/code] the [code]CollisionObject[/code] will continue to receive input events as the mouse is dragged across its shapes. Default value: [code]false[/code]. </member> <member name="input_ray_pickable" type="bool" setter="set_ray_pickable" getter="is_ray_pickable"> + If [code]true[/code] the [CollisionObject]'s shapes will respond to [RayCast]s. Default value: [code]true[/code]. </member> </members> <signals> @@ -226,6 +202,7 @@ <argument index="4" name="shape_idx" type="int"> </argument> <description> + Emitted when [method _input_event] receives an event. See its description for details. </description> </signal> <signal name="mouse_entered"> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index d10368229c..086513cad5 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionObject2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="CollisionObject2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Base node for 2D collision objects. </brief_description> @@ -21,6 +21,7 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> + Accepts unhandled [InputEvent]s. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events. </description> </method> <method name="create_shape_owner"> @@ -46,13 +47,6 @@ Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument. </description> </method> - <method name="is_pickable" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this object is pickable. - </description> - </method> <method name="is_shape_owner_disabled" qualifiers="const"> <return type="bool"> </return> @@ -68,6 +62,7 @@ <argument index="0" name="owner_id" type="int"> </argument> <description> + Returns [code]true[/code] if collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s. </description> </method> <method name="remove_shape_owner"> @@ -79,15 +74,6 @@ Removes the given shape owner. </description> </method> - <method name="set_pickable"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. - </description> - </method> <method name="shape_find_owner" qualifiers="const"> <return type="int"> </return> @@ -154,6 +140,7 @@ <argument index="1" name="shape_id" type="int"> </argument> <description> + Returns the child index of the [Shape2D] with the given id from the given shape owner. </description> </method> <method name="shape_owner_get_transform" qualifiers="const"> @@ -195,6 +182,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s. </description> </method> <method name="shape_owner_set_transform"> @@ -223,7 +211,7 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> - Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code]. + Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code]. See [method _input_event] for details. </description> </signal> <signal name="mouse_entered"> diff --git a/doc/classes/CollisionPolygon.xml b/doc/classes/CollisionPolygon.xml index 13a993e9f4..ff689e36f4 100644 --- a/doc/classes/CollisionPolygon.xml +++ b/doc/classes/CollisionPolygon.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionPolygon" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="CollisionPolygon" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Editor-only class for defining a collision polygon in 3D space. </brief_description> @@ -11,48 +11,6 @@ <demos> </demos> <methods> - <method name="get_depth" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_polygon" qualifiers="const"> - <return type="PoolVector2Array"> - </return> - <description> - </description> - </method> - <method name="is_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_depth"> - <return type="void"> - </return> - <argument index="0" name="depth" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_disabled"> - <return type="void"> - </return> - <argument index="0" name="disabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_polygon"> - <return type="void"> - </return> - <argument index="0" name="polygon" type="PoolVector2Array"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="depth" type="float" setter="set_depth" getter="get_depth"> diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml index bc4d2a5b16..995b868f89 100644 --- a/doc/classes/CollisionPolygon2D.xml +++ b/doc/classes/CollisionPolygon2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionPolygon2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="CollisionPolygon2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Defines a 2D collision polygon. </brief_description> @@ -11,67 +11,6 @@ <demos> </demos> <methods> - <method name="get_build_mode" qualifiers="const"> - <return type="int" enum="CollisionPolygon2D.BuildMode"> - </return> - <description> - Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). - </description> - </method> - <method name="get_polygon" qualifiers="const"> - <return type="PoolVector2Array"> - </return> - <description> - Return the list of points that define the polygon. - </description> - </method> - <method name="is_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_one_way_collision_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_build_mode"> - <return type="void"> - </return> - <argument index="0" name="build_mode" type="int" enum="CollisionPolygon2D.BuildMode"> - </argument> - <description> - Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). - </description> - </method> - <method name="set_disabled"> - <return type="void"> - </return> - <argument index="0" name="disabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_one_way_collision"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_polygon"> - <return type="void"> - </return> - <argument index="0" name="polygon" type="PoolVector2Array"> - </argument> - <description> - Set the array of points forming the polygon. - When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode==0[/code]), or a list of lines (for [code]build_mode==1[/code]). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point. - </description> - </method> </methods> <members> <member name="build_mode" type="int" setter="set_build_mode" getter="get_build_mode" enum="CollisionPolygon2D.BuildMode"> @@ -88,10 +27,10 @@ </member> </members> <constants> - <constant name="BUILD_SOLIDS" value="0"> + <constant name="BUILD_SOLIDS" value="0" enum="BuildMode"> Collisions will include the polygon and its contained area. </constant> - <constant name="BUILD_SEGMENTS" value="1"> + <constant name="BUILD_SEGMENTS" value="1" enum="BuildMode"> Collisions will only include the polygon edges. </constant> </constants> diff --git a/doc/classes/CollisionShape.xml b/doc/classes/CollisionShape.xml index 3c9e252788..b893ee79ad 100644 --- a/doc/classes/CollisionShape.xml +++ b/doc/classes/CollisionShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionShape" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="CollisionShape" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Node that represents collision shape data in 3D space. </brief_description> @@ -11,18 +11,6 @@ <demos> </demos> <methods> - <method name="get_shape" qualifiers="const"> - <return type="Shape"> - </return> - <description> - </description> - </method> - <method name="is_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="make_convex_from_brothers"> <return type="void"> </return> @@ -39,22 +27,6 @@ If this method exists within a script it will be called whenever the shape resource has been modified. </description> </method> - <method name="set_disabled"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_shape"> - <return type="void"> - </return> - <argument index="0" name="shape" type="Shape"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml index caf3f8d8be..2ab9540196 100644 --- a/doc/classes/CollisionShape2D.xml +++ b/doc/classes/CollisionShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionShape2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="CollisionShape2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Node that represents collision shape data in 2D space. </brief_description> @@ -11,48 +11,6 @@ <demos> </demos> <methods> - <method name="get_shape" qualifiers="const"> - <return type="Shape2D"> - </return> - <description> - </description> - </method> - <method name="is_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_one_way_collision_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_disabled"> - <return type="void"> - </return> - <argument index="0" name="disabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_one_way_collision"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_shape"> - <return type="void"> - </return> - <argument index="0" name="shape" type="Shape2D"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 479eb719d4..6fa7ed0a86 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Color" category="Built-In Types" version="3.0-alpha"> +<class name="Color" category="Built-In Types" version="3.0-beta"> <brief_description> Color in RGBA format with some support for ARGB format. </brief_description> @@ -103,6 +103,19 @@ [/codeblock] </description> </method> + <method name="darkened"> + <return type="Color"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + Returns a new color resulting from making this color darker by the specified percentage (0-1). + [codeblock] + var green = Color(0.0, 1.0, 0.0) + var darkgreen = green.darkened(0.2) # 20% darker than regular green + [/codeblock] + </description> + </method> <method name="gray"> <return type="float"> </return> @@ -126,6 +139,19 @@ [/codeblock] </description> </method> + <method name="lightened"> + <return type="Color"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + Returns a new color resulting from making this color lighter by the specified percentage (0-1). + [codeblock] + var green = Color(0.0, 1.0, 0.0) + var lightgreen = green.lightened(0.2) # 20% lighter than regular green + [/codeblock] + </description> + </method> <method name="linear_interpolate"> <return type="Color"> </return> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index b6aeb8d0e3..192f139ba9 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ColorPicker" inherits="BoxContainer" category="Core" version="3.0-alpha"> +<class name="ColorPicker" inherits="BoxContainer" category="Core" version="3.0-beta"> <brief_description> Color picker control. </brief_description> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 24b37580d6..185460eef2 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ColorPickerButton" inherits="Button" category="Core" version="3.0-alpha"> +<class name="ColorPickerButton" inherits="Button" category="Core" version="3.0-beta"> <brief_description> Button that pops out a [ColorPicker] </brief_description> @@ -11,53 +11,27 @@ <demos> </demos> <methods> - <method name="get_pick_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> <method name="get_picker"> <return type="ColorPicker"> </return> <description> + Returns the [code]ColorPicker[/code] that this [code]ColorPickerButton[/code] toggles. </description> </method> - <method name="is_editing_alpha" qualifiers="const"> - <return type="bool"> - </return> - <description> - See [method ColorPicker.is_edit_alpha] - </description> - </method> - <method name="set_edit_alpha"> - <return type="void"> + <method name="get_popup"> + <return type="PopupPanel"> </return> - <argument index="0" name="show" type="bool"> - </argument> - <description> - See [method ColorPicker.set_edit_alpha] - </description> - </method> - <method name="set_pick_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> <description> - Set new color to ColorRect. - - [codeblock] - var cr = get_node("colorrect_node") - cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red - [/codeblock] + Returns the control's [PopupPanel] which allows you to connect to Popup Signals. This allows you to handle events when the ColorPicker is shown or hidden. </description> </method> </methods> <members> <member name="color" type="Color" setter="set_pick_color" getter="get_pick_color"> + The currently selected color. </member> <member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha"> + If [code]true[/code] the alpha channel in the displayed [ColorPicker] will be visible. Default value: [code]true[/code]. </member> </members> <signals> @@ -65,7 +39,7 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Emitted when the color is changed. + Emitted when the color changes. </description> </signal> </signals> diff --git a/doc/classes/ColorRect.xml b/doc/classes/ColorRect.xml index 4dbc4f010c..af1b0f57e2 100644 --- a/doc/classes/ColorRect.xml +++ b/doc/classes/ColorRect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ColorRect" inherits="Control" category="Core" version="3.0-alpha"> +<class name="ColorRect" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Colored rect for canvas. </brief_description> @@ -11,30 +11,6 @@ <demos> </demos> <methods> - <method name="get_frame_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - Return the color in RGBA format. - [codeblock] - var cr = get_node("colorrect_node") - var c = cr.get_frame_color() # Default color is white - [/codeblock] - </description> - </method> - <method name="set_frame_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - Set new color to ColorRect. - [codeblock] - var cr = get_node("colorrect_node") - cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red - [/codeblock] - </description> - </method> </methods> <members> <member name="color" type="Color" setter="set_frame_color" getter="get_frame_color"> diff --git a/doc/classes/ConcavePolygonShape.xml b/doc/classes/ConcavePolygonShape.xml index e586eb11c5..bae86d5b22 100644 --- a/doc/classes/ConcavePolygonShape.xml +++ b/doc/classes/ConcavePolygonShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConcavePolygonShape" inherits="Shape" category="Core" version="3.0-alpha"> +<class name="ConcavePolygonShape" inherits="Shape" category="Core" version="3.0-beta"> <brief_description> Concave polygon shape. </brief_description> diff --git a/doc/classes/ConcavePolygonShape2D.xml b/doc/classes/ConcavePolygonShape2D.xml index 5d2dbb4596..1d2aabd6ea 100644 --- a/doc/classes/ConcavePolygonShape2D.xml +++ b/doc/classes/ConcavePolygonShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConcavePolygonShape2D" inherits="Shape2D" category="Core" version="3.0-alpha"> +<class name="ConcavePolygonShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> <brief_description> Concave polygon 2D shape resource for physics. </brief_description> @@ -12,25 +12,10 @@ <demos> </demos> <methods> - <method name="get_segments" qualifiers="const"> - <return type="PoolVector2Array"> - </return> - <description> - Return the array of segments. - </description> - </method> - <method name="set_segments"> - <return type="void"> - </return> - <argument index="0" name="segments" type="PoolVector2Array"> - </argument> - <description> - Set the array of segments. - </description> - </method> </methods> <members> <member name="segments" type="PoolVector2Array" setter="set_segments" getter="get_segments"> + The array of points that make up the [code]ConcavePolygonShape2D[/code]'s line segments. </member> </members> <constants> diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index 2f72b451f3..4fcacb6d46 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConeTwistJoint" inherits="Joint" category="Core" version="3.0-alpha"> +<class name="ConeTwistJoint" inherits="Joint" category="Core" version="3.0-beta"> <brief_description> A twist joint between two 3D bodies </brief_description> @@ -13,24 +13,6 @@ <demos> </demos> <methods> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="ConeTwistJoint.Param"> - </argument> - <description> - </description> - </method> - <method name="set_param"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="ConeTwistJoint.Param"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="bias" type="float" setter="set_param" getter="get_param"> @@ -55,27 +37,27 @@ </member> </members> <constants> - <constant name="PARAM_SWING_SPAN" value="0"> + <constant name="PARAM_SWING_SPAN" value="0" enum="Param"> Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected allong the swing axis. Could be defined as looseness in the [code]ConeTwistJoint[/code]. If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code]. </constant> - <constant name="PARAM_TWIST_SPAN" value="1"> + <constant name="PARAM_TWIST_SPAN" value="1" enum="Param"> Twist is the rotation around the twist axis, this value defined how far the joint can twist. Twist is locked if below 0.05. </constant> - <constant name="PARAM_BIAS" value="2"> + <constant name="PARAM_BIAS" value="2" enum="Param"> The speed with which the swing or twist will take place. The higher, the faster. </constant> - <constant name="PARAM_SOFTNESS" value="3"> + <constant name="PARAM_SOFTNESS" value="3" enum="Param"> The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. </constant> - <constant name="PARAM_RELAXATION" value="4"> + <constant name="PARAM_RELAXATION" value="4" enum="Param"> Defines, how fast the swing- and twist-speed-difference on both sides gets synced. </constant> - <constant name="PARAM_MAX" value="5"> + <constant name="PARAM_MAX" value="5" enum="Param"> End flag of PARAM_* constants, used internally. </constant> </constants> diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index ef668ca994..fcd8834b0c 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConfigFile" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="ConfigFile" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Helper class to handle INI-style files. </brief_description> diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index 1bbb338c07..77eb1bfc2c 100644 --- a/doc/classes/ConfirmationDialog.xml +++ b/doc/classes/ConfirmationDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConfirmationDialog" inherits="AcceptDialog" category="Core" version="3.0-alpha"> +<class name="ConfirmationDialog" inherits="AcceptDialog" category="Core" version="3.0-beta"> <brief_description> Dialog for confirmation of actions. </brief_description> diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml index 5490c84bae..a2aa39414c 100644 --- a/doc/classes/Container.xml +++ b/doc/classes/Container.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Container" inherits="Control" category="Core" version="3.0-alpha"> +<class name="Container" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Base node for containers. </brief_description> @@ -39,7 +39,7 @@ </signal> </signals> <constants> - <constant name="NOTIFICATION_SORT_CHILDREN" value="50" enum=""> + <constant name="NOTIFICATION_SORT_CHILDREN" value="50"> Notification for when sorting the children, it must be obeyed immediately. </constant> </constants> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 79870dd411..6c30a92ed5 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Control" inherits="CanvasItem" category="Core" version="3.0-alpha"> +<class name="Control" inherits="CanvasItem" category="Core" version="3.0-beta"> <brief_description> All User Interface nodes inherit from Control. Features anchors and margins to adapt its position and size to its parent. </brief_description> @@ -60,7 +60,7 @@ <argument index="1" name="constant" type="int"> </argument> <description> - Overrides an integer constant in the [theme] resource the node uses. If the [code]constant[code] is invalid, Godot clears the override. See [member Theme.INVALID_CONSTANT] for more information. + Overrides an integer constant in the [Theme] resource the node uses. If the [code]constant[/code] is invalid, Godot clears the override. See [member Theme.INVALID_CONSTANT] for more information. </description> </method> <method name="add_font_override"> @@ -137,15 +137,6 @@ <description> </description> </method> - <method name="get_anchor" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). - </description> - </method> <method name="get_begin" qualifiers="const"> <return type="Vector2"> </return> @@ -187,12 +178,6 @@ Returns the mouse cursor shape the control displays on mouse hover, one of the [code]CURSOR_*[/code] constants. </description> </method> - <method name="get_custom_minimum_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> <method name="get_default_cursor_shape" qualifiers="const"> <return type="int" enum="Control.CursorShape"> </return> @@ -222,15 +207,6 @@ Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). </description> </method> - <method name="get_focus_neighbour" qualifiers="const"> - <return type="NodePath"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. - </description> - </method> <method name="get_focus_owner" qualifiers="const"> <return type="Control"> </return> @@ -262,19 +238,6 @@ Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_position], [method get_size]). </description> </method> - <method name="get_h_grow_direction" qualifiers="const"> - <return type="int" enum="Control.GrowDirection"> - </return> - <description> - </description> - </method> - <method name="get_h_size_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - Hint for containers, return horizontal positioning flags. - </description> - </method> <method name="get_icon" qualifiers="const"> <return type="Texture"> </return> @@ -285,15 +248,6 @@ <description> </description> </method> - <method name="get_margin" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode. - </description> - </method> <method name="get_minimum_size" qualifiers="const"> <return type="Vector2"> </return> @@ -301,13 +255,6 @@ Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. </description> </method> - <method name="get_mouse_filter" qualifiers="const"> - <return type="int" enum="Control.MouseFilter"> - </return> - <description> - Return when the control is ignoring mouse events (even touchpad events send mouse events). - </description> - </method> <method name="get_parent_area_size" qualifiers="const"> <return type="Vector2"> </return> @@ -320,19 +267,6 @@ <description> </description> </method> - <method name="get_pivot_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. - </description> - </method> <method name="get_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -347,33 +281,6 @@ Return the rotation (in radians) </description> </method> - <method name="get_rotation_degrees" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the rotation (in degrees) - </description> - </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by[/b] [method get_minimum_size]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]). - </description> - </method> - <method name="get_stretch_ratio" qualifiers="const"> - <return type="float"> - </return> - <description> - Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. - </description> - </method> <method name="get_stylebox" qualifiers="const"> <return type="StyleBox"> </return> @@ -384,13 +291,6 @@ <description> </description> </method> - <method name="get_theme" qualifiers="const"> - <return type="Theme"> - </return> - <description> - Return a [Theme] override, if one exists (see [method set_theme]). - </description> - </method> <method name="get_tooltip" qualifiers="const"> <return type="String"> </return> @@ -400,19 +300,6 @@ Return the tooltip, which will appear when the cursor is resting over this control. </description> </method> - <method name="get_v_grow_direction" qualifiers="const"> - <return type="int" enum="Control.GrowDirection"> - </return> - <description> - </description> - </method> - <method name="get_v_size_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - Hint for containers, return vertical positioning flags. - </description> - </method> <method name="grab_click_focus"> <return type="void"> </return> @@ -531,12 +418,6 @@ <description> </description> </method> - <method name="is_clipping_contents"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="minimum_size_changed"> <return type="void"> </return> @@ -609,22 +490,6 @@ Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). </description> </method> - <method name="set_clip_contents"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_custom_minimum_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - </description> - </method> <method name="set_default_cursor_shape"> <return type="void"> </return> @@ -668,17 +533,6 @@ Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals. </description> </method> - <method name="set_focus_neighbour"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="neighbour" type="NodePath"> - </argument> - <description> - Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. - </description> - </method> <method name="set_global_position"> <return type="void"> </return> @@ -688,34 +542,6 @@ Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]). </description> </method> - <method name="set_h_grow_direction"> - <return type="void"> - </return> - <argument index="0" name="direction" type="int" enum="Control.GrowDirection"> - </argument> - <description> - </description> - </method> - <method name="set_h_size_flags"> - <return type="void"> - </return> - <argument index="0" name="flags" type="int"> - </argument> - <description> - Hint for containers, set horizontal positioning flags. - </description> - </method> - <method name="set_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="offset" type="float"> - </argument> - <description> - Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode. - </description> - </method> <method name="set_margins_preset"> <return type="void"> </return> @@ -728,32 +554,6 @@ <description> </description> </method> - <method name="set_mouse_filter"> - <return type="void"> - </return> - <argument index="0" name="filter" type="int" enum="Control.MouseFilter"> - </argument> - <description> - Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER_* constants) - </description> - </method> - <method name="set_pivot_offset"> - <return type="void"> - </return> - <argument index="0" name="pivot_offset" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [method set_margin]). - </description> - </method> <method name="set_rotation"> <return type="void"> </return> @@ -763,76 +563,6 @@ Set the rotation (in radians). </description> </method> - <method name="set_rotation_degrees"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - Set the rotation (in degrees). - </description> - </method> - <method name="set_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]). - </description> - </method> - <method name="set_stretch_ratio"> - <return type="void"> - </return> - <argument index="0" name="ratio" type="float"> - </argument> - <description> - Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. - </description> - </method> - <method name="set_theme"> - <return type="void"> - </return> - <argument index="0" name="theme" type="Theme"> - </argument> - <description> - Overrides the whole [Theme] for this node and all its [code]Control[/code] children. - </description> - </method> - <method name="set_tooltip"> - <return type="void"> - </return> - <argument index="0" name="tooltip" type="String"> - </argument> - <description> - Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments. - </description> - </method> - <method name="set_v_grow_direction"> - <return type="void"> - </return> - <argument index="0" name="direction" type="int" enum="Control.GrowDirection"> - </argument> - <description> - </description> - </method> - <method name="set_v_size_flags"> - <return type="void"> - </return> - <argument index="0" name="flags" type="int"> - </argument> - <description> - Hint for containers, set vertical positioning flags. - </description> - </method> <method name="show_modal"> <return type="void"> </return> @@ -877,6 +607,10 @@ <member name="focus_neighbour_top" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour"> Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a [code]Control[/code]. If this property is not set, Godot will give focus to the closest [code]Control[/code] to the bottom of this one. </member> + <member name="focus_next" type="NodePath" setter="set_focus_next" getter="get_focus_next"> + </member> + <member name="focus_previous" type="NodePath" setter="set_focus_previous" getter="get_focus_previous"> + </member> <member name="grow_horizontal" type="int" setter="set_h_grow_direction" getter="get_h_grow_direction" enum="Control.GrowDirection"> </member> <member name="grow_vertical" type="int" setter="set_v_grow_direction" getter="get_v_grow_direction" enum="Control.GrowDirection"> @@ -982,172 +716,172 @@ </signal> </signals> <constants> - <constant name="FOCUS_NONE" value="0"> + <constant name="FOCUS_NONE" value="0" enum="FocusMode"> The node cannot grab focus. Use with [member set_focus_mode]. </constant> - <constant name="FOCUS_CLICK" value="1"> + <constant name="FOCUS_CLICK" value="1" enum="FocusMode"> The node can only grab focus on mouse clicks. Use with [member set_focus_mode]. </constant> - <constant name="FOCUS_ALL" value="2"> + <constant name="FOCUS_ALL" value="2" enum="FocusMode"> The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with [member set_focus_mode]. </constant> - <constant name="NOTIFICATION_RESIZED" value="40" enum=""> + <constant name="NOTIFICATION_RESIZED" value="40"> Sent when the node changes size. Use [member rect_size] to get the new size. </constant> - <constant name="NOTIFICATION_MOUSE_ENTER" value="41" enum=""> + <constant name="NOTIFICATION_MOUSE_ENTER" value="41"> Sent when the mouse pointer enters the node's [code]Rect[/code] area. </constant> - <constant name="NOTIFICATION_MOUSE_EXIT" value="42" enum=""> + <constant name="NOTIFICATION_MOUSE_EXIT" value="42"> Sent when the mouse pointer exits the node's [code]Rect[/code] area. </constant> - <constant name="NOTIFICATION_FOCUS_ENTER" value="43" enum=""> + <constant name="NOTIFICATION_FOCUS_ENTER" value="43"> Sent when the node grabs focus. </constant> - <constant name="NOTIFICATION_FOCUS_EXIT" value="44" enum=""> + <constant name="NOTIFICATION_FOCUS_EXIT" value="44"> Sent when the node loses focus. </constant> - <constant name="NOTIFICATION_THEME_CHANGED" value="45" enum=""> + <constant name="NOTIFICATION_THEME_CHANGED" value="45"> Sent when the node's [member theme] changes, right before Godot redraws the [code]Control[/code]. Happens when you call one of the [code]add_*_override[/code] </constant> - <constant name="NOTIFICATION_MODAL_CLOSE" value="46" enum=""> + <constant name="NOTIFICATION_MODAL_CLOSE" value="46"> Sent when an open modal dialog closes. See [member show_modal]. </constant> - <constant name="CURSOR_ARROW" value="0"> + <constant name="CURSOR_ARROW" value="0" enum="CursorShape"> Show the system's arrow mouse cursor when the user hovers the node. Use with [method set_default_cursor_shape]. </constant> - <constant name="CURSOR_IBEAM" value="1"> + <constant name="CURSOR_IBEAM" value="1" enum="CursorShape"> Show the system's I-beam mouse cursor when the user hovers the node. The I-beam pointer has a shape similar to "I". It tells the user they can highlight or insert text. </constant> - <constant name="CURSOR_POINTING_HAND" value="2"> + <constant name="CURSOR_POINTING_HAND" value="2" enum="CursorShape"> Show the system's pointing hand mouse cursor when the user hovers the node. </constant> - <constant name="CURSOR_CROSS" value="3"> + <constant name="CURSOR_CROSS" value="3" enum="CursorShape"> Show the system's cross mouse cursor when the user hovers the node. </constant> - <constant name="CURSOR_WAIT" value="4"> + <constant name="CURSOR_WAIT" value="4" enum="CursorShape"> Show the system's wait mouse cursor, often an hourglass, when the user hovers the node. </constant> - <constant name="CURSOR_BUSY" value="5"> + <constant name="CURSOR_BUSY" value="5" enum="CursorShape"> Show the system's busy mouse cursor when the user hovers the node. Often an hourglass. </constant> - <constant name="CURSOR_DRAG" value="6"> + <constant name="CURSOR_DRAG" value="6" enum="CursorShape"> Show the system's drag mouse cursor, often a closed fist or a cross symbol, when the user hovers the node. It tells the user they're currently dragging an item, like a node in the Scene dock. </constant> - <constant name="CURSOR_CAN_DROP" value="7"> + <constant name="CURSOR_CAN_DROP" value="7" enum="CursorShape"> Show the system's drop mouse cursor when the user hovers the node. It can be an open hand. It tells the user they can drop an item they're currently grabbing, like a node in the Scene dock. </constant> - <constant name="CURSOR_FORBIDDEN" value="8"> + <constant name="CURSOR_FORBIDDEN" value="8" enum="CursorShape"> Show the system's forbidden mouse cursor when the user hovers the node. Often a crossed circle. </constant> - <constant name="CURSOR_VSIZE" value="9"> + <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. </constant> - <constant name="CURSOR_HSIZE" value="10"> + <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. </constant> - <constant name="CURSOR_BDIAGSIZE" value="11"> + <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. </constant> - <constant name="CURSOR_FDIAGSIZE" value="12"> + <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 [code]CURSOR_BDIAGSIZE[/code]. It tells the user they can resize the window or the panel both horizontally and vertically. </constant> - <constant name="CURSOR_MOVE" value="13"> + <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. </constant> - <constant name="CURSOR_VSPLIT" value="14"> + <constant name="CURSOR_VSPLIT" value="14" enum="CursorShape"> Show the system's vertical split mouse cursor when the user hovers the node. On Windows, it's the same as [code]CURSOR_VSIZE[/code]. </constant> - <constant name="CURSOR_HSPLIT" value="15"> + <constant name="CURSOR_HSPLIT" value="15" enum="CursorShape"> Show the system's horizontal split mouse cursor when the user hovers the node. On Windows, it's the same as [code]CURSOR_HSIZE[/code]. </constant> - <constant name="CURSOR_HELP" value="16"> + <constant name="CURSOR_HELP" value="16" enum="CursorShape"> Show the system's help mouse cursor when the user hovers the node, a question mark. </constant> - <constant name="PRESET_TOP_LEFT" value="0"> + <constant name="PRESET_TOP_LEFT" value="0" enum="LayoutPreset"> Snap all 4 anchors to the top-left of the parent container's bounds. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_TOP_RIGHT" value="1"> + <constant name="PRESET_TOP_RIGHT" value="1" enum="LayoutPreset"> Snap all 4 anchors to the top-right of the parent container's bounds. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_BOTTOM_LEFT" value="2"> + <constant name="PRESET_BOTTOM_LEFT" value="2" enum="LayoutPreset"> Snap all 4 anchors to the bottom-left of the parent container's bounds. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_BOTTOM_RIGHT" value="3"> + <constant name="PRESET_BOTTOM_RIGHT" value="3" enum="LayoutPreset"> Snap all 4 anchors to the bottom-right of the parent container's bounds. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_CENTER_LEFT" value="4"> + <constant name="PRESET_CENTER_LEFT" value="4" enum="LayoutPreset"> Snap all 4 anchors to the center of the left edge of the parent container's bounds. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_CENTER_TOP" value="5"> + <constant name="PRESET_CENTER_TOP" value="5" enum="LayoutPreset"> Snap all 4 anchors to the center of the top edge of the parent container's bounds. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_CENTER_RIGHT" value="6"> + <constant name="PRESET_CENTER_RIGHT" value="6" enum="LayoutPreset"> Snap all 4 anchors to the center of the right edge of the parent container's bounds. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_CENTER_BOTTOM" value="7"> + <constant name="PRESET_CENTER_BOTTOM" value="7" enum="LayoutPreset"> Snap all 4 anchors to the center of the bottom edge of the parent container's bounds. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_CENTER" value="8"> + <constant name="PRESET_CENTER" value="8" enum="LayoutPreset"> Snap all 4 anchors to the center of the parent container's bounds. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_LEFT_WIDE" value="9"> + <constant name="PRESET_LEFT_WIDE" value="9" enum="LayoutPreset"> Snap all 4 anchors to the left edge of the parent container. The left margin becomes relative to the left edge and the top margin relative to the top left corner of the node's parent. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_TOP_WIDE" value="10"> + <constant name="PRESET_TOP_WIDE" value="10" enum="LayoutPreset"> Snap all 4 anchors to the top edge of the parent container. The left margin becomes relative to the top left corner, the top margin relative to the top edge, and the right margin relative to the top right corner of the node's parent. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_RIGHT_WIDE" value="11"> + <constant name="PRESET_RIGHT_WIDE" value="11" enum="LayoutPreset"> Snap all 4 anchors to the right edge of the parent container. The right margin becomes relative to the right edge and the top margin relative to the top right corner of the node's parent. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_BOTTOM_WIDE" value="12"> + <constant name="PRESET_BOTTOM_WIDE" value="12" enum="LayoutPreset"> Snap all 4 anchors to the bottom edge of the parent container. The left margin becomes relative to the bottom left corner, the bottom margin relative to the bottom edge, and the right margin relative to the bottom right corner of the node's parent. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_VCENTER_WIDE" value="13"> + <constant name="PRESET_VCENTER_WIDE" value="13" enum="LayoutPreset"> Snap all 4 anchors to a vertical line that cuts the parent container in half. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_HCENTER_WIDE" value="14"> + <constant name="PRESET_HCENTER_WIDE" value="14" enum="LayoutPreset"> Snap all 4 anchors to a horizontal line that cuts the parent container in half. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_WIDE" value="15"> + <constant name="PRESET_WIDE" value="15" enum="LayoutPreset"> Snap all 4 anchors to the respective corners of the parent container. Set all 4 margins to 0 after you applied this preset and the [code]Control[/code] will fit its parent container. Use with [method set_anchors_preset]. </constant> - <constant name="PRESET_MODE_MINSIZE" value="0"> + <constant name="PRESET_MODE_MINSIZE" value="0" enum="LayoutPresetMode"> </constant> - <constant name="PRESET_MODE_KEEP_WIDTH" value="1"> + <constant name="PRESET_MODE_KEEP_WIDTH" value="1" enum="LayoutPresetMode"> </constant> - <constant name="PRESET_MODE_KEEP_HEIGHT" value="2"> + <constant name="PRESET_MODE_KEEP_HEIGHT" value="2" enum="LayoutPresetMode"> </constant> - <constant name="PRESET_MODE_KEEP_SIZE" value="3"> + <constant name="PRESET_MODE_KEEP_SIZE" value="3" enum="LayoutPresetMode"> </constant> - <constant name="SIZE_FILL" value="1"> + <constant name="SIZE_FILL" value="1" enum="SizeFlags"> Tells the parent [Container] to expand the bounds of this node to fill all the available space without pushing any other node. Use with [member size_flags_horizontal] and [member size_flags_vertical]. </constant> - <constant name="SIZE_EXPAND" value="2"> + <constant name="SIZE_EXPAND" value="2" enum="SizeFlags"> Tells the parent [Container] to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See [member size_flags_stretch_ratio]. Use with [member size_flags_horizontal] and [member size_flags_vertical]. </constant> - <constant name="SIZE_EXPAND_FILL" value="3"> + <constant name="SIZE_EXPAND_FILL" value="3" enum="SizeFlags"> Sets the node's size flags to both fill and expand. See the 2 constants above for more information. </constant> - <constant name="SIZE_SHRINK_CENTER" value="4"> + <constant name="SIZE_SHRINK_CENTER" value="4" enum="SizeFlags"> Tells the parent [Container] to center the node in itself. It centers the [code]Control[/code] based on its bounding box, so 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="SIZE_SHRINK_END" value="8"> + <constant name="SIZE_SHRINK_END" value="8" enum="SizeFlags"> 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"> + <constant name="MOUSE_FILTER_STOP" value="0" enum="MouseFilter"> </constant> - <constant name="MOUSE_FILTER_PASS" value="1"> + <constant name="MOUSE_FILTER_PASS" value="1" enum="MouseFilter"> </constant> - <constant name="MOUSE_FILTER_IGNORE" value="2"> + <constant name="MOUSE_FILTER_IGNORE" value="2" enum="MouseFilter"> </constant> - <constant name="GROW_DIRECTION_BEGIN" value="0"> + <constant name="GROW_DIRECTION_BEGIN" value="0" enum="GrowDirection"> </constant> - <constant name="GROW_DIRECTION_END" value="1"> + <constant name="GROW_DIRECTION_END" value="1" enum="GrowDirection"> </constant> - <constant name="ANCHOR_BEGIN" value="0"> + <constant name="ANCHOR_BEGIN" value="0" enum="Anchor"> Snaps one of the 4 anchor's sides to the origin of the node's [code]Rect[/code], in the top left. Use it with one of the [code]anchor_*[/code] member variables, like [member anchor_left]. To change all 4 anchors at once, use [method set_anchors_preset]. </constant> - <constant name="ANCHOR_END" value="1"> + <constant name="ANCHOR_END" value="1" enum="Anchor"> Snaps one of the 4 anchor's sides to the end of the node's [code]Rect[/code], in the bottom right. Use it with one of the [code]anchor_*[/code] member variables, like [member anchor_left]. To change all 4 anchors at once, use [method set_anchors_preset]. </constant> </constants> diff --git a/doc/classes/ConvexPolygonShape.xml b/doc/classes/ConvexPolygonShape.xml index 0ea140148c..5ed57a5c05 100644 --- a/doc/classes/ConvexPolygonShape.xml +++ b/doc/classes/ConvexPolygonShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConvexPolygonShape" inherits="Shape" category="Core" version="3.0-alpha"> +<class name="ConvexPolygonShape" inherits="Shape" category="Core" version="3.0-beta"> <brief_description> Convex polygon shape for 3D physics. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_points" qualifiers="const"> - <return type="PoolVector3Array"> - </return> - <description> - </description> - </method> - <method name="set_points"> - <return type="void"> - </return> - <argument index="0" name="points" type="PoolVector3Array"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="points" type="PoolVector3Array" setter="set_points" getter="get_points"> diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index 40507c6a6b..a670ddc9cd 100644 --- a/doc/classes/ConvexPolygonShape2D.xml +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core" version="3.0-alpha"> +<class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> <brief_description> Convex Polygon Shape for 2D physics. </brief_description> @@ -12,13 +12,6 @@ <demos> </demos> <methods> - <method name="get_points" qualifiers="const"> - <return type="PoolVector2Array"> - </return> - <description> - Returns a list of points in either clockwise or counter clockwise order, forming a convex polygon. - </description> - </method> <method name="set_point_cloud"> <return type="void"> </return> @@ -28,15 +21,6 @@ Currently, this method does nothing. </description> </method> - <method name="set_points"> - <return type="void"> - </return> - <argument index="0" name="points" type="PoolVector2Array"> - </argument> - <description> - Sets a list of points in either clockwise or counter clockwise order, forming a convex polygon. - </description> - </method> </methods> <members> <member name="points" type="PoolVector2Array" setter="set_points" getter="get_points"> diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index 9b0837306e..30022efd38 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CubeMap" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="CubeMap" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> A CubeMap is a 6 sided 3D texture. </brief_description> <description> - A CubeMap is a 6 sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods. + A 6-sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods. </description> <tutorials> </tutorials> @@ -15,19 +15,14 @@ <return type="int"> </return> <description> + Returns the render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details. </description> </method> <method name="get_height" qualifiers="const"> <return type="int"> </return> <description> - Returns the CubeMap's height. - </description> - </method> - <method name="get_lossy_storage_quality" qualifiers="const"> - <return type="float"> - </return> - <description> + Returns the [code]CubeMap[/code]'s height. </description> </method> <method name="get_side" qualifiers="const"> @@ -36,20 +31,14 @@ <argument index="0" name="side" type="int" enum="CubeMap.Side"> </argument> <description> - Returns an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5. - </description> - </method> - <method name="get_storage" qualifiers="const"> - <return type="int" enum="CubeMap.Storage"> - </return> - <description> + Returns an [Image] for a side of the [code]CubeMap[/code] using one of the [code]SIDE_*[/code] constants or an integer 0-5. </description> </method> <method name="get_width" qualifiers="const"> <return type="int"> </return> <description> - Returns the CubeMap's width. + Returns the [code]CubeMap[/code]'s width. </description> </method> <method name="set_flags"> @@ -58,14 +47,7 @@ <argument index="0" name="flags" type="int"> </argument> <description> - </description> - </method> - <method name="set_lossy_storage_quality"> - <return type="void"> - </return> - <argument index="0" name="quality" type="float"> - </argument> - <description> + Returns the render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details. </description> </method> <method name="set_side"> @@ -76,52 +58,57 @@ <argument index="1" name="image" type="Image"> </argument> <description> - Sets an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5. - </description> - </method> - <method name="set_storage"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="CubeMap.Storage"> - </argument> - <description> + Sets an [Image] for a side of the [code]CubeMap[/code] using one of the [code]SIDE_*[/code] constants or an integer 0-5. </description> </method> </methods> <members> <member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality"> - The lossy storage quality of the CubeMap if the storage mode is set to STORAGE_COMPRESS_LOSSY. + The lossy storage quality of the [code]CubeMap[/code] if the storage mode is set to STORAGE_COMPRESS_LOSSY. </member> <member name="storage_mode" type="int" setter="set_storage" getter="get_storage" enum="CubeMap.Storage"> - The CubeMap's storage mode. See [code]STORAGE_*[/code] constants. + The [code]CubeMap[/code]'s storage mode. See [code]STORAGE_*[/code] constants. </member> </members> <constants> - <constant name="STORAGE_RAW" value="0"> + <constant name="STORAGE_RAW" value="0" enum="Storage"> + Store the [code]CubeMap[/code] without any compression. </constant> - <constant name="STORAGE_COMPRESS_LOSSY" value="1"> + <constant name="STORAGE_COMPRESS_LOSSY" value="1" enum="Storage"> + Store the [code]CubeMap[/code] with strong compression that reduces image quality. </constant> - <constant name="STORAGE_COMPRESS_LOSSLESS" value="2"> + <constant name="STORAGE_COMPRESS_LOSSLESS" value="2" enum="Storage"> + Store the [code]CubeMap[/code] with moderate compression that doesn't reduce image quality. </constant> - <constant name="SIDE_LEFT" value="0"> + <constant name="SIDE_LEFT" value="0" enum="Side"> + Identifier for the left face of the [code]CubeMap[/code]. </constant> - <constant name="SIDE_RIGHT" value="1"> + <constant name="SIDE_RIGHT" value="1" enum="Side"> + Identifier for the right face of the [code]CubeMap[/code]. </constant> - <constant name="SIDE_BOTTOM" value="2"> + <constant name="SIDE_BOTTOM" value="2" enum="Side"> + Identifier for the bottom face of the [code]CubeMap[/code]. </constant> - <constant name="SIDE_TOP" value="3"> + <constant name="SIDE_TOP" value="3" enum="Side"> + Identifier for the top face of the [code]CubeMap[/code]. </constant> - <constant name="SIDE_FRONT" value="4"> + <constant name="SIDE_FRONT" value="4" enum="Side"> + Identifier for the front face of the [code]CubeMap[/code]. </constant> - <constant name="SIDE_BACK" value="5"> + <constant name="SIDE_BACK" value="5" enum="Side"> + Identifier for the back face of the [code]CubeMap[/code]. </constant> - <constant name="FLAG_MIPMAPS" value="1"> + <constant name="FLAG_MIPMAPS" value="1" enum="Flags"> + Generate mipmaps, to enable smooth zooming out of the texture. </constant> - <constant name="FLAG_REPEAT" value="2"> + <constant name="FLAG_REPEAT" value="2" enum="Flags"> + Repeat (instead of clamp to edge). </constant> - <constant name="FLAG_FILTER" value="4"> + <constant name="FLAG_FILTER" value="4" enum="Flags"> + Turn on magnifying filter, to enable smooth zooming in of the texture. </constant> - <constant name="FLAGS_DEFAULT" value="7"> + <constant name="FLAGS_DEFAULT" value="7" enum="Flags"> + Default flags. Generate mipmaps, repeat, and filter are enabled. </constant> </constants> </class> diff --git a/doc/classes/CubeMesh.xml b/doc/classes/CubeMesh.xml index 4a8ad104b7..56ca64e10a 100644 --- a/doc/classes/CubeMesh.xml +++ b/doc/classes/CubeMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CubeMesh" inherits="PrimitiveMesh" category="Core" version="3.0-alpha"> +<class name="CubeMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> <brief_description> Generate an axis-aligned cuboid [PrimitiveMesh]. </brief_description> @@ -11,62 +11,6 @@ <demos> </demos> <methods> - <method name="get_size" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_subdivide_depth" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_subdivide_height" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_subdivide_width" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_subdivide_depth"> - <return type="void"> - </return> - <argument index="0" name="divisions" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_subdivide_height"> - <return type="void"> - </return> - <argument index="0" name="divisions" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_subdivide_width"> - <return type="void"> - </return> - <argument index="0" name="subdivide" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="size" type="Vector3" setter="set_size" getter="get_size"> diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index 3741f51fad..f7ef9a182c 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Curve" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Curve" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> + 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. </description> <tutorials> </tutorials> @@ -23,42 +25,28 @@ <argument index="4" name="right_mode" type="int" enum="Curve.TangentMode" default="0"> </argument> <description> + Adds a point to the curve. For each side, if the [code]*_mode[/code] is [code]TANGENT_LINEAR[/code], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [code]TANGENT_FREE[/code]. </description> </method> <method name="bake"> <return type="void"> </return> <description> + Recomputes the baked cache of points for the curve. </description> </method> <method name="clean_dupes"> <return type="void"> </return> <description> + Removes points that are closer than [code]CMP_EPSILON[/code] (0.00001) units to their neighbor on the curve. </description> </method> <method name="clear_points"> <return type="void"> </return> <description> - </description> - </method> - <method name="get_bake_resolution" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_max_value" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_min_value" qualifiers="const"> - <return type="float"> - </return> - <description> + Removes all points from the curve. </description> </method> <method name="get_point_left_mode" qualifiers="const"> @@ -67,6 +55,7 @@ <argument index="0" name="index" type="int"> </argument> <description> + Returns the left [code]TangentMode[/code] for the point at [code]index[/code]. </description> </method> <method name="get_point_left_tangent" qualifiers="const"> @@ -75,6 +64,7 @@ <argument index="0" name="index" type="int"> </argument> <description> + Returns the left tangent angle (in degrees) for the point at [code]index[/code]. </description> </method> <method name="get_point_position" qualifiers="const"> @@ -83,6 +73,7 @@ <argument index="0" name="index" type="int"> </argument> <description> + Returns the curve coordinates for the point at [code]index[/code]. </description> </method> <method name="get_point_right_mode" qualifiers="const"> @@ -91,6 +82,7 @@ <argument index="0" name="index" type="int"> </argument> <description> + Returns the right [code]TangentMode[/code] for the point at [code]index[/code]. </description> </method> <method name="get_point_right_tangent" qualifiers="const"> @@ -99,6 +91,7 @@ <argument index="0" name="index" type="int"> </argument> <description> + Returns the right tangent angle (in degrees) for the point at [code]index[/code]. </description> </method> <method name="interpolate" qualifiers="const"> @@ -107,12 +100,14 @@ <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. </description> </method> <method name="interpolate_baked"> <return type="float"> </return> <argument index="0" name="offset" type="float"> + 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. </argument> <description> </description> @@ -123,30 +118,7 @@ <argument index="0" name="index" type="int"> </argument> <description> - </description> - </method> - <method name="set_bake_resolution"> - <return type="void"> - </return> - <argument index="0" name="resolution" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_max_value"> - <return type="void"> - </return> - <argument index="0" name="max" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_min_value"> - <return type="void"> - </return> - <argument index="0" name="min" type="float"> - </argument> - <description> + Removes the point at [code]index[/code] from the curve. </description> </method> <method name="set_point_left_mode"> @@ -157,6 +129,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]. </description> </method> <method name="set_point_left_tangent"> @@ -167,6 +140,7 @@ <argument index="1" name="tangent" type="float"> </argument> <description> + Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code]. </description> </method> <method name="set_point_offset"> @@ -177,6 +151,7 @@ <argument index="1" name="offset" type="float"> </argument> <description> + Sets the offset from [code]0.5[/code] </description> </method> <method name="set_point_right_mode"> @@ -187,6 +162,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]. </description> </method> <method name="set_point_right_tangent"> @@ -197,6 +173,7 @@ <argument index="1" name="tangent" type="float"> </argument> <description> + Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code]. </description> </method> <method name="set_point_value"> @@ -207,31 +184,37 @@ <argument index="1" name="y" type="float"> </argument> <description> + Assigns the vertical position [code]y[/code] to the point at [code]index[/code]. </description> </method> </methods> <members> - <member name="_data" type="Array" setter="_set_data" getter="_get_data"> - </member> <member name="bake_resolution" type="int" setter="set_bake_resolution" getter="get_bake_resolution"> + The number of points to include in the baked (i.e. cached) curve data. </member> <member name="max_value" type="float" setter="set_max_value" getter="get_max_value"> + The maximum value the curve can reach. Default value: [code]1[/code]. </member> <member name="min_value" type="float" setter="set_min_value" getter="get_min_value"> + The minimum value the curve can reach. Default value: [code]0[/code]. </member> </members> <signals> <signal name="range_changed"> <description> + Emitted when [member max_value] or [member min_value] is changed. </description> </signal> </signals> <constants> - <constant name="TANGENT_FREE" value="0"> + <constant name="TANGENT_FREE" value="0" enum="TangentMode"> + The tangent on this side of the point is user-defined. </constant> - <constant name="TANGENT_LINEAR" value="1"> + <constant name="TANGENT_LINEAR" value="1" enum="TangentMode"> + The curve calculates the tangent on this side of the point as the slope halfway towards the adjacent point. </constant> - <constant name="TANGENT_MODE_COUNT" value="2"> + <constant name="TANGENT_MODE_COUNT" value="2" enum="TangentMode"> + The total number of available tangent modes. </constant> </constants> </class> diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 0d9dfad643..8a857799e6 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Curve2D" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Curve2D" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Describes a Bezier curve in 2D space. </brief_description> @@ -35,13 +35,6 @@ Removes all points from the curve. </description> </method> - <method name="get_bake_interval" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the distance between two adjacent cached points. - </description> - </method> <method name="get_baked_length" qualifiers="const"> <return type="float"> </return> @@ -133,15 +126,6 @@ Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. </description> </method> - <method name="set_bake_interval"> - <return type="void"> - </return> - <argument index="0" name="distance" type="float"> - </argument> - <description> - Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. - </description> - </method> <method name="set_point_in"> <return type="void"> </return> @@ -191,9 +175,6 @@ </method> </methods> <members> - <member name="_data" type="Dictionary" setter="_set_data" getter="_get_data"> - The points describing the curve. Value is a [Dictionary] with the keys [code]in[/code], [code]out[/code], and [code]pos[/code]. The key pos is the position of a vertex of the curve, the key in is the vector from that position to the control point before this vertex, the key out is the vector from that position to the controlpoint after this vertex. - </member> <member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval"> The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. </member> diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 35f8db0177..91d7a9bed8 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Curve3D" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Curve3D" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Describes a Bezier curve in 3D space. </brief_description> @@ -32,13 +32,7 @@ <return type="void"> </return> <description> - </description> - </method> - <method name="get_bake_interval" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the distance between two adjacent cached points. + Removes all points from the curve. </description> </method> <method name="get_baked_length" qualifiers="const"> @@ -148,15 +142,6 @@ Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. </description> </method> - <method name="set_bake_interval"> - <return type="void"> - </return> - <argument index="0" name="distance" type="float"> - </argument> - <description> - Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. - </description> - </method> <method name="set_point_in"> <return type="void"> </return> @@ -218,9 +203,8 @@ </method> </methods> <members> - <member name="_data" type="Dictionary" setter="_set_data" getter="_get_data"> - </member> <member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval"> + The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. </member> </members> <constants> diff --git a/doc/classes/CurveTexture.xml b/doc/classes/CurveTexture.xml index 61a6a2486f..f62da8a135 100644 --- a/doc/classes/CurveTexture.xml +++ b/doc/classes/CurveTexture.xml @@ -1,41 +1,23 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CurveTexture" inherits="Texture" category="Core" version="3.0-alpha"> +<class name="CurveTexture" inherits="Texture" category="Core" version="3.0-beta"> <brief_description> + A texture that shows a curve. </brief_description> <description> + Renders a given [Curve] provided to it. Simplifies the task of drawing curves and/or saving them as image files. </description> <tutorials> </tutorials> <demos> </demos> <methods> - <method name="get_curve" qualifiers="const"> - <return type="Curve"> - </return> - <description> - </description> - </method> - <method name="set_curve"> - <return type="void"> - </return> - <argument index="0" name="curve" type="Curve"> - </argument> - <description> - </description> - </method> - <method name="set_width"> - <return type="void"> - </return> - <argument index="0" name="width" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="curve" type="Curve" setter="set_curve" getter="get_curve"> + The [code]curve[/code] rendered onto the texture. </member> <member name="width" type="int" setter="set_width" getter="get_width"> + The width of the texture. </member> </members> <constants> diff --git a/doc/classes/CylinderMesh.xml b/doc/classes/CylinderMesh.xml index 8398b52ee0..57c0027c4c 100644 --- a/doc/classes/CylinderMesh.xml +++ b/doc/classes/CylinderMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CylinderMesh" inherits="PrimitiveMesh" category="Core" version="3.0-alpha"> +<class name="CylinderMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> <brief_description> Class representing a cylindrical [PrimitiveMesh]. </brief_description> @@ -11,76 +11,6 @@ <demos> </demos> <methods> - <method name="get_bottom_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_height" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_radial_segments" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_rings" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_top_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_bottom_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_height"> - <return type="void"> - </return> - <argument index="0" name="height" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_radial_segments"> - <return type="void"> - </return> - <argument index="0" name="segments" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_rings"> - <return type="void"> - </return> - <argument index="0" name="rings" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_top_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="bottom_radius" type="float" setter="set_bottom_radius" getter="get_bottom_radius"> diff --git a/doc/classes/DampedSpringJoint2D.xml b/doc/classes/DampedSpringJoint2D.xml index da7147933d..a49f03eb07 100644 --- a/doc/classes/DampedSpringJoint2D.xml +++ b/doc/classes/DampedSpringJoint2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DampedSpringJoint2D" inherits="Joint2D" category="Core" version="3.0-alpha"> +<class name="DampedSpringJoint2D" inherits="Joint2D" category="Core" version="3.0-beta"> <brief_description> Damped spring constraint for 2D physics. </brief_description> @@ -11,70 +11,6 @@ <demos> </demos> <methods> - <method name="get_damping" qualifiers="const"> - <return type="float"> - </return> - <description> - Return 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). - </description> - </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the maximum length of the spring joint. - </description> - </method> - <method name="get_rest_length" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. - </description> - </method> - <method name="get_stiffness" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. - </description> - </method> - <method name="set_damping"> - <return type="void"> - </return> - <argument index="0" name="damping" type="float"> - </argument> - <description> - 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). - </description> - </method> - <method name="set_length"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - Set the maximum length of the spring joint. - </description> - </method> - <method name="set_rest_length"> - <return type="void"> - </return> - <argument index="0" name="rest_length" type="float"> - </argument> - <description> - Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. - </description> - </method> - <method name="set_stiffness"> - <return type="void"> - </return> - <argument index="0" name="stiffness" type="float"> - </argument> - <description> - Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. - </description> - </method> </methods> <members> <member name="damping" type="float" setter="set_damping" getter="get_damping"> diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index 5664b2079b..40b60f00cf 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Dictionary" category="Built-In Types" version="3.0-alpha"> +<class name="Dictionary" category="Built-In Types" version="3.0-beta"> <brief_description> Dictionary type. </brief_description> diff --git a/doc/classes/DirectionalLight.xml b/doc/classes/DirectionalLight.xml index f0cc007339..287c98e715 100644 --- a/doc/classes/DirectionalLight.xml +++ b/doc/classes/DirectionalLight.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DirectionalLight" inherits="Light" category="Core" version="3.0-alpha"> +<class name="DirectionalLight" inherits="Light" category="Core" version="3.0-beta"> <brief_description> Directional Light, such as the Sun or the Moon. </brief_description> @@ -11,48 +11,6 @@ <demos> </demos> <methods> - <method name="get_shadow_depth_range" qualifiers="const"> - <return type="int" enum="DirectionalLight.ShadowDepthRange"> - </return> - <description> - </description> - </method> - <method name="get_shadow_mode" qualifiers="const"> - <return type="int" enum="DirectionalLight.ShadowMode"> - </return> - <description> - </description> - </method> - <method name="is_blend_splits_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_blend_splits"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_shadow_depth_range"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="DirectionalLight.ShadowDepthRange"> - </argument> - <description> - </description> - </method> - <method name="set_shadow_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="DirectionalLight.ShadowMode"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="directional_shadow_bias_split_scale" type="float" setter="set_param" getter="get_param"> @@ -75,15 +33,15 @@ </member> </members> <constants> - <constant name="SHADOW_ORTHOGONAL" value="0"> + <constant name="SHADOW_ORTHOGONAL" value="0" enum="ShadowMode"> </constant> - <constant name="SHADOW_PARALLEL_2_SPLITS" value="1"> + <constant name="SHADOW_PARALLEL_2_SPLITS" value="1" enum="ShadowMode"> </constant> - <constant name="SHADOW_PARALLEL_4_SPLITS" value="2"> + <constant name="SHADOW_PARALLEL_4_SPLITS" value="2" enum="ShadowMode"> </constant> - <constant name="SHADOW_DEPTH_RANGE_STABLE" value="0"> + <constant name="SHADOW_DEPTH_RANGE_STABLE" value="0" enum="ShadowDepthRange"> </constant> - <constant name="SHADOW_DEPTH_RANGE_OPTIMIZED" value="1"> + <constant name="SHADOW_DEPTH_RANGE_OPTIMIZED" value="1" enum="ShadowDepthRange"> </constant> </constants> </class> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index b11e0629cd..c87d1ef006 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Directory" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="Directory" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Type used to handle the filesystem. </brief_description> diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index 9149e14a62..eae7a1b02b 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DynamicFont" inherits="Font" category="Core" version="3.0-alpha"> +<class name="DynamicFont" inherits="Font" category="Core" version="3.0-beta"> <brief_description> DynamicFont renders vector font files at runtime. </brief_description> @@ -36,42 +36,6 @@ Returns the number of fallback fonts. </description> </method> - <method name="get_font_data" qualifiers="const"> - <return type="DynamicFontData"> - </return> - <description> - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the font size in pixels. - </description> - </method> - <method name="get_spacing" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="type" type="int"> - </argument> - <description> - Returns the given type of spacing in pixels. See [code]SPACING_*[/code] constants. - </description> - </method> - <method name="get_use_filter" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if filtering is used. - </description> - </method> - <method name="get_use_mipmaps" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if mipmapping is used. - </description> - </method> <method name="remove_fallback"> <return type="void"> </return> @@ -92,53 +56,6 @@ Sets the fallback font at index [code]idx[/code]. </description> </method> - <method name="set_font_data"> - <return type="void"> - </return> - <argument index="0" name="data" type="DynamicFontData"> - </argument> - <description> - Sets the [DynamicFontData]. - </description> - </method> - <method name="set_size"> - <return type="void"> - </return> - <argument index="0" name="data" type="int"> - </argument> - <description> - Sets the font size. - </description> - </method> - <method name="set_spacing"> - <return type="void"> - </return> - <argument index="0" name="type" type="int"> - </argument> - <argument index="1" name="value" type="int"> - </argument> - <description> - Sets the spacing of the given type. See [code]SPACING_*[/code] constants. - </description> - </method> - <method name="set_use_filter"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set to [code]true[/code] to use filtering. - </description> - </method> - <method name="set_use_mipmaps"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set to [code]true[/code] to use mipmapping. - </description> - </method> </methods> <members> <member name="extra_spacing_bottom" type="int" setter="set_spacing" getter="get_spacing"> @@ -167,16 +84,16 @@ </member> </members> <constants> - <constant name="SPACING_TOP" value="0"> + <constant name="SPACING_TOP" value="0" enum="SpacingType"> Spacing at the top. </constant> - <constant name="SPACING_BOTTOM" value="1"> + <constant name="SPACING_BOTTOM" value="1" enum="SpacingType"> Spacing at the bottom. </constant> - <constant name="SPACING_CHAR" value="2"> + <constant name="SPACING_CHAR" value="2" enum="SpacingType"> Character spacing. </constant> - <constant name="SPACING_SPACE" value="3"> + <constant name="SPACING_SPACE" value="3" enum="SpacingType"> Space spacing. </constant> </constants> diff --git a/doc/classes/DynamicFontData.xml b/doc/classes/DynamicFontData.xml index 26529006cb..360f0cb0d8 100644 --- a/doc/classes/DynamicFontData.xml +++ b/doc/classes/DynamicFontData.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DynamicFontData" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="DynamicFontData" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Used with [DynamicFont] to describe the location of a font file. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_font_path" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the font path. - </description> - </method> - <method name="set_font_path"> - <return type="void"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - Sets the font path. - </description> - </method> </methods> <members> <member name="font_path" type="String" setter="set_font_path" getter="get_font_path"> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index a3bab32476..ef430d31be 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorExportPlugin" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="EditorExportPlugin" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -14,6 +14,12 @@ </return> <argument index="0" name="features" type="PoolStringArray"> </argument> + <argument index="1" name="is_debug" type="bool"> + </argument> + <argument index="2" name="path" type="String"> + </argument> + <argument index="3" name="flags" type="int"> + </argument> <description> </description> </method> @@ -41,11 +47,53 @@ <description> </description> </method> + <method name="add_ios_bundle_file"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_ios_cpp_code"> + <return type="void"> + </return> + <argument index="0" name="code" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_ios_framework"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_ios_linker_flags"> + <return type="void"> + </return> + <argument index="0" name="flags" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_ios_plist_content"> + <return type="void"> + </return> + <argument index="0" name="plist_content" type="String"> + </argument> + <description> + </description> + </method> <method name="add_shared_object"> <return type="void"> </return> <argument index="0" name="path" type="String"> </argument> + <argument index="1" name="tags" type="PoolStringArray"> + </argument> <description> </description> </method> diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index f29d9fd4dd..1a1c382e59 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorFileDialog" inherits="ConfirmationDialog" category="Core" version="3.0-alpha"> +<class name="EditorFileDialog" inherits="ConfirmationDialog" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -15,179 +15,111 @@ <argument index="0" name="filter" type="String"> </argument> <description> + Adds a comma-delimited file extension filter option to the [code]EditorFileDialog[/code] with an optional semi-colon-delimited label. + Example: "*.tscn, *.scn; Scenes", results in filter text "Scenes (*.tscn, *.scn)". </description> </method> <method name="clear_filters"> <return type="void"> </return> <description> - </description> - </method> - <method name="get_access" qualifiers="const"> - <return type="int" enum="EditorFileDialog.Access"> - </return> - <description> - </description> - </method> - <method name="get_current_dir" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_current_file" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_current_path" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_display_mode" qualifiers="const"> - <return type="int" enum="EditorFileDialog.DisplayMode"> - </return> - <description> - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int" enum="EditorFileDialog.Mode"> - </return> - <description> + Removes all filters except for "All Files (*)". </description> </method> <method name="get_vbox"> <return type="VBoxContainer"> </return> <description> + Returns the [code]VBoxContainer[/code] used to display the file system. </description> </method> <method name="invalidate"> <return type="void"> </return> <description> - </description> - </method> - <method name="is_overwrite_warning_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_showing_hidden_files" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_access"> - <return type="void"> - </return> - <argument index="0" name="access" type="int" enum="EditorFileDialog.Access"> - </argument> - <description> - </description> - </method> - <method name="set_current_dir"> - <return type="void"> - </return> - <argument index="0" name="dir" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_current_file"> - <return type="void"> - </return> - <argument index="0" name="file" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_current_path"> - <return type="void"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_disable_overwrite_warning"> - <return type="void"> - </return> - <argument index="0" name="disable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_display_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="EditorFileDialog.DisplayMode"> - </argument> - <description> - </description> - </method> - <method name="set_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="EditorFileDialog.Mode"> - </argument> - <description> - </description> - </method> - <method name="set_show_hidden_files"> - <return type="void"> - </return> - <argument index="0" name="show" type="bool"> - </argument> - <description> + Notify the [code]EditorFileDialog[/code] that its view of the data is no longer accurate. Updates the view contents on next view update. </description> </method> </methods> + <members> + <member name="access" type="int" setter="set_access" getter="get_access" enum="EditorFileDialog.Access"> + The location from which the user may select a file, including [code]res://[/code], [code]user://[/code], and the local file system. + </member> + <member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir"> + The currently occupied directory. + </member> + <member name="current_file" type="String" setter="set_current_file" getter="get_current_file"> + The currently selected file. + </member> + <member name="current_path" type="String" setter="set_current_path" getter="get_current_path"> + The file system path in the address bar. + </member> + <member name="disable_overwrite_warning" type="bool" setter="set_disable_overwrite_warning" getter="is_overwrite_warning_disabled"> + If [code]true[/code] the [code]EditorFileDialog[/code] will not warn the user before overwriting files. + </member> + <member name="display_mode" type="int" setter="set_display_mode" getter="get_display_mode" enum="EditorFileDialog.DisplayMode"> + The view format in which the [code]EditorFileDialog[/code] displays resources to the user. + </member> + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="EditorFileDialog.Mode"> + The purpose of the [code]EditorFileDialog[/code]. Changes 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 [code]EditorFileDialog[/code]. + </member> + </members> <signals> <signal name="dir_selected"> <argument index="0" name="dir" type="String"> </argument> <description> + Emitted when a directory is selected. </description> </signal> <signal name="file_selected"> <argument index="0" name="path" type="String"> </argument> <description> + Emitted when a file is selected. </description> </signal> <signal name="files_selected"> <argument index="0" name="paths" type="PoolStringArray"> </argument> <description> + Emitted when multiple files are selected. </description> </signal> </signals> <constants> - <constant name="MODE_OPEN_FILE" value="0"> + <constant name="MODE_OPEN_FILE" value="0" enum="Mode"> + The [code]EditorFileDialog[/code] can select only one file. Accepting the window will open the file. </constant> - <constant name="MODE_OPEN_FILES" value="1"> + <constant name="MODE_OPEN_FILES" value="1" enum="Mode"> + The [code]EditorFileDialog[/code] can select multiple files. Accepting the window will open all files. </constant> - <constant name="MODE_OPEN_DIR" value="2"> + <constant name="MODE_OPEN_DIR" value="2" enum="Mode"> + The [code]EditorFileDialog[/code] can select only one directory. Accepting the window will open the directory. </constant> - <constant name="MODE_OPEN_ANY" value="3"> + <constant name="MODE_OPEN_ANY" value="3" enum="Mode"> + The [code]EditorFileDialog[/code] can select a file or directory. Accepting the window will open it. </constant> - <constant name="MODE_SAVE_FILE" value="4"> + <constant name="MODE_SAVE_FILE" value="4" enum="Mode"> + The [code]EditorFileDialog[/code] can select only one file. Accepting the window will save the file. </constant> - <constant name="ACCESS_RESOURCES" value="0"> + <constant name="ACCESS_RESOURCES" value="0" enum="Access"> + The [code]EditorFileDialog[/code] can only view [code]res://[/code] directory contents. </constant> - <constant name="ACCESS_USERDATA" value="1"> + <constant name="ACCESS_USERDATA" value="1" enum="Access"> + The [code]EditorFileDialog[/code] can only view [code]user://[/code] directory contents. </constant> - <constant name="ACCESS_FILESYSTEM" value="2"> + <constant name="ACCESS_FILESYSTEM" value="2" enum="Access"> + The [code]EditorFileDialog[/code] can view the entire local file system. </constant> - <constant name="DISPLAY_THUMBNAILS" value="0"> + <constant name="DISPLAY_THUMBNAILS" value="0" enum="DisplayMode"> + The [code]EditorFileDialog[/code] displays resources as thumbnails. </constant> - <constant name="DISPLAY_LIST" value="1"> + <constant name="DISPLAY_LIST" value="1" enum="DisplayMode"> + The [code]EditorFileDialog[/code] displays resources as a list of filenames. </constant> </constants> </class> diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index afec85184c..54b3accb19 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorFileSystem" inherits="Node" category="Core" version="3.0-alpha"> +<class name="EditorFileSystem" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Resource filesystem, as the editor sees it. </brief_description> @@ -33,6 +33,7 @@ <argument index="0" name="path" type="String"> </argument> <description> + Returns a view into the filesystem at [code]path[/code]. </description> </method> <method name="get_scanning_progress" qualifiers="const"> @@ -83,6 +84,7 @@ <argument index="0" name="resources" type="PoolStringArray"> </argument> <description> + Remitted if a resource is reimported. </description> </signal> <signal name="sources_changed"> diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 99bca09eb6..1a2f73a683 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -1,9 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.0-alpha"> +<class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.0-beta"> <brief_description> A diretory for the resource filesystem. </brief_description> <description> + A more generalized, low-level variation of the directory concept. </description> <tutorials> </tutorials> @@ -16,6 +17,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found. </description> </method> <method name="find_file_index" qualifiers="const"> @@ -24,6 +26,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found. </description> </method> <method name="get_file" qualifiers="const"> @@ -32,12 +35,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the name of the file at index [code]idx[/code]. </description> </method> <method name="get_file_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of files in this directory. </description> </method> <method name="get_file_import_is_valid" qualifiers="const"> @@ -46,6 +51,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns [code]true[/code] if the file at index [code]idx[/code] imported properly. </description> </method> <method name="get_file_path" qualifiers="const"> @@ -54,6 +60,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the path to the file at index [code]idx[/code]. </description> </method> <method name="get_file_type" qualifiers="const"> @@ -62,24 +69,28 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the file extension of the file at index [code]idx[/code]. </description> </method> <method name="get_name"> <return type="String"> </return> <description> + Returns the name of this directory. </description> </method> <method name="get_parent"> <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]. </description> </method> <method name="get_path" qualifiers="const"> <return type="String"> </return> <description> + Returns the path to this directory. </description> </method> <method name="get_subdir"> @@ -88,12 +99,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the subdirectory at index [code]idx[/code]. </description> </method> <method name="get_subdir_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of subdirectories in this directory. </description> </method> </methods> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 9836fb2527..f9e3c288e7 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorImportPlugin" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="EditorImportPlugin" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type. </brief_description> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 0059804c00..4bbbac8cf7 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorInterface" inherits="Node" category="Core" version="3.0-alpha"> +<class name="EditorInterface" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Editor interface and main components. </brief_description> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index f9bdf1dcd5..ada0ee56a8 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorPlugin" inherits="Node" category="Core" version="3.0-alpha"> +<class name="EditorPlugin" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Used by the editor to extend its functionality. </brief_description> @@ -82,6 +82,14 @@ <description> </description> </method> + <method name="add_scene_import_plugin"> + <return type="void"> + </return> + <argument index="0" name="scene_importer" type="EditorSceneImporter"> + </argument> + <description> + </description> + </method> <method name="add_tool_submenu_item"> <return type="void"> </return> @@ -135,15 +143,20 @@ <description> </description> </method> - <method name="forward_draw_over_canvas" qualifiers="virtual"> + <method name="forward_draw_over_viewport" qualifiers="virtual"> <return type="void"> </return> - <argument index="0" name="canvas_xform" type="Transform2D"> + <argument index="0" name="overlay" type="Control"> </argument> - <argument index="1" name="canvas" type="Control"> + <description> + </description> + </method> + <method name="forward_force_draw_over_viewport" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="overlay" type="Control"> </argument> <description> - This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call [method update_canvas]. </description> </method> <method name="forward_spatial_gui_input" qualifiers="virtual"> @@ -171,6 +184,12 @@ <description> </description> </method> + <method name="get_plugin_icon" qualifiers="virtual"> + <return type="Object"> + </return> + <description> + </description> + </method> <method name="get_plugin_name" qualifiers="virtual"> <return type="String"> </return> @@ -290,6 +309,14 @@ <description> </description> </method> + <method name="remove_scene_import_plugin"> + <return type="void"> + </return> + <argument index="0" name="scene_importer" type="EditorSceneImporter"> + </argument> + <description> + </description> + </method> <method name="save_external_data" qualifiers="virtual"> <return type="void"> </return> @@ -297,6 +324,12 @@ This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. </description> </method> + <method name="set_force_draw_over_forwarding_enabled"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="set_input_event_forwarding_always_enabled"> <return type="void"> </return> @@ -322,11 +355,10 @@ Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout]. </description> </method> - <method name="update_canvas"> - <return type="void"> + <method name="update_overlays" qualifiers="const"> + <return type="int"> </return> <description> - Updates the control used to draw the edited scene over the 2D canvas. This is used together with [method forward_canvas_input_event]. </description> </method> </methods> @@ -354,39 +386,39 @@ </signal> </signals> <constants> - <constant name="CONTAINER_TOOLBAR" value="0"> + <constant name="CONTAINER_TOOLBAR" value="0" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_SPATIAL_EDITOR_MENU" value="1"> + <constant name="CONTAINER_SPATIAL_EDITOR_MENU" value="1" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_SPATIAL_EDITOR_SIDE" value="2"> + <constant name="CONTAINER_SPATIAL_EDITOR_SIDE" value="2" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="3"> + <constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="3" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_CANVAS_EDITOR_MENU" value="4"> + <constant name="CONTAINER_CANVAS_EDITOR_MENU" value="4" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5"> + <constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="6"> + <constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="6" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7"> + <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7" enum="CustomControlContainer"> </constant> - <constant name="DOCK_SLOT_LEFT_UL" value="0"> + <constant name="DOCK_SLOT_LEFT_UL" value="0" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_LEFT_BL" value="1"> + <constant name="DOCK_SLOT_LEFT_BL" value="1" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_LEFT_UR" value="2"> + <constant name="DOCK_SLOT_LEFT_UR" value="2" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_LEFT_BR" value="3"> + <constant name="DOCK_SLOT_LEFT_BR" value="3" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_RIGHT_UL" value="4"> + <constant name="DOCK_SLOT_RIGHT_UL" value="4" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_RIGHT_BL" value="5"> + <constant name="DOCK_SLOT_RIGHT_BL" value="5" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_RIGHT_UR" value="6"> + <constant name="DOCK_SLOT_RIGHT_UR" value="6" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_RIGHT_BR" value="7"> + <constant name="DOCK_SLOT_RIGHT_BR" value="7" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_MAX" value="8"> + <constant name="DOCK_SLOT_MAX" value="8" enum="DockSlot"> </constant> </constants> </class> diff --git a/doc/classes/EditorResourceConversionPlugin.xml b/doc/classes/EditorResourceConversionPlugin.xml index 6fbb60ddf6..8d6aa3a605 100644 --- a/doc/classes/EditorResourceConversionPlugin.xml +++ b/doc/classes/EditorResourceConversionPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorResourceConversionPlugin" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="EditorResourceConversionPlugin" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -18,7 +18,7 @@ </description> </method> <method name="_converts_to" qualifiers="virtual"> - <return type="bool"> + <return type="String"> </return> <description> </description> diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index 44f60d4d2c..481ffed70b 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorResourcePreview" inherits="Node" category="Core" version="3.0-alpha"> +<class name="EditorResourcePreview" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Helper to generate previews of resources or files. </brief_description> diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index 3de0dbc708..03cb232619 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorResourcePreviewGenerator" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="EditorResourcePreviewGenerator" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Custom generator of previews. </brief_description> diff --git a/doc/classes/EditorSceneImporter.xml b/doc/classes/EditorSceneImporter.xml new file mode 100644 index 0000000000..69fe4050f4 --- /dev/null +++ b/doc/classes/EditorSceneImporter.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorSceneImporter" inherits="Reference" category="Core" version="3.0-beta"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_get_extensions" qualifiers="virtual"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="_get_import_flags" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="_import_animation" qualifiers="virtual"> + <return type="Animation"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="flags" type="int"> + </argument> + <argument index="2" name="bake_fps" type="int"> + </argument> + <description> + </description> + </method> + <method name="_import_scene" qualifiers="virtual"> + <return type="Node"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="flags" type="int"> + </argument> + <argument index="2" name="bake_fps" type="int"> + </argument> + <description> + </description> + </method> + <method name="import_animation_from_other_importer"> + <return type="Animation"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="flags" type="int"> + </argument> + <argument index="2" name="bake_fps" type="int"> + </argument> + <description> + </description> + </method> + <method name="import_scene_from_other_importer"> + <return type="Node"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="flags" type="int"> + </argument> + <argument index="2" name="bake_fps" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="IMPORT_SCENE" value="1"> + </constant> + <constant name="IMPORT_ANIMATION" value="2"> + </constant> + <constant name="IMPORT_ANIMATION_DETECT_LOOP" value="4"> + </constant> + <constant name="IMPORT_ANIMATION_OPTIMIZE" value="8"> + </constant> + <constant name="IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS" value="16"> + </constant> + <constant name="IMPORT_ANIMATION_KEEP_VALUE_TRACKS" value="32"> + </constant> + <constant name="IMPORT_GENERATE_TANGENT_ARRAYS" value="256"> + </constant> + <constant name="IMPORT_FAIL_ON_MISSING_DEPENDENCIES" value="512"> + </constant> + <constant name="IMPORT_MATERIALS_IN_INSTANCES" value="1024"> + </constant> + <constant name="IMPORT_USE_COMPRESSION" value="2048"> + </constant> + </constants> +</class> diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml new file mode 100644 index 0000000000..a9bc659e7d --- /dev/null +++ b/doc/classes/EditorScenePostImport.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorScenePostImport" inherits="Reference" category="Core" version="3.0-beta"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="post_import" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="scene" type="Object"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 1e46164fc6..97f126e7f7 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorScript" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="EditorScript" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Base script that can be used to add extension functions to the editor. </brief_description> @@ -9,7 +9,7 @@ [codeblock] tool extends EditorScript - + func _run(): print("Hello from the Godot Editor!") [/codeblock] @@ -33,6 +33,8 @@ <argument index="0" name="node" type="Node"> </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. </description> </method> <method name="get_editor_interface"> diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml index 999cb5e505..31e27a1b01 100644 --- a/doc/classes/EditorSelection.xml +++ b/doc/classes/EditorSelection.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSelection" inherits="Object" category="Core" version="3.0-alpha"> +<class name="EditorSelection" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Manages the SceneTree selection in the editor. </brief_description> diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index a0e4fdb8e0..174b62fde0 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSettings" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="EditorSettings" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Object that holds the project-independent editor settings. </brief_description> @@ -55,7 +55,7 @@ Get the list of favorite directories for this project. </description> </method> - <method name="get_project_settings_path" qualifiers="const"> + <method name="get_project_settings_dir" qualifiers="const"> <return type="String"> </return> <description> @@ -77,7 +77,7 @@ <description> </description> </method> - <method name="get_settings_path" qualifiers="const"> + <method name="get_settings_dir" qualifiers="const"> <return type="String"> </return> <description> diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index e111eec3b9..e55cdd0ca7 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSpatialGizmo" inherits="SpatialGizmo" category="Core" version="3.0-alpha"> +<class name="EditorSpatialGizmo" inherits="SpatialGizmo" category="Core" version="3.0-beta"> <brief_description> Custom gizmo for editing Spatial objects. </brief_description> @@ -24,7 +24,7 @@ </return> <argument index="0" name="triangles" type="TriangleMesh"> </argument> - <argument index="1" name="bounds" type="Rect3"> + <argument index="1" name="bounds" type="AABB"> </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]. diff --git a/doc/classes/EncodedObjectAsID.xml b/doc/classes/EncodedObjectAsID.xml index 41839e3d01..b60f2fc2bd 100644 --- a/doc/classes/EncodedObjectAsID.xml +++ b/doc/classes/EncodedObjectAsID.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EncodedObjectAsID" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="EncodedObjectAsID" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index f43bbc2e9d..0fd5892860 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Engine" inherits="Object" category="Core" version="3.0-alpha"> +<class name="Engine" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Access to basic engine properties. </brief_description> @@ -71,8 +71,8 @@ "minor" - Holds the minor version number as a String "patch" - Holds the patch version number as a String "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String - "revision" - Holds the revision (e.g. "custom-build") as a String - "string" - major + minor + patch + status + revision in a single String + "build" - Holds the build name (e.g. "custom-build") as a String + "string" - major + minor + patch + status + build in a single String </description> </method> <method name="has_singleton" qualifiers="const"> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 285caa8d0a..e252f67774 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Environment" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Environment" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Resource for environment nodes (like [WorldEnvironment]) that define multiple rendering options. </brief_description> @@ -16,1004 +16,6 @@ <demos> </demos> <methods> - <method name="get_adjustment_brightness" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_adjustment_color_correction" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_adjustment_contrast" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_adjustment_saturation" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ambient_light_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_ambient_light_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ambient_light_sky_contribution" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_background" qualifiers="const"> - <return type="int" enum="Environment.BGMode"> - </return> - <description> - </description> - </method> - <method name="get_bg_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_bg_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_canvas_max_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_dof_blur_far_amount" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_dof_blur_far_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_dof_blur_far_quality" qualifiers="const"> - <return type="int" enum="Environment.DOFBlurQuality"> - </return> - <description> - </description> - </method> - <method name="get_dof_blur_far_transition" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_dof_blur_near_amount" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_dof_blur_near_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_dof_blur_near_quality" qualifiers="const"> - <return type="int" enum="Environment.DOFBlurQuality"> - </return> - <description> - </description> - </method> - <method name="get_dof_blur_near_transition" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fog_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_fog_depth_begin" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fog_depth_curve" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fog_height_curve" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fog_height_max" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fog_height_min" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fog_sun_amount" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fog_sun_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_fog_transmit_curve" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_glow_blend_mode" qualifiers="const"> - <return type="int" enum="Environment.GlowBlendMode"> - </return> - <description> - </description> - </method> - <method name="get_glow_bloom" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_glow_hdr_bleed_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_glow_hdr_bleed_threshold" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_glow_intensity" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_glow_strength" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sky" qualifiers="const"> - <return type="Sky"> - </return> - <description> - </description> - </method> - <method name="get_sky_custom_fov" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssao_bias" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssao_blur" qualifiers="const"> - <return type="int" enum="Environment.SSAOBlur"> - </return> - <description> - </description> - </method> - <method name="get_ssao_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_ssao_direct_light_affect" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssao_edge_sharpness" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssao_intensity" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssao_intensity2" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssao_quality" qualifiers="const"> - <return type="int" enum="Environment.SSAOQuality"> - </return> - <description> - </description> - </method> - <method name="get_ssao_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssao_radius2" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssr_depth_tolerance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssr_fade_in" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssr_fade_out" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ssr_max_steps" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_tonemap_auto_exposure" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_tonemap_auto_exposure_grey" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tonemap_auto_exposure_max" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tonemap_auto_exposure_min" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tonemap_auto_exposure_speed" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tonemap_exposure" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tonemap_white" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_tonemapper" qualifiers="const"> - <return type="int" enum="Environment.ToneMapper"> - </return> - <description> - </description> - </method> - <method name="is_adjustment_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_dof_blur_far_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_dof_blur_near_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_fog_depth_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_fog_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_fog_height_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_fog_transmit_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_glow_bicubic_upscale_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_glow_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_glow_level_enabled" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_ssao_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_ssr_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_ssr_rough" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_adjustment_brightness"> - <return type="void"> - </return> - <argument index="0" name="brightness" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_adjustment_color_correction"> - <return type="void"> - </return> - <argument index="0" name="color_correction" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_adjustment_contrast"> - <return type="void"> - </return> - <argument index="0" name="contrast" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_adjustment_enable"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_adjustment_saturation"> - <return type="void"> - </return> - <argument index="0" name="saturation" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ambient_light_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_ambient_light_energy"> - <return type="void"> - </return> - <argument index="0" name="energy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ambient_light_sky_contribution"> - <return type="void"> - </return> - <argument index="0" name="energy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_background"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Environment.BGMode"> - </argument> - <description> - </description> - </method> - <method name="set_bg_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_bg_energy"> - <return type="void"> - </return> - <argument index="0" name="energy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_canvas_max_layer"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_far_amount"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_far_distance"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_far_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_far_quality"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="int" enum="Environment.DOFBlurQuality"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_far_transition"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_near_amount"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_near_distance"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_near_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_near_quality"> - <return type="void"> - </return> - <argument index="0" name="level" type="int" enum="Environment.DOFBlurQuality"> - </argument> - <description> - </description> - </method> - <method name="set_dof_blur_near_transition"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fog_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_fog_depth_begin"> - <return type="void"> - </return> - <argument index="0" name="distance" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fog_depth_curve"> - <return type="void"> - </return> - <argument index="0" name="curve" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fog_depth_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_fog_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_fog_height_curve"> - <return type="void"> - </return> - <argument index="0" name="curve" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fog_height_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_fog_height_max"> - <return type="void"> - </return> - <argument index="0" name="height" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fog_height_min"> - <return type="void"> - </return> - <argument index="0" name="height" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fog_sun_amount"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fog_sun_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_fog_transmit_curve"> - <return type="void"> - </return> - <argument index="0" name="curve" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fog_transmit_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_glow_bicubic_upscale"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_glow_blend_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Environment.GlowBlendMode"> - </argument> - <description> - </description> - </method> - <method name="set_glow_bloom"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_glow_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_glow_hdr_bleed_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_glow_hdr_bleed_threshold"> - <return type="void"> - </return> - <argument index="0" name="threshold" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_glow_intensity"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_glow_level"> - <return type="void"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_glow_strength"> - <return type="void"> - </return> - <argument index="0" name="strength" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sky"> - <return type="void"> - </return> - <argument index="0" name="sky" type="Sky"> - </argument> - <description> - </description> - </method> - <method name="set_sky_custom_fov"> - <return type="void"> - </return> - <argument index="0" name="scale" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_bias"> - <return type="void"> - </return> - <argument index="0" name="bias" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_blur"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Environment.SSAOBlur"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_direct_light_affect"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_edge_sharpness"> - <return type="void"> - </return> - <argument index="0" name="edge_sharpness" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_intensity"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_intensity2"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_quality"> - <return type="void"> - </return> - <argument index="0" name="quality" type="int" enum="Environment.SSAOQuality"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssao_radius2"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssr_depth_tolerance"> - <return type="void"> - </return> - <argument index="0" name="depth_tolerance" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssr_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_ssr_fade_in"> - <return type="void"> - </return> - <argument index="0" name="fade_in" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssr_fade_out"> - <return type="void"> - </return> - <argument index="0" name="fade_out" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ssr_max_steps"> - <return type="void"> - </return> - <argument index="0" name="max_steps" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_ssr_rough"> - <return type="void"> - </return> - <argument index="0" name="rough" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_tonemap_auto_exposure"> - <return type="void"> - </return> - <argument index="0" name="auto_exposure" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_tonemap_auto_exposure_grey"> - <return type="void"> - </return> - <argument index="0" name="exposure_grey" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tonemap_auto_exposure_max"> - <return type="void"> - </return> - <argument index="0" name="exposure_max" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tonemap_auto_exposure_min"> - <return type="void"> - </return> - <argument index="0" name="exposure_min" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tonemap_auto_exposure_speed"> - <return type="void"> - </return> - <argument index="0" name="exposure_speed" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tonemap_exposure"> - <return type="void"> - </return> - <argument index="0" name="exposure" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tonemap_white"> - <return type="void"> - </return> - <argument index="0" name="white" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_tonemapper"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Environment.ToneMapper"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="adjustment_brightness" type="float" setter="set_adjustment_brightness" getter="get_adjustment_brightness"> @@ -1231,73 +233,73 @@ </member> </members> <constants> - <constant name="BG_KEEP" value="5"> + <constant name="BG_KEEP" value="5" enum="BGMode"> Keep on screen every pixel drawn in the background. </constant> - <constant name="BG_CLEAR_COLOR" value="0"> + <constant name="BG_CLEAR_COLOR" value="0" enum="BGMode"> Clear the background using the project's clear color. </constant> - <constant name="BG_COLOR" value="1"> + <constant name="BG_COLOR" value="1" enum="BGMode"> Clear the background using a custom clear color. </constant> - <constant name="BG_SKY" value="2"> + <constant name="BG_SKY" value="2" enum="BGMode"> Display a user-defined sky in the background. </constant> - <constant name="BG_COLOR_SKY" value="3"> + <constant name="BG_COLOR_SKY" value="3" enum="BGMode"> Clear the background using a custom clear color and allows defining a sky for shading and reflection. </constant> - <constant name="BG_CANVAS" value="4"> + <constant name="BG_CANVAS" value="4" enum="BGMode"> Display a [CanvasLayer] in the background. </constant> - <constant name="BG_MAX" value="6"> + <constant name="BG_MAX" value="6" enum="BGMode"> Helper constant keeping track of the enum's size, has no direct usage in API calls. </constant> - <constant name="GLOW_BLEND_MODE_ADDITIVE" value="0"> + <constant name="GLOW_BLEND_MODE_ADDITIVE" value="0" enum="GlowBlendMode"> Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. </constant> - <constant name="GLOW_BLEND_MODE_SCREEN" value="1"> + <constant name="GLOW_BLEND_MODE_SCREEN" value="1" enum="GlowBlendMode"> Screen glow blending mode. Increases brightness, used frequently with bloom. </constant> - <constant name="GLOW_BLEND_MODE_SOFTLIGHT" value="2"> + <constant name="GLOW_BLEND_MODE_SOFTLIGHT" value="2" enum="GlowBlendMode"> Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom. </constant> - <constant name="GLOW_BLEND_MODE_REPLACE" value="3"> + <constant name="GLOW_BLEND_MODE_REPLACE" value="3" enum="GlowBlendMode"> Replace glow blending mode. Replaces all pixels' color by the glow value. </constant> - <constant name="TONE_MAPPER_LINEAR" value="0"> + <constant name="TONE_MAPPER_LINEAR" value="0" enum="ToneMapper"> Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. </constant> - <constant name="TONE_MAPPER_REINHARDT" value="1"> + <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). </constant> - <constant name="TONE_MAPPER_FILMIC" value="2"> + <constant name="TONE_MAPPER_FILMIC" value="2" enum="ToneMapper"> Filmic tonemapper operator. </constant> - <constant name="TONE_MAPPER_ACES" value="3"> + <constant name="TONE_MAPPER_ACES" value="3" enum="ToneMapper"> Academy Color Encoding System tonemapper operator. </constant> - <constant name="DOF_BLUR_QUALITY_LOW" value="0"> + <constant name="DOF_BLUR_QUALITY_LOW" value="0" enum="DOFBlurQuality"> Low depth-of-field blur quality. </constant> - <constant name="DOF_BLUR_QUALITY_MEDIUM" value="1"> + <constant name="DOF_BLUR_QUALITY_MEDIUM" value="1" enum="DOFBlurQuality"> Medium depth-of-field blur quality. </constant> - <constant name="DOF_BLUR_QUALITY_HIGH" value="2"> + <constant name="DOF_BLUR_QUALITY_HIGH" value="2" enum="DOFBlurQuality"> High depth-of-field blur quality. </constant> - <constant name="SSAO_BLUR_DISABLED" value="0"> + <constant name="SSAO_BLUR_DISABLED" value="0" enum="SSAOBlur"> </constant> - <constant name="SSAO_BLUR_1x1" value="1"> + <constant name="SSAO_BLUR_1x1" value="1" enum="SSAOBlur"> </constant> - <constant name="SSAO_BLUR_2x2" value="2"> + <constant name="SSAO_BLUR_2x2" value="2" enum="SSAOBlur"> </constant> - <constant name="SSAO_BLUR_3x3" value="3"> + <constant name="SSAO_BLUR_3x3" value="3" enum="SSAOBlur"> </constant> - <constant name="SSAO_QUALITY_LOW" value="0"> + <constant name="SSAO_QUALITY_LOW" value="0" enum="SSAOQuality"> </constant> - <constant name="SSAO_QUALITY_MEDIUM" value="1"> + <constant name="SSAO_QUALITY_MEDIUM" value="1" enum="SSAOQuality"> </constant> - <constant name="SSAO_QUALITY_HIGH" value="2"> + <constant name="SSAO_QUALITY_HIGH" value="2" enum="SSAOQuality"> </constant> </constants> </class> diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 8ec56e9c48..8c270ece4b 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="File" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="File" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Type to handle file reading and writing operations. </brief_description> @@ -394,28 +394,28 @@ </method> </methods> <constants> - <constant name="READ" value="1"> + <constant name="READ" value="1" enum="ModeFlags"> Opens the file for read operations. </constant> - <constant name="WRITE" value="2"> + <constant name="WRITE" value="2" enum="ModeFlags"> Opens the file for write operations. Create it if the file does not exist and truncate if it exists. </constant> - <constant name="READ_WRITE" value="3"> + <constant name="READ_WRITE" value="3" enum="ModeFlags"> Opens the file for read and write operations. Does not truncate the file. </constant> - <constant name="WRITE_READ" value="7"> + <constant name="WRITE_READ" value="7" enum="ModeFlags"> 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"> + <constant name="COMPRESSION_FASTLZ" value="0" enum="CompressionMode"> Uses the FastLZ compression method. </constant> - <constant name="COMPRESSION_DEFLATE" value="1"> + <constant name="COMPRESSION_DEFLATE" value="1" enum="CompressionMode"> Uses the Deflate compression method. </constant> - <constant name="COMPRESSION_ZSTD" value="2"> + <constant name="COMPRESSION_ZSTD" value="2" enum="CompressionMode"> Uses the Zstd compression method. </constant> - <constant name="COMPRESSION_GZIP" value="3"> + <constant name="COMPRESSION_GZIP" value="3" enum="CompressionMode"> Uses the gzip compression method. </constant> </constants> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 7dda486ac9..3387b4a2ed 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="FileDialog" inherits="ConfirmationDialog" category="Core" version="3.0-alpha"> +<class name="FileDialog" inherits="ConfirmationDialog" category="Core" version="3.0-beta"> <brief_description> Dialog for selecting files or directories in the filesystem. </brief_description> @@ -27,11 +27,10 @@ Clear all the added filters in the dialog. </description> </method> - <method name="get_access" qualifiers="const"> - <return type="int" enum="FileDialog.Access"> + <method name="deselect_items"> + <return type="void"> </return> <description> - Return the file access permission of the dialog. </description> </method> <method name="get_current_dir" qualifiers="const"> @@ -55,19 +54,6 @@ Get the current selected path (directory and file) of the file dialog (empty if none). </description> </method> - <method name="get_filters" qualifiers="const"> - <return type="PoolStringArray"> - </return> - <description> - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int" enum="FileDialog.Mode"> - </return> - <description> - Get the file dialog mode from the MODE_* enum. - </description> - </method> <method name="get_vbox"> <return type="VBoxContainer"> </return> @@ -82,22 +68,6 @@ Invalidate and update the current dialog content list. </description> </method> - <method name="is_showing_hidden_files" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the dialog allows show hidden files. - </description> - </method> - <method name="set_access"> - <return type="void"> - </return> - <argument index="0" name="access" type="int" enum="FileDialog.Access"> - </argument> - <description> - Set the file access permission of the dialog(Must be one of [ACCESS_RESOURCES], [ACCESS_USERDATA] or [ACCESS_FILESYSTEM]). - </description> - </method> <method name="set_current_dir"> <return type="void"> </return> @@ -125,32 +95,6 @@ Set the current selected file path of the file dialog. </description> </method> - <method name="set_filters"> - <return type="void"> - </return> - <argument index="0" name="filters" type="PoolStringArray"> - </argument> - <description> - </description> - </method> - <method name="set_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="FileDialog.Mode"> - </argument> - <description> - Set the file dialog mode from the MODE_* enum. - </description> - </method> - <method name="set_show_hidden_files"> - <return type="void"> - </return> - <argument index="0" name="show" type="bool"> - </argument> - <description> - Set the dialog should show hidden files. - </description> - </method> </methods> <members> <member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access"> @@ -159,6 +103,9 @@ </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode"> </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 [code]MODE_OPEN_FILE[/code] will change the window title to "Open a File"). + </member> <member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files"> </member> </members> @@ -186,28 +133,28 @@ </signal> </signals> <constants> - <constant name="MODE_OPEN_FILE" value="0"> + <constant name="MODE_OPEN_FILE" value="0" enum="Mode"> The dialog allows the selection of one, and only one file. </constant> - <constant name="MODE_OPEN_FILES" value="1"> + <constant name="MODE_OPEN_FILES" value="1" enum="Mode"> The dialog allows the selection of multiple files. </constant> - <constant name="MODE_OPEN_DIR" value="2"> + <constant name="MODE_OPEN_DIR" value="2" enum="Mode"> The dialog functions as a folder selector, disallowing the selection of any file. </constant> - <constant name="MODE_OPEN_ANY" value="3"> + <constant name="MODE_OPEN_ANY" value="3" enum="Mode"> The dialog allows the selection of a file or a directory. </constant> - <constant name="MODE_SAVE_FILE" value="4"> + <constant name="MODE_SAVE_FILE" value="4" enum="Mode"> The dialog will warn when a file exists. </constant> - <constant name="ACCESS_RESOURCES" value="0"> + <constant name="ACCESS_RESOURCES" value="0" enum="Access"> The dialog allows the selection of file and directory. </constant> - <constant name="ACCESS_USERDATA" value="1"> + <constant name="ACCESS_USERDATA" value="1" enum="Access"> The dialog allows access files under [Resource] path(res://) . </constant> - <constant name="ACCESS_FILESYSTEM" value="2"> + <constant name="ACCESS_FILESYSTEM" value="2" enum="Access"> The dialog allows access files in whole file system. </constant> </constants> @@ -216,6 +163,8 @@ </theme_item> <theme_item name="folder" type="Texture"> </theme_item> + <theme_item name="parent_folder" type="Texture"> + </theme_item> <theme_item name="reload" type="Texture"> </theme_item> </theme_items> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index b83d66830f..bc4557a171 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Font" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Font" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Internationalized font and text drawing support. </brief_description> diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml index 65da5dd98f..802f35dd10 100644 --- a/doc/classes/FuncRef.xml +++ b/doc/classes/FuncRef.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="FuncRef" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="FuncRef" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Reference to a function in an object. </brief_description> diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml index e445d94835..0644e3f24e 100644 --- a/doc/classes/GIProbe.xml +++ b/doc/classes/GIProbe.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GIProbe" inherits="VisualInstance" category="Core" version="3.0-alpha"> +<class name="GIProbe" inherits="VisualInstance" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -25,146 +25,6 @@ <description> </description> </method> - <method name="get_bias" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_dynamic_range" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_extents" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_normal_bias" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_probe_data" qualifiers="const"> - <return type="GIProbeData"> - </return> - <description> - </description> - </method> - <method name="get_propagation" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_subdiv" qualifiers="const"> - <return type="int" enum="GIProbe.Subdiv"> - </return> - <description> - </description> - </method> - <method name="is_compressed" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_interior" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_bias"> - <return type="void"> - </return> - <argument index="0" name="max" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_compress"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_dynamic_range"> - <return type="void"> - </return> - <argument index="0" name="max" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_energy"> - <return type="void"> - </return> - <argument index="0" name="max" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_extents"> - <return type="void"> - </return> - <argument index="0" name="extents" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_interior"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_normal_bias"> - <return type="void"> - </return> - <argument index="0" name="max" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_probe_data"> - <return type="void"> - </return> - <argument index="0" name="data" type="GIProbeData"> - </argument> - <description> - </description> - </method> - <method name="set_propagation"> - <return type="void"> - </return> - <argument index="0" name="max" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_subdiv"> - <return type="void"> - </return> - <argument index="0" name="subdiv" type="int" enum="GIProbe.Subdiv"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="bias" type="float" setter="set_bias" getter="get_bias"> @@ -189,15 +49,15 @@ </member> </members> <constants> - <constant name="SUBDIV_64" value="0"> + <constant name="SUBDIV_64" value="0" enum="Subdiv"> </constant> - <constant name="SUBDIV_128" value="1"> + <constant name="SUBDIV_128" value="1" enum="Subdiv"> </constant> - <constant name="SUBDIV_256" value="2"> + <constant name="SUBDIV_256" value="2" enum="Subdiv"> </constant> - <constant name="SUBDIV_512" value="3"> + <constant name="SUBDIV_512" value="3" enum="Subdiv"> </constant> - <constant name="SUBDIV_MAX" value="4"> + <constant name="SUBDIV_MAX" value="4" enum="Subdiv"> </constant> </constants> </class> diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index 3777eba6af..aba59f57ea 100644 --- a/doc/classes/GIProbeData.xml +++ b/doc/classes/GIProbeData.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GIProbeData" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="GIProbeData" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -16,7 +16,7 @@ </description> </method> <method name="get_bounds" qualifiers="const"> - <return type="Rect3"> + <return type="AABB"> </return> <description> </description> @@ -86,7 +86,7 @@ <method name="set_bounds"> <return type="void"> </return> - <argument index="0" name="bounds" type="Rect3"> + <argument index="0" name="bounds" type="AABB"> </argument> <description> </description> @@ -164,30 +164,6 @@ </description> </method> </methods> - <members> - <member name="bias" type="float" setter="set_bias" getter="get_bias"> - </member> - <member name="bounds" type="Rect3" setter="set_bounds" getter="get_bounds"> - </member> - <member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size"> - </member> - <member name="compress" type="bool" setter="set_compress" getter="is_compressed"> - </member> - <member name="dynamic_data" type="PoolIntArray" setter="set_dynamic_data" getter="get_dynamic_data"> - </member> - <member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range"> - </member> - <member name="energy" type="float" setter="set_energy" getter="get_energy"> - </member> - <member name="interior" type="bool" setter="set_interior" getter="is_interior"> - </member> - <member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias"> - </member> - <member name="propagation" type="float" setter="set_propagation" getter="get_propagation"> - </member> - <member name="to_cell_xform" type="Transform" setter="set_to_cell_xform" getter="get_to_cell_xform"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index 202e461652..e44ae867d4 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.0-alpha"> +<class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.0-beta"> <brief_description> The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation. </brief_description> @@ -11,114 +11,6 @@ <demos> </demos> <methods> - <method name="get_flag_x" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> - </argument> - <description> - </description> - </method> - <method name="get_flag_y" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> - </argument> - <description> - </description> - </method> - <method name="get_flag_z" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> - </argument> - <description> - </description> - </method> - <method name="get_param_x" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> - </argument> - <description> - </description> - </method> - <method name="get_param_y" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> - </argument> - <description> - </description> - </method> - <method name="get_param_z" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> - </argument> - <description> - </description> - </method> - <method name="set_flag_x"> - <return type="void"> - </return> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_flag_y"> - <return type="void"> - </return> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_flag_z"> - <return type="void"> - </return> - <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_param_x"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_param_y"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_param_z"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="angular_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x"> @@ -277,61 +169,61 @@ </member> </members> <constants> - <constant name="PARAM_LINEAR_LOWER_LIMIT" value="0"> + <constant name="PARAM_LINEAR_LOWER_LIMIT" value="0" enum="Param"> The minimum difference between the pivot points' axes. </constant> - <constant name="PARAM_LINEAR_UPPER_LIMIT" value="1"> + <constant name="PARAM_LINEAR_UPPER_LIMIT" value="1" enum="Param"> The maximum difference between the pivot points' axes. </constant> - <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> + <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. </constant> - <constant name="PARAM_LINEAR_RESTITUTION" value="3"> + <constant name="PARAM_LINEAR_RESTITUTION" value="3" enum="Param"> The amount of restitution on the axes movement The lower, the more momentum gets lost. </constant> - <constant name="PARAM_LINEAR_DAMPING" value="4"> + <constant name="PARAM_LINEAR_DAMPING" value="4" enum="Param"> The amount of damping that happens at the linear motion across the axes. </constant> - <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5"> + <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5" enum="Param"> The minimum rotation in negative direction to break loose and rotate arround the axes. </constant> - <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6"> + <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6" enum="Param"> The minimum rotation in positive direction to break loose and rotate arround the axes. </constant> - <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7"> + <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7" enum="Param"> The speed of all rotations across the axes. </constant> - <constant name="PARAM_ANGULAR_DAMPING" value="8"> + <constant name="PARAM_ANGULAR_DAMPING" value="8" enum="Param"> The amount of rotational damping across the axes. The lower, the more dampening occurs. </constant> - <constant name="PARAM_ANGULAR_RESTITUTION" value="9"> + <constant name="PARAM_ANGULAR_RESTITUTION" value="9" enum="Param"> The amount of rotational restitution across the axes. The lower, the more restitution occurs. </constant> - <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10"> + <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10" enum="Param"> The maximum amount of force that can occur, when rotating arround the axes. </constant> - <constant name="PARAM_ANGULAR_ERP" value="11"> + <constant name="PARAM_ANGULAR_ERP" value="11" enum="Param"> When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </constant> - <constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="12"> + <constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="12" enum="Param"> Target speed for the motor at the axes. </constant> - <constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="13"> + <constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="13" enum="Param"> Maximum acceleration for the motor at the axes. </constant> - <constant name="PARAM_MAX" value="14"> + <constant name="PARAM_MAX" value="14" enum="Param"> End flag of PARAM_* constants, used internally. </constant> - <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0"> + <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="Flag"> If [code]set[/code] there is linear motion possible within the given limits. </constant> - <constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1"> + <constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1" enum="Flag"> If [code]set[/code] there is rotational motion possible. </constant> - <constant name="FLAG_ENABLE_MOTOR" value="2"> + <constant name="FLAG_ENABLE_MOTOR" value="2" enum="Flag"> If [code]set[/code] there is a rotational motor across these axes. </constant> - <constant name="FLAG_MAX" value="3"> + <constant name="FLAG_MAX" value="3" enum="Flag"> End flag of FLAG_* constants, used internally. </constant> </constants> diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 5da3ca0059..3f25d04f16 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Geometry" inherits="Object" category="Core" version="3.0-alpha"> +<class name="Geometry" inherits="Object" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index f21dbecd04..981873b1fe 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GeometryInstance" inherits="VisualInstance" category="Core" version="3.0-alpha"> +<class name="GeometryInstance" inherits="VisualInstance" category="Core" version="3.0-beta"> <brief_description> Base node for geometry based visual instances. </brief_description> @@ -11,155 +11,55 @@ <demos> </demos> <methods> - <method name="get_cast_shadows_setting" qualifiers="const"> - <return type="int" enum="GeometryInstance.ShadowCastingSetting"> - </return> - <description> - </description> - </method> - <method name="get_extra_cull_margin" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int" enum="GeometryInstance.Flags"> - </argument> - <description> - </description> - </method> - <method name="get_lod_max_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_lod_max_hysteresis" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_lod_min_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_lod_min_hysteresis" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_material_override" qualifiers="const"> - <return type="Material"> - </return> - <description> - Return the material override for the whole geometry. - </description> - </method> - <method name="set_cast_shadows_setting"> - <return type="void"> - </return> - <argument index="0" name="shadow_casting_setting" type="int" enum="GeometryInstance.ShadowCastingSetting"> - </argument> - <description> - </description> - </method> - <method name="set_extra_cull_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_flag"> - <return type="void"> - </return> - <argument index="0" name="flag" type="int" enum="GeometryInstance.Flags"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_lod_max_distance"> - <return type="void"> - </return> - <argument index="0" name="mode" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_lod_max_hysteresis"> - <return type="void"> - </return> - <argument index="0" name="mode" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_lod_min_distance"> - <return type="void"> - </return> - <argument index="0" name="mode" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_lod_min_hysteresis"> - <return type="void"> - </return> - <argument index="0" name="mode" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_material_override"> - <return type="void"> - </return> - <argument index="0" name="material" type="Material"> - </argument> - <description> - Set the material override for the whole geometry. - </description> - </method> </methods> <members> <member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting"> + The selected shadow casting flag. See SHADOW_CASTING_SETTING_* constants for values. </member> <member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin"> + The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box. </member> <member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance"> + The GeometryInstance's max LOD distance. </member> <member name="lod_max_hysteresis" type="float" setter="set_lod_max_hysteresis" getter="get_lod_max_hysteresis"> + The GeometryInstance's max LOD margin. </member> <member name="lod_min_distance" type="float" setter="set_lod_min_distance" getter="get_lod_min_distance"> + The GeometryInstance's min LOD distance. </member> <member name="lod_min_hysteresis" type="float" setter="set_lod_min_hysteresis" getter="get_lod_min_hysteresis"> + The GeometryInstance's min LOD margin. </member> <member name="material_override" type="Material" setter="set_material_override" getter="get_material_override"> + The material override for the whole geometry. + If there is a material in material_override, it will be used instead of any material set in any material slot of the mesh. </member> <member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag"> + If [code]true[/code] this GeometryInstance will be used when baking lights using a [GIProbe] and/or any other form of baked lighting. </member> </members> <constants> - <constant name="SHADOW_CASTING_SETTING_OFF" value="0"> + <constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting"> + Will not cast any shadows. </constant> - <constant name="SHADOW_CASTING_SETTING_ON" value="1"> + <constant name="SHADOW_CASTING_SETTING_ON" value="1" enum="ShadowCastingSetting"> + Will cast shadows from all visible faces in the GeometryInstance. + Will take culling into account, so faces not being rendered will not be taken into account when shadow casting. </constant> - <constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2"> + <constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2" enum="ShadowCastingSetting"> + Will cast shadows from all visible faces in the GeometryInstance. + Will not take culling into account, so all faces will be taken into account when shadow casting. </constant> - <constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3"> + <constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting"> + Will only show the shadows casted from this object. + In other words: The actual mesh will not be visible, only the shadows casted from the mesh. </constant> - <constant name="FLAG_USE_BAKED_LIGHT" value="0"> + <constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags"> + Will allow the GeometryInstance to be used when baking lights using a [GIProbe] and/or any other form of baked lighting. + Added documentation for GeometryInstance and VisualInstance </constant> - <constant name="FLAG_MAX" value="1"> + <constant name="FLAG_MAX" value="1" enum="Flags"> </constant> </constants> </class> diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index d557ec11c5..b1a723ee47 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Gradient" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Gradient" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Color interpolator node. </brief_description> @@ -31,13 +31,6 @@ Returns the color of the ramp color at index [i]point[/i] </description> </method> - <method name="get_colors" qualifiers="const"> - <return type="PoolColorArray"> - </return> - <description> - Returns the colors in the ramp - </description> - </method> <method name="get_offset" qualifiers="const"> <return type="float"> </return> @@ -47,13 +40,6 @@ Returns the offset of the ramp color at index [i]point[/i] </description> </method> - <method name="get_offsets" qualifiers="const"> - <return type="PoolRealArray"> - </return> - <description> - Returns the offsets for the colors in this ramp - </description> - </method> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> @@ -90,15 +76,6 @@ Sets the color of the ramp color at index [i]point[/i] </description> </method> - <method name="set_colors"> - <return type="void"> - </return> - <argument index="0" name="colors" type="PoolColorArray"> - </argument> - <description> - Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements. - </description> - </method> <method name="set_offset"> <return type="void"> </return> @@ -110,15 +87,6 @@ Sets the offset for the ramp color at index [i]point[/i] </description> </method> - <method name="set_offsets"> - <return type="void"> - </return> - <argument index="0" name="offsets" type="PoolRealArray"> - </argument> - <description> - Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default. - </description> - </method> </methods> <members> <member name="colors" type="PoolColorArray" setter="set_colors" getter="get_colors"> diff --git a/doc/classes/GradientTexture.xml b/doc/classes/GradientTexture.xml index 88a776cb6a..e28dd2ce42 100644 --- a/doc/classes/GradientTexture.xml +++ b/doc/classes/GradientTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GradientTexture" inherits="Texture" category="Core" version="3.0-alpha"> +<class name="GradientTexture" inherits="Texture" category="Core" version="3.0-beta"> <brief_description> Gradient filled texture. </brief_description> @@ -11,28 +11,6 @@ <demos> </demos> <methods> - <method name="get_gradient" qualifiers="const"> - <return type="Gradient"> - </return> - <description> - </description> - </method> - <method name="set_gradient"> - <return type="void"> - </return> - <argument index="0" name="gradient" type="Gradient"> - </argument> - <description> - </description> - </method> - <method name="set_width"> - <return type="void"> - </return> - <argument index="0" name="width" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient"> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index a07809ce95..3bc7fed1d9 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GraphEdit" inherits="Control" category="Core" version="3.0-alpha"> +<class name="GraphEdit" inherits="Control" category="Core" version="3.0-beta"> <brief_description> GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. </brief_description> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 2ad0cc1182..c1b18e4cd8 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GraphNode" inherits="Container" category="Core" version="3.0-alpha"> +<class name="GraphNode" inherits="Container" category="Core" version="3.0-beta"> <brief_description> A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. </brief_description> @@ -144,32 +144,12 @@ Return the (integer) type of right (output) 'idx' slot. </description> </method> - <method name="get_title" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the title of the GraphNode. - </description> - </method> - <method name="is_close_button_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns true if the close button is shown. False otherwise. - </description> - </method> <method name="is_comment" qualifiers="const"> <return type="bool"> </return> <description> </description> </method> - <method name="is_resizable" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_selected"> <return type="bool"> </return> @@ -219,14 +199,6 @@ <description> </description> </method> - <method name="set_resizable"> - <return type="void"> - </return> - <argument index="0" name="resizable" type="bool"> - </argument> - <description> - </description> - </method> <method name="set_selected"> <return type="void"> </return> @@ -235,15 +207,6 @@ <description> </description> </method> - <method name="set_show_close_button"> - <return type="void"> - </return> - <argument index="0" name="show" type="bool"> - </argument> - <description> - Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. - </description> - </method> <method name="set_slot"> <return type="void"> </return> @@ -268,15 +231,6 @@ <description> </description> </method> - <method name="set_title"> - <return type="void"> - </return> - <argument index="0" name="title" type="String"> - </argument> - <description> - Set the title of the GraphNode. - </description> - </method> </methods> <members> <member name="resizable" type="bool" setter="set_resizable" getter="is_resizable"> @@ -319,11 +273,11 @@ </signal> </signals> <constants> - <constant name="OVERLAY_DISABLED" value="0"> + <constant name="OVERLAY_DISABLED" value="0" enum="Overlay"> </constant> - <constant name="OVERLAY_BREAKPOINT" value="1"> + <constant name="OVERLAY_BREAKPOINT" value="1" enum="Overlay"> </constant> - <constant name="OVERLAY_POSITION" value="2"> + <constant name="OVERLAY_POSITION" value="2" enum="Overlay"> </constant> </constants> <theme_items> diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml index 01bbed6ea7..9deec7e410 100644 --- a/doc/classes/GridContainer.xml +++ b/doc/classes/GridContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GridContainer" inherits="Container" category="Core" version="3.0-alpha"> +<class name="GridContainer" inherits="Container" category="Core" version="3.0-beta"> <brief_description> Grid container used to arrange elements in a grid like layout </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_columns" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the number of columns in this container - </description> - </method> - <method name="set_columns"> - <return type="void"> - </return> - <argument index="0" name="columns" type="int"> - </argument> - <description> - Sets the numbers of columns in the container, then reorder its children to accommodate the new layout - </description> - </method> </methods> <members> <member name="columns" type="int" setter="set_columns" getter="get_columns"> diff --git a/doc/classes/GrooveJoint2D.xml b/doc/classes/GrooveJoint2D.xml index 182bf5e8f1..6ccad9a155 100644 --- a/doc/classes/GrooveJoint2D.xml +++ b/doc/classes/GrooveJoint2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GrooveJoint2D" inherits="Joint2D" category="Core" version="3.0-alpha"> +<class name="GrooveJoint2D" inherits="Joint2D" category="Core" version="3.0-beta"> <brief_description> Groove constraint for 2D physics. </brief_description> @@ -11,38 +11,6 @@ <demos> </demos> <methods> - <method name="get_initial_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Set the final offset of the groove on body A. - </description> - </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the length of the groove. - </description> - </method> - <method name="set_initial_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="float"> - </argument> - <description> - Set the initial offset of the groove on body A. - </description> - </method> - <method name="set_length"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - Set the length of the groove. - </description> - </method> </methods> <members> <member name="initial_offset" type="float" setter="set_initial_offset" getter="get_initial_offset"> diff --git a/doc/classes/HBoxContainer.xml b/doc/classes/HBoxContainer.xml index 6ee9a2c1f4..c94aa709cb 100644 --- a/doc/classes/HBoxContainer.xml +++ b/doc/classes/HBoxContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HBoxContainer" inherits="BoxContainer" category="Core" version="3.0-alpha"> +<class name="HBoxContainer" inherits="BoxContainer" category="Core" version="3.0-beta"> <brief_description> Horizontal box container. </brief_description> diff --git a/doc/classes/HScrollBar.xml b/doc/classes/HScrollBar.xml index 7fe26ec863..0add27d996 100644 --- a/doc/classes/HScrollBar.xml +++ b/doc/classes/HScrollBar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HScrollBar" inherits="ScrollBar" category="Core" version="3.0-alpha"> +<class name="HScrollBar" inherits="ScrollBar" category="Core" version="3.0-beta"> <brief_description> Horizontal scroll bar. </brief_description> diff --git a/doc/classes/HSeparator.xml b/doc/classes/HSeparator.xml index 487f83ec1d..ee5422592f 100644 --- a/doc/classes/HSeparator.xml +++ b/doc/classes/HSeparator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HSeparator" inherits="Separator" category="Core" version="3.0-alpha"> +<class name="HSeparator" inherits="Separator" category="Core" version="3.0-beta"> <brief_description> Horizontal separator. </brief_description> diff --git a/doc/classes/HSlider.xml b/doc/classes/HSlider.xml index b4a97425f3..a04ce73fcb 100644 --- a/doc/classes/HSlider.xml +++ b/doc/classes/HSlider.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HSlider" inherits="Slider" category="Core" version="3.0-alpha"> +<class name="HSlider" inherits="Slider" category="Core" version="3.0-beta"> <brief_description> Horizontal slider. </brief_description> diff --git a/doc/classes/HSplitContainer.xml b/doc/classes/HSplitContainer.xml index a107d30be7..4c1528f098 100644 --- a/doc/classes/HSplitContainer.xml +++ b/doc/classes/HSplitContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HSplitContainer" inherits="SplitContainer" category="Core" version="3.0-alpha"> +<class name="HSplitContainer" inherits="SplitContainer" category="Core" version="3.0-beta"> <brief_description> Horizontal split container. </brief_description> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 569c76ae0c..9d4b45a8d7 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HTTPClient" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="HTTPClient" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Hyper-text transfer protocol client. </brief_description> <description> - Hyper-text transfer protocol client. Supports SSL and SSL server certificate verification. - Can be reused to connect to different hosts and make many requests. + 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. + A [code]HTTPClient[/code] 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> <tutorials> </tutorials> @@ -16,7 +18,7 @@ <return type="void"> </return> <description> - Cloces the current connection, allows for reusal of [code]HTTPClient[/code]. + Closes the current connection, allowing reuse of this [code]HTTPClient[/code]. </description> </method> <method name="connect_to_host"> @@ -33,35 +35,35 @@ <description> Connect 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. - verify_host will check the SSL identity of the host if set to true. + [code]verify_host[/code] will check the SSL identity of the host if set to [code]true[/code]. </description> </method> <method name="get_connection" qualifiers="const"> <return type="StreamPeer"> </return> <description> - Return current connection. + Returns the current connection. </description> </method> <method name="get_response_body_length" qualifiers="const"> <return type="int"> </return> <description> - Return the response's body length. + Returns the response's body length. </description> </method> <method name="get_response_code" qualifiers="const"> <return type="int"> </return> <description> - Return the HTTP status code of the response. + Returns the response's HTTP status code. </description> </method> <method name="get_response_headers"> <return type="PoolStringArray"> </return> <description> - Return the response headers. + Returns the response headers. </description> </method> <method name="get_response_headers_as_dictionary"> @@ -84,21 +86,21 @@ <return type="bool"> </return> <description> - Return whether this [code]HTTPClient[/code] has a response available. + If [code]true[/code] this [code]HTTPClient[/code] has a response available. </description> </method> <method name="is_blocking_mode_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether blocking mode is enabled. + If [code]true[/code] blocking mode is enabled. </description> </method> <method name="is_response_chunked" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this [code]HTTPClient[/code] has a response that is chunked. + If [code]true[/code] this [code]HTTPClient[/code] has a response that is chunked. </description> </method> <method name="poll"> @@ -141,8 +143,8 @@ <argument index="3" name="body" type="String" default=""""> </argument> <description> - Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". - Headers are HTTP request headers. + Sends a request to the connected host. The URL parameter is just the part after the host, so for [code]http://somehost.com/index.php[/code], it is [code]index.php[/code]. + Headers are HTTP request headers. For available HTTP methods, see [code]METHOD_*[/code]. To create a POST request with query strings to push to the server, do: [codeblock] var fields = {"username" : "user", "password" : "pass"} @@ -164,9 +166,9 @@ <argument index="3" name="body" type="PoolByteArray"> </argument> <description> - Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". - Headers are HTTP request headers. - Sends body raw, as a byte array, does not encode it in any way. + Sends a raw request to the connected host. The URL parameter is just the part after the host, so for [code]http://somehost.com/index.php[/code], it is [code]index.php[/code]. + Headers are HTTP request headers. For available HTTP methods, see [code]METHOD_*[/code]. + Sends the body data raw, as a byte array and does not encode it in any way. </description> </method> <method name="set_blocking_mode"> @@ -184,7 +186,7 @@ <argument index="0" name="connection" type="StreamPeer"> </argument> <description> - Set connection to use, for this client. + Sets connection to use for this client. </description> </method> <method name="set_read_chunk_size"> @@ -198,141 +200,248 @@ </method> </methods> <constants> - <constant name="METHOD_GET" value="0"> + <constant name="METHOD_GET" value="0" enum="Method"> + HTTP GET method. The GET method requests a representation of the specified resource. Requests using GET should only retrieve data. </constant> - <constant name="METHOD_HEAD" value="1"> + <constant name="METHOD_HEAD" value="1" enum="Method"> + HTTP HEAD method. The HEAD method asks for a response identical to that of a GET request, but without the response body. This is useful to request metadata like HTTP headers or to check if a resource exists. </constant> - <constant name="METHOD_POST" value="2"> + <constant name="METHOD_POST" value="2" enum="Method"> + HTTP POST method. The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server. This is often used for forms and submitting data or uploading files. </constant> - <constant name="METHOD_PUT" value="3"> + <constant name="METHOD_PUT" value="3" enum="Method"> + HTTP PUT method. The PUT method asks to replace all current representations of the target resource with the request payload. (You can think of [code]POST[/code] as "create or update" and [code]PUT[/code] as "update", although many services tend to not make a clear distinction or change their meaning). </constant> - <constant name="METHOD_DELETE" value="4"> + <constant name="METHOD_DELETE" value="4" enum="Method"> + HTTP DELETE method. The DELETE method requests to delete the specified resource. </constant> - <constant name="METHOD_OPTIONS" value="5"> + <constant name="METHOD_OPTIONS" value="5" enum="Method"> + HTTP OPTIONS method. The OPTIONS method asks for a description of the communication options for the target resource. Rarely used. </constant> - <constant name="METHOD_TRACE" value="6"> + <constant name="METHOD_TRACE" value="6" enum="Method"> + HTTP TRACE method. The TRACE method performs a message loop-back test along the path to the target resource. Returns the entire HTTP request received in the response body. Rarely used. </constant> - <constant name="METHOD_CONNECT" value="7"> + <constant name="METHOD_CONNECT" value="7" enum="Method"> + HTTP CONNECT method. The CONNECT method establishes a tunnel to the server identified by the target resource. Rarely used. </constant> - <constant name="METHOD_MAX" value="8"> + <constant name="METHOD_PATCH" value="8" enum="Method"> + HTTP PATCH method. The PATCH method is used to apply partial modifications to a resource. </constant> - <constant name="STATUS_DISCONNECTED" value="0"> + <constant name="METHOD_MAX" value="9" enum="Method"> + Marker for end of [code]METHOD_*[/code] enum. Not used. </constant> - <constant name="STATUS_RESOLVING" value="1"> + <constant name="STATUS_DISCONNECTED" value="0" enum="Status"> + Status: Disconnected from the server. </constant> - <constant name="STATUS_CANT_RESOLVE" value="2"> + <constant name="STATUS_RESOLVING" value="1" enum="Status"> + Status: Currently resolving the hostname for the given URL into an IP. </constant> - <constant name="STATUS_CONNECTING" value="3"> + <constant name="STATUS_CANT_RESOLVE" value="2" enum="Status"> + Status: DNS failure: Can't resolve the hostname for the given URL. </constant> - <constant name="STATUS_CANT_CONNECT" value="4"> + <constant name="STATUS_CONNECTING" value="3" enum="Status"> + Status: Currently connecting to server. </constant> - <constant name="STATUS_CONNECTED" value="5"> + <constant name="STATUS_CANT_CONNECT" value="4" enum="Status"> + Status: Can't connect to the server. </constant> - <constant name="STATUS_REQUESTING" value="6"> + <constant name="STATUS_CONNECTED" value="5" enum="Status"> + Status: Connection established. </constant> - <constant name="STATUS_BODY" value="7"> + <constant name="STATUS_REQUESTING" value="6" enum="Status"> + Status: Currently sending request. </constant> - <constant name="STATUS_CONNECTION_ERROR" value="8"> + <constant name="STATUS_BODY" value="7" enum="Status"> + Status: HTTP body received. </constant> - <constant name="STATUS_SSL_HANDSHAKE_ERROR" value="9"> + <constant name="STATUS_CONNECTION_ERROR" value="8" enum="Status"> + Status: Error in HTTP connection. </constant> - <constant name="RESPONSE_CONTINUE" value="100"> + <constant name="STATUS_SSL_HANDSHAKE_ERROR" value="9" enum="Status"> + Status: Error in SSL handshake. </constant> - <constant name="RESPONSE_SWITCHING_PROTOCOLS" value="101"> + <constant name="RESPONSE_CONTINUE" value="100" enum="ResponseCode"> + HTTP status code [code]100 Continue[/code]. Interim response that indicates everything so far is OK and that the client should continue with the request (or ignore this status if already finished). </constant> - <constant name="RESPONSE_PROCESSING" value="102"> + <constant name="RESPONSE_SWITCHING_PROTOCOLS" value="101" enum="ResponseCode"> + HTTP status code [code]101 Switching Protocol[/code]. Sent in response to an [code]Upgrade[/code] request header by the client. Indicates the protocol the server is switching to. </constant> - <constant name="RESPONSE_OK" value="200"> + <constant name="RESPONSE_PROCESSING" value="102" enum="ResponseCode"> + HTTP status code [code]102 Processing[/code] (WebDAV). Indicates that the server has received and is processing the request, but no response is available yet. </constant> - <constant name="RESPONSE_CREATED" value="201"> + <constant name="RESPONSE_OK" value="200" enum="ResponseCode"> + HTTP status code [code]200 OK[/code]. The request has succeeded. Default response for successful requests. Meaning varies depending on the request. GET: The resource has been fetched and is transmitted in the message body. HEAD: The entity headers are in the message body. POST: The resource describing the result of the action is transmitted in the message body. TRACE: The message body contains the request message as received by the server. </constant> - <constant name="RESPONSE_ACCEPTED" value="202"> + <constant name="RESPONSE_CREATED" value="201" enum="ResponseCode"> + HTTP status code [code]201 Created[/code]. The request has succeeded and a new resource has been created as a result of it. This is typically the response sent after a PUT request. </constant> - <constant name="RESPONSE_NON_AUTHORITATIVE_INFORMATION" value="203"> + <constant name="RESPONSE_ACCEPTED" value="202" enum="ResponseCode"> + HTTP status code [code]202 Accepted[/code]. The request has been received but not yet acted upon. It is non-committal, meaning that there is no way in HTTP to later send an asynchronous response indicating the outcome of processing the request. It is intended for cases where another process or server handles the request, or for batch processing. </constant> - <constant name="RESPONSE_NO_CONTENT" value="204"> + <constant name="RESPONSE_NON_AUTHORITATIVE_INFORMATION" value="203" enum="ResponseCode"> + HTTP status code [code]203 Non-Authoritative Information[/code]. This response code means returned meta-information set is not exact set as available from the origin server, but collected from a local or a third party copy. Except this condition, 200 OK response should be preferred instead of this response. </constant> - <constant name="RESPONSE_RESET_CONTENT" value="205"> + <constant name="RESPONSE_NO_CONTENT" value="204" enum="ResponseCode"> + HTTP status code [code]204 No Content[/code]. There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones. </constant> - <constant name="RESPONSE_PARTIAL_CONTENT" value="206"> + <constant name="RESPONSE_RESET_CONTENT" value="205" enum="ResponseCode"> + HTTP status code [code]205 Reset Content[/code]. The server has fulfilled the request and desires that the client resets the "document view" that caused the request to be sent to its original state as received from the origin server. </constant> - <constant name="RESPONSE_MULTI_STATUS" value="207"> + <constant name="RESPONSE_PARTIAL_CONTENT" value="206" enum="ResponseCode"> + HTTP status code [code]206 Partial Content[/code]. This response code is used because of a range header sent by the client to separate download into multiple streams. </constant> - <constant name="RESPONSE_IM_USED" value="226"> + <constant name="RESPONSE_MULTI_STATUS" value="207" enum="ResponseCode"> + HTTP status code [code]207 Multi-Status[/code] (WebDAV). A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate. </constant> - <constant name="RESPONSE_MULTIPLE_CHOICES" value="300"> + <constant name="RESPONSE_ALREADY_REPORTED" value="208" enum="ResponseCode"> + HTTP status code [code]208 Already Reported[/code] (WebDAV). Used inside a DAV: propstat response element to avoid enumerating the internal members of multiple bindings to the same collection repeatedly. </constant> - <constant name="RESPONSE_MOVED_PERMANENTLY" value="301"> + <constant name="RESPONSE_IM_USED" value="226" enum="ResponseCode"> + HTTP status code [code]226 IM Used[/code] (WebDAV). The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. </constant> - <constant name="RESPONSE_FOUND" value="302"> + <constant name="RESPONSE_MULTIPLE_CHOICES" value="300" enum="ResponseCode"> + HTTP status code [code]300 Multiple Choice[/code]. The request has more than one possible responses and there is no standardized way to choose one of the responses. User-agent or user should choose one of them. </constant> - <constant name="RESPONSE_SEE_OTHER" value="303"> + <constant name="RESPONSE_MOVED_PERMANENTLY" value="301" enum="ResponseCode"> + HTTP status code [code]301 Moved Permanently[/code]. Redirection. This response code means the URI of requested resource has been changed. The new URI is usually included in the response. </constant> - <constant name="RESPONSE_NOT_MODIFIED" value="304"> + <constant name="RESPONSE_FOUND" value="302" enum="ResponseCode"> + HTTP status code [code]302 Found[/code]. Temporary redirection. This response code means the URI of requested resource has been changed temporarily. New changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests. </constant> - <constant name="RESPONSE_USE_PROXY" value="305"> + <constant name="RESPONSE_SEE_OTHER" value="303" enum="ResponseCode"> + HTTP status code [code]303 See Other[/code]. The server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request. </constant> - <constant name="RESPONSE_TEMPORARY_REDIRECT" value="307"> + <constant name="RESPONSE_NOT_MODIFIED" value="304" enum="ResponseCode"> + 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 false. </constant> - <constant name="RESPONSE_BAD_REQUEST" value="400"> + <constant name="RESPONSE_USE_PROXY" value="305" enum="ResponseCode"> + HTTP status code [code]305 Use Proxy[/code]. Deprecated. Do not use. </constant> - <constant name="RESPONSE_UNAUTHORIZED" value="401"> + <constant name="RESPONSE_SWITCH_PROXY" value="306" enum="ResponseCode"> + HTTP status code [code]306 Switch Proxy[/code]. Deprecated. Do not use. </constant> - <constant name="RESPONSE_PAYMENT_REQUIRED" value="402"> + <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. </constant> - <constant name="RESPONSE_FORBIDDEN" value="403"> + <constant name="RESPONSE_PERMANENT_REDIRECT" value="308" enum="ResponseCode"> + HTTP status code [code]308 Permanent Redirect[/code]. The target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs. </constant> - <constant name="RESPONSE_NOT_FOUND" value="404"> + <constant name="RESPONSE_BAD_REQUEST" value="400" enum="ResponseCode"> + HTTP status code [code]400 Bad Request[/code]. The request was invalid. The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, invalid request contents, or deceptive request routing). </constant> - <constant name="RESPONSE_METHOD_NOT_ALLOWED" value="405"> + <constant name="RESPONSE_UNAUTHORIZED" value="401" enum="ResponseCode"> + HTTP status code [code]401 Unauthorized[/code]. Credentials required. The request has not been applied because it lacks valid authentication credentials for the target resource. </constant> - <constant name="RESPONSE_NOT_ACCEPTABLE" value="406"> + <constant name="RESPONSE_PAYMENT_REQUIRED" value="402" enum="ResponseCode"> + HTTP status code [code]402 Payment Required[/code]. This response code is reserved for future use. Initial aim for creating this code was using it for digital payment systems, however this is not currently used. </constant> - <constant name="RESPONSE_PROXY_AUTHENTICATION_REQUIRED" value="407"> + <constant name="RESPONSE_FORBIDDEN" value="403" enum="ResponseCode"> + HTTP status code [code]403 Forbidden[/code]. The client does not have access rights to the content, i.e. they are unauthorized, so server is rejecting to give proper response. Unlike [code]401[/code], the client's identity is known to the server. </constant> - <constant name="RESPONSE_REQUEST_TIMEOUT" value="408"> + <constant name="RESPONSE_NOT_FOUND" value="404" enum="ResponseCode"> + HTTP status code [code]404 Not Found[/code]. The server can not find requested resource. Either the URL is not recognized or the endpoint is valid but the resource itself does not exist. May also be sent instead of 403 to hide existence of a resource if the client is not authorized. </constant> - <constant name="RESPONSE_CONFLICT" value="409"> + <constant name="RESPONSE_METHOD_NOT_ALLOWED" value="405" enum="ResponseCode"> + HTTP status code [code]405 Method Not Allowed[/code]. The request's HTTP method is known by the server but has been disabled and cannot be used. For example, an API may forbid DELETE-ing a resource. The two mandatory methods, GET and HEAD, must never be disabled and should not return this error code. </constant> - <constant name="RESPONSE_GONE" value="410"> + <constant name="RESPONSE_NOT_ACCEPTABLE" value="406" enum="ResponseCode"> + HTTP status code [code]406 Not Acceptable[/code]. The target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request. Used when negotiation content. </constant> - <constant name="RESPONSE_LENGTH_REQUIRED" value="411"> + <constant name="RESPONSE_PROXY_AUTHENTICATION_REQUIRED" value="407" enum="ResponseCode"> + HTTP status code [code]407 Proxy Authentication Required[/code]. Similar to 401 Unauthorized, but it indicates that the client needs to authenticate itself in order to use a proxy. </constant> - <constant name="RESPONSE_PRECONDITION_FAILED" value="412"> + <constant name="RESPONSE_REQUEST_TIMEOUT" value="408" enum="ResponseCode"> + HTTP status code [code]408 Request Timeout[/code]. The server did not receive a complete request message within the time that it was prepared to wait. </constant> - <constant name="RESPONSE_REQUEST_ENTITY_TOO_LARGE" value="413"> + <constant name="RESPONSE_CONFLICT" value="409" enum="ResponseCode"> + HTTP status code [code]409 Conflict[/code]. The request could not be completed due to a conflict with the current state of the target resource. This code is used in situations where the user might be able to resolve the conflict and resubmit the request. </constant> - <constant name="RESPONSE_REQUEST_URI_TOO_LONG" value="414"> + <constant name="RESPONSE_GONE" value="410" enum="ResponseCode"> + HTTP status code [code]410 Gone[/code]. The target resource is no longer available at the origin server and this condition is likely permanent. </constant> - <constant name="RESPONSE_UNSUPPORTED_MEDIA_TYPE" value="415"> + <constant name="RESPONSE_LENGTH_REQUIRED" value="411" enum="ResponseCode"> + HTTP status code [code]411 Length Required[/code]. The server refuses to accept the request without a defined Content-Length header. </constant> - <constant name="RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE" value="416"> + <constant name="RESPONSE_PRECONDITION_FAILED" value="412" enum="ResponseCode"> + HTTP status code [code]412 Precondition Failed[/code]. One or more conditions given in the request header fields evaluated to false when tested on the server. </constant> - <constant name="RESPONSE_EXPECTATION_FAILED" value="417"> + <constant name="RESPONSE_REQUEST_ENTITY_TOO_LARGE" value="413" enum="ResponseCode"> + HTTP status code [code]413 Entity Too Large[/code]. The server is refusing to process a request because the request payload is larger than the server is willing or able to process. </constant> - <constant name="RESPONSE_UNPROCESSABLE_ENTITY" value="422"> + <constant name="RESPONSE_REQUEST_URI_TOO_LONG" value="414" enum="ResponseCode"> + HTTP status code [code]414 Request-URI Too Long[/code]. The server is refusing to service the request because the request-target is longer than the server is willing to interpret. </constant> - <constant name="RESPONSE_LOCKED" value="423"> + <constant name="RESPONSE_UNSUPPORTED_MEDIA_TYPE" value="415" enum="ResponseCode"> + HTTP status code [code]415 Unsupported Media Type[/code]. The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource. </constant> - <constant name="RESPONSE_FAILED_DEPENDENCY" value="424"> + <constant name="RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE" value="416" enum="ResponseCode"> + HTTP status code [code]416 Requested Range Not Satisfiable[/code]. None of the ranges in the request's Range header field overlap the current extent of the selected resource or the set of ranges requested has been rejected due to invalid ranges or an excessive request of small or overlapping ranges. </constant> - <constant name="RESPONSE_UPGRADE_REQUIRED" value="426"> + <constant name="RESPONSE_EXPECTATION_FAILED" value="417" enum="ResponseCode"> + HTTP status code [code]417 Expectation Failed[/code]. The expectation given in the request's Expect header field could not be met by at least one of the inbound servers. </constant> - <constant name="RESPONSE_INTERNAL_SERVER_ERROR" value="500"> + <constant name="RESPONSE_IM_A_TEAPOT" value="418" enum="ResponseCode"> + HTTP status code [code]418 I'm A Teapot[/code]. Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout. </constant> - <constant name="RESPONSE_NOT_IMPLEMENTED" value="501"> + <constant name="RESPONSE_MISDIRECTED_REQUEST" value="421" enum="ResponseCode"> + HTTP status code [code]421 Misdirected Request[/code]. The request was directed at a server that is not able to produce a response. This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI. </constant> - <constant name="RESPONSE_BAD_GATEWAY" value="502"> + <constant name="RESPONSE_UNPROCESSABLE_ENTITY" value="422" enum="ResponseCode"> + HTTP status code [code]422 Unprocessable Entity[/code] (WebDAV). The server understands the content type of the request entity (hence a 415 Unsupported Media Type status code is inappropriate), and the syntax of the request entity is correct (thus a 400 Bad Request status code is inappropriate) but was unable to process the contained instructions. </constant> - <constant name="RESPONSE_SERVICE_UNAVAILABLE" value="503"> + <constant name="RESPONSE_LOCKED" value="423" enum="ResponseCode"> + HTTP status code [code]423 Locked[/code] (WebDAV). The source or destination resource of a method is locked. </constant> - <constant name="RESPONSE_GATEWAY_TIMEOUT" value="504"> + <constant name="RESPONSE_FAILED_DEPENDENCY" value="424" enum="ResponseCode"> + HTTP status code [code]424 Failed Dependency[/code] (WebDAV). The method could not be performed on the resource because the requested action depended on another action and that action failed. </constant> - <constant name="RESPONSE_HTTP_VERSION_NOT_SUPPORTED" value="505"> + <constant name="RESPONSE_UPGRADE_REQUIRED" value="426" enum="ResponseCode"> + HTTP status code [code]426 Upgrade Required[/code]. The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. </constant> - <constant name="RESPONSE_INSUFFICIENT_STORAGE" value="507"> + <constant name="RESPONSE_PRECONDITION_REQUIRED" value="428" enum="ResponseCode"> + HTTP status code [code]428 Precondition Required[/code]. The origin server requires the request to be conditional. </constant> - <constant name="RESPONSE_NOT_EXTENDED" value="510"> + <constant name="RESPONSE_TOO_MANY_REQUESTS" value="429" enum="ResponseCode"> + HTTP status code [code]429 Too Many Requests[/code]. The user has sent too many requests in a given amount of time (see "rate limiting"). Back off and increase time between requests or try again later. + </constant> + <constant name="RESPONSE_REQUEST_HEADER_FIELDS_TOO_LARGE" value="431" enum="ResponseCode"> + HTTP status code [code]431 Rquest Header Fields Too Large[/code]. The server is unwilling to process the request because its header fields are too large. The request MAY be resubmitted after reducing the size of the request header fields. + </constant> + <constant name="RESPONSE_UNAVAILABLE_FOR_LEGAL_REASONS" value="451" enum="ResponseCode"> + HTTP status code [code]451 Response Unavailable For Legal Reasons[/code]. The server is denying access to the resource as a consequence of a legal demand. + </constant> + <constant name="RESPONSE_INTERNAL_SERVER_ERROR" value="500" enum="ResponseCode"> + HTTP status code [code]500 Internal Server Error[/code]. The server encountered an unexpected condition that prevented it from fulfilling the request. + </constant> + <constant name="RESPONSE_NOT_IMPLEMENTED" value="501" enum="ResponseCode"> + HTTP status code [code]501 Not Implemented[/code]. The server does not support the functionality required to fulfill the request. + </constant> + <constant name="RESPONSE_BAD_GATEWAY" value="502" enum="ResponseCode"> + HTTP status code [code]502 Bad Gateway[/code]. The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request. Usually returned by load balancers or proxies. + </constant> + <constant name="RESPONSE_SERVICE_UNAVAILABLE" value="503" enum="ResponseCode"> + HTTP status code [code]503 Service Unavailable[/code]. The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. Try again later. + </constant> + <constant name="RESPONSE_GATEWAY_TIMEOUT" value="504" enum="ResponseCode"> + HTTP status code [code]504 Gateway Timeout[/code]. The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. Usually returned by load balancers or proxies. + </constant> + <constant name="RESPONSE_HTTP_VERSION_NOT_SUPPORTED" value="505" enum="ResponseCode"> + HTTP status code [code]505 HTTP Version Not Supported[/code]. The server does not support, or refuses to support, the major version of HTTP that was used in the request message. + </constant> + <constant name="RESPONSE_VARIANT_ALSO_NEGOTIATES" value="506" enum="ResponseCode"> + HTTP status code [code]506 Variant Also Negotiates[/code]. The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process. + </constant> + <constant name="RESPONSE_INSUFFICIENT_STORAGE" value="507" enum="ResponseCode"> + HTTP status code [code]507 Insufficient Storage[/code]. The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. + </constant> + <constant name="RESPONSE_LOOP_DETECTED" value="508" enum="ResponseCode"> + HTTP status code [code]508 Loop Detected[/code]. The server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity". This status indicates that the entire operation failed. + </constant> + <constant name="RESPONSE_NOT_EXTENDED" value="510" enum="ResponseCode"> + HTTP status code [code]510 Not Extended[/code]. The policy for accessing the resource has not been met in the request. The server should send back all the information necessary for the client to issue an extended request. + </constant> + <constant name="RESPONSE_NETWORK_AUTH_REQUIRED" value="511" enum="ResponseCode"> + HTTP status code [code]511 Network Authentication Required[/code]. The client needs to authenticate to gain network access. </constant> </constants> </class> diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index a1a84d2211..985198c76f 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HTTPRequest" inherits="Node" category="Core" version="3.0-alpha"> +<class name="HTTPRequest" inherits="Node" category="Core" version="3.0-beta"> <brief_description> - A Node with the ability to send HTTP requests. + A node with the ability to send HTTP requests. </brief_description> <description> - A Node with the ability to send HTTP requests. Uses a [HTTPClient] internally, supports HTTPS. - Can be used to make HTTP requests or download files via HTTP. + A node with the ability to send HTTP requests. Uses [HTTPClient] internally. + Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP. </description> <tutorials> </tutorials> @@ -16,56 +16,35 @@ <return type="void"> </return> <description> - Cancel the current request. + Cancels the current request. </description> </method> <method name="get_body_size" qualifiers="const"> <return type="int"> </return> <description> - Return the response body length. - </description> - </method> - <method name="get_body_size_limit" qualifiers="const"> - <return type="int"> - </return> - <description> - Return current body size limit. + Returns the response body length. </description> </method> <method name="get_download_file" qualifiers="const"> <return type="String"> </return> <description> - Return the file this request will download into. + Returns the file this request will download into. </description> </method> <method name="get_downloaded_bytes" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of bytes this HTTPRequest downloaded. + Returns the amount of bytes this HTTPRequest downloaded. </description> </method> <method name="get_http_client_status" qualifiers="const"> <return type="int" enum="HTTPClient.Status"> </return> <description> - Return the current status of the underlying [HTTPClient]. - </description> - </method> - <method name="get_max_redirects" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the maximum amount of redirects that will be followed. - </description> - </method> - <method name="is_using_threads" qualifiers="const"> - <return type="bool"> - </return> - <description> - Whether this request is using threads. + Returns the current status of the underlying [HTTPClient]. See [code]STATUS_*[/code] enum on [HTTPClient]. </description> </method> <method name="request"> @@ -84,49 +63,25 @@ <description> </description> </method> - <method name="set_body_size_limit"> - <return type="void"> - </return> - <argument index="0" name="bytes" type="int"> - </argument> - <description> - Set the response body size limit. - </description> - </method> <method name="set_download_file"> <return type="void"> </return> <argument index="0" name="path" type="String"> </argument> <description> - Set the file to download into. Outputs the response body into the file. - </description> - </method> - <method name="set_max_redirects"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Set the maximum amount of redirects the request will follow. - </description> - </method> - <method name="set_use_threads"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Make this HTTPRequest use threads. + Sets the file to download into. Outputs the response body into the file if set. </description> </method> </methods> <members> <member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit"> + Maximum allowed size for response bodies. </member> <member name="max_redirects" type="int" setter="set_max_redirects" getter="get_max_redirects"> + Maximum number of allowed redirects. </member> <member name="use_threads" type="bool" setter="set_use_threads" getter="is_using_threads"> + If [code]true[/code] multithreading is used to improve performance. </member> </members> <signals> @@ -145,39 +100,39 @@ </signal> </signals> <constants> - <constant name="RESULT_SUCCESS" value="0"> + <constant name="RESULT_SUCCESS" value="0" enum="Result"> Request successful. </constant> - <constant name="RESULT_CHUNKED_BODY_SIZE_MISMATCH" value="1"> + <constant name="RESULT_CHUNKED_BODY_SIZE_MISMATCH" value="1" enum="Result"> </constant> - <constant name="RESULT_CANT_CONNECT" value="2"> + <constant name="RESULT_CANT_CONNECT" value="2" enum="Result"> Request failed while connecting. </constant> - <constant name="RESULT_CANT_RESOLVE" value="3"> + <constant name="RESULT_CANT_RESOLVE" value="3" enum="Result"> Request failed while resolving. </constant> - <constant name="RESULT_CONNECTION_ERROR" value="4"> + <constant name="RESULT_CONNECTION_ERROR" value="4" enum="Result"> Request failed due to connection(read/write) error. </constant> - <constant name="RESULT_SSL_HANDSHAKE_ERROR" value="5"> + <constant name="RESULT_SSL_HANDSHAKE_ERROR" value="5" enum="Result"> Request failed on SSL handshake. </constant> - <constant name="RESULT_NO_RESPONSE" value="6"> + <constant name="RESULT_NO_RESPONSE" value="6" enum="Result"> Request does not have a response(yet). </constant> - <constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7"> + <constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7" enum="Result"> Request exceeded its maximum size limit, see [method set_body_size_limit]. </constant> - <constant name="RESULT_REQUEST_FAILED" value="8"> - Request failed. (unused) + <constant name="RESULT_REQUEST_FAILED" value="8" enum="Result"> + Request failed. (Unused) </constant> - <constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="9"> + <constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="9" enum="Result"> HTTPRequest couldn't open the download file. </constant> - <constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10"> + <constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10" enum="Result"> HTTPRequest couldn't write to the download file. </constant> - <constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11"> + <constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11" enum="Result"> Request reached its maximum redirect limit, see [method set_max_redirects]. </constant> </constants> diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index 2d91549a66..4a23f63d5a 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HingeJoint" inherits="Joint" category="Core" version="3.0-alpha"> +<class name="HingeJoint" inherits="Joint" category="Core" version="3.0-beta"> <brief_description> A hinge between two 3D bodies. </brief_description> @@ -11,42 +11,6 @@ <demos> </demos> <methods> - <method name="get_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int" enum="HingeJoint.Flag"> - </argument> - <description> - </description> - </method> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="HingeJoint.Param"> - </argument> - <description> - </description> - </method> - <method name="set_flag"> - <return type="void"> - </return> - <argument index="0" name="flag" type="int" enum="HingeJoint.Flag"> - </argument> - <argument index="1" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_param"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="HingeJoint.Param"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="angular_limit/bias" type="float" setter="set_param" getter="get_param"> @@ -80,39 +44,39 @@ </member> </members> <constants> - <constant name="PARAM_BIAS" value="0"> + <constant name="PARAM_BIAS" value="0" enum="Param"> The speed with wich the two bodies get pulled together when they move in different directions. </constant> - <constant name="PARAM_LIMIT_UPPER" value="1"> + <constant name="PARAM_LIMIT_UPPER" value="1" enum="Param"> The maximum rotation. only active if [member angular_limit/enable] is [code]true[/code]. </constant> - <constant name="PARAM_LIMIT_LOWER" value="2"> + <constant name="PARAM_LIMIT_LOWER" value="2" enum="Param"> The minimum rotation. only active if [member angular_limit/enable] is [code]true[/code]. </constant> - <constant name="PARAM_LIMIT_BIAS" value="3"> + <constant name="PARAM_LIMIT_BIAS" value="3" enum="Param"> The speed with which the rotation across the axis perpendicular to the hinge gets corrected. </constant> - <constant name="PARAM_LIMIT_SOFTNESS" value="4"> + <constant name="PARAM_LIMIT_SOFTNESS" value="4" enum="Param"> </constant> - <constant name="PARAM_LIMIT_RELAXATION" value="5"> + <constant name="PARAM_LIMIT_RELAXATION" value="5" enum="Param"> The lower this value, the more the rotation gets slowed down. </constant> - <constant name="PARAM_MOTOR_TARGET_VELOCITY" value="6"> + <constant name="PARAM_MOTOR_TARGET_VELOCITY" value="6" enum="Param"> Target speed for the motor. </constant> - <constant name="PARAM_MOTOR_MAX_IMPULSE" value="7"> + <constant name="PARAM_MOTOR_MAX_IMPULSE" value="7" enum="Param"> Maximum acceleration for the motor. </constant> - <constant name="PARAM_MAX" value="8"> + <constant name="PARAM_MAX" value="8" enum="Param"> End flag of PARAM_* constants, used internally. </constant> - <constant name="FLAG_USE_LIMIT" value="0"> + <constant name="FLAG_USE_LIMIT" value="0" enum="Flag"> If [code]true[/code] the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects. </constant> - <constant name="FLAG_ENABLE_MOTOR" value="1"> + <constant name="FLAG_ENABLE_MOTOR" value="1" enum="Flag"> When activated, a motor turns the hinge. </constant> - <constant name="FLAG_MAX" value="2"> + <constant name="FLAG_MAX" value="2" enum="Flag"> End flag of FLAG_* constants, used internally. </constant> </constants> diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index 721cf07441..cd669e3de1 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="IP" inherits="Object" category="Core" version="3.0-alpha"> +<class name="IP" inherits="Object" category="Core" version="3.0-beta"> <brief_description> - IP Protocol support functions. + Internet protocol (IP) support functions like DNS resolution. </brief_description> <description> - IP contains support functions for the IPv4 protocol. TCP/IP support is in different classes (see [StreamPeerTCP] and [TCP_Server]). IP provides hostname resolution support, both blocking and threaded. + 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. </description> <tutorials> </tutorials> @@ -78,25 +78,35 @@ </method> </methods> <constants> - <constant name="RESOLVER_STATUS_NONE" value="0"> + <constant name="RESOLVER_STATUS_NONE" value="0" enum="ResolverStatus"> + DNS hostname resolver status: No status. </constant> - <constant name="RESOLVER_STATUS_WAITING" value="1"> + <constant name="RESOLVER_STATUS_WAITING" value="1" enum="ResolverStatus"> + DNS hostname resolver status: Waiting. </constant> - <constant name="RESOLVER_STATUS_DONE" value="2"> + <constant name="RESOLVER_STATUS_DONE" value="2" enum="ResolverStatus"> + DNS hostname resolver status: Done. </constant> - <constant name="RESOLVER_STATUS_ERROR" value="3"> + <constant name="RESOLVER_STATUS_ERROR" value="3" enum="ResolverStatus"> + DNS hostname resolver status: Error. </constant> - <constant name="RESOLVER_MAX_QUERIES" value="32" enum=""> + <constant name="RESOLVER_MAX_QUERIES" value="32"> + Maximum number of concurrent DNS resolver queries allowed, [code]RESOLVER_INVALID_ID[/code] is returned if exceeded. </constant> - <constant name="RESOLVER_INVALID_ID" value="-1" enum=""> + <constant name="RESOLVER_INVALID_ID" value="-1"> + Invalid ID constant. Returned if [code]RESOLVER_MAX_QUERIES[/code] is exceeded. </constant> - <constant name="TYPE_NONE" value="0"> + <constant name="TYPE_NONE" value="0" enum="Type"> + Address type: None. </constant> - <constant name="TYPE_IPV4" value="1"> + <constant name="TYPE_IPV4" value="1" enum="Type"> + Address type: Internet protocol version 4 (IPv4). </constant> - <constant name="TYPE_IPV6" value="2"> + <constant name="TYPE_IPV6" value="2" enum="Type"> + Address type: Internet protocol version 6 (IPv6). </constant> - <constant name="TYPE_ANY" value="3"> + <constant name="TYPE_ANY" value="3" enum="Type"> + Address type: Any. </constant> </constants> </class> diff --git a/doc/classes/IP_Unix.xml b/doc/classes/IP_Unix.xml index bac7e374bb..1d376c7233 100644 --- a/doc/classes/IP_Unix.xml +++ b/doc/classes/IP_Unix.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="IP_Unix" inherits="IP" category="Core" version="3.0-alpha"> +<class name="IP_Unix" inherits="IP" category="Core" version="3.0-beta"> <brief_description> + Unix IP support. See [IP]. </brief_description> <description> + 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 4f8da7af9e..54eaf6cc7a 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Image" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Image" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Image datatype. </brief_description> @@ -318,7 +318,7 @@ <return type="void"> </return> <description> - Locks the data and prevents changes. + Locks the data for writing access. </description> </method> <method name="normalmap_to_xy"> @@ -376,14 +376,14 @@ <argument index="2" name="color" type="Color"> </argument> <description> - Sets the [Color] of the pixel at [code](x, y)[/code] if the image is unlocked. Example: - [code] + Sets the [Color] of the pixel at [code](x, y)[/code] if the image is locked. Example: + [codeblock] var img = Image.new() img.lock() - img.set_pixel(x, y, color) # Does not have an effect - img.unlock() img.set_pixel(x, y, color) # Works - [/code]. + img.unlock() + img.set_pixel(x, y, color) # Does not have an effect + [/codeblock] </description> </method> <method name="shrink_x2"> @@ -404,7 +404,7 @@ <return type="void"> </return> <description> - Unlocks the data for writing access. + Unlocks the data and prevents changes. </description> </method> </methods> @@ -414,109 +414,109 @@ </member> </members> <constants> - <constant name="FORMAT_L8" value="0"> + <constant name="FORMAT_L8" value="0" enum="Format"> </constant> - <constant name="FORMAT_LA8" value="1"> + <constant name="FORMAT_LA8" value="1" enum="Format"> </constant> - <constant name="FORMAT_R8" value="2"> + <constant name="FORMAT_R8" value="2" enum="Format"> </constant> - <constant name="FORMAT_RG8" value="3"> + <constant name="FORMAT_RG8" value="3" enum="Format"> </constant> - <constant name="FORMAT_RGB8" value="4"> + <constant name="FORMAT_RGB8" value="4" enum="Format"> </constant> - <constant name="FORMAT_RGBA8" value="5"> + <constant name="FORMAT_RGBA8" value="5" enum="Format"> </constant> - <constant name="FORMAT_RGBA4444" value="6"> + <constant name="FORMAT_RGBA4444" value="6" enum="Format"> </constant> - <constant name="FORMAT_RGBA5551" value="7"> + <constant name="FORMAT_RGBA5551" value="7" enum="Format"> </constant> - <constant name="FORMAT_RF" value="8"> + <constant name="FORMAT_RF" value="8" enum="Format"> </constant> - <constant name="FORMAT_RGF" value="9"> + <constant name="FORMAT_RGF" value="9" enum="Format"> </constant> - <constant name="FORMAT_RGBF" value="10"> + <constant name="FORMAT_RGBF" value="10" enum="Format"> </constant> - <constant name="FORMAT_RGBAF" value="11"> + <constant name="FORMAT_RGBAF" value="11" enum="Format"> </constant> - <constant name="FORMAT_RH" value="12"> + <constant name="FORMAT_RH" value="12" enum="Format"> </constant> - <constant name="FORMAT_RGH" value="13"> + <constant name="FORMAT_RGH" value="13" enum="Format"> </constant> - <constant name="FORMAT_RGBH" value="14"> + <constant name="FORMAT_RGBH" value="14" enum="Format"> </constant> - <constant name="FORMAT_RGBAH" value="15"> + <constant name="FORMAT_RGBAH" value="15" enum="Format"> </constant> - <constant name="FORMAT_RGBE9995" value="16"> + <constant name="FORMAT_RGBE9995" value="16" enum="Format"> </constant> - <constant name="FORMAT_DXT1" value="17"> + <constant name="FORMAT_DXT1" value="17" enum="Format"> </constant> - <constant name="FORMAT_DXT3" value="18"> + <constant name="FORMAT_DXT3" value="18" enum="Format"> </constant> - <constant name="FORMAT_DXT5" value="19"> + <constant name="FORMAT_DXT5" value="19" enum="Format"> </constant> - <constant name="FORMAT_RGTC_R" value="20"> + <constant name="FORMAT_RGTC_R" value="20" enum="Format"> </constant> - <constant name="FORMAT_RGTC_RG" value="21"> + <constant name="FORMAT_RGTC_RG" value="21" enum="Format"> </constant> - <constant name="FORMAT_BPTC_RGBA" value="22"> + <constant name="FORMAT_BPTC_RGBA" value="22" enum="Format"> </constant> - <constant name="FORMAT_BPTC_RGBF" value="23"> + <constant name="FORMAT_BPTC_RGBF" value="23" enum="Format"> </constant> - <constant name="FORMAT_BPTC_RGBFU" value="24"> + <constant name="FORMAT_BPTC_RGBFU" value="24" enum="Format"> </constant> - <constant name="FORMAT_PVRTC2" value="25"> + <constant name="FORMAT_PVRTC2" value="25" enum="Format"> </constant> - <constant name="FORMAT_PVRTC2A" value="26"> + <constant name="FORMAT_PVRTC2A" value="26" enum="Format"> </constant> - <constant name="FORMAT_PVRTC4" value="27"> + <constant name="FORMAT_PVRTC4" value="27" enum="Format"> </constant> - <constant name="FORMAT_PVRTC4A" value="28"> + <constant name="FORMAT_PVRTC4A" value="28" enum="Format"> </constant> - <constant name="FORMAT_ETC" value="29"> + <constant name="FORMAT_ETC" value="29" enum="Format"> </constant> - <constant name="FORMAT_ETC2_R11" value="30"> + <constant name="FORMAT_ETC2_R11" value="30" enum="Format"> </constant> - <constant name="FORMAT_ETC2_R11S" value="31"> + <constant name="FORMAT_ETC2_R11S" value="31" enum="Format"> </constant> - <constant name="FORMAT_ETC2_RG11" value="32"> + <constant name="FORMAT_ETC2_RG11" value="32" enum="Format"> </constant> - <constant name="FORMAT_ETC2_RG11S" value="33"> + <constant name="FORMAT_ETC2_RG11S" value="33" enum="Format"> </constant> - <constant name="FORMAT_ETC2_RGB8" value="34"> + <constant name="FORMAT_ETC2_RGB8" value="34" enum="Format"> </constant> - <constant name="FORMAT_ETC2_RGBA8" value="35"> + <constant name="FORMAT_ETC2_RGBA8" value="35" enum="Format"> </constant> - <constant name="FORMAT_ETC2_RGB8A1" value="36"> + <constant name="FORMAT_ETC2_RGB8A1" value="36" enum="Format"> </constant> - <constant name="FORMAT_MAX" value="37"> + <constant name="FORMAT_MAX" value="37" enum="Format"> </constant> - <constant name="INTERPOLATE_NEAREST" value="0"> + <constant name="INTERPOLATE_NEAREST" value="0" enum="Interpolation"> </constant> - <constant name="INTERPOLATE_BILINEAR" value="1"> + <constant name="INTERPOLATE_BILINEAR" value="1" enum="Interpolation"> </constant> - <constant name="INTERPOLATE_CUBIC" value="2"> + <constant name="INTERPOLATE_CUBIC" value="2" enum="Interpolation"> </constant> - <constant name="ALPHA_NONE" value="0"> + <constant name="ALPHA_NONE" value="0" enum="AlphaMode"> </constant> - <constant name="ALPHA_BIT" value="1"> + <constant name="ALPHA_BIT" value="1" enum="AlphaMode"> </constant> - <constant name="ALPHA_BLEND" value="2"> + <constant name="ALPHA_BLEND" value="2" enum="AlphaMode"> </constant> - <constant name="COMPRESS_S3TC" value="0"> + <constant name="COMPRESS_S3TC" value="0" enum="CompressMode"> </constant> - <constant name="COMPRESS_PVRTC2" value="1"> + <constant name="COMPRESS_PVRTC2" value="1" enum="CompressMode"> </constant> - <constant name="COMPRESS_PVRTC4" value="2"> + <constant name="COMPRESS_PVRTC4" value="2" enum="CompressMode"> </constant> - <constant name="COMPRESS_ETC" value="3"> + <constant name="COMPRESS_ETC" value="3" enum="CompressMode"> </constant> - <constant name="COMPRESS_ETC2" value="4"> + <constant name="COMPRESS_ETC2" value="4" enum="CompressMode"> </constant> - <constant name="COMPRESS_SOURCE_GENERIC" value="0"> + <constant name="COMPRESS_SOURCE_GENERIC" value="0" enum="CompressSource"> </constant> - <constant name="COMPRESS_SOURCE_SRGB" value="1"> + <constant name="COMPRESS_SOURCE_SRGB" value="1" enum="CompressSource"> </constant> - <constant name="COMPRESS_SOURCE_NORMAL" value="2"> + <constant name="COMPRESS_SOURCE_NORMAL" value="2" enum="CompressSource"> </constant> </constants> </class> diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index d179794c1f..a20af677cb 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ImageTexture" inherits="Texture" category="Core" version="3.0-alpha"> +<class name="ImageTexture" inherits="Texture" category="Core" version="3.0-beta"> <brief_description> A [Texture] based on an [Image]. </brief_description> @@ -107,13 +107,13 @@ </method> </methods> <constants> - <constant name="STORAGE_RAW" value="0"> + <constant name="STORAGE_RAW" value="0" enum="Storage"> [Image] data is stored raw and unaltered. </constant> - <constant name="STORAGE_COMPRESS_LOSSY" value="1"> + <constant name="STORAGE_COMPRESS_LOSSY" value="1" enum="Storage"> [Image] data is compressed with a lossy algorithm. You can set the storage quality with [method set_lossy_storage_quality]. </constant> - <constant name="STORAGE_COMPRESS_LOSSLESS" value="2"> + <constant name="STORAGE_COMPRESS_LOSSLESS" value="2" enum="Storage"> [Image] data is compressed with a lossless algorithm. </constant> </constants> diff --git a/doc/classes/ImmediateGeometry.xml b/doc/classes/ImmediateGeometry.xml index 7ad09c3fe9..11b513fb84 100644 --- a/doc/classes/ImmediateGeometry.xml +++ b/doc/classes/ImmediateGeometry.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ImmediateGeometry" inherits="GeometryInstance" category="Core" version="3.0-alpha"> +<class name="ImmediateGeometry" inherits="GeometryInstance" category="Core" version="3.0-beta"> <brief_description> Draws simple geometry from code. </brief_description> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 114c8d2c59..1200ac5170 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Input" inherits="Object" category="Core" version="3.0-alpha"> +<class name="Input" inherits="Object" category="Core" version="3.0-beta"> <brief_description> A Singleton that deals with inputs. </brief_description> @@ -336,16 +336,16 @@ </signal> </signals> <constants> - <constant name="MOUSE_MODE_VISIBLE" value="0"> + <constant name="MOUSE_MODE_VISIBLE" value="0" enum="MouseMode"> Makes the mouse cursor visible if it is hidden. </constant> - <constant name="MOUSE_MODE_HIDDEN" value="1"> + <constant name="MOUSE_MODE_HIDDEN" value="1" enum="MouseMode"> Makes the mouse cursor hidden if it is visible. </constant> - <constant name="MOUSE_MODE_CAPTURED" value="2"> + <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. </constant> - <constant name="MOUSE_MODE_CONFINED" value="3"> + <constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode"> </constant> </constants> </class> diff --git a/doc/classes/InputDefault.xml b/doc/classes/InputDefault.xml index 9cbc993af1..28cba56334 100644 --- a/doc/classes/InputDefault.xml +++ b/doc/classes/InputDefault.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputDefault" inherits="Input" category="Core" version="3.0-alpha"> +<class name="InputDefault" inherits="Input" category="Core" version="3.0-beta"> <brief_description> Default implementation of the [Input] class. </brief_description> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 1cebed7efc..cc31da0627 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEvent" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="InputEvent" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Generic input event </brief_description> @@ -18,7 +18,7 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Returns [code]true[/code] if this event matches [code]event[event]. + Returns [code]true[/code] if this event matches [code]event[/code]. </description> </method> <method name="as_text" qualifiers="const"> @@ -28,13 +28,6 @@ Returns a [String] representation of the event. </description> </method> - <method name="get_device" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the device's id that generated the event. - </description> - </method> <method name="get_id" qualifiers="const"> <return type="int"> </return> @@ -90,14 +83,6 @@ Returns [code]true[/code] if this input event is pressed. Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. </description> </method> - <method name="set_device"> - <return type="void"> - </return> - <argument index="0" name="device" type="int"> - </argument> - <description> - </description> - </method> <method name="set_id"> <return type="void"> </return> diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index 13d3a14511..9d05c44498 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventAction" inherits="InputEvent" category="Core" version="3.0-alpha"> +<class name="InputEventAction" inherits="InputEvent" category="Core" version="3.0-beta"> <brief_description> 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 type of inputs. Actions can be created from the project settings menu [code]Project > Project Settings > Input Map[/code]. See [method Node._input]. </description> <tutorials> http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#actions @@ -12,28 +12,6 @@ <demos> </demos> <methods> - <method name="get_action" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_action"> - <return type="void"> - </return> - <argument index="0" name="action" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_pressed"> - <return type="void"> - </return> - <argument index="0" name="pressed" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="action" type="String" setter="set_action" getter="get_action"> diff --git a/doc/classes/InputEventGesture.xml b/doc/classes/InputEventGesture.xml new file mode 100644 index 0000000000..bf8f9667e3 --- /dev/null +++ b/doc/classes/InputEventGesture.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventGesture" inherits="InputEventWithModifiers" category="Core" version="3.0-beta"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="position" type="Vector2" setter="set_position" getter="get_position"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index fecd65e6a2..66c7320369 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.0-alpha"> +<class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.0-beta"> <brief_description> Input event for gamepad buttons. </brief_description> @@ -12,42 +12,6 @@ <demos> </demos> <methods> - <method name="get_button_index" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_pressure" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_button_index"> - <return type="void"> - </return> - <argument index="0" name="button_index" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_pressed"> - <return type="void"> - </return> - <argument index="0" name="pressed" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_pressure"> - <return type="void"> - </return> - <argument index="0" name="pressure" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index"> diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index a89c91fbe6..f52225d302 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0-alpha"> +<class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0-beta"> <brief_description> Input event type for gamepad joysticks and other motions. For buttons see [code]InputEventJoypadMotion[/code]. </brief_description> @@ -12,34 +12,6 @@ <demos> </demos> <methods> - <method name="get_axis" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_axis_value" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_axis"> - <return type="void"> - </return> - <argument index="0" name="axis" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_axis_value"> - <return type="void"> - </return> - <argument index="0" name="axis_value" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="axis" type="int" setter="set_axis" getter="get_axis"> diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 440e1347f8..c8cbab59d4 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.0-alpha"> +<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.0-beta"> <brief_description> Input event type for keyboard events. </brief_description> @@ -12,56 +12,12 @@ <demos> </demos> <methods> - <method name="get_scancode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_scancode_with_modifiers" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="get_unicode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_echo"> - <return type="void"> - </return> - <argument index="0" name="echo" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_pressed"> - <return type="void"> - </return> - <argument index="0" name="pressed" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_scancode"> - <return type="void"> - </return> - <argument index="0" name="scancode" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_unicode"> - <return type="void"> - </return> - <argument index="0" name="unicode" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="echo" type="bool" setter="set_echo" getter="is_echo"> diff --git a/doc/classes/InputEventMagnifyGesture.xml b/doc/classes/InputEventMagnifyGesture.xml new file mode 100644 index 0000000000..796f9e6a2f --- /dev/null +++ b/doc/classes/InputEventMagnifyGesture.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventMagnifyGesture" inherits="InputEventGesture" category="Core" version="3.0-beta"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="factor" type="float" setter="set_factor" getter="get_factor"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 24a771cef3..748cc4b9f9 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.0-alpha"> +<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.0-beta"> <brief_description> Base input event type for mouse events. </brief_description> @@ -12,48 +12,6 @@ <demos> </demos> <methods> - <method name="get_button_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_global_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_button_mask"> - <return type="void"> - </return> - <argument index="0" name="button_mask" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_global_position"> - <return type="void"> - </return> - <argument index="0" name="global_position" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask"> diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index ff7c1da34e..cd1037b022 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.0-alpha"> +<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.0-beta"> <brief_description> Input event type for mouse button events. </brief_description> @@ -12,56 +12,6 @@ <demos> </demos> <methods> - <method name="get_button_index" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_factor"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="is_doubleclick" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_button_index"> - <return type="void"> - </return> - <argument index="0" name="button_index" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_doubleclick"> - <return type="void"> - </return> - <argument index="0" name="doubleclick" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_factor"> - <return type="void"> - </return> - <argument index="0" name="factor" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_pressed"> - <return type="void"> - </return> - <argument index="0" name="pressed" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index"> diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 6c9165fea8..192c8dbe16 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMouseMotion" inherits="InputEventMouse" category="Core" version="3.0-alpha"> +<class name="InputEventMouseMotion" inherits="InputEventMouse" category="Core" version="3.0-beta"> <brief_description> Input event type for mouse motion events. </brief_description> @@ -12,34 +12,6 @@ <demos> </demos> <methods> - <method name="get_relative" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_speed" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_relative"> - <return type="void"> - </return> - <argument index="0" name="relative" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_speed"> - <return type="void"> - </return> - <argument index="0" name="speed" type="Vector2"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="relative" type="Vector2" setter="set_relative" getter="get_relative"> diff --git a/doc/classes/InputEventPanGesture.xml b/doc/classes/InputEventPanGesture.xml new file mode 100644 index 0000000000..a17f5823ba --- /dev/null +++ b/doc/classes/InputEventPanGesture.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventPanGesture" inherits="InputEventGesture" category="Core" version="3.0-beta"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="delta" type="Vector2" setter="set_delta" getter="get_delta"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index a68f444a7c..43553f97bd 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.0-alpha"> +<class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.0-beta"> <brief_description> Input event type for screen drag events. (only available on mobile devices) @@ -13,62 +13,6 @@ <demos> </demos> <methods> - <method name="get_index" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_relative" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_speed" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_index"> - <return type="void"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_relative"> - <return type="void"> - </return> - <argument index="0" name="relative" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_speed"> - <return type="void"> - </return> - <argument index="0" name="speed" type="Vector2"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="index" type="int" setter="set_index" getter="get_index"> diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index d0c7181e84..6f5ebc9481 100644 --- a/doc/classes/InputEventScreenTouch.xml +++ b/doc/classes/InputEventScreenTouch.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventScreenTouch" inherits="InputEvent" category="Core" version="3.0-alpha"> +<class name="InputEventScreenTouch" inherits="InputEvent" category="Core" version="3.0-beta"> <brief_description> Input event type for screen touch events. (only available on mobile devices) @@ -13,42 +13,6 @@ <demos> </demos> <methods> - <method name="get_index" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_index"> - <return type="void"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_pressed"> - <return type="void"> - </return> - <argument index="0" name="pressed" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="index" type="int" setter="set_index" getter="get_index"> diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index 8e5ffed149..70d2b57e8d 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.0-alpha"> +<class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.0-beta"> <brief_description> Base class for keys events with modifiers. </brief_description> @@ -12,76 +12,6 @@ <demos> </demos> <methods> - <method name="get_alt" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_command" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_control" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_metakey" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_shift" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_alt"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_command"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_control"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_metakey"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_shift"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="alt" type="bool" setter="set_alt" getter="get_alt"> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index a04b9e78ae..ff5491bde2 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputMap" inherits="Object" category="Core" version="3.0-alpha"> +<class name="InputMap" inherits="Object" category="Core" version="3.0-beta"> <brief_description> 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 [code]Project > Project Settings > Input Map[/code] or in code with [method add_action] and [method action_add_event]. See [method Node._input]. </description> <tutorials> http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#inputmap diff --git a/doc/classes/InstancePlaceholder.xml b/doc/classes/InstancePlaceholder.xml index 4105065cb6..570ce239ff 100644 --- a/doc/classes/InstancePlaceholder.xml +++ b/doc/classes/InstancePlaceholder.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InstancePlaceholder" inherits="Node" category="Core" version="3.0-alpha"> +<class name="InstancePlaceholder" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Placeholder for the root [Node] of a [PackedScene]. </brief_description> diff --git a/doc/classes/InterpolatedCamera.xml b/doc/classes/InterpolatedCamera.xml index bd532bec85..b268825efe 100644 --- a/doc/classes/InterpolatedCamera.xml +++ b/doc/classes/InterpolatedCamera.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InterpolatedCamera" inherits="Camera" category="Core" version="3.0-alpha"> +<class name="InterpolatedCamera" inherits="Camera" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,40 +9,6 @@ <demos> </demos> <methods> - <method name="get_speed" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_target_path" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="is_interpolation_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_interpolation_enabled"> - <return type="void"> - </return> - <argument index="0" name="target_path" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_speed"> - <return type="void"> - </return> - <argument index="0" name="speed" type="float"> - </argument> - <description> - </description> - </method> <method name="set_target"> <return type="void"> </return> @@ -51,14 +17,6 @@ <description> </description> </method> - <method name="set_target_path"> - <return type="void"> - </return> - <argument index="0" name="target_path" type="NodePath"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="enabled" type="bool" setter="set_interpolation_enabled" getter="is_interpolation_enabled"> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 950b43417b..f3d0c271ac 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ItemList" inherits="Control" category="Core" version="3.0-alpha"> +<class name="ItemList" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns. </brief_description> @@ -53,38 +53,12 @@ Ensure selection is visible, adjusting the scroll position as necessary. </description> </method> - <method name="get_allow_rmb_select" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether or not items may be selected via right mouse clicking. - </description> - </method> - <method name="get_fixed_column_width" qualifiers="const"> - <return type="int"> - </return> - <description> - If column size has been fixed to a value, return that value. - </description> - </method> <method name="get_fixed_icon_size" qualifiers="const"> <return type="Vector2"> </return> <description> </description> </method> - <method name="get_icon_mode" qualifiers="const"> - <return type="int" enum="ItemList.IconMode"> - </return> - <description> - </description> - </method> - <method name="get_icon_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_item_at_position" qualifiers="const"> <return type="int"> </return> @@ -153,26 +127,6 @@ Return tooltip hint for specified item index. </description> </method> - <method name="get_max_columns" qualifiers="const"> - <return type="int"> - </return> - <description> - Return total number of columns in use by the list. - </description> - </method> - <method name="get_max_text_lines" qualifiers="const"> - <return type="int"> - </return> - <description> - Return total number of lines currently in use by the list. - </description> - </method> - <method name="get_select_mode" qualifiers="const"> - <return type="int" enum="ItemList.SelectMode"> - </return> - <description> - </description> - </method> <method name="get_selected_items"> <return type="PoolIntArray"> </return> @@ -187,12 +141,6 @@ Returns the current vertical scroll bar for the List. </description> </method> - <method name="has_auto_height" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_item_disabled" qualifiers="const"> <return type="bool"> </return> @@ -220,13 +168,6 @@ Returns whether the tooltip is enabled for specified item index. </description> </method> - <method name="is_same_column_width" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether or not all columns of the list are of the same size. - </description> - </method> <method name="is_selected" qualifiers="const"> <return type="bool"> </return> @@ -257,32 +198,6 @@ Note: This method does not trigger the item selection signal. </description> </method> - <method name="set_allow_rmb_select"> - <return type="void"> - </return> - <argument index="0" name="allow" type="bool"> - </argument> - <description> - Allow (or disallow) selection of (selectable) items in the list using right mouse button. - </description> - </method> - <method name="set_auto_height"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_fixed_column_width"> - <return type="void"> - </return> - <argument index="0" name="width" type="int"> - </argument> - <description> - Set the size (width) all columns in the list are to use. - </description> - </method> <method name="set_fixed_icon_size"> <return type="void"> </return> @@ -291,22 +206,6 @@ <description> </description> </method> - <method name="set_icon_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="ItemList.IconMode"> - </argument> - <description> - </description> - </method> - <method name="set_icon_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="float"> - </argument> - <description> - </description> - </method> <method name="set_item_custom_bg_color"> <return type="void"> </return> @@ -405,41 +304,6 @@ Sets whether the tooltip is enabled for specified item index. </description> </method> - <method name="set_max_columns"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Set maximum number of columns to use for the list. - </description> - </method> - <method name="set_max_text_lines"> - <return type="void"> - </return> - <argument index="0" name="lines" type="int"> - </argument> - <description> - Set maximum number of lines to use for the list. - </description> - </method> - <method name="set_same_column_width"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Sets a fixed size (width) to use for all columns of the list. - </description> - </method> - <method name="set_select_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="ItemList.SelectMode"> - </argument> - <description> - </description> - </method> <method name="sort_items_by_text"> <return type="void"> </return> @@ -468,8 +332,6 @@ </member> <member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale"> </member> - <member name="items" type="Array" setter="_set_items" getter="_get_items"> - </member> <member name="max_columns" type="int" setter="set_max_columns" getter="get_max_columns"> </member> <member name="max_text_lines" type="int" setter="set_max_text_lines" getter="get_max_text_lines"> @@ -514,15 +376,25 @@ Fired when a multiple selection is altered on a list allowing multiple selection. </description> </signal> + <signal name="nothing_selected"> + <description> + </description> + </signal> + <signal name="rmb_clicked"> + <argument index="0" name="at_position" type="Vector2"> + </argument> + <description> + </description> + </signal> </signals> <constants> - <constant name="ICON_MODE_TOP" value="0"> + <constant name="ICON_MODE_TOP" value="0" enum="IconMode"> </constant> - <constant name="ICON_MODE_LEFT" value="1"> + <constant name="ICON_MODE_LEFT" value="1" enum="IconMode"> </constant> - <constant name="SELECT_SINGLE" value="0"> + <constant name="SELECT_SINGLE" value="0" enum="SelectMode"> </constant> - <constant name="SELECT_MULTI" value="1"> + <constant name="SELECT_MULTI" value="1" enum="SelectMode"> </constant> </constants> <theme_items> diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index e945a580db..28f04c3eb0 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JSON" inherits="Object" category="Core" version="3.0-alpha"> +<class name="JSON" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Helper class for parsing JSON data. </brief_description> <description> - Helper class for parsing JSON data. + Helper class for parsing JSON data. For usage example, see [JSONParseResult]. </description> <tutorials> </tutorials> @@ -25,6 +25,10 @@ </return> <argument index="0" name="value" type="Variant"> </argument> + <argument index="1" name="indent" type="String" default=""""> + </argument> + <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. </description> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 5bf9298f7a..835920818a 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JSONParseResult" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="JSONParseResult" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Data class wrapper for decoded JSON. </brief_description> @@ -11,82 +11,26 @@ <demos> </demos> <methods> - <method name="get_error" qualifiers="const"> - <return type="int" enum="Error"> - </return> - <description> - </description> - </method> - <method name="get_error_line" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_error_string" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_result" qualifiers="const"> - <return type="Variant"> - </return> - <description> - </description> - </method> - <method name="set_error"> - <return type="void"> - </return> - <argument index="0" name="error" type="int" enum="Error"> - </argument> - <description> - </description> - </method> - <method name="set_error_line"> - <return type="void"> - </return> - <argument index="0" name="error_line" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_error_string"> - <return type="void"> - </return> - <argument index="0" name="error_string" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_result"> - <return type="void"> - </return> - <argument index="0" name="result" type="Variant"> - </argument> - <description> - </description> - </method> </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 JSON source was not successfully parsed. See [@GlobalScope] ERR_* 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 [@GlobalScope] ERR_* 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 braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned. + 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] [codeblock] p = JSON.parse('["hello", "world", "!"]') if typeof(p) == TYPE_ARRAY: - print(p[0]) # prints 'hello' + print(p[0]) # prints 'hello' else: - print("unexpected results") + print("unexpected results") [/codeblock] </member> </members> diff --git a/doc/classes/JavaScript.xml b/doc/classes/JavaScript.xml new file mode 100644 index 0000000000..027e4764ac --- /dev/null +++ b/doc/classes/JavaScript.xml @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="JavaScript" inherits="Object" category="Core" version="3.0-beta"> + <brief_description> + 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. + </description> + <tutorials> + http://docs.godotengine.org/en/stable/learning/workflow/export/exporting_for_web.html#calling-javascript-from-script + </tutorials> + <demos> + </demos> + <methods> + <method name="eval"> + <return type="Variant"> + </return> + <argument index="0" name="code" type="String"> + </argument> + <argument index="1" name="use_global_execution_context" type="bool" default="false"> + </argument> + <description> + Execute the string [code]code[/code] as JavaScript code within the browser window. This is a call to the actual global JavaScript function [code]eval()[/code]. + If [code]use_global_execution_context[/code] is [code]true[/code], the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Joint.xml b/doc/classes/Joint.xml index 30ece8df1f..443aec21a8 100644 --- a/doc/classes/Joint.xml +++ b/doc/classes/Joint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Joint" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="Joint" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Base class for all 3D joints </brief_description> @@ -11,62 +11,6 @@ <demos> </demos> <methods> - <method name="get_exclude_nodes_from_collision" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_node_a" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="get_node_b" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="get_solver_priority" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_exclude_nodes_from_collision"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_node_a"> - <return type="void"> - </return> - <argument index="0" name="node" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="set_node_b"> - <return type="void"> - </return> - <argument index="0" name="node" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="set_solver_priority"> - <return type="void"> - </return> - <argument index="0" name="priority" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="collision/exclude_nodes" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision"> diff --git a/doc/classes/Joint2D.xml b/doc/classes/Joint2D.xml index df70a04f10..dec965cd09 100644 --- a/doc/classes/Joint2D.xml +++ b/doc/classes/Joint2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Joint2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Joint2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Base node for all joint constraints in 2D physics. </brief_description> @@ -11,66 +11,6 @@ <demos> </demos> <methods> - <method name="get_bias" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_exclude_nodes_from_collision" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_node_a" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - Return the path to the A node for the joint. - </description> - </method> - <method name="get_node_b" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - Return the path to the B node for the joint. - </description> - </method> - <method name="set_bias"> - <return type="void"> - </return> - <argument index="0" name="bias" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_exclude_nodes_from_collision"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_node_a"> - <return type="void"> - </return> - <argument index="0" name="node" type="NodePath"> - </argument> - <description> - Set the path to the A node for the joint. Must be of type [PhysicsBody2D]. - </description> - </method> - <method name="set_node_b"> - <return type="void"> - </return> - <argument index="0" name="node" type="NodePath"> - </argument> - <description> - Set the path to the B node for the joint. Must be of type [PhysicsBody2D]. - </description> - </method> </methods> <members> <member name="bias" type="float" setter="set_bias" getter="get_bias"> diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index b827db474d..d1dc236d40 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicBody" inherits="PhysicsBody" category="Core" version="3.0-alpha"> +<class name="KinematicBody" inherits="PhysicsBody" category="Core" version="3.0-beta"> <brief_description> Kinematic body 3D node. </brief_description> @@ -20,19 +20,13 @@ Returns the velocity of the floor. Only updates when calling [method move_and_slide]. </description> </method> - <method name="get_safe_margin" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_slide_collision"> <return type="KinematicCollision"> </return> <argument index="0" name="slide_idx" type="int"> </argument> <description> - Returns a [KinematicCollision], which contains information about a collision that occured 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). + Returns a [KinematicCollision], which contains information about a collision that occured 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). </description> </method> <method name="get_slide_count" qualifiers="const"> @@ -95,14 +89,6 @@ Returns the movement that remained when the body stopped. To get more detailed information about collisions that occured, use [method get_slide_collision]. </description> </method> - <method name="set_safe_margin"> - <return type="void"> - </return> - <argument index="0" name="pixels" type="float"> - </argument> - <description> - </description> - </method> <method name="test_move"> <return type="bool"> </return> @@ -116,6 +102,18 @@ </method> </methods> <members> + <member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> <member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin"> If the body is at least this close to another body, this body will consider them to be colliding. </member> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index 264e414ad4..8563b059f2 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-alpha"> +<class name="KinematicBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-beta"> <brief_description> Kinematic body 2D node. </brief_description> @@ -20,19 +20,13 @@ Returns the velocity of the floor. Only updates when calling [method move_and_slide]. </description> </method> - <method name="get_safe_margin" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_slide_collision"> <return type="KinematicCollision2D"> </return> <argument index="0" name="slide_idx" type="int"> </argument> <description> - Returns a [KinematicCollision2D], which contains information about a collision that occured 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). + Returns a [KinematicCollision2D], which contains information about a collision that occured 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). </description> </method> <method name="get_slide_count" qualifiers="const"> @@ -95,14 +89,6 @@ Returns the movement that remained when the body stopped. To get more detailed information about collisions that occured, use [method get_slide_collision]. </description> </method> - <method name="set_safe_margin"> - <return type="void"> - </return> - <argument index="0" name="pixels" type="float"> - </argument> - <description> - </description> - </method> <method name="test_move"> <return type="bool"> </return> diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml index ce82004839..9f25bece2c 100644 --- a/doc/classes/KinematicCollision.xml +++ b/doc/classes/KinematicCollision.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicCollision" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="KinematicCollision" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> - Collision data for KinematicBody2D 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. @@ -12,72 +12,6 @@ <demos> </demos> <methods> - <method name="get_collider" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="get_collider_id" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_collider_metadata" qualifiers="const"> - <return type="Variant"> - </return> - <description> - </description> - </method> - <method name="get_collider_shape" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="get_collider_shape_index" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_collider_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_local_shape" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="get_normal" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_remainder" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_travel" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> </methods> <members> <member name="collider" type="Object" setter="" getter="get_collider"> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index e498dea7a5..01b09f1c01 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicCollision2D" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="KinematicCollision2D" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Collision data for KinematicBody2D collisions. </brief_description> @@ -12,72 +12,6 @@ <demos> </demos> <methods> - <method name="get_collider" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="get_collider_id" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_collider_metadata" qualifiers="const"> - <return type="Variant"> - </return> - <description> - </description> - </method> - <method name="get_collider_shape" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="get_collider_shape_index" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_collider_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_local_shape" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="get_normal" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_remainder" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_travel" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> </methods> <members> <member name="collider" type="Object" setter="" getter="get_collider"> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 93d7b20491..089b81164b 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Label" inherits="Control" category="Core" version="3.0-alpha"> +<class name="Label" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Displays plain text in a line or wrapped inside a rectangle. For formatted text, use [RichTextLabel]. </brief_description> @@ -11,13 +11,6 @@ <demos> </demos> <methods> - <method name="get_align" qualifiers="const"> - <return type="int" enum="Label.Align"> - </return> - <description> - Returns the alignment mode (any of the ALIGN_* enumeration values). - </description> - </method> <method name="get_line_count" qualifiers="const"> <return type="int"> </return> @@ -32,34 +25,6 @@ Returns the font size in pixels. </description> </method> - <method name="get_lines_skipped" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the the number of lines to skip before displaying. - </description> - </method> - <method name="get_max_lines_visible" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the maximum number of lines to display. Returns -1 if unrestricted. - </description> - </method> - <method name="get_percent_visible" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the maximum number of characters to display as a percentage of the total text. - </description> - </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the label text. Text can contain newlines. - </description> - </method> <method name="get_total_character_count" qualifiers="const"> <return type="int"> </return> @@ -67,13 +32,6 @@ Returns the total length of the text. </description> </method> - <method name="get_valign" qualifiers="const"> - <return type="int" enum="Label.VAlign"> - </return> - <description> - Returns the vertical alignment mode (any of the VALIGN_* enumeration values). - </description> - </method> <method name="get_visible_characters" qualifiers="const"> <return type="int"> </return> @@ -88,108 +46,6 @@ Returns the number of lines shown. Useful if the [code]Label[/code] 's height cannot currently display all lines. </description> </method> - <method name="has_autowrap" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if [i]autowrap[/i] mode (see [method set_autowrap]). - </description> - </method> - <method name="is_clipping_text" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if text would be cut off if it is too wide. - </description> - </method> - <method name="is_uppercase" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if text is displayed in all capitals. - </description> - </method> - <method name="set_align"> - <return type="void"> - </return> - <argument index="0" name="align" type="int" enum="Label.Align"> - </argument> - <description> - Sets the alignment mode to any of the ALIGN_* enumeration values. - </description> - </method> - <method name="set_autowrap"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set [i]autowrap[/i] mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows. - </description> - </method> - <method name="set_clip_text"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Cuts off the rest of the text if it is too wide. - </description> - </method> - <method name="set_lines_skipped"> - <return type="void"> - </return> - <argument index="0" name="lines_skipped" type="int"> - </argument> - <description> - Sets the number of lines to skip before displaying. Useful for scrolling text. - </description> - </method> - <method name="set_max_lines_visible"> - <return type="void"> - </return> - <argument index="0" name="lines_visible" type="int"> - </argument> - <description> - Restricts the number of lines to display. Set to -1 to disable. - </description> - </method> - <method name="set_percent_visible"> - <return type="void"> - </return> - <argument index="0" name="percent_visible" type="float"> - </argument> - <description> - Restricts the number of characters to display (as a percentage of the total text). - </description> - </method> - <method name="set_text"> - <return type="void"> - </return> - <argument index="0" name="text" type="String"> - </argument> - <description> - Set the label text. Text can contain newlines. - </description> - </method> - <method name="set_uppercase"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Display text in all capitals. - </description> - </method> - <method name="set_valign"> - <return type="void"> - </return> - <argument index="0" name="valign" type="int" enum="Label.VAlign"> - </argument> - <description> - Sets the vertical alignment mode to any of the VALIGN_* enumeration values. - </description> - </method> <method name="set_visible_characters"> <return type="void"> </return> @@ -230,28 +86,28 @@ </member> </members> <constants> - <constant name="ALIGN_LEFT" value="0"> + <constant name="ALIGN_LEFT" value="0" enum="Align"> Align rows to the left (default). </constant> - <constant name="ALIGN_CENTER" value="1"> + <constant name="ALIGN_CENTER" value="1" enum="Align"> Align rows centered. </constant> - <constant name="ALIGN_RIGHT" value="2"> + <constant name="ALIGN_RIGHT" value="2" enum="Align"> Align rows to the right (default). </constant> - <constant name="ALIGN_FILL" value="3"> + <constant name="ALIGN_FILL" value="3" enum="Align"> Expand row whitespaces to fit the width. </constant> - <constant name="VALIGN_TOP" value="0"> + <constant name="VALIGN_TOP" value="0" enum="VAlign"> Align the whole text to the top. </constant> - <constant name="VALIGN_CENTER" value="1"> + <constant name="VALIGN_CENTER" value="1" enum="VAlign"> Align the whole text to the center. </constant> - <constant name="VALIGN_BOTTOM" value="2"> + <constant name="VALIGN_BOTTOM" value="2" enum="VAlign"> Align the whole text to the bottom. </constant> - <constant name="VALIGN_FILL" value="3"> + <constant name="VALIGN_FILL" value="3" enum="VAlign"> Align the whole text by spreading the rows. </constant> </constants> diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml index 6ec3c80bca..9d79034dea 100644 --- a/doc/classes/LargeTexture.xml +++ b/doc/classes/LargeTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LargeTexture" inherits="Texture" category="Core" version="3.0-alpha"> +<class name="LargeTexture" inherits="Texture" category="Core" version="3.0-beta"> <brief_description> A Texture capable of storing many smaller Textures with offsets. </brief_description> @@ -87,14 +87,6 @@ </description> </method> </methods> - <members> - <member name="_data" type="Array" setter="_set_data" getter="_get_data"> - Returns an [Array] with offsets and textures data of each added piece. Schema is [offsets1, texture1, offsets2, texture2, large_texture_size]. - [code]offsets[/code] : [Vector2] offsets of the texture piece. - [code]second[/code] : [StreamTexture] data of the texture piece. - [code]last entry[/code] : [Vector2] size of the entire large texture. - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index 1c625d59e1..e4f92cc9b3 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Light" inherits="VisualInstance" category="Core" version="3.0-alpha"> +<class name="Light" inherits="VisualInstance" category="Core" version="3.0-beta"> <brief_description> Provides a base class for different kinds of light nodes. </brief_description> @@ -11,122 +11,6 @@ <demos> </demos> <methods> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_cull_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="Light.Param"> - </argument> - <description> - </description> - </method> - <method name="get_shadow_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_shadow_reverse_cull_face" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="has_shadow" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_editor_only" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_negative" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_cull_mask"> - <return type="void"> - </return> - <argument index="0" name="cull_mask" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_editor_only"> - <return type="void"> - </return> - <argument index="0" name="editor_only" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_negative"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_param"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="Light.Param"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_shadow"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_shadow_color"> - <return type="void"> - </return> - <argument index="0" name="shadow_color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_shadow_reverse_cull_face"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only"> @@ -137,6 +21,8 @@ </member> <member name="light_energy" type="float" setter="set_param" getter="get_param"> </member> + <member name="light_indirect_energy" type="float" setter="set_param" getter="get_param"> + </member> <member name="light_negative" type="bool" setter="set_negative" getter="is_negative"> </member> <member name="light_specular" type="float" setter="set_param" getter="get_param"> @@ -153,35 +39,37 @@ </member> </members> <constants> - <constant name="PARAM_ENERGY" value="0"> + <constant name="PARAM_ENERGY" value="0" enum="Param"> + </constant> + <constant name="PARAM_INDIRECT_ENERGY" value="1" enum="Param"> </constant> - <constant name="PARAM_SPECULAR" value="1"> + <constant name="PARAM_SPECULAR" value="2" enum="Param"> </constant> - <constant name="PARAM_RANGE" value="2"> + <constant name="PARAM_RANGE" value="3" enum="Param"> </constant> - <constant name="PARAM_ATTENUATION" value="3"> + <constant name="PARAM_ATTENUATION" value="4" enum="Param"> </constant> - <constant name="PARAM_SPOT_ANGLE" value="4"> + <constant name="PARAM_SPOT_ANGLE" value="5" enum="Param"> </constant> - <constant name="PARAM_SPOT_ATTENUATION" value="5"> + <constant name="PARAM_SPOT_ATTENUATION" value="6" enum="Param"> </constant> - <constant name="PARAM_CONTACT_SHADOW_SIZE" value="6"> + <constant name="PARAM_CONTACT_SHADOW_SIZE" value="7" enum="Param"> </constant> - <constant name="PARAM_SHADOW_MAX_DISTANCE" value="7"> + <constant name="PARAM_SHADOW_MAX_DISTANCE" value="8" enum="Param"> </constant> - <constant name="PARAM_SHADOW_SPLIT_1_OFFSET" value="8"> + <constant name="PARAM_SHADOW_SPLIT_1_OFFSET" value="9" enum="Param"> </constant> - <constant name="PARAM_SHADOW_SPLIT_2_OFFSET" value="9"> + <constant name="PARAM_SHADOW_SPLIT_2_OFFSET" value="10" enum="Param"> </constant> - <constant name="PARAM_SHADOW_SPLIT_3_OFFSET" value="10"> + <constant name="PARAM_SHADOW_SPLIT_3_OFFSET" value="11" enum="Param"> </constant> - <constant name="PARAM_SHADOW_NORMAL_BIAS" value="11"> + <constant name="PARAM_SHADOW_NORMAL_BIAS" value="12" enum="Param"> </constant> - <constant name="PARAM_SHADOW_BIAS" value="12"> + <constant name="PARAM_SHADOW_BIAS" value="13" enum="Param"> </constant> - <constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="13"> + <constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14" enum="Param"> </constant> - <constant name="PARAM_MAX" value="14"> + <constant name="PARAM_MAX" value="15" enum="Param"> </constant> </constants> </class> diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 285d302ba7..fe1f25ad9e 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Light2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Light2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Casts light in a 2D environment. </brief_description> @@ -11,332 +11,6 @@ <demos> </demos> <methods> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - Return the color of the Light2D. - </description> - </method> - <method name="get_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the energy value of the Light2D. - </description> - </method> - <method name="get_height" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the height of the Light2D. Used with 2D normalmapping. - </description> - </method> - <method name="get_item_cull_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_item_shadow_cull_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_layer_range_max" qualifiers="const"> - <return type="int"> - </return> - <description> - Set the maximum layer value of objects of the scene that are affected by the Light2D. - </description> - </method> - <method name="get_layer_range_min" qualifiers="const"> - <return type="int"> - </return> - <description> - Get the minimum layer value of objects of the scene that are affected by the Light2D. - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int" enum="Light2D.Mode"> - </return> - <description> - Return the current mode set to the Light2D. - </description> - </method> - <method name="get_shadow_buffer_size" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the shadow buffer size. - </description> - </method> - <method name="get_shadow_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - Return the color of casted shadows for this Light2D. - </description> - </method> - <method name="get_shadow_filter" qualifiers="const"> - <return type="int" enum="Light2D.ShadowFilter"> - </return> - <description> - </description> - </method> - <method name="get_shadow_gradient_length" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_shadow_smooth" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - Return the texture of the Light2D. - </description> - </method> - <method name="get_texture_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the offset of the light texture. - </description> - </method> - <method name="get_texture_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the scale value of the light texture. - </description> - </method> - <method name="get_z_range_max" qualifiers="const"> - <return type="int"> - </return> - <description> - Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D. - </description> - </method> - <method name="get_z_range_min" qualifiers="const"> - <return type="int"> - </return> - <description> - Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. - </description> - </method> - <method name="is_editor_only" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the Light2D is enabled, false if it is not. - </description> - </method> - <method name="is_shadow_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if shadow casting is enabled for this Light2D, else return false. - </description> - </method> - <method name="set_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - Set the color of the Light2D. - </description> - </method> - <method name="set_editor_only"> - <return type="void"> - </return> - <argument index="0" name="editor_only" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Switches the Light2D on or off, depending on the 'enabled' parameter. - </description> - </method> - <method name="set_energy"> - <return type="void"> - </return> - <argument index="0" name="energy" type="float"> - </argument> - <description> - Set the energy value of the Light2D. The bigger the value, the stronger the light. - </description> - </method> - <method name="set_height"> - <return type="void"> - </return> - <argument index="0" name="height" type="float"> - </argument> - <description> - Set the height of the Light2D. Used with 2D normalmapping. - </description> - </method> - <method name="set_item_cull_mask"> - <return type="void"> - </return> - <argument index="0" name="item_cull_mask" type="int"> - </argument> - <description> - Set the item mask of the Light2D to 'item_mask' value. - </description> - </method> - <method name="set_item_shadow_cull_mask"> - <return type="void"> - </return> - <argument index="0" name="item_shadow_cull_mask" type="int"> - </argument> - <description> - Set the item shadow mask to 'item_shadow_mask' value. - </description> - </method> - <method name="set_layer_range_max"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - Set the maximum layer value of objects of the scene that are affected by the Light2D. - </description> - </method> - <method name="set_layer_range_min"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - Set the minimum layer value of objects of the scene that are affected by the Light2D. - </description> - </method> - <method name="set_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Light2D.Mode"> - </argument> - <description> - Set the behaviour mode of the Light2D. Use constants defined in the constants section. - </description> - </method> - <method name="set_shadow_buffer_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="int"> - </argument> - <description> - Set the shadow buffer size. - </description> - </method> - <method name="set_shadow_color"> - <return type="void"> - </return> - <argument index="0" name="shadow_color" type="Color"> - </argument> - <description> - Set the color of casted shadows for this Light2D. - </description> - </method> - <method name="set_shadow_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. - </description> - </method> - <method name="set_shadow_filter"> - <return type="void"> - </return> - <argument index="0" name="filter" type="int" enum="Light2D.ShadowFilter"> - </argument> - <description> - </description> - </method> - <method name="set_shadow_gradient_length"> - <return type="void"> - </return> - <argument index="0" name="multiplier" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_shadow_smooth"> - <return type="void"> - </return> - <argument index="0" name="smooth" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - Set the texture of the Light2D. - </description> - </method> - <method name="set_texture_offset"> - <return type="void"> - </return> - <argument index="0" name="texture_offset" type="Vector2"> - </argument> - <description> - Set the offset of the light texture. - </description> - </method> - <method name="set_texture_scale"> - <return type="void"> - </return> - <argument index="0" name="texture_scale" type="float"> - </argument> - <description> - Set the scale value of the light texture. - </description> - </method> - <method name="set_z_range_max"> - <return type="void"> - </return> - <argument index="0" name="z" type="int"> - </argument> - <description> - Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. - </description> - </method> - <method name="set_z_range_min"> - <return type="void"> - </return> - <argument index="0" name="z" type="int"> - </argument> - <description> - Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. - </description> - </method> </methods> <members> <member name="color" type="Color" setter="set_color" getter="get_color"> @@ -404,34 +78,34 @@ </member> </members> <constants> - <constant name="MODE_ADD" value="0"> + <constant name="MODE_ADD" value="0" enum="Mode"> Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. </constant> - <constant name="MODE_SUB" value="1"> + <constant name="MODE_SUB" value="1" enum="Mode"> Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. </constant> - <constant name="MODE_MIX" value="2"> + <constant name="MODE_MIX" value="2" enum="Mode"> Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. </constant> - <constant name="MODE_MASK" value="3"> + <constant name="MODE_MASK" value="3" enum="Mode"> The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. </constant> - <constant name="SHADOW_FILTER_NONE" value="0"> + <constant name="SHADOW_FILTER_NONE" value="0" enum="ShadowFilter"> No filter applies to the shadow map. See [method shadow_filter]. </constant> - <constant name="SHADOW_FILTER_PCF3" value="1"> + <constant name="SHADOW_FILTER_PCF3" value="1" enum="ShadowFilter"> Percentage closer filtering (3 samples) applies to the shadow map. See [method shadow_filter]. </constant> - <constant name="SHADOW_FILTER_PCF5" value="2"> + <constant name="SHADOW_FILTER_PCF5" value="2" enum="ShadowFilter"> Percentage closer filtering (5 samples) applies to the shadow map. See [method shadow_filter]. </constant> - <constant name="SHADOW_FILTER_PCF7" value="3"> + <constant name="SHADOW_FILTER_PCF7" value="3" enum="ShadowFilter"> Percentage closer filtering (7 samples) applies to the shadow map. See [method shadow_filter]. </constant> - <constant name="SHADOW_FILTER_PCF9" value="4"> + <constant name="SHADOW_FILTER_PCF9" value="4" enum="ShadowFilter"> Percentage closer filtering (9 samples) applies to the shadow map. See [method shadow_filter]. </constant> - <constant name="SHADOW_FILTER_PCF13" value="5"> + <constant name="SHADOW_FILTER_PCF13" value="5" enum="ShadowFilter"> Percentage closer filtering (13 samples) applies to the shadow map. See [method shadow_filter]. </constant> </constants> diff --git a/doc/classes/LightOccluder2D.xml b/doc/classes/LightOccluder2D.xml index 9a1b84158b..de42b2812c 100644 --- a/doc/classes/LightOccluder2D.xml +++ b/doc/classes/LightOccluder2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LightOccluder2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="LightOccluder2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Occludes light cast by a Light2D, casting shadows. </brief_description> @@ -11,38 +11,6 @@ <demos> </demos> <methods> - <method name="get_occluder_light_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the light mask of the LightOccluder2D. - </description> - </method> - <method name="get_occluder_polygon" qualifiers="const"> - <return type="OccluderPolygon2D"> - </return> - <description> - Return the OccluderPolygon2D that defines the LightOccluder2D. - </description> - </method> - <method name="set_occluder_light_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s). - </description> - </method> - <method name="set_occluder_polygon"> - <return type="void"> - </return> - <argument index="0" name="polygon" type="OccluderPolygon2D"> - </argument> - <description> - Set the OccluderPolygon2D that defines the LightOccluder2D. - </description> - </method> </methods> <members> <member name="light_mask" type="int" setter="set_occluder_light_mask" getter="get_occluder_light_mask"> diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index f49a806f0e..9455882f02 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Line2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Line2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> A 2D line. </brief_description> @@ -20,36 +20,6 @@ Add a point at the [code]position[/code]. Appends the point at the end of the line. </description> </method> - <method name="get_begin_cap_mode" qualifiers="const"> - <return type="int" enum="Line2D.LineCapMode"> - </return> - <description> - </description> - </method> - <method name="get_default_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_end_cap_mode" qualifiers="const"> - <return type="int" enum="Line2D.LineCapMode"> - </return> - <description> - </description> - </method> - <method name="get_gradient" qualifiers="const"> - <return type="Gradient"> - </return> - <description> - </description> - </method> - <method name="get_joint_mode" qualifiers="const"> - <return type="int" enum="Line2D.LineJointMode"> - </return> - <description> - </description> - </method> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> @@ -63,43 +33,7 @@ <argument index="0" name="i" type="int"> </argument> <description> - Returns point [code]i[code]'s position. - </description> - </method> - <method name="get_points" qualifiers="const"> - <return type="PoolVector2Array"> - </return> - <description> - </description> - </method> - <method name="get_round_precision" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_sharp_limit" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_texture_mode" qualifiers="const"> - <return type="int" enum="Line2D.LineTextureMode"> - </return> - <description> - </description> - </method> - <method name="get_width" qualifiers="const"> - <return type="float"> - </return> - <description> + Returns point [code]i[/code]'s position. </description> </method> <method name="remove_point"> @@ -111,46 +45,6 @@ Remove the point at index [code]i[/code] from the line. </description> </method> - <method name="set_begin_cap_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Line2D.LineCapMode"> - </argument> - <description> - </description> - </method> - <method name="set_default_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_end_cap_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Line2D.LineCapMode"> - </argument> - <description> - </description> - </method> - <method name="set_gradient"> - <return type="void"> - </return> - <argument index="0" name="color" type="Gradient"> - </argument> - <description> - </description> - </method> - <method name="set_joint_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Line2D.LineJointMode"> - </argument> - <description> - </description> - </method> <method name="set_point_position"> <return type="void"> </return> @@ -162,54 +56,6 @@ Overwites the position in point [code]i[/code] with the supplied [code]position[/code]. </description> </method> - <method name="set_points"> - <return type="void"> - </return> - <argument index="0" name="points" type="PoolVector2Array"> - </argument> - <description> - </description> - </method> - <method name="set_round_precision"> - <return type="void"> - </return> - <argument index="0" name="precision" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_sharp_limit"> - <return type="void"> - </return> - <argument index="0" name="limit" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_texture_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Line2D.LineTextureMode"> - </argument> - <description> - </description> - </method> - <method name="set_width"> - <return type="void"> - </return> - <argument index="0" name="width" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="begin_cap_mode" type="int" setter="set_begin_cap_mode" getter="get_begin_cap_mode" enum="Line2D.LineCapMode"> @@ -247,28 +93,28 @@ </member> </members> <constants> - <constant name="LINE_JOINT_SHARP" value="0"> + <constant name="LINE_JOINT_SHARP" value="0" enum="LineJointMode"> The line's joints will be pointy. If [code]sharp_limit[/code] is greater than the rotation of a joint, it becomes a bevel joint instead. </constant> - <constant name="LINE_JOINT_BEVEL" value="1"> + <constant name="LINE_JOINT_BEVEL" value="1" enum="LineJointMode"> The line's joints will be bevelled/chamfered. </constant> - <constant name="LINE_JOINT_ROUND" value="2"> + <constant name="LINE_JOINT_ROUND" value="2" enum="LineJointMode"> The line's joints will be rounded. </constant> - <constant name="LINE_CAP_NONE" value="0"> + <constant name="LINE_CAP_NONE" value="0" enum="LineCapMode"> Don't have a line cap. </constant> - <constant name="LINE_CAP_BOX" value="1"> + <constant name="LINE_CAP_BOX" value="1" enum="LineCapMode"> Draws the line cap as a box. </constant> - <constant name="LINE_CAP_ROUND" value="2"> + <constant name="LINE_CAP_ROUND" value="2" enum="LineCapMode"> Draws the line cap as a circle. </constant> - <constant name="LINE_TEXTURE_NONE" value="0"> + <constant name="LINE_TEXTURE_NONE" value="0" enum="LineTextureMode"> Takes the left pixels of the texture and renders it over the whole line. </constant> - <constant name="LINE_TEXTURE_TILE" value="1"> + <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. </constant> </constants> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 432f583566..9a03d4e0c1 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LineEdit" inherits="Control" category="Core" version="3.0-alpha"> +<class name="LineEdit" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Control that provides single line string editing. </brief_description> @@ -27,45 +27,6 @@ Erases the [LineEdit] text. </description> </method> - <method name="cursor_get_blink_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Gets whether the line edit caret is blinking. - </description> - </method> - <method name="cursor_get_blink_speed" qualifiers="const"> - <return type="float"> - </return> - <description> - Gets the line edit caret blink speed. - </description> - </method> - <method name="cursor_set_blink_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set the line edit caret to blink. - </description> - </method> - <method name="cursor_set_blink_speed"> - <return type="void"> - </return> - <argument index="0" name="blink_speed" type="float"> - </argument> - <description> - Set the line edit caret blink speed. Cannot be less then or equal to 0. - </description> - </method> - <method name="get_align" qualifiers="const"> - <return type="int" enum="LineEdit.Align"> - </return> - <description> - Return the align mode of the [code]LineEdit[/code]. - </description> - </method> <method name="get_cursor_position" qualifiers="const"> <return type="int"> </return> @@ -73,19 +34,6 @@ Returns the cursor position inside the [code]LineEdit[/code]. </description> </method> - <method name="get_expand_to_text_length" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_max_length" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the maximum amount of characters the [code]LineEdit[/code] can edit. If 0 is returned, no limit exists. - </description> - </method> <method name="get_menu" qualifiers="const"> <return type="PopupMenu"> </return> @@ -93,48 +41,6 @@ Returns the [PopupMenu] of this [code]LineEdit[/code]. By default, this menu is displayed when right-clicking on the [LineEdit]. </description> </method> - <method name="get_placeholder" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the placeholder text. - </description> - </method> - <method name="get_placeholder_alpha" qualifiers="const"> - <return type="float"> - </return> - <description> - Return transparency of the placeholder text. - </description> - </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the text in the [code]LineEdit[/code]. - </description> - </method> - <method name="is_context_menu_enabled"> - <return type="bool"> - </return> - <description> - Returns true if the context menu is enabled. - </description> - </method> - <method name="is_editable" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return the [i]editable[/i] status of the [code]LineEdit[/code] (see [method set_editable]). - </description> - </method> - <method name="is_secret" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return the [i]secret[/i] status of the [code]LineEdit[/code] (see [method set_secret]). - </description> - </method> <method name="menu_option"> <return type="void"> </return> @@ -168,24 +74,6 @@ Selects the whole [String]. </description> </method> - <method name="set_align"> - <return type="void"> - </return> - <argument index="0" name="align" type="int" enum="LineEdit.Align"> - </argument> - <description> - Set text alignment of the [code]LineEdit[/code]. - </description> - </method> - <method name="set_context_menu_enabled"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set the status of the context menu. When enabled, the context menu will appear when the [code]LineEdit[/code] is right clicked. - </description> - </method> <method name="set_cursor_position"> <return type="void"> </return> @@ -195,68 +83,6 @@ Sets the cursor position inside the [code]LineEdit[/code]. The text may scroll if needed. </description> </method> - <method name="set_editable"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set the [i]editable[/i] status of the [code]LineEdit[/code]. When disabled, existing text can't be modified and new text can't be added. - </description> - </method> - <method name="set_expand_to_text_length"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_max_length"> - <return type="void"> - </return> - <argument index="0" name="chars" type="int"> - </argument> - <description> - Set the maximum amount of characters the [code]LineEdit[/code] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. - </description> - </method> - <method name="set_placeholder"> - <return type="void"> - </return> - <argument index="0" name="text" type="String"> - </argument> - <description> - Set the placeholder text. - </description> - </method> - <method name="set_placeholder_alpha"> - <return type="void"> - </return> - <argument index="0" name="alpha" type="float"> - </argument> - <description> - Set transparency of the placeholder text. - </description> - </method> - <method name="set_secret"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set the [i]secret[/i] status of the [code]LineEdit[/code]. When enabled, every character is displayed as "*". - </description> - </method> - <method name="set_text"> - <return type="void"> - </return> - <argument index="0" name="text" type="String"> - </argument> - <description> - Set the text in the [code]LineEdit[/code], clearing the existing one and the selection. - </description> - </method> </methods> <members> <member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align"> @@ -274,7 +100,7 @@ <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. </member> - <member name="expand_to_len" type="bool" setter="set_expand_to_text_length" getter="get_expand_to_text_length"> + <member name="expand_to_text_length" type="bool" setter="set_expand_to_text_length" getter="get_expand_to_text_length"> If [code]true[/code] the [LineEdit] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened. </member> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode"> @@ -313,39 +139,39 @@ </signal> </signals> <constants> - <constant name="ALIGN_LEFT" value="0"> + <constant name="ALIGN_LEFT" value="0" enum="Align"> Aligns the text on the left hand side of the [LineEdit]. </constant> - <constant name="ALIGN_CENTER" value="1"> + <constant name="ALIGN_CENTER" value="1" enum="Align"> Centers the text in the middle of the [LineEdit]. </constant> - <constant name="ALIGN_RIGHT" value="2"> + <constant name="ALIGN_RIGHT" value="2" enum="Align"> Aligns the text on the right hand side of the [LineEdit]. </constant> - <constant name="ALIGN_FILL" value="3"> + <constant name="ALIGN_FILL" value="3" enum="Align"> Stretches whitespaces to fit the [LineEdit]'s width. </constant> - <constant name="MENU_CUT" value="0"> + <constant name="MENU_CUT" value="0" enum="MenuItems"> Cuts (Copies and clears) the selected text. </constant> - <constant name="MENU_COPY" value="1"> + <constant name="MENU_COPY" value="1" enum="MenuItems"> Copies the selected text. </constant> - <constant name="MENU_PASTE" value="2"> + <constant name="MENU_PASTE" value="2" enum="MenuItems"> Pastes the clipboard text over the selected text (or at the cursor's position). </constant> - <constant name="MENU_CLEAR" value="3"> + <constant name="MENU_CLEAR" value="3" enum="MenuItems"> Erases the whole [Linedit] text. </constant> - <constant name="MENU_SELECT_ALL" value="4"> + <constant name="MENU_SELECT_ALL" value="4" enum="MenuItems"> Selects the whole [Linedit] text. </constant> - <constant name="MENU_UNDO" value="5"> + <constant name="MENU_UNDO" value="5" enum="MenuItems"> Undoes the previous action. </constant> - <constant name="MENU_REDO" value="6"> + <constant name="MENU_REDO" value="6" enum="MenuItems"> </constant> - <constant name="MENU_MAX" value="7"> + <constant name="MENU_MAX" value="7" enum="MenuItems"> </constant> </constants> <theme_items> diff --git a/doc/classes/LineShape2D.xml b/doc/classes/LineShape2D.xml index 6ae6fad6f4..e55676fd59 100644 --- a/doc/classes/LineShape2D.xml +++ b/doc/classes/LineShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LineShape2D" inherits="Shape2D" category="Core" version="3.0-alpha"> +<class name="LineShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> <brief_description> Line shape for 2D collisions. </brief_description> @@ -11,38 +11,6 @@ <demos> </demos> <methods> - <method name="get_d" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the line distance from the origin. - </description> - </method> - <method name="get_normal" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the line normal. - </description> - </method> - <method name="set_d"> - <return type="void"> - </return> - <argument index="0" name="d" type="float"> - </argument> - <description> - Set the line distance from the origin. - </description> - </method> - <method name="set_normal"> - <return type="void"> - </return> - <argument index="0" name="normal" type="Vector2"> - </argument> - <description> - Set the line normal. - </description> - </method> </methods> <members> <member name="d" type="float" setter="set_d" getter="get_d"> diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index d13a0d7be6..82b3a90180 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LinkButton" inherits="BaseButton" category="Core" version="3.0-alpha"> +<class name="LinkButton" inherits="BaseButton" category="Core" version="3.0-beta"> <brief_description> Simple button used to represent a link to some resource </brief_description> @@ -11,38 +11,6 @@ <demos> </demos> <methods> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the text of the button. - </description> - </method> - <method name="get_underline_mode" qualifiers="const"> - <return type="int" enum="LinkButton.UnderlineMode"> - </return> - <description> - Returns the underline mode for this button. - </description> - </method> - <method name="set_text"> - <return type="void"> - </return> - <argument index="0" name="text" type="String"> - </argument> - <description> - Sets the text of the button. - </description> - </method> - <method name="set_underline_mode"> - <return type="void"> - </return> - <argument index="0" name="underline_mode" type="int" enum="LinkButton.UnderlineMode"> - </argument> - <description> - Sets the underline mode for this button, the argument must be one of the [code]LinkButton[/code] constants (see constants section). - </description> - </method> </methods> <members> <member name="text" type="String" setter="set_text" getter="get_text"> @@ -51,17 +19,19 @@ </member> </members> <constants> - <constant name="UNDERLINE_MODE_ALWAYS" value="0"> + <constant name="UNDERLINE_MODE_ALWAYS" value="0" enum="UnderlineMode"> The LinkButton will always show an underline at the bottom of its text </constant> - <constant name="UNDERLINE_MODE_ON_HOVER" value="1"> + <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. </constant> - <constant name="UNDERLINE_MODE_NEVER" value="2"> + <constant name="UNDERLINE_MODE_NEVER" value="2" enum="UnderlineMode"> The LinkButton will never show an underline at the bottom of its text. </constant> </constants> <theme_items> + <theme_item name="focus" type="StyleBox"> + </theme_item> <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> diff --git a/doc/classes/Listener.xml b/doc/classes/Listener.xml index 742198acd0..3b21e3fdac 100644 --- a/doc/classes/Listener.xml +++ b/doc/classes/Listener.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Listener" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="Listener" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index 048b13a7ca..c5a4e53907 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MainLoop" inherits="Object" category="Core" version="3.0-alpha"> +<class name="MainLoop" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Main loop is the abstract main loop base class. </brief_description> @@ -114,25 +114,25 @@ </method> </methods> <constants> - <constant name="NOTIFICATION_WM_MOUSE_ENTER" value="2" enum=""> + <constant name="NOTIFICATION_WM_MOUSE_ENTER" value="2"> </constant> - <constant name="NOTIFICATION_WM_MOUSE_EXIT" value="3" enum=""> + <constant name="NOTIFICATION_WM_MOUSE_EXIT" value="3"> </constant> - <constant name="NOTIFICATION_WM_FOCUS_IN" value="4" enum=""> + <constant name="NOTIFICATION_WM_FOCUS_IN" value="4"> </constant> - <constant name="NOTIFICATION_WM_FOCUS_OUT" value="5" enum=""> + <constant name="NOTIFICATION_WM_FOCUS_OUT" value="5"> </constant> - <constant name="NOTIFICATION_WM_QUIT_REQUEST" value="6" enum=""> + <constant name="NOTIFICATION_WM_QUIT_REQUEST" value="6"> </constant> - <constant name="NOTIFICATION_WM_GO_BACK_REQUEST" value="7" enum=""> + <constant name="NOTIFICATION_WM_GO_BACK_REQUEST" value="7"> </constant> - <constant name="NOTIFICATION_WM_UNFOCUS_REQUEST" value="8" enum=""> + <constant name="NOTIFICATION_WM_UNFOCUS_REQUEST" value="8"> </constant> - <constant name="NOTIFICATION_OS_MEMORY_WARNING" value="9" enum=""> + <constant name="NOTIFICATION_OS_MEMORY_WARNING" value="9"> </constant> - <constant name="NOTIFICATION_TRANSLATION_CHANGED" value="90" enum=""> + <constant name="NOTIFICATION_TRANSLATION_CHANGED" value="90"> </constant> - <constant name="NOTIFICATION_WM_ABOUT" value="91" enum=""> + <constant name="NOTIFICATION_WM_ABOUT" value="91"> </constant> </constants> </class> diff --git a/doc/classes/MarginContainer.xml b/doc/classes/MarginContainer.xml index 1c748de229..c56f9a5c58 100644 --- a/doc/classes/MarginContainer.xml +++ b/doc/classes/MarginContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MarginContainer" inherits="Container" category="Core" version="3.0-alpha"> +<class name="MarginContainer" inherits="Container" category="Core" version="3.0-beta"> <brief_description> Simple margin container. </brief_description> diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index 0e561ab374..d83c81a960 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Marshalls" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="Marshalls" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Data transformation (marshalling) and encoding helpers. </brief_description> diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml index 87c2e51003..2b2f45e8be 100644 --- a/doc/classes/Material.xml +++ b/doc/classes/Material.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Material" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Material" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Abstract base [Resource] for coloring and shading geometry. </brief_description> @@ -11,34 +11,6 @@ <demos> </demos> <methods> - <method name="get_next_pass" qualifiers="const"> - <return type="Material"> - </return> - <description> - </description> - </method> - <method name="get_render_priority" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_next_pass"> - <return type="void"> - </return> - <argument index="0" name="next_pass" type="Material"> - </argument> - <description> - </description> - </method> - <method name="set_render_priority"> - <return type="void"> - </return> - <argument index="0" name="priority" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="next_pass" type="Material" setter="set_next_pass" getter="get_next_pass"> @@ -47,9 +19,9 @@ </member> </members> <constants> - <constant name="RENDER_PRIORITY_MAX" value="127" enum=""> + <constant name="RENDER_PRIORITY_MAX" value="127"> </constant> - <constant name="RENDER_PRIORITY_MIN" value="-128" enum=""> + <constant name="RENDER_PRIORITY_MIN" value="-128"> </constant> </constants> </class> diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 54be44d3d8..c41c86d693 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MenuButton" inherits="Button" category="Core" version="3.0-alpha"> +<class name="MenuButton" inherits="Button" category="Core" version="3.0-beta"> <brief_description> Special button that brings up a [PopupMenu] when clicked. </brief_description> @@ -19,10 +19,6 @@ </description> </method> </methods> - <members> - <member name="items" type="Array" setter="_set_items" getter="_get_items"> - </member> - </members> <signals> <signal name="about_to_show"> <description> diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 733f76728c..465b68171e 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Mesh" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Mesh" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> A [Resource] that contains vertex-array based geometry. </brief_description> @@ -49,95 +49,99 @@ </description> </method> </methods> + <members> + <member name="lightmap_size_hint" type="Vector2" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint"> + </member> + </members> <constants> - <constant name="PRIMITIVE_POINTS" value="0"> + <constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType"> Render array as points (one vertex equals one point). </constant> - <constant name="PRIMITIVE_LINES" value="1"> + <constant name="PRIMITIVE_LINES" value="1" enum="PrimitiveType"> Render array as lines (every two vertices a line is created). </constant> - <constant name="PRIMITIVE_LINE_STRIP" value="2"> + <constant name="PRIMITIVE_LINE_STRIP" value="2" enum="PrimitiveType"> Render array as line strip. </constant> - <constant name="PRIMITIVE_LINE_LOOP" value="3"> + <constant name="PRIMITIVE_LINE_LOOP" value="3" enum="PrimitiveType"> Render array as line loop (like line strip, but closed). </constant> - <constant name="PRIMITIVE_TRIANGLES" value="4"> + <constant name="PRIMITIVE_TRIANGLES" value="4" enum="PrimitiveType"> Render array as triangles (every three vertices a triangle is created). </constant> - <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> + <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5" enum="PrimitiveType"> Render array as triangle strips. </constant> - <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> + <constant name="PRIMITIVE_TRIANGLE_FAN" value="6" enum="PrimitiveType"> Render array as triangle fans. </constant> - <constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0"> + <constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode"> </constant> - <constant name="BLEND_SHAPE_MODE_RELATIVE" value="1"> + <constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode"> </constant> - <constant name="ARRAY_FORMAT_VERTEX" value="1"> + <constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FORMAT_NORMAL" value="2"> + <constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FORMAT_TANGENT" value="4"> + <constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FORMAT_COLOR" value="8"> + <constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + <constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> + <constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FORMAT_BONES" value="64"> + <constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FORMAT_INDEX" value="256"> + <constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_BASE" value="9"> + <constant name="ARRAY_COMPRESS_BASE" value="9" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_VERTEX" value="512"> + <constant name="ARRAY_COMPRESS_VERTEX" value="512" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_NORMAL" value="1024"> + <constant name="ARRAY_COMPRESS_NORMAL" value="1024" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_TANGENT" value="2048"> + <constant name="ARRAY_COMPRESS_TANGENT" value="2048" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_COLOR" value="4096"> + <constant name="ARRAY_COMPRESS_COLOR" value="4096" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_TEX_UV" value="8192"> + <constant name="ARRAY_COMPRESS_TEX_UV" value="8192" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_TEX_UV2" value="16384"> + <constant name="ARRAY_COMPRESS_TEX_UV2" value="16384" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_BONES" value="32768"> + <constant name="ARRAY_COMPRESS_BONES" value="32768" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_WEIGHTS" value="65536"> + <constant name="ARRAY_COMPRESS_WEIGHTS" value="65536" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_INDEX" value="131072"> + <constant name="ARRAY_COMPRESS_INDEX" value="131072" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144"> + <constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288"> + <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_DEFAULT" value="97792"> + <constant name="ARRAY_COMPRESS_DEFAULT" value="97792" enum="ArrayFormat"> </constant> - <constant name="ARRAY_VERTEX" value="0"> + <constant name="ARRAY_VERTEX" value="0" enum="ArrayType"> </constant> - <constant name="ARRAY_NORMAL" value="1"> + <constant name="ARRAY_NORMAL" value="1" enum="ArrayType"> </constant> - <constant name="ARRAY_TANGENT" value="2"> + <constant name="ARRAY_TANGENT" value="2" enum="ArrayType"> </constant> - <constant name="ARRAY_COLOR" value="3"> + <constant name="ARRAY_COLOR" value="3" enum="ArrayType"> </constant> - <constant name="ARRAY_TEX_UV" value="4"> + <constant name="ARRAY_TEX_UV" value="4" enum="ArrayType"> </constant> - <constant name="ARRAY_TEX_UV2" value="5"> + <constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType"> </constant> - <constant name="ARRAY_BONES" value="6"> + <constant name="ARRAY_BONES" value="6" enum="ArrayType"> </constant> - <constant name="ARRAY_WEIGHTS" value="7"> + <constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType"> </constant> - <constant name="ARRAY_INDEX" value="8"> + <constant name="ARRAY_INDEX" value="8" enum="ArrayType"> </constant> - <constant name="ARRAY_MAX" value="9"> + <constant name="ARRAY_MAX" value="9" enum="ArrayType"> </constant> </constants> </class> diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index f433d7a753..db20179116 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MeshDataTool" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="MeshDataTool" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index 5bd6bedf7e..9273e87430 100644 --- a/doc/classes/MeshInstance.xml +++ b/doc/classes/MeshInstance.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MeshInstance" inherits="GeometryInstance" category="Core" version="3.0-alpha"> +<class name="MeshInstance" inherits="GeometryInstance" category="Core" version="3.0-beta"> <brief_description> Node that instances meshes into a scenario. </brief_description> <description> - MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. + MeshInstance is a node that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. </description> <tutorials> </tutorials> @@ -15,33 +15,21 @@ <return type="void"> </return> <description> - This helper creates a [StaticBody] child [Node] with a [ConvexPolygonShape] [CollisionShape] calculated from the mesh geometry. It's mainly used for testing. + This helper creates a [StaticBody] child node with a [ConvexPolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing. </description> </method> <method name="create_debug_tangents"> <return type="void"> </return> <description> + This helper creates a [MeshInstance] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. </description> </method> <method name="create_trimesh_collision"> <return type="void"> </return> <description> - This helper creates a [StaticBody] child [Node] with a [ConcavePolygonShape] [CollisionShape] calculated from the mesh geometry. It's mainly used for testing. - </description> - </method> - <method name="get_mesh" qualifiers="const"> - <return type="Mesh"> - </return> - <description> - Returns the current [Mesh] resource for the instance. - </description> - </method> - <method name="get_skeleton_path"> - <return type="NodePath"> - </return> - <description> + This helper creates a [StaticBody] child node with a [ConcavePolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing. </description> </method> <method name="get_surface_material" qualifiers="const"> @@ -53,22 +41,6 @@ Returns the [Material] for a surface of the [Mesh] resource. </description> </method> - <method name="set_mesh"> - <return type="void"> - </return> - <argument index="0" name="mesh" type="Mesh"> - </argument> - <description> - </description> - </method> - <method name="set_skeleton_path"> - <return type="void"> - </return> - <argument index="0" name="skeleton_path" type="NodePath"> - </argument> - <description> - </description> - </method> <method name="set_surface_material"> <return type="void"> </return> diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index 54a8228d02..3275969e78 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MeshLibrary" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="MeshLibrary" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Library of meshes. </brief_description> diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 73384c27e4..ff2d89b2ca 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MultiMesh" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="MultiMesh" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Provides high performance mesh instancing. </brief_description> @@ -7,7 +7,7 @@ MultiMesh provides low level mesh instancing. If the amount of [Mesh] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance] nodes may affect performance by using too much CPU or video memory. For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little 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 Rect3 used for visibility must be provided by the user. + Since instances may have any behavior, the AABB used for visibility must be provided by the user. </description> <tutorials> </tutorials> @@ -15,16 +15,10 @@ </demos> <methods> <method name="get_aabb" qualifiers="const"> - <return type="Rect3"> - </return> - <description> - Return the visibility Rect3. - </description> - </method> - <method name="get_color_format" qualifiers="const"> - <return type="int" enum="MultiMesh.ColorFormat"> + <return type="AABB"> </return> <description> + Return the visibility AABB. </description> </method> <method name="get_instance_color" qualifiers="const"> @@ -36,13 +30,6 @@ Get the color of a specific instance. </description> </method> - <method name="get_instance_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the amount of instances that is going to be drawn. - </description> - </method> <method name="get_instance_transform" qualifiers="const"> <return type="Transform"> </return> @@ -52,27 +39,6 @@ Return the transform of a specific instance. </description> </method> - <method name="get_mesh" qualifiers="const"> - <return type="Mesh"> - </return> - <description> - Return the [Mesh] resource drawn as multiple instances. - </description> - </method> - <method name="get_transform_format" qualifiers="const"> - <return type="int" enum="MultiMesh.TransformFormat"> - </return> - <description> - </description> - </method> - <method name="set_color_format"> - <return type="void"> - </return> - <argument index="0" name="format" type="int" enum="MultiMesh.ColorFormat"> - </argument> - <description> - </description> - </method> <method name="set_instance_color"> <return type="void"> </return> @@ -84,15 +50,6 @@ Set the color of a specific instance. </description> </method> - <method name="set_instance_count"> - <return type="void"> - </return> - <argument index="0" name="count" type="int"> - </argument> - <description> - Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. - </description> - </method> <method name="set_instance_transform"> <return type="void"> </return> @@ -104,48 +61,27 @@ Set the transform for a specific instance. </description> </method> - <method name="set_mesh"> - <return type="void"> - </return> - <argument index="0" name="mesh" type="Mesh"> - </argument> - <description> - Set the [Mesh] resource to be drawn in multiple instances. - </description> - </method> - <method name="set_transform_format"> - <return type="void"> - </return> - <argument index="0" name="format" type="int" enum="MultiMesh.TransformFormat"> - </argument> - <description> - </description> - </method> </methods> <members> - <member name="color_array" type="PoolColorArray" setter="_set_color_array" getter="_get_color_array"> - </member> <member name="color_format" type="int" setter="set_color_format" getter="get_color_format" enum="MultiMesh.ColorFormat"> </member> <member name="instance_count" type="int" setter="set_instance_count" getter="get_instance_count"> </member> <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> </member> - <member name="transform_array" type="PoolVector3Array" setter="_set_transform_array" getter="_get_transform_array"> - </member> <member name="transform_format" type="int" setter="set_transform_format" getter="get_transform_format" enum="MultiMesh.TransformFormat"> </member> </members> <constants> - <constant name="TRANSFORM_2D" value="0"> + <constant name="TRANSFORM_2D" value="0" enum="TransformFormat"> </constant> - <constant name="TRANSFORM_3D" value="1"> + <constant name="TRANSFORM_3D" value="1" enum="TransformFormat"> </constant> - <constant name="COLOR_NONE" value="0"> + <constant name="COLOR_NONE" value="0" enum="ColorFormat"> </constant> - <constant name="COLOR_8BIT" value="1"> + <constant name="COLOR_8BIT" value="1" enum="ColorFormat"> </constant> - <constant name="COLOR_FLOAT" value="2"> + <constant name="COLOR_FLOAT" value="2" enum="ColorFormat"> </constant> </constants> </class> diff --git a/doc/classes/MultiMeshInstance.xml b/doc/classes/MultiMeshInstance.xml index 11e22c2581..bad61fa254 100644 --- a/doc/classes/MultiMeshInstance.xml +++ b/doc/classes/MultiMeshInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MultiMeshInstance" inherits="GeometryInstance" category="Core" version="3.0-alpha"> +<class name="MultiMeshInstance" inherits="GeometryInstance" category="Core" version="3.0-beta"> <brief_description> Node that instances a [MultiMesh]. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_multimesh" qualifiers="const"> - <return type="MultiMesh"> - </return> - <description> - Return the [MultiMesh] that is used for instancing. - </description> - </method> - <method name="set_multimesh"> - <return type="void"> - </return> - <argument index="0" name="multimesh" type="MultiMesh"> - </argument> - <description> - Set the [MultiMesh] to be instanced. - </description> - </method> </methods> <members> <member name="multimesh" type="MultiMesh" setter="set_multimesh" getter="get_multimesh"> diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index d36dbb64c1..4b845c05ad 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Mutex" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="Mutex" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> A synchronization Mutex. </brief_description> diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index c83e81b197..8fe520f853 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Navigation" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="Navigation" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> + A collection of [code]NavigationMesh[/code] resources and methods used for pathfinding. </brief_description> <description> + The Navigation node is used for basic or advanced navigation. By default it will automatically collect all child [code]NavigationMesh[/code] resources, but they can also be added on the fly through scripting. It can be used for generating a simple path between two points or it can be used to ensure that a navigation agent is angled perfectly to the terrain it is navigating. </description> <tutorials> </tutorials> @@ -15,6 +17,7 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> + Returns the closest navigation point to the point passed. </description> </method> <method name="get_closest_point_normal"> @@ -23,6 +26,7 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> + Returns the surface normal of the navigation mesh at the point passed. For instance, if the point passed was at a 45 degree slope it would return something like (0.5,0.5,0). This is useful for rotating a navigation agent in accordance with the [code]NavigationMesh[/code]. </description> </method> <method name="get_closest_point_owner"> @@ -31,6 +35,7 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> + Returns the nearest [code]NavigationMeshInstance[/code] to the point passed. </description> </method> <method name="get_closest_point_to_segment"> @@ -43,6 +48,7 @@ <argument index="2" name="use_collision" type="bool" default="false"> </argument> <description> + Returns the nearest point to the line segment passed. The third optional parameter takes collisions into account. </description> </method> <method name="get_simple_path"> @@ -55,15 +61,10 @@ <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> + Returns a path of points as a [code]PoolVector3Array[/code]. If [code]optimize[/code] is false the [code]NavigationMesh[/code] agent properties will be taken into account, otherwise it will return the nearest path and ignore agent radius, height, etc. </description> </method> - <method name="get_up_vector" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="navmesh_create"> + <method name="navmesh_add"> <return type="int"> </return> <argument index="0" name="mesh" type="NavigationMesh"> @@ -73,6 +74,7 @@ <argument index="2" name="owner" type="Object" default="null"> </argument> <description> + Adds a [code]NavigationMesh[/code] to the list of NavigationMesh's in this node. Returns an id. Its position, rotation and scale are associated with the [code]Transform[/code] passed. The [code]Node[/code] (or [code]Object[/code]) that owns this node is an optional parameter. </description> </method> <method name="navmesh_remove"> @@ -81,6 +83,7 @@ <argument index="0" name="id" type="int"> </argument> <description> + Removes a [code]NavigationMesh[/code] from the list of NavigationMesh's in this node. </description> </method> <method name="navmesh_set_transform"> @@ -91,19 +94,13 @@ <argument index="1" name="xform" type="Transform"> </argument> <description> - </description> - </method> - <method name="set_up_vector"> - <return type="void"> - </return> - <argument index="0" name="up" type="Vector3"> - </argument> - <description> + Associates a [code]NavigationMesh[/code]'s id with a [code]Transform[/code]. Its position, rotation and scale are based on the [code]Transform[/code] passed. </description> </method> </methods> <members> <member name="up_vector" type="Vector3" setter="set_up_vector" getter="get_up_vector"> + Defines which direction is up. The default defines 0,1,0 as up which is the world up direction. To make this a ceiling use 0,-1,0 to define down as up. </member> </members> <constants> diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index ac2e0d88d8..18c15a616a 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Navigation2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Navigation2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -37,7 +37,7 @@ <description> </description> </method> - <method name="navpoly_create"> + <method name="navpoly_add"> <return type="int"> </return> <argument index="0" name="mesh" type="NavigationPolygon"> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index dd49b0a593..55a3771d79 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationMesh" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="NavigationMesh" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -31,84 +31,6 @@ <description> </description> </method> - <method name="get_agent_height" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_agent_max_climb" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_agent_max_slope" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_agent_radius"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_cell_height" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_cell_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_detail_sample_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_detail_sample_max_error" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_edge_max_error" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_edge_max_length" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_filter_ledge_spans" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_filter_low_hanging_obstacles" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_filter_walkable_low_height_spans" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="get_polygon"> <return type="PoolIntArray"> </return> @@ -123,164 +45,12 @@ <description> </description> </method> - <method name="get_region_merge_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_region_min_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sample_partition_type" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_vertices" qualifiers="const"> <return type="PoolVector3Array"> </return> <description> </description> </method> - <method name="get_verts_per_poly" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_agent_height"> - <return type="void"> - </return> - <argument index="0" name="agent_height" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_agent_max_climb"> - <return type="void"> - </return> - <argument index="0" name="agent_max_climb" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_agent_max_slope"> - <return type="void"> - </return> - <argument index="0" name="agent_max_slope" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_agent_radius"> - <return type="void"> - </return> - <argument index="0" name="agent_radius" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_cell_height"> - <return type="void"> - </return> - <argument index="0" name="cell_height" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_cell_size"> - <return type="void"> - </return> - <argument index="0" name="cell_size" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_detail_sample_distance"> - <return type="void"> - </return> - <argument index="0" name="detail_sample_dist" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_detail_sample_max_error"> - <return type="void"> - </return> - <argument index="0" name="detail_sample_max_error" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_edge_max_error"> - <return type="void"> - </return> - <argument index="0" name="edge_max_error" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_edge_max_length"> - <return type="void"> - </return> - <argument index="0" name="edge_max_length" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_filter_ledge_spans"> - <return type="void"> - </return> - <argument index="0" name="filter_ledge_spans" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_filter_low_hanging_obstacles"> - <return type="void"> - </return> - <argument index="0" name="filter_low_hanging_obstacles" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_filter_walkable_low_height_spans"> - <return type="void"> - </return> - <argument index="0" name="filter_walkable_low_height_spans" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_region_merge_size"> - <return type="void"> - </return> - <argument index="0" name="region_merge_size" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_region_min_size"> - <return type="void"> - </return> - <argument index="0" name="region_min_size" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sample_partition_type"> - <return type="void"> - </return> - <argument index="0" name="sample_partition_type" type="int"> - </argument> - <description> - </description> - </method> <method name="set_vertices"> <return type="void"> </return> @@ -289,14 +59,6 @@ <description> </description> </method> - <method name="set_verts_per_poly"> - <return type="void"> - </return> - <argument index="0" name="verts_per_poly" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="agent/height" type="float" setter="set_agent_height" getter="get_agent_height"> @@ -327,23 +89,19 @@ </member> <member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly"> </member> - <member name="polygons" type="Array" setter="_set_polygons" getter="_get_polygons"> - </member> <member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size"> </member> <member name="region/min_size" type="float" setter="set_region_min_size" getter="get_region_min_size"> </member> <member name="sample_partition_type/sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type"> </member> - <member name="vertices" type="PoolVector3Array" setter="set_vertices" getter="get_vertices"> - </member> </members> <constants> - <constant name="SAMPLE_PARTITION_WATERSHED" value="0" enum=""> + <constant name="SAMPLE_PARTITION_WATERSHED" value="0"> </constant> - <constant name="SAMPLE_PARTITION_MONOTONE" value="1" enum=""> + <constant name="SAMPLE_PARTITION_MONOTONE" value="1"> </constant> - <constant name="SAMPLE_PARTITION_LAYERS" value="2" enum=""> + <constant name="SAMPLE_PARTITION_LAYERS" value="2"> </constant> </constants> </class> diff --git a/doc/classes/NavigationMeshInstance.xml b/doc/classes/NavigationMeshInstance.xml index 1e8998009e..ddca9d747e 100644 --- a/doc/classes/NavigationMeshInstance.xml +++ b/doc/classes/NavigationMeshInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationMeshInstance" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="NavigationMeshInstance" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,34 +9,6 @@ <demos> </demos> <methods> - <method name="get_navigation_mesh" qualifiers="const"> - <return type="NavigationMesh"> - </return> - <description> - </description> - </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_navigation_mesh"> - <return type="void"> - </return> - <argument index="0" name="navmesh" type="NavigationMesh"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index fd7238114e..663ac4cd67 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationPolygon" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="NavigationPolygon" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -114,14 +114,6 @@ </description> </method> </methods> - <members> - <member name="outlines" type="Array" setter="_set_outlines" getter="_get_outlines"> - </member> - <member name="polygons" type="Array" setter="_set_polygons" getter="_get_polygons"> - </member> - <member name="vertices" type="PoolVector2Array" setter="set_vertices" getter="get_vertices"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/NavigationPolygonInstance.xml b/doc/classes/NavigationPolygonInstance.xml index ac56b03002..ea314667ca 100644 --- a/doc/classes/NavigationPolygonInstance.xml +++ b/doc/classes/NavigationPolygonInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationPolygonInstance" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="NavigationPolygonInstance" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,34 +9,6 @@ <demos> </demos> <methods> - <method name="get_navigation_polygon" qualifiers="const"> - <return type="NavigationPolygon"> - </return> - <description> - </description> - </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_navigation_polygon"> - <return type="void"> - </return> - <argument index="0" name="navpoly" type="NavigationPolygon"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index 4333c3d28a..a7350b3863 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NetworkedMultiplayerPeer" inherits="PacketPeer" category="Core" version="3.0-alpha"> +<class name="NetworkedMultiplayerPeer" inherits="PacketPeer" category="Core" version="3.0-beta"> <brief_description> + A high-level network interface to simplify multiplayer interactions. </brief_description> <description> + Manages the connection to network peers. Assigns unique IDs to each client connected to the server. </description> <tutorials> </tutorials> @@ -13,31 +15,35 @@ <return type="int" enum="NetworkedMultiplayerPeer.ConnectionStatus"> </return> <description> + Returns the current state of the connection. See [enum ConnectionStatus]. </description> </method> <method name="get_packet_peer" qualifiers="const"> <return type="int"> </return> <description> + Returns the ID of the [code]NetworkedMultiplayerPeer[/code] who sent the most recent packet. </description> </method> <method name="get_unique_id" qualifiers="const"> <return type="int"> </return> <description> + Returns the ID of this [code]NetworkedMultiplayerPeer[/code]. </description> </method> <method name="is_refusing_new_connections" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this [code]NetworkedMultiplayerPeer[/code] is refusing new connections. + Returns [code]true[/code] if this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. </description> </method> <method name="poll"> <return type="void"> </return> <description> + Waits up to 1 second to receive a new network event. </description> </method> <method name="set_refuse_new_connections"> @@ -46,7 +52,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - If [code]endable[/code] is true, this [code]NetworkedMultiplayerPeer[/code] will refuse new connections. + If [code]true[/code] this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. </description> </method> <method name="set_target_peer"> @@ -55,6 +61,7 @@ <argument index="0" name="id" type="int"> </argument> <description> + The peer to which packets will be sent. Default value: [code]0[/code]. </description> </method> <method name="set_transfer_mode"> @@ -63,56 +70,65 @@ <argument index="0" name="mode" type="int" enum="NetworkedMultiplayerPeer.TransferMode"> </argument> <description> + The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. </description> </method> </methods> <signals> <signal name="connection_failed"> <description> - Emitted when failed to connect to server. + Emitted when a connection attempt fails. </description> </signal> <signal name="connection_succeeded"> <description> - Emitted when successfully connected to server. + Emitted when a connection attempt succeeds. </description> </signal> <signal name="peer_connected"> <argument index="0" name="id" type="int"> </argument> <description> - Emitted by the server when a client is connected. + Emitted by the server when a client connects. </description> </signal> <signal name="peer_disconnected"> <argument index="0" name="id" type="int"> </argument> <description> - Emitted by the server when a client is disconnected. + Emitted by the server when a client disconnects. </description> </signal> <signal name="server_disconnected"> <description> - Emitted by clients when server is disconnected. + Emitted by clients when the server disconnects. </description> </signal> </signals> <constants> - <constant name="TRANSFER_MODE_UNRELIABLE" value="0"> + <constant name="TRANSFER_MODE_UNRELIABLE" value="0" enum="TransferMode"> + Packets are sent via unordered UDP packets. </constant> - <constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1"> + <constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1" enum="TransferMode"> + Packets are sent via ordered UDP packets. </constant> - <constant name="TRANSFER_MODE_RELIABLE" value="2"> + <constant name="TRANSFER_MODE_RELIABLE" value="2" enum="TransferMode"> + Packets are sent via TCP packets. </constant> - <constant name="CONNECTION_DISCONNECTED" value="0"> + <constant name="CONNECTION_DISCONNECTED" value="0" enum="ConnectionStatus"> + The ongoing connection disconnected. </constant> - <constant name="CONNECTION_CONNECTING" value="1"> + <constant name="CONNECTION_CONNECTING" value="1" enum="ConnectionStatus"> + A connection attempt is ongoing. </constant> - <constant name="CONNECTION_CONNECTED" value="2"> + <constant name="CONNECTION_CONNECTED" value="2" enum="ConnectionStatus"> + The connection attempt succeeded. </constant> - <constant name="TARGET_PEER_BROADCAST" value="0" enum=""> + <constant name="TARGET_PEER_BROADCAST" value="0"> + Packets are sent to the server and then redistributed to other peers. </constant> - <constant name="TARGET_PEER_SERVER" value="1" enum=""> + <constant name="TARGET_PEER_SERVER" value="1"> + Packets are sent to the server alone. </constant> </constants> </class> diff --git a/doc/classes/Nil.xml b/doc/classes/Nil.xml index 1fccdc0148..a30dae8af1 100644 --- a/doc/classes/Nil.xml +++ b/doc/classes/Nil.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Nil" category="Built-In Types" version="3.0-alpha"> +<class name="Nil" category="Built-In Types" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -100,7 +100,7 @@ </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Rect3"> + <argument index="0" name="from" type="AABB"> </argument> <description> </description> diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 2c8bce52a0..b7440137c8 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NinePatchRect" inherits="Control" category="Core" version="3.0-alpha"> +<class name="NinePatchRect" inherits="Control" category="Core" version="3.0-beta"> <brief_description> 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> @@ -11,94 +11,6 @@ <demos> </demos> <methods> - <method name="get_h_axis_stretch_mode" qualifiers="const"> - <return type="int" enum="NinePatchRect.AxisStretchMode"> - </return> - <description> - </description> - </method> - <method name="get_patch_margin" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - </description> - </method> - <method name="get_region_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_v_axis_stretch_mode" qualifiers="const"> - <return type="int" enum="NinePatchRect.AxisStretchMode"> - </return> - <description> - </description> - </method> - <method name="is_draw_center_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_draw_center"> - <return type="void"> - </return> - <argument index="0" name="draw_center" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_h_axis_stretch_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="NinePatchRect.AxisStretchMode"> - </argument> - <description> - </description> - </method> - <method name="set_patch_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="value" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_region_rect"> - <return type="void"> - </return> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_v_axis_stretch_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="NinePatchRect.AxisStretchMode"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="NinePatchRect.AxisStretchMode"> @@ -137,13 +49,13 @@ </signal> </signals> <constants> - <constant name="AXIS_STRETCH_MODE_STRETCH" value="0"> + <constant name="AXIS_STRETCH_MODE_STRETCH" value="0" enum="AxisStretchMode"> Doesn't do anything at the time of writing. Default value for [code]axis_stretch_horizontal[/code] and [code]axis_stretch_vertical[/code]. </constant> - <constant name="AXIS_STRETCH_MODE_TILE" value="1"> + <constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode"> Doesn't do anything at the time of writing. </constant> - <constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2"> + <constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode"> Doesn't do anything at the time of writing. </constant> </constants> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index a103d0eba0..e56733f102 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Node" inherits="Object" category="Core" version="3.0-alpha"> +<class name="Node" inherits="Object" category="Core" version="3.0-beta"> <brief_description> - Base class for all the [i]scene[/i] elements. + Base class for all [i]scene[/i] objects. </brief_description> <description> - Nodes are the base bricks with which Godot games are developed. They can be set as children of other nodes, resulting in a tree arrangement. A given node can contain any number of nodes as children (but there is only one scene tree root node) with the requirement that all siblings (direct children of a node) should have unique names. - Any tree of nodes is called a [i]scene[/i]. Scenes can be saved to the disk and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of the projects. Nodes can optionally be added to groups. This makes it easy to reach a number of nodes from the code (for example an "enemies" group) to perform grouped actions. - [b]Scene tree:[/b] The [SceneTree] contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its [method _enter_tree] callback is triggered. Children nodes are always added [i]after[/i] their parent node, i.e. the [method _enter_tree] callback of a parent node will be triggered before its child's. - Once all nodes have been added in the scene tree, they receive the NOTIFICATION_READY notification and their respective [method _ready] callbacks are triggered. For groups of nodes, the [method _ready] callback is called in reverse order, from the children up to the parent nodes. - It means that when adding a scene to the scene tree, the following order will be used for the callbacks: [method _enter_tree] of the parent, [method _enter_tree] of the children, [method _ready] of the children and finally [method _ready] of the parent (and that recursively for the whole scene). - [b]Processing:[/b] Nodes can be set to the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback [method _process], toggled with [method set_process]) happens as fast as possible and is dependent on the frame rate, so the processing time [i]delta[/i] is variable. Physics processing (callback [method _physics_process], toggled with [method set_physics_process]) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. - Nodes can also process input events. When set, the [method _input] function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the [method _unhandled_input] function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI [Control] nodes), ensuring that the node only receives the events that were meant for it. + Nodes are Godot's building blocks. They can be assigned as the child of another node, resulting in a tree arrangement. A given node can contain any number of nodes as children with the requirement that all siblings (direct children of a node) should have unique names. + A tree of nodes is called a [i]scene[/i]. Scenes can be saved to the disk and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of Godot projects. Nodes can also optionally be added to groups. This makes it possible to access a number of nodes from code (an "enemies" group, for example) to perform grouped actions. + [b]Scene tree:[/b] The [SceneTree] contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its [method _enter_tree] callback is triggered. Child nodes are always added [i]after[/i] their parent node, i.e. the [method _enter_tree] callback of a parent node will be triggered before its child's. + Once all nodes have been added in the scene tree, they receive the NOTIFICATION_READY notification and their respective [method _ready] callbacks are triggered. For groups of nodes, the [method _ready] callback is called in reverse order, starting with the children and moving up to the parent nodes. + This means that when adding a node to the scene tree, the following order will be used for the callbacks: [method _enter_tree] of the parent, [method _enter_tree] of the children, [method _ready] of the children and finally [method _ready] of the parent (recursively for the entire scene tree). + [b]Processing:[/b] Nodes can override the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback [method _process], toggled with [method set_process]) happens as fast as possible and is dependent on the frame rate, so the processing time [i]delta[/i] is passed as an argument. Physics processing (callback [method _physics_process], toggled with [method set_physics_process]) happens a fixed number of times per second (60 by default) and is useful for code related to the physics engine. + Nodes can also process input events. When present, the [method _input] function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the [method _unhandled_input] function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI [Control] nodes), ensuring that the node only receives the events that were meant for it. To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with [method set_owner]. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed with [method free] or [method queue_free], it will also free all its children. - [b]Networking with nodes:[/b] After connecting to a server (or making one, see [NetworkedMultiplayerENet]) it is possible to use the built-in RPC (remote procedure call) system to easily communicate over the network. By calling [method rpc] with a method name, it will be called locally, and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode ([method set_network_mode]) on the receiving peer. To identify which [code]Node[/code] receives the RPC call Godot will use its [NodePath] (make sure node names are the same on all peers). + [b]Networking with nodes:[/b] After connecting to a server (or making one, see [NetworkedMultiplayerENet]) it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling [method rpc] with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode ([method set_network_mode]) of the receiving peer. To identify which node receives the RPC call Godot will use its [NodePath] (make sure node names are the same on all peers). </description> <tutorials> </tutorials> @@ -24,7 +24,7 @@ <return type="void"> </return> <description> - Called when the node enters the [SceneTree] (e.g. upon instancing, scene changing or after calling [method add_child] in a script). If the node has children, its [method _enter_tree] callback will be called first, and then that of the children. + Called when the node enters the [SceneTree] (e.g. upon instancing, scene changing, or after calling [method add_child] in a script). If the node has children, its [method _enter_tree] callback will be called first, and then that of the children. Corresponds to the NOTIFICATION_ENTER_TREE notification in [method Object._notification]. </description> </method> @@ -32,7 +32,7 @@ <return type="void"> </return> <description> - Called when the node leaves the [SceneTree] (e.g. upon freeing, scene changing or after calling [method remove_child] in a script). If the node has children, its [method _exit_tree] callback will be called last, after all its children have left the tree. + Called when the node leaves the [SceneTree] (e.g. upon freeing, scene changing, or after calling [method remove_child] in a script). If the node has children, its [method _exit_tree] callback will be called last, after all its children have left the tree. Corresponds to the NOTIFICATION_EXIT_TREE notification in [method Object._notification]. </description> </method> @@ -42,7 +42,8 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Called when there is a change to input devices. Propagated through the node tree until a Node consumes it. + Called when there is an input event. The input event propagates through the node tree until a node consumes it. + It is only called if input processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_process_input]. </description> </method> <method name="_physics_process" qualifiers="virtual"> @@ -52,7 +53,7 @@ </argument> <description> Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant. - It is only called if physics processing has been enabled with [method set_physics_process]. + It is only called if physics processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_physics_process]. Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in [method Object._notification]. </description> </method> @@ -63,7 +64,7 @@ </argument> <description> Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [code]delta[/code] time since the previous frame is not constant. - It is only called if processing has been enabled with [method set_process]. + It is only called if processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_process]. Corresponds to the NOTIFICATION_PROCESS notification in [method Object._notification]. </description> </method> @@ -71,7 +72,7 @@ <return type="void"> </return> <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] callback gets triggered first, and the node will receive the ready notification only afterwards. + 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 NOTIFICATION_READY notification in [method Object._notification]. </description> </method> @@ -82,6 +83,7 @@ </argument> <description> Propagated to all nodes when the previous InputEvent is not consumed by any nodes. + It is only called if unhandled input processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_process_unhandled_input]. </description> </method> <method name="_unhandled_key_input" qualifiers="virtual"> @@ -100,8 +102,8 @@ <argument index="1" name="legible_unique_name" type="bool" default="false"> </argument> <description> - Add a child [code]Node[/code]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. - The optional boolean argument enforces creating child nodes with human-readable names, based on the name of the node being instanced instead of its type only. + 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 "legible_unique_name" [code]true[/code] creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. </description> </method> <method name="add_child_below_node"> @@ -114,6 +116,8 @@ <argument index="2" name="legible_unique_name" type="bool" default="false"> </argument> <description> + Adds a child node. The child is placed below the given node in the list of children. + Setting "legible_unique_name" [code]true[/code] creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. </description> </method> <method name="add_to_group"> @@ -124,14 +128,14 @@ <argument index="1" name="persistent" type="bool" default="false"> </argument> <description> - Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example "enemies" or "collectables". A [code]Node[/code] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]). + Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see [method is_inside_tree]). </description> </method> <method name="can_process" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the node can process, i.e. whether its pause mode allows processing while the scene tree is paused (see [method set_pause_mode]). Always returns true if the scene tree is not paused, and false if the node is not in the tree. FIXME: Why FAIL_COND? + Returns [code]true[/code] if the node can process while the scene tree is paused (see [method set_pause_mode]). Always returns [code]true[/code] if the scene tree is not paused, and [code]false[/code] if the node is not in the tree. FIXME: Why FAIL_COND? </description> </method> <method name="duplicate" qualifiers="const"> @@ -140,8 +144,8 @@ <argument index="0" name="flags" type="int" default="15"> </argument> <description> - Duplicate the node, returning a new [code]Node[/code]. - You can fine-tune the behavior using the [code]flags[/code], which are based on the DUPLICATE_* constants. + Duplicates the node, returning a new node. + You can fine-tune the behavior using the [code]flags[/code]. See DUPLICATE_* constants. </description> </method> <method name="find_node" qualifiers="const"> @@ -154,7 +158,7 @@ <argument index="2" name="owned" type="bool" default="true"> </argument> <description> - Find 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. + 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. </description> </method> <method name="get_child" qualifiers="const"> @@ -163,55 +167,56 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return a child node by its index (see [method get_child_count]). This method is often used for iterating all children of a node. + Returns a child node by its index (see [method get_child_count]). This method is often used for iterating all children of a node. </description> </method> <method name="get_child_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of child nodes. + Returns the number of child nodes. </description> </method> <method name="get_children" qualifiers="const"> <return type="Array"> </return> <description> - Return an array of references ([code]Node[/code]) to the child nodes. + Returns an array of references to node's children. </description> </method> <method name="get_filename" qualifiers="const"> <return type="String"> </return> <description> - Return a filename that may be contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [method set_filename]). + Returns a filename that may be contained by the node. When a scene is instanced from a file, its topmost node contains the filename from which it was loaded (see [method set_filename]). </description> </method> <method name="get_groups" qualifiers="const"> <return type="Array"> </return> <description> - Return an array listing the groups that the node is part of. + Returns an array listing the groups that the node is a member of. </description> </method> <method name="get_index" qualifiers="const"> <return type="int"> </return> <description> - Get the node index, i.e. its position among the siblings of its parent. + Returns the node's index, i.e. its position among the siblings of its parent. </description> </method> <method name="get_name" qualifiers="const"> <return type="String"> </return> <description> - Return the name of the node. This name is unique among the siblings (other child nodes from the same parent). + Returns the name of the node. This name is unique among the siblings (other child nodes from the same parent). </description> </method> <method name="get_network_master" qualifiers="const"> <return type="int"> </return> <description> + Returns the peer ID of the network master for this node. </description> </method> <method name="get_node" qualifiers="const"> @@ -220,7 +225,7 @@ <argument index="0" name="path" type="NodePath"> </argument> <description> - Fetch a node. The [NodePath] must be valid (or else an error will be raised) and can be either the path to child node, a relative path (from the current node to another node), or an absolute path to a node. + Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and attempts to access it will result in an "Attempt to call <method> on a null instance." error. Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). [i]Example:[/i] Assume your current node is Character and the following tree: [codeblock] @@ -254,21 +259,21 @@ <return type="Node"> </return> <description> - Get the node owner (see [method set_owner]). + Returns the node owner (see [method set_owner]). </description> </method> <method name="get_parent" qualifiers="const"> <return type="Node"> </return> <description> - Return the parent node of the current node, or an empty [code]Node[/code] if the node lacks a parent. + Returns the parent node of the current node, or an empty [code]Node[/code] if the node lacks a parent. </description> </method> <method name="get_path" qualifiers="const"> <return type="NodePath"> </return> <description> - Return the absolute path of the current node. This only works if the current node is inside the scene tree (see [method is_inside_tree]). + Returns the absolute path of the current node. This only works if the current node is inside the scene tree (see [method is_inside_tree]). </description> </method> <method name="get_path_to" qualifiers="const"> @@ -277,35 +282,28 @@ <argument index="0" name="node" type="Node"> </argument> <description> - Return the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or else the function will fail. - </description> - </method> - <method name="get_pause_mode" qualifiers="const"> - <return type="int" enum="Node.PauseMode"> - </return> - <description> - Return the pause mode (PAUSE_MODE_*) of this Node. + Returns the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or the function will fail. </description> </method> <method name="get_physics_process_delta_time" qualifiers="const"> <return type="float"> </return> <description> - Return the time elapsed since the last physics-bound frame (see [method _physics_process]). This is always a constant value in physics processing unless the frames per second is changed in [OS]. + Returns the time elapsed since the last physics-bound frame (see [method _physics_process]). This is always a constant value in physics processing unless the frames per second is changed in [OS]. </description> </method> <method name="get_position_in_parent" qualifiers="const"> <return type="int"> </return> <description> - Return the order in the node tree branch, i.e. if called by the first child Node, return 0. + Returns the node's order in the scene tree branch. For example, if called on the first child node the position is [code]0[/code]. </description> </method> <method name="get_process_delta_time" qualifiers="const"> <return type="float"> </return> <description> - Return the time elapsed (in seconds) since the last process callback. This is almost always different each time. + Returns the time elapsed (in seconds) since the last process callback. This value may vary from frame to frame. </description> </method> <method name="get_scene_instance_load_placeholder" qualifiers="const"> @@ -318,13 +316,14 @@ <return type="SceneTree"> </return> <description> - Return a [SceneTree] that this node is inside. + Returns the [SceneTree] that contains this node. </description> </method> <method name="get_viewport" qualifiers="const"> <return type="Viewport"> </return> <description> + Returns the node's [Viewport]. </description> </method> <method name="has_node" qualifiers="const"> @@ -333,7 +332,7 @@ <argument index="0" name="path" type="NodePath"> </argument> <description> - Return whether the node that a given [NodePath] points too exists. + Returns [code]true[/code] if the node that the [NodePath] points to exists. </description> </method> <method name="has_node_and_resource" qualifiers="const"> @@ -350,13 +349,14 @@ <argument index="0" name="node" type="Node"> </argument> <description> - Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i]. + Returns [code]true[/code] if the given node is a direct or indirect child of the current node. </description> </method> <method name="is_displayed_folded" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the node is folded (collapsed) in the Scene dock. </description> </method> <method name="is_greater_than" qualifiers="const"> @@ -365,7 +365,7 @@ <argument index="0" name="node" type="Node"> </argument> <description> - Return [i]true[/i] if "node" occurs later in the scene hierarchy than the current node, otherwise return [i]false[/i]. + Returns [code]true[/code] if the given node occurs later in the scene hierarchy than the current node. </description> </method> <method name="is_in_group" qualifiers="const"> @@ -374,14 +374,14 @@ <argument index="0" name="group" type="String"> </argument> <description> - Return whether this Node is in the specified group. + Returns [code]true[/code] if this node is in the specified group. </description> </method> <method name="is_inside_tree" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this Node is inside a [SceneTree]. + Returns [code]true[/code] if this node is currently inside a [SceneTree]. </description> </method> <method name="is_network_master" qualifiers="const"> @@ -394,7 +394,7 @@ <return type="bool"> </return> <description> - Return true if physics processing is enabled (see [method set_physics_process]). + Returns [code]true[/code] if physics processing is enabled (see [method set_physics_process]). </description> </method> <method name="is_physics_processing_internal" qualifiers="const"> @@ -407,14 +407,14 @@ <return type="bool"> </return> <description> - Return whether processing is enabled in the current node (see [method set_process]). + Returns [code]true[/code] if processing is enabled (see [method set_process]). </description> </method> <method name="is_processing_input" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the node is processing input (see [method set_process_input]). + Returns [code]true[/code] if the node is processing input (see [method set_process_input]). </description> </method> <method name="is_processing_internal" qualifiers="const"> @@ -427,13 +427,14 @@ <return type="bool"> </return> <description> - Return true if the node is processing unhandled input (see [method set_process_unhandled_input]). + Returns [code]true[/code] if the node is processing unhandled input (see [method set_process_unhandled_input]). </description> </method> <method name="is_processing_unhandled_key_input" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the node is processing unhandled key input (see [method set_process_unhandled_key_input]). </description> </method> <method name="move_child"> @@ -444,7 +445,7 @@ <argument index="1" name="to_position" type="int"> </argument> <description> - Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. + Moves a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. </description> </method> <method name="print_stray_nodes"> @@ -457,7 +458,7 @@ <return type="void"> </return> <description> - Print the scene to stdout. Used mainly for debugging purposes. + Prints the scene to stdout. Used mainly for debugging purposes. </description> </method> <method name="propagate_call"> @@ -470,7 +471,7 @@ <argument index="2" name="parent_first" type="bool" default="false"> </argument> <description> - Calls the method (if present) with the arguments given in "args" on this Node and recursively on all children. If the parent_first argument is true then the method will be called on the current [code]Node[/code] first, then on all children. If it is false then the children will get 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 parent_first 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. </description> </method> <method name="propagate_notification"> @@ -479,28 +480,28 @@ <argument index="0" name="what" type="int"> </argument> <description> - Notify the current node and all its children recursively by calling notification() in all of them. + Notifies the current node and all its children recursively by calling notification() on all of them. </description> </method> <method name="queue_free"> <return type="void"> </return> <description> - Queues a node for deletion at the end of the current frame. When deleted, all of its children nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to [method Object.free]. Use [method Object.is_queued_for_deletion] to know whether a node will be deleted at the end of the frame. + Queues a node for deletion at the end of the current frame. When deleted, all of its child nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to [method Object.free]. Use [method Object.is_queued_for_deletion] to check whether a node will be deleted at the end of the frame. </description> </method> <method name="raise"> <return type="void"> </return> <description> - Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([Control]), because their order of drawing fully depends on their order in the tree. + Moves this node to the top of the array of nodes of the parent node. This is often useful in GUIs ([Control] nodes), because their order of drawing depends on their order in the tree. </description> </method> <method name="remove_and_skip"> <return type="void"> </return> <description> - Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. + Removes a node and sets all its children as children of the parent node (if it exists). All event subscriptions that pass by the removed node will be unsubscribed. </description> </method> <method name="remove_child"> @@ -509,7 +510,7 @@ <argument index="0" name="node" type="Node"> </argument> <description> - Remove a child [code]Node[/code]. Node is NOT deleted and will have to be deleted manually. + Removes a child node. The node is NOT deleted and must be deleted manually. </description> </method> <method name="remove_from_group"> @@ -518,7 +519,7 @@ <argument index="0" name="group" type="String"> </argument> <description> - Remove a node from a group. + Removes a node from a group. </description> </method> <method name="replace_by"> @@ -529,14 +530,14 @@ <argument index="1" name="keep_data" type="bool" default="false"> </argument> <description> - Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. + Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost. </description> </method> <method name="request_ready"> <return type="void"> </return> <description> - Request that [code]_ready[/code] be called again. + Requests that [code]_ready[/code] be called again. </description> </method> <method name="rpc" qualifiers="vararg"> @@ -545,7 +546,7 @@ <argument index="0" name="method" type="String"> </argument> <description> - Send a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same [NodePath]. + Sends a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same [NodePath]. </description> </method> <method name="rpc_config"> @@ -556,7 +557,7 @@ <argument index="1" name="mode" type="int" enum="Node.RPCMode"> </argument> <description> - Change the method's RPC mode (one of RPC_MODE_* constants). + Changes the method's RPC mode (one of RPC_MODE_* constants). </description> </method> <method name="rpc_id" qualifiers="vararg"> @@ -567,7 +568,7 @@ <argument index="1" name="method" type="String"> </argument> <description> - Send a [method rpc] to a specific peer identified by [i]peer_id[/i]. + Sends a [method rpc] to a specific peer identified by [i]peer_id[/i]. </description> </method> <method name="rpc_unreliable" qualifiers="vararg"> @@ -576,7 +577,7 @@ <argument index="0" name="method" type="String"> </argument> <description> - Send a [method rpc] using an unreliable protocol. + Sends a [method rpc] using an unreliable protocol. </description> </method> <method name="rpc_unreliable_id" qualifiers="vararg"> @@ -587,7 +588,7 @@ <argument index="1" name="method" type="String"> </argument> <description> - Send a [method rpc] to a specific peer identified by [i]peer_id[/i] using an unreliable protocol. + Sends a [method rpc] to a specific peer identified by [i]peer_id[/i] using an unreliable protocol. </description> </method> <method name="rset"> @@ -598,7 +599,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> - Remotely change property's value on other peers (and locally). + Remotely changes property's value on other peers (and locally). </description> </method> <method name="rset_config"> @@ -609,7 +610,7 @@ <argument index="1" name="mode" type="int" enum="Node.RPCMode"> </argument> <description> - Change the property's RPC mode (one of RPC_MODE_* constants). + Changes the property's RPC mode (one of RPC_MODE_* constants). </description> </method> <method name="rset_id"> @@ -622,7 +623,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Remotely change property's value on a specific peer identified by [i]peer_id[/i]. + Remotely changes property's value on a specific peer identified by [i]peer_id[/i]. </description> </method> <method name="rset_unreliable"> @@ -633,7 +634,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> - Remotely change property's value on other peers (and locally) using an unreliable protocol. + Remotely changes property's value on other peers (and locally) using an unreliable protocol. </description> </method> <method name="rset_unreliable_id"> @@ -646,7 +647,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Remotely change property's value on a specific peer identified by [i]peer_id[/i] using an unreliable protocol. + Remotely changes property's value on a specific peer identified by [i]peer_id[/i] using an unreliable protocol. </description> </method> <method name="set_display_folded"> @@ -655,6 +656,7 @@ <argument index="0" name="fold" type="bool"> </argument> <description> + Sets the folded state of the node in the Scene dock. </description> </method> <method name="set_filename"> @@ -663,7 +665,7 @@ <argument index="0" name="filename" type="String"> </argument> <description> - A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded. + A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. </description> </method> <method name="set_name"> @@ -672,7 +674,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Set the name of the [code]Node[/code]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. + Sets the name of the node. The name must be unique within the parent. Using an existing name will cause the node to be automatically renamed. </description> </method> <method name="set_network_master"> @@ -683,6 +685,7 @@ <argument index="1" name="recursive" type="bool" default="true"> </argument> <description> + Sets the node network master to the peer with the given peer ID. The network master is the peer that has authority over it on the network. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). </description> </method> <method name="set_owner"> @@ -691,16 +694,7 @@ <argument index="0" name="owner" type="Node"> </argument> <description> - Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing. - </description> - </method> - <method name="set_pause_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Node.PauseMode"> - </argument> - <description> - Set pause mode (PAUSE_MODE_*) of this Node. + Sets 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 SceneSaver) all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing. </description> </method> <method name="set_physics_process"> @@ -709,7 +703,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables the node's physics (alias fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _physics_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_physics_process_delta_time]. + Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, see [OS] to change) interval (and the [method _physics_process] callback will be called if exists). Enabled automatically if [method _physics_process] is overriden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_physics_process_internal"> @@ -726,7 +720,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_process_delta_time]. + Enables or disables processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). Enabled automatically if [method _process] is overriden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_input"> @@ -735,7 +729,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]). + Enables or disables input processing. This is not required for GUI controls! Enabled automatically if [method _input] is overriden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_internal"> @@ -752,7 +746,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]). + Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a [Control]). Enabled automatically if [method _unhandled_input] is overriden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_unhandled_key_input"> @@ -761,6 +755,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + Enables unhandled key input processing. Enabled automatically if [method _unhandled_key_input] is overriden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_scene_instance_load_placeholder"> @@ -773,10 +768,6 @@ </method> </methods> <members> - <member name="_import_path" type="NodePath" setter="_set_import_path" getter="_get_import_path"> - </member> - <member name="editor/display_folded" type="bool" setter="set_display_folded" getter="is_displayed_folded"> - </member> <member name="pause_mode" type="int" setter="set_pause_mode" getter="get_pause_mode" enum="Node.PauseMode"> </member> </members> @@ -788,84 +779,98 @@ </signal> <signal name="tree_entered"> <description> - Emitted when Node enters the tree. + Emitted when the node enters the tree. </description> </signal> <signal name="tree_exited"> <description> - Emitted when Node exits the tree. + Emitted when the node exits the tree. </description> </signal> </signals> <constants> - <constant name="NOTIFICATION_ENTER_TREE" value="10" enum=""> + <constant name="NOTIFICATION_ENTER_TREE" value="10"> + Notification received when the node enters a [SceneTree]. </constant> - <constant name="NOTIFICATION_EXIT_TREE" value="11" enum=""> + <constant name="NOTIFICATION_EXIT_TREE" value="11"> + Notification received when the node exits a [SceneTree]. </constant> - <constant name="NOTIFICATION_MOVED_IN_PARENT" value="12" enum=""> + <constant name="NOTIFICATION_MOVED_IN_PARENT" value="12"> + Notification received when the node is moved in the parent. </constant> - <constant name="NOTIFICATION_READY" value="13" enum=""> + <constant name="NOTIFICATION_READY" value="13"> + Notification received when the node is ready. See [method _ready]. </constant> - <constant name="NOTIFICATION_PAUSED" value="14" enum=""> + <constant name="NOTIFICATION_PAUSED" value="14"> + Notification received when the node is paused. </constant> - <constant name="NOTIFICATION_UNPAUSED" value="15" enum=""> + <constant name="NOTIFICATION_UNPAUSED" value="15"> + Notification received when the node is unpaused. </constant> - <constant name="NOTIFICATION_PHYSICS_PROCESS" value="16" enum=""> + <constant name="NOTIFICATION_PHYSICS_PROCESS" value="16"> Notification received every frame when the physics process flag is set (see [method set_physics_process]). </constant> - <constant name="NOTIFICATION_PROCESS" value="17" enum=""> + <constant name="NOTIFICATION_PROCESS" value="17"> Notification received every frame when the process flag is set (see [method set_process]). </constant> - <constant name="NOTIFICATION_PARENTED" value="18" enum=""> + <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 Scene Tree. </constant> - <constant name="NOTIFICATION_UNPARENTED" value="19" enum=""> + <constant name="NOTIFICATION_UNPARENTED" value="19"> Notification received when a node is unparented (parent removed it from the list of children). </constant> - <constant name="NOTIFICATION_INSTANCED" value="20" enum=""> + <constant name="NOTIFICATION_INSTANCED" value="20"> + Notification received when the node is instanced. </constant> - <constant name="NOTIFICATION_DRAG_BEGIN" value="21" enum=""> + <constant name="NOTIFICATION_DRAG_BEGIN" value="21"> + Notification received when a drag begins. </constant> - <constant name="NOTIFICATION_DRAG_END" value="22" enum=""> + <constant name="NOTIFICATION_DRAG_END" value="22"> + Notification received when a drag ends. </constant> - <constant name="NOTIFICATION_PATH_CHANGED" value="23" enum=""> + <constant name="NOTIFICATION_PATH_CHANGED" value="23"> + Notification received when the node's [NodePath] changed. </constant> - <constant name="NOTIFICATION_TRANSLATION_CHANGED" value="24" enum=""> + <constant name="NOTIFICATION_TRANSLATION_CHANGED" value="24"> </constant> - <constant name="NOTIFICATION_INTERNAL_PROCESS" value="25" enum=""> + <constant name="NOTIFICATION_INTERNAL_PROCESS" value="25"> </constant> - <constant name="NOTIFICATION_INTERNAL_PHYSICS_PROCESS" value="26" enum=""> + <constant name="NOTIFICATION_INTERNAL_PHYSICS_PROCESS" value="26"> </constant> - <constant name="RPC_MODE_DISABLED" value="0"> + <constant name="RPC_MODE_DISABLED" value="0" enum="RPCMode"> </constant> - <constant name="RPC_MODE_REMOTE" value="1"> + <constant name="RPC_MODE_REMOTE" value="1" enum="RPCMode"> Call a method remotely. </constant> - <constant name="RPC_MODE_SYNC" value="2"> + <constant name="RPC_MODE_SYNC" value="2" enum="RPCMode"> Call a method both remotely and locally. </constant> - <constant name="RPC_MODE_MASTER" value="3"> + <constant name="RPC_MODE_MASTER" value="3" enum="RPCMode"> Call a method if the Node is Master. </constant> - <constant name="RPC_MODE_SLAVE" value="4"> + <constant name="RPC_MODE_SLAVE" value="4" enum="RPCMode"> Call a method if the Node is Slave. </constant> - <constant name="PAUSE_MODE_INHERIT" value="0"> + <constant name="PAUSE_MODE_INHERIT" value="0" enum="PauseMode"> Inherits pause mode from parent. For root node, it is equivalent to PAUSE_MODE_STOP. </constant> - <constant name="PAUSE_MODE_STOP" value="1"> + <constant name="PAUSE_MODE_STOP" value="1" enum="PauseMode"> Stop processing when SceneTree is paused. </constant> - <constant name="PAUSE_MODE_PROCESS" value="2"> + <constant name="PAUSE_MODE_PROCESS" value="2" enum="PauseMode"> Continue to process regardless of SceneTree pause state. </constant> - <constant name="DUPLICATE_SIGNALS" value="1"> + <constant name="DUPLICATE_SIGNALS" value="1" enum="DuplicateFlags"> + Duplicate the node's signals. </constant> - <constant name="DUPLICATE_GROUPS" value="2"> + <constant name="DUPLICATE_GROUPS" value="2" enum="DuplicateFlags"> + Duplicate the node's groups. </constant> - <constant name="DUPLICATE_SCRIPTS" value="4"> + <constant name="DUPLICATE_SCRIPTS" value="4" enum="DuplicateFlags"> + Duplicate the node's scripts. </constant> - <constant name="DUPLICATE_USE_INSTANCING" value="8"> + <constant name="DUPLICATE_USE_INSTANCING" value="8" enum="DuplicateFlags"> + Duplicate using instancing. </constant> </constants> </class> diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 195dd9265f..81978809d7 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Node2D" inherits="CanvasItem" category="Core" version="3.0-alpha"> +<class name="Node2D" inherits="CanvasItem" category="Core" version="3.0-beta"> <brief_description> A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index. </brief_description> @@ -20,15 +20,6 @@ Multiplies the current scale by the 'ratio' vector. </description> </method> - <method name="edit_set_pivot"> - <return type="void"> - </return> - <argument index="0" name="pivot" type="Vector2"> - </argument> - <description> - Sets the node's pivot position. - </description> - </method> <method name="get_angle_to" qualifiers="const"> <return type="float"> </return> @@ -38,41 +29,6 @@ Returns the angle between the node and the 'point' in radians. </description> </method> - <method name="get_global_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the node's global position. - </description> - </method> - <method name="get_global_rotation" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the node's global rotation in radians. - </description> - </method> - <method name="get_global_rotation_degrees" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the node's global rotation in degrees. - </description> - </method> - <method name="get_global_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the node's global scale. - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the node's position. - </description> - </method> <method name="get_relative_transform_to_parent" qualifiers="const"> <return type="Transform2D"> </return> @@ -86,28 +42,6 @@ <return type="float"> </return> <description> - Returns the node's rotation in radians. - </description> - </method> - <method name="get_rotation_degrees" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the node's rotation in degrees. - </description> - </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the node's scale. - </description> - </method> - <method name="get_z" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the node's Z-index. </description> </method> <method name="global_translate"> @@ -119,13 +53,6 @@ Adds the 'offset' vector to the node's global position. </description> </method> - <method name="is_z_relative" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns true if this node's Z-index is relative to its parent's. Else, returns false. - </description> - </method> <method name="look_at"> <return type="void"> </return> @@ -166,112 +93,12 @@ Applies a rotation to the node, in radians, starting from its current rotation. </description> </method> - <method name="set_global_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - Sets the node's global position. - </description> - </method> - <method name="set_global_rotation"> - <return type="void"> - </return> - <argument index="0" name="radians" type="float"> - </argument> - <description> - Sets the node's global rotation in radians. - </description> - </method> - <method name="set_global_rotation_degrees"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - Sets the node's global rotation in degrees. - </description> - </method> - <method name="set_global_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - Sets the node's global scale. - </description> - </method> - <method name="set_global_transform"> - <return type="void"> - </return> - <argument index="0" name="xform" type="Transform2D"> - </argument> - <description> - Sets the node's global [Transform2D]. - </description> - </method> - <method name="set_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - Sets the node's position. - </description> - </method> <method name="set_rotation"> <return type="void"> </return> <argument index="0" name="radians" type="float"> </argument> <description> - Sets the node's rotation in radians. - </description> - </method> - <method name="set_rotation_degrees"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - Sets the node's rotation in degrees. - </description> - </method> - <method name="set_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - Sets the node's scale. - </description> - </method> - <method name="set_transform"> - <return type="void"> - </return> - <argument index="0" name="xform" type="Transform2D"> - </argument> - <description> - Sets the node's local [Transform2D]. - </description> - </method> - <method name="set_z"> - <return type="void"> - </return> - <argument index="0" name="z" type="int"> - </argument> - <description> - Sets the node's Z-index. - </description> - </method> - <method name="set_z_as_relative"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Makes the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. </description> </method> <method name="to_global" qualifiers="const"> @@ -321,9 +148,6 @@ <member name="position" type="Vector2" setter="set_position" getter="get_position"> Position, relative to the node's parent. </member> - <member name="rotation" type="float" setter="set_rotation" getter="get_rotation"> - Rotation in radians, relative to the node's parent. - </member> <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees"> Rotation in degrees, relative to the node's parent. </member> diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index c706864379..8d5de705b5 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NodePath" category="Built-In Types" version="3.0-alpha"> +<class name="NodePath" category="Built-In Types" version="3.0-beta"> <brief_description> Pre-parsed scene tree path. </brief_description> @@ -22,6 +22,18 @@ 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. </description> </method> + <method name="get_as_property_path"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_concatenated_subnames"> + <return type="String"> + </return> + <description> + </description> + </method> <method name="get_name"> <return type="String"> </return> @@ -38,13 +50,6 @@ Get the number of node names which make up the path. </description> </method> - <method name="get_property"> - <return type="String"> - </return> - <description> - Get the path's property name, or an empty string if the path doesn't have a property. - </description> - </method> <method name="get_subname"> <return type="String"> </return> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index db70b99de4..902bf4ebfa 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OS" inherits="Object" category="Core" version="3.0-alpha"> +<class name="OS" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Operating System functions. </brief_description> @@ -127,13 +127,6 @@ Returns the current screen index (0 padded). </description> </method> - <method name="get_data_dir" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the absolute directory path of user data path([user://]). - </description> - </method> <method name="get_date" qualifiers="const"> <return type="Dictionary"> </return> @@ -397,6 +390,13 @@ You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored. </description> </method> + <method name="get_user_data_dir" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the absolute directory path where user data is written ([code]user://[/code]). + </description> + </method> <method name="get_virtual_keyboard_height"> <return type="int"> </return> @@ -828,83 +828,83 @@ </method> </methods> <constants> - <constant name="DAY_SUNDAY" value="0"> + <constant name="DAY_SUNDAY" value="0" enum="Weekday"> </constant> - <constant name="DAY_MONDAY" value="1"> + <constant name="DAY_MONDAY" value="1" enum="Weekday"> </constant> - <constant name="DAY_TUESDAY" value="2"> + <constant name="DAY_TUESDAY" value="2" enum="Weekday"> </constant> - <constant name="DAY_WEDNESDAY" value="3"> + <constant name="DAY_WEDNESDAY" value="3" enum="Weekday"> </constant> - <constant name="DAY_THURSDAY" value="4"> + <constant name="DAY_THURSDAY" value="4" enum="Weekday"> </constant> - <constant name="DAY_FRIDAY" value="5"> + <constant name="DAY_FRIDAY" value="5" enum="Weekday"> </constant> - <constant name="DAY_SATURDAY" value="6"> + <constant name="DAY_SATURDAY" value="6" enum="Weekday"> </constant> - <constant name="MONTH_JANUARY" value="1"> + <constant name="MONTH_JANUARY" value="1" enum="Month"> </constant> - <constant name="MONTH_FEBRUARY" value="2"> + <constant name="MONTH_FEBRUARY" value="2" enum="Month"> </constant> - <constant name="MONTH_MARCH" value="3"> + <constant name="MONTH_MARCH" value="3" enum="Month"> </constant> - <constant name="MONTH_APRIL" value="4"> + <constant name="MONTH_APRIL" value="4" enum="Month"> </constant> - <constant name="MONTH_MAY" value="5"> + <constant name="MONTH_MAY" value="5" enum="Month"> </constant> - <constant name="MONTH_JUNE" value="6"> + <constant name="MONTH_JUNE" value="6" enum="Month"> </constant> - <constant name="MONTH_JULY" value="7"> + <constant name="MONTH_JULY" value="7" enum="Month"> </constant> - <constant name="MONTH_AUGUST" value="8"> + <constant name="MONTH_AUGUST" value="8" enum="Month"> </constant> - <constant name="MONTH_SEPTEMBER" value="9"> + <constant name="MONTH_SEPTEMBER" value="9" enum="Month"> </constant> - <constant name="MONTH_OCTOBER" value="10"> + <constant name="MONTH_OCTOBER" value="10" enum="Month"> </constant> - <constant name="MONTH_NOVEMBER" value="11"> + <constant name="MONTH_NOVEMBER" value="11" enum="Month"> </constant> - <constant name="MONTH_DECEMBER" value="12"> + <constant name="MONTH_DECEMBER" value="12" enum="Month"> </constant> - <constant name="SCREEN_ORIENTATION_LANDSCAPE" value="0"> + <constant name="SCREEN_ORIENTATION_LANDSCAPE" value="0" enum="ScreenOrientation"> </constant> - <constant name="SCREEN_ORIENTATION_PORTRAIT" value="1"> + <constant name="SCREEN_ORIENTATION_PORTRAIT" value="1" enum="ScreenOrientation"> </constant> - <constant name="SCREEN_ORIENTATION_REVERSE_LANDSCAPE" value="2"> + <constant name="SCREEN_ORIENTATION_REVERSE_LANDSCAPE" value="2" enum="ScreenOrientation"> </constant> - <constant name="SCREEN_ORIENTATION_REVERSE_PORTRAIT" value="3"> + <constant name="SCREEN_ORIENTATION_REVERSE_PORTRAIT" value="3" enum="ScreenOrientation"> </constant> - <constant name="SCREEN_ORIENTATION_SENSOR_LANDSCAPE" value="4"> + <constant name="SCREEN_ORIENTATION_SENSOR_LANDSCAPE" value="4" enum="ScreenOrientation"> </constant> - <constant name="SCREEN_ORIENTATION_SENSOR_PORTRAIT" value="5"> + <constant name="SCREEN_ORIENTATION_SENSOR_PORTRAIT" value="5" enum="ScreenOrientation"> </constant> - <constant name="SCREEN_ORIENTATION_SENSOR" value="6"> + <constant name="SCREEN_ORIENTATION_SENSOR" value="6" enum="ScreenOrientation"> </constant> - <constant name="SYSTEM_DIR_DESKTOP" value="0"> + <constant name="SYSTEM_DIR_DESKTOP" value="0" enum="SystemDir"> </constant> - <constant name="SYSTEM_DIR_DCIM" value="1"> + <constant name="SYSTEM_DIR_DCIM" value="1" enum="SystemDir"> </constant> - <constant name="SYSTEM_DIR_DOCUMENTS" value="2"> + <constant name="SYSTEM_DIR_DOCUMENTS" value="2" enum="SystemDir"> </constant> - <constant name="SYSTEM_DIR_DOWNLOADS" value="3"> + <constant name="SYSTEM_DIR_DOWNLOADS" value="3" enum="SystemDir"> </constant> - <constant name="SYSTEM_DIR_MOVIES" value="4"> + <constant name="SYSTEM_DIR_MOVIES" value="4" enum="SystemDir"> </constant> - <constant name="SYSTEM_DIR_MUSIC" value="5"> + <constant name="SYSTEM_DIR_MUSIC" value="5" enum="SystemDir"> </constant> - <constant name="SYSTEM_DIR_PICTURES" value="6"> + <constant name="SYSTEM_DIR_PICTURES" value="6" enum="SystemDir"> </constant> - <constant name="SYSTEM_DIR_RINGTONES" value="7"> + <constant name="SYSTEM_DIR_RINGTONES" value="7" enum="SystemDir"> </constant> - <constant name="POWERSTATE_UNKNOWN" value="0"> + <constant name="POWERSTATE_UNKNOWN" value="0" enum="PowerState"> </constant> - <constant name="POWERSTATE_ON_BATTERY" value="1"> + <constant name="POWERSTATE_ON_BATTERY" value="1" enum="PowerState"> </constant> - <constant name="POWERSTATE_NO_BATTERY" value="2"> + <constant name="POWERSTATE_NO_BATTERY" value="2" enum="PowerState"> </constant> - <constant name="POWERSTATE_CHARGING" value="3"> + <constant name="POWERSTATE_CHARGING" value="3" enum="PowerState"> </constant> - <constant name="POWERSTATE_CHARGED" value="4"> + <constant name="POWERSTATE_CHARGED" value="4" enum="PowerState"> </constant> </constants> </class> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index bea4c14a3c..5d0e51c481 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Object" category="Core" version="3.0-alpha"> +<class name="Object" category="Core" version="3.0-beta"> <brief_description> Base class for all non built-in types. </brief_description> @@ -178,6 +178,14 @@ - "method_name" is a name of method to which signal is connected. </description> </method> + <method name="get_indexed" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="property" type="NodePath"> + </argument> + <description> + </description> + </method> <method name="get_instance_id" qualifiers="const"> <return type="int"> </return> @@ -338,6 +346,16 @@ If set to true, signal emission is blocked. </description> </method> + <method name="set_indexed"> + <return type="void"> + </return> + <argument index="0" name="property" type="NodePath"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> <method name="set_message_translation"> <return type="void"> </return> @@ -384,19 +402,19 @@ </signal> </signals> <constants> - <constant name="NOTIFICATION_POSTINITIALIZE" value="0" enum=""> + <constant name="NOTIFICATION_POSTINITIALIZE" value="0"> Called right when the object is initialized. Not available in script. </constant> - <constant name="NOTIFICATION_PREDELETE" value="1" enum=""> + <constant name="NOTIFICATION_PREDELETE" value="1"> Called before the object is about to be deleted. </constant> - <constant name="CONNECT_DEFERRED" value="1"> + <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. </constant> - <constant name="CONNECT_PERSIST" value="2"> + <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"> + <constant name="CONNECT_ONESHOT" value="4" enum="ConnectFlags"> One shot connections disconnect themselves after emission. </constant> </constants> diff --git a/doc/classes/OccluderPolygon2D.xml b/doc/classes/OccluderPolygon2D.xml index e86aa999ad..f11f82c7de 100644 --- a/doc/classes/OccluderPolygon2D.xml +++ b/doc/classes/OccluderPolygon2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OccluderPolygon2D" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="OccluderPolygon2D" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Defines a 2D polygon for LightOccluder2D. </brief_description> @@ -11,48 +11,6 @@ <demos> </demos> <methods> - <method name="get_cull_mode" qualifiers="const"> - <return type="int" enum="OccluderPolygon2D.CullMode"> - </return> - <description> - </description> - </method> - <method name="get_polygon" qualifiers="const"> - <return type="PoolVector2Array"> - </return> - <description> - </description> - </method> - <method name="is_closed" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_closed"> - <return type="void"> - </return> - <argument index="0" name="closed" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_cull_mode"> - <return type="void"> - </return> - <argument index="0" name="cull_mode" type="int" enum="OccluderPolygon2D.CullMode"> - </argument> - <description> - </description> - </method> - <method name="set_polygon"> - <return type="void"> - </return> - <argument index="0" name="polygon" type="PoolVector2Array"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="closed" type="bool" setter="set_closed" getter="is_closed"> @@ -66,13 +24,13 @@ </member> </members> <constants> - <constant name="CULL_DISABLED" value="0"> + <constant name="CULL_DISABLED" value="0" enum="CullMode"> Culling mode for the occlusion. Disabled means no culling. See [member cull_mode]. </constant> - <constant name="CULL_CLOCKWISE" value="1"> + <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]. </constant> - <constant name="CULL_COUNTER_CLOCKWISE" value="2"> + <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]. </constant> </constants> diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml index 7c8b1d4756..f0c5c81a47 100644 --- a/doc/classes/OmniLight.xml +++ b/doc/classes/OmniLight.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OmniLight" inherits="Light" category="Core" version="3.0-alpha"> +<class name="OmniLight" inherits="Light" category="Core" version="3.0-beta"> <brief_description> OmniDirectional Light, such as a light bulb or a candle. </brief_description> @@ -11,34 +11,6 @@ <demos> </demos> <methods> - <method name="get_shadow_detail" qualifiers="const"> - <return type="int" enum="OmniLight.ShadowDetail"> - </return> - <description> - </description> - </method> - <method name="get_shadow_mode" qualifiers="const"> - <return type="int" enum="OmniLight.ShadowMode"> - </return> - <description> - </description> - </method> - <method name="set_shadow_detail"> - <return type="void"> - </return> - <argument index="0" name="detail" type="int" enum="OmniLight.ShadowDetail"> - </argument> - <description> - </description> - </method> - <method name="set_shadow_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="OmniLight.ShadowMode"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="omni_attenuation" type="float" setter="set_param" getter="get_param"> @@ -51,13 +23,13 @@ </member> </members> <constants> - <constant name="SHADOW_DUAL_PARABOLOID" value="0"> + <constant name="SHADOW_DUAL_PARABOLOID" value="0" enum="ShadowMode"> </constant> - <constant name="SHADOW_CUBE" value="1"> + <constant name="SHADOW_CUBE" value="1" enum="ShadowMode"> </constant> - <constant name="SHADOW_DETAIL_VERTICAL" value="0"> + <constant name="SHADOW_DETAIL_VERTICAL" value="0" enum="ShadowDetail"> </constant> - <constant name="SHADOW_DETAIL_HORIZONTAL" value="1"> + <constant name="SHADOW_DETAIL_HORIZONTAL" value="1" enum="ShadowDetail"> </constant> </constants> </class> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index e08b5cac16..76265e700a 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OptionButton" inherits="Button" category="Core" version="3.0-alpha"> +<class name="OptionButton" inherits="Button" category="Core" version="3.0-beta"> <brief_description> Button control that provides selectable options when pressed. </brief_description> @@ -91,13 +91,6 @@ Return the text of the item at index "idx". </description> </method> - <method name="get_selected" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the current item index - </description> - </method> <method name="get_selected_id" qualifiers="const"> <return type="int"> </return> @@ -190,8 +183,6 @@ </method> </methods> <members> - <member name="items" type="Array" setter="_set_items" getter="_get_items"> - </member> <member name="selected" type="int" setter="_select_int" getter="get_selected"> </member> </members> diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index 4677c15b7b..0e297ba875 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PCKPacker" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="PCKPacker" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PHashTranslation.xml b/doc/classes/PHashTranslation.xml index c74cc8793f..04220e5155 100644 --- a/doc/classes/PHashTranslation.xml +++ b/doc/classes/PHashTranslation.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PHashTranslation" inherits="Translation" category="Core" version="3.0-alpha"> +<class name="PHashTranslation" inherits="Translation" category="Core" version="3.0-beta"> <brief_description> Optimized translation. </brief_description> diff --git a/doc/classes/PackedDataContainer.xml b/doc/classes/PackedDataContainer.xml index 6e660b983a..d4b7bc36c6 100644 --- a/doc/classes/PackedDataContainer.xml +++ b/doc/classes/PackedDataContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PackedDataContainer" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="PackedDataContainer" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PackedDataContainerRef.xml b/doc/classes/PackedDataContainerRef.xml index 9d44307afe..93a5bbb627 100644 --- a/doc/classes/PackedDataContainerRef.xml +++ b/doc/classes/PackedDataContainerRef.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PackedDataContainerRef" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="PackedDataContainerRef" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index a226a2bc28..80ef3afdb1 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PackedScene" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="PackedScene" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> + An abstraction of a serialized scene. </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. TODO: explain ownership, and that node does not need to own itself </description> <tutorials> @@ -14,12 +16,14 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if the scene file has nodes. </description> </method> <method name="get_state"> <return type="SceneState"> </return> <description> + Returns the [code]SceneState[/code] representing the scene file contents. </description> </method> <method name="instance" qualifiers="const"> @@ -28,6 +32,7 @@ <argument index="0" name="edit_state" type="int" enum="PackedScene.GenEditState" default="0"> </argument> <description> + Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the [enum Object.NOTIFICATION_INSTANCED] notification on the root node. </description> </method> <method name="pack"> @@ -42,14 +47,19 @@ </methods> <members> <member name="_bundled" type="Dictionary" setter="_set_bundled_scene" getter="_get_bundled_scene"> + A dictionary representation of the scene contents. + Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. </member> </members> <constants> - <constant name="GEN_EDIT_STATE_DISABLED" value="0"> + <constant name="GEN_EDIT_STATE_DISABLED" value="0" enum="GenEditState"> + If passed to [method instance], blocks edits to the scene state. </constant> - <constant name="GEN_EDIT_STATE_INSTANCE" value="1"> + <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. </constant> - <constant name="GEN_EDIT_STATE_MAIN" value="2"> + <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. </constant> </constants> </class> diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index b99d5dc5e9..891f0c9ffc 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PacketPeer" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="PacketPeer" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Abstraction and base class for packet-based protocols. </brief_description> diff --git a/doc/classes/PacketPeerStream.xml b/doc/classes/PacketPeerStream.xml index 38e2d9c1a1..5d320a09f8 100644 --- a/doc/classes/PacketPeerStream.xml +++ b/doc/classes/PacketPeerStream.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.0-alpha"> +<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.0-beta"> <brief_description> Wrapper to use a PacketPeer over a StreamPeer. </brief_description> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 758ad35365..838365bc87 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PacketPeerUDP" inherits="PacketPeer" category="Core" version="3.0-alpha"> +<class name="PacketPeerUDP" inherits="PacketPeer" category="Core" version="3.0-beta"> <brief_description> UDP packet peer. </brief_description> diff --git a/doc/classes/Panel.xml b/doc/classes/Panel.xml index 28a1e304aa..e0dc2cafce 100644 --- a/doc/classes/Panel.xml +++ b/doc/classes/Panel.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Panel" inherits="Control" category="Core" version="3.0-alpha"> +<class name="Panel" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Provides an opaque background for [Control] children. </brief_description> diff --git a/doc/classes/PanelContainer.xml b/doc/classes/PanelContainer.xml index 415d71c8e7..2a3fb2eeb9 100644 --- a/doc/classes/PanelContainer.xml +++ b/doc/classes/PanelContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PanelContainer" inherits="Container" category="Core" version="3.0-alpha"> +<class name="PanelContainer" inherits="Container" category="Core" version="3.0-beta"> <brief_description> Panel container type. </brief_description> diff --git a/doc/classes/PanoramaSky.xml b/doc/classes/PanoramaSky.xml index 7f24bb294b..6a26347120 100644 --- a/doc/classes/PanoramaSky.xml +++ b/doc/classes/PanoramaSky.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PanoramaSky" inherits="Sky" category="Core" version="3.0-alpha"> +<class name="PanoramaSky" inherits="Sky" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,20 +9,6 @@ <demos> </demos> <methods> - <method name="get_panorama" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="set_panorama"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="panorama" type="Texture" setter="set_panorama" getter="get_panorama"> diff --git a/doc/classes/ParallaxBackground.xml b/doc/classes/ParallaxBackground.xml index 3186f6b972..da22f03845 100644 --- a/doc/classes/ParallaxBackground.xml +++ b/doc/classes/ParallaxBackground.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ParallaxBackground" inherits="CanvasLayer" category="Core" version="3.0-alpha"> +<class name="ParallaxBackground" inherits="CanvasLayer" category="Core" version="3.0-beta"> <brief_description> A node used to create a parallax scrolling background. </brief_description> @@ -11,100 +11,6 @@ <demos> </demos> <methods> - <method name="get_limit_begin" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the beginning limit. - </description> - </method> - <method name="get_limit_end" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the ending limit. - </description> - </method> - <method name="get_scroll_base_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the base offset. - </description> - </method> - <method name="get_scroll_base_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the base motion scale. - </description> - </method> - <method name="get_scroll_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="is_ignore_camera_zoom"> - <return type="bool"> - </return> - <description> - Return ignoring camera zoom. - </description> - </method> - <method name="set_ignore_camera_zoom"> - <return type="void"> - </return> - <argument index="0" name="ignore" type="bool"> - </argument> - <description> - Set to true for all child [ParallaxLayer] nodes to not be affected by the zoom level of the camera. - </description> - </method> - <method name="set_limit_begin"> - <return type="void"> - </return> - <argument index="0" name="ofs" type="Vector2"> - </argument> - <description> - Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis. - </description> - </method> - <method name="set_limit_end"> - <return type="void"> - </return> - <argument index="0" name="ofs" type="Vector2"> - </argument> - <description> - Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis. - </description> - </method> - <method name="set_scroll_base_offset"> - <return type="void"> - </return> - <argument index="0" name="ofs" type="Vector2"> - </argument> - <description> - Set the base offset in pixels of all children [ParallaxLayer] nodes. - </description> - </method> - <method name="set_scroll_base_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - Set the base motion scale of all children [ParallaxLayer] nodes. - </description> - </method> - <method name="set_scroll_offset"> - <return type="void"> - </return> - <argument index="0" name="ofs" type="Vector2"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="scroll_base_offset" type="Vector2" setter="set_scroll_base_offset" getter="get_scroll_base_offset"> diff --git a/doc/classes/ParallaxLayer.xml b/doc/classes/ParallaxLayer.xml index 784395b1ec..c70e6befc4 100644 --- a/doc/classes/ParallaxLayer.xml +++ b/doc/classes/ParallaxLayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ParallaxLayer" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="ParallaxLayer" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> A parallax scrolling layer to be used with [ParallaxBackground]. </brief_description> @@ -12,52 +12,6 @@ <demos> </demos> <methods> - <method name="get_mirroring" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the mirroring of the ParallaxLayer. - </description> - </method> - <method name="get_motion_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_motion_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the motion scale of the ParallaxLayer. - </description> - </method> - <method name="set_mirroring"> - <return type="void"> - </return> - <argument index="0" name="mirror" type="Vector2"> - </argument> - <description> - Set the mirroring of the ParallaxLayer. If an axis is set to 0 then that axis will have no mirroring. - </description> - </method> - <method name="set_motion_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_motion_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera. - </description> - </method> </methods> <members> <member name="motion_mirroring" type="Vector2" setter="set_mirroring" getter="get_mirroring"> diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index 4e070f67fd..2a5dcb26e8 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Particles" inherits="GeometryInstance" category="Core" version="3.0-alpha"> +<class name="Particles" inherits="GeometryInstance" category="Core" version="3.0-beta"> <brief_description> 3D particle emitter. </brief_description> @@ -13,105 +13,7 @@ </demos> <methods> <method name="capture_aabb" qualifiers="const"> - <return type="Rect3"> - </return> - <description> - </description> - </method> - <method name="get_amount" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_draw_order" qualifiers="const"> - <return type="int" enum="Particles.DrawOrder"> - </return> - <description> - </description> - </method> - <method name="get_draw_pass_mesh" qualifiers="const"> - <return type="Mesh"> - </return> - <argument index="0" name="pass" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_draw_passes" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_explosiveness_ratio" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fixed_fps" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_fractional_delta" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_lifetime" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_one_shot" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_pre_process_time" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_process_material" qualifiers="const"> - <return type="Material"> - </return> - <description> - </description> - </method> - <method name="get_randomness_ratio" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_speed_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_use_local_coordinates" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_visibility_aabb" qualifiers="const"> - <return type="Rect3"> - </return> - <description> - </description> - </method> - <method name="is_emitting" qualifiers="const"> - <return type="bool"> + <return type="AABB"> </return> <description> </description> @@ -122,136 +24,6 @@ <description> </description> </method> - <method name="set_amount"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_draw_order"> - <return type="void"> - </return> - <argument index="0" name="order" type="int" enum="Particles.DrawOrder"> - </argument> - <description> - </description> - </method> - <method name="set_draw_pass_mesh"> - <return type="void"> - </return> - <argument index="0" name="pass" type="int"> - </argument> - <argument index="1" name="mesh" type="Mesh"> - </argument> - <description> - </description> - </method> - <method name="set_draw_passes"> - <return type="void"> - </return> - <argument index="0" name="passes" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_emitting"> - <return type="void"> - </return> - <argument index="0" name="emitting" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_explosiveness_ratio"> - <return type="void"> - </return> - <argument index="0" name="ratio" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fixed_fps"> - <return type="void"> - </return> - <argument index="0" name="fps" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_fractional_delta"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_lifetime"> - <return type="void"> - </return> - <argument index="0" name="secs" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_one_shot"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_pre_process_time"> - <return type="void"> - </return> - <argument index="0" name="secs" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_process_material"> - <return type="void"> - </return> - <argument index="0" name="material" type="Material"> - </argument> - <description> - </description> - </method> - <method name="set_randomness_ratio"> - <return type="void"> - </return> - <argument index="0" name="ratio" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_speed_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_use_local_coordinates"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_visibility_aabb"> - <return type="void"> - </return> - <argument index="0" name="aabb" type="Rect3"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="amount" type="int" setter="set_amount" getter="get_amount"> @@ -300,20 +72,20 @@ <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> Speed scaling ratio. Default value: [code]1[/code]. </member> - <member name="visibility_aabb" type="Rect3" setter="set_visibility_aabb" getter="get_visibility_aabb"> + <member name="visibility_aabb" type="AABB" setter="set_visibility_aabb" getter="get_visibility_aabb"> </member> </members> <constants> - <constant name="DRAW_ORDER_INDEX" value="0"> + <constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder"> Particles are drawn in the order emitted. </constant> - <constant name="DRAW_ORDER_LIFETIME" value="1"> + <constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder"> Particles are drawn in order of remaining lifetime. </constant> - <constant name="DRAW_ORDER_VIEW_DEPTH" value="2"> + <constant name="DRAW_ORDER_VIEW_DEPTH" value="2" enum="DrawOrder"> Particles are drawn in order of depth. </constant> - <constant name="MAX_DRAW_PASSES" value="4" enum=""> + <constant name="MAX_DRAW_PASSES" value="4"> </constant> </constants> </class> diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index be69e03d56..8b908a1fa2 100644 --- a/doc/classes/Particles2D.xml +++ b/doc/classes/Particles2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Particles2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Particles2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> 2D particle emitter. </brief_description> @@ -18,271 +18,12 @@ <description> </description> </method> - <method name="get_amount" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the amount of particles spawned at each emission - </description> - </method> - <method name="get_draw_order" qualifiers="const"> - <return type="int" enum="Particles2D.DrawOrder"> - </return> - <description> - </description> - </method> - <method name="get_explosiveness_ratio" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fixed_fps" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_fractional_delta" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_h_frames" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_lifetime" qualifiers="const"> - <return type="float"> - </return> - <description> - Gets the amount of seconds that each particle will be visible. - </description> - </method> - <method name="get_normal_map" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_one_shot" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_pre_process_time" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_process_material" qualifiers="const"> - <return type="Material"> - </return> - <description> - </description> - </method> - <method name="get_randomness_ratio" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_speed_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - Returns the texture for emitted particles - </description> - </method> - <method name="get_use_local_coordinates" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_v_frames" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_visibility_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="is_emitting" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether this emitter is currently emitting or not - </description> - </method> <method name="restart"> <return type="void"> </return> <description> </description> </method> - <method name="set_amount"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Sets the amount of particles spawned at each emission - </description> - </method> - <method name="set_draw_order"> - <return type="void"> - </return> - <argument index="0" name="order" type="int" enum="Particles2D.DrawOrder"> - </argument> - <description> - </description> - </method> - <method name="set_emitting"> - <return type="void"> - </return> - <argument index="0" name="emitting" type="bool"> - </argument> - <description> - If this is set to true then the particle emitter will emit particles, if its false it will not. - </description> - </method> - <method name="set_explosiveness_ratio"> - <return type="void"> - </return> - <argument index="0" name="ratio" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fixed_fps"> - <return type="void"> - </return> - <argument index="0" name="fps" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_fractional_delta"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_h_frames"> - <return type="void"> - </return> - <argument index="0" name="frames" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_lifetime"> - <return type="void"> - </return> - <argument index="0" name="secs" type="float"> - </argument> - <description> - Sets the amount of seconds that each particle will be visible. - </description> - </method> - <method name="set_normal_map"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_one_shot"> - <return type="void"> - </return> - <argument index="0" name="secs" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_pre_process_time"> - <return type="void"> - </return> - <argument index="0" name="secs" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_process_material"> - <return type="void"> - </return> - <argument index="0" name="material" type="Material"> - </argument> - <description> - </description> - </method> - <method name="set_randomness_ratio"> - <return type="void"> - </return> - <argument index="0" name="ratio" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_speed_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_use_local_coordinates"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_v_frames"> - <return type="void"> - </return> - <argument index="0" name="frames" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_visibility_rect"> - <return type="void"> - </return> - <argument index="0" name="aabb" type="Rect2"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="amount" type="int" setter="set_amount" getter="get_amount"> @@ -338,10 +79,10 @@ </member> </members> <constants> - <constant name="DRAW_ORDER_INDEX" value="0"> + <constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder"> Particles are drawn in the order emitted. </constant> - <constant name="DRAW_ORDER_LIFETIME" value="1"> + <constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder"> Particles are drawn in order of remaining lifetime. </constant> </constants> diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 2428d1880d..42bc1b2d05 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ParticlesMaterial" inherits="Material" category="Core" version="3.0-alpha"> +<class name="ParticlesMaterial" inherits="Material" category="Core" version="3.0-beta"> <brief_description> Particle properties for [Particles] and [Particles2D] nodes. </brief_description> @@ -12,288 +12,6 @@ <demos> </demos> <methods> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_color_ramp" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_emission_box_extents" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_emission_color_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_emission_normal_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_emission_point_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_emission_point_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_emission_shape" qualifiers="const"> - <return type="int" enum="ParticlesMaterial.EmissionShape"> - </return> - <description> - </description> - </method> - <method name="get_emission_sphere_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int" enum="ParticlesMaterial.Flags"> - </argument> - <description> - </description> - </method> - <method name="get_flatness" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_gravity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> - </argument> - <description> - </description> - </method> - <method name="get_param_randomness" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> - </argument> - <description> - </description> - </method> - <method name="get_param_texture" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> - </argument> - <description> - </description> - </method> - <method name="get_spread" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_trail_color_modifier" qualifiers="const"> - <return type="GradientTexture"> - </return> - <description> - </description> - </method> - <method name="get_trail_divisor" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_trail_size_modifier" qualifiers="const"> - <return type="CurveTexture"> - </return> - <description> - </description> - </method> - <method name="set_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_color_ramp"> - <return type="void"> - </return> - <argument index="0" name="ramp" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_emission_box_extents"> - <return type="void"> - </return> - <argument index="0" name="extents" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_emission_color_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_emission_normal_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_emission_point_count"> - <return type="void"> - </return> - <argument index="0" name="point_count" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_emission_point_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_emission_shape"> - <return type="void"> - </return> - <argument index="0" name="shape" type="int" enum="ParticlesMaterial.EmissionShape"> - </argument> - <description> - </description> - </method> - <method name="set_emission_sphere_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_flag"> - <return type="void"> - </return> - <argument index="0" name="flag" type="int" enum="ParticlesMaterial.Flags"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_flatness"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_gravity"> - <return type="void"> - </return> - <argument index="0" name="accel_vec" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_param"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_param_randomness"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> - </argument> - <argument index="1" name="randomness" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_param_texture"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_spread"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_trail_color_modifier"> - <return type="void"> - </return> - <argument index="0" name="texture" type="GradientTexture"> - </argument> - <description> - </description> - </method> - <method name="set_trail_divisor"> - <return type="void"> - </return> - <argument index="0" name="divisor" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_trail_size_modifier"> - <return type="void"> - </return> - <argument index="0" name="texture" type="CurveTexture"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="angle" type="float" setter="set_param" getter="get_param"> @@ -454,64 +172,64 @@ </member> </members> <constants> - <constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0"> + <constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set initial velocity properties. </constant> - <constant name="PARAM_ANGULAR_VELOCITY" value="1"> + <constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angular velocity properties. </constant> - <constant name="PARAM_ORBIT_VELOCITY" value="2"> + <constant name="PARAM_ORBIT_VELOCITY" value="2" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set orbital_velocity properties. </constant> - <constant name="PARAM_LINEAR_ACCEL" value="3"> + <constant name="PARAM_LINEAR_ACCEL" value="3" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set linear acceleration properties. </constant> - <constant name="PARAM_RADIAL_ACCEL" value="4"> + <constant name="PARAM_RADIAL_ACCEL" value="4" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set radial acceleration properties. </constant> - <constant name="PARAM_TANGENTIAL_ACCEL" value="5"> + <constant name="PARAM_TANGENTIAL_ACCEL" value="5" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set tangential acceleration properties. </constant> - <constant name="PARAM_DAMPING" value="6"> + <constant name="PARAM_DAMPING" value="6" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set damping properties. </constant> - <constant name="PARAM_ANGLE" value="7"> + <constant name="PARAM_ANGLE" value="7" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angle properties. </constant> - <constant name="PARAM_SCALE" value="8"> + <constant name="PARAM_SCALE" value="8" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set scale properties. </constant> - <constant name="PARAM_HUE_VARIATION" value="9"> + <constant name="PARAM_HUE_VARIATION" value="9" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue_variation properties. </constant> - <constant name="PARAM_ANIM_SPEED" value="10"> + <constant name="PARAM_ANIM_SPEED" value="10" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation speed properties. </constant> - <constant name="PARAM_ANIM_OFFSET" value="11"> + <constant name="PARAM_ANIM_OFFSET" value="11" enum="Parameter"> Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation offset properties. </constant> - <constant name="PARAM_MAX" value="12"> + <constant name="PARAM_MAX" value="12" enum="Parameter"> </constant> - <constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0"> + <constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="Flags"> Use with [method set_flag] to set [member flag_align_y]. </constant> - <constant name="FLAG_ROTATE_Y" value="1"> + <constant name="FLAG_ROTATE_Y" value="1" enum="Flags"> Use with [method set_flag] to set [member flag_rotate_y] </constant> - <constant name="FLAG_MAX" value="4"> + <constant name="FLAG_MAX" value="4" enum="Flags"> </constant> - <constant name="EMISSION_SHAPE_POINT" value="0"> + <constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape"> All particles will be emitted from a single point. </constant> - <constant name="EMISSION_SHAPE_SPHERE" value="1"> + <constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape"> Particles will be emitted in the volume of a sphere. </constant> - <constant name="EMISSION_SHAPE_BOX" value="2"> + <constant name="EMISSION_SHAPE_BOX" value="2" enum="EmissionShape"> Particles will be emitted in the volume of a box. </constant> - <constant name="EMISSION_SHAPE_POINTS" value="3"> + <constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape"> </constant> - <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4"> + <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape"> </constant> </constants> </class> diff --git a/doc/classes/Path.xml b/doc/classes/Path.xml index 8138a92dcc..a5e690e121 100644 --- a/doc/classes/Path.xml +++ b/doc/classes/Path.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Path" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="Path" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Container for a [Curve3D]. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_curve" qualifiers="const"> - <return type="Curve3D"> - </return> - <description> - Returns the [Curve3D] contained. - </description> - </method> - <method name="set_curve"> - <return type="void"> - </return> - <argument index="0" name="curve" type="Curve3D"> - </argument> - <description> - Sets the [Curve3D]. - </description> - </method> </methods> <members> <member name="curve" type="Curve3D" setter="set_curve" getter="get_curve"> diff --git a/doc/classes/Path2D.xml b/doc/classes/Path2D.xml index 8172fc2c4b..832b86f516 100644 --- a/doc/classes/Path2D.xml +++ b/doc/classes/Path2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Path2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Path2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Contains a [Curve2D] path for [PathFollow2D] nodes to follow. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_curve" qualifiers="const"> - <return type="Curve2D"> - </return> - <description> - Returns the [Curve2D] contained. - </description> - </method> - <method name="set_curve"> - <return type="void"> - </return> - <argument index="0" name="curve" type="Curve2D"> - </argument> - <description> - Sets the [Curve2D]. - </description> - </method> </methods> <members> <member name="curve" type="Curve2D" setter="set_curve" getter="get_curve"> diff --git a/doc/classes/PathFollow.xml b/doc/classes/PathFollow.xml index bdf2a082e0..de7bb8715c 100644 --- a/doc/classes/PathFollow.xml +++ b/doc/classes/PathFollow.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PathFollow" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="PathFollow" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Point sampler for a [Path]. </brief_description> @@ -129,16 +129,16 @@ </method> </methods> <constants> - <constant name="ROTATION_NONE" value="0"> + <constant name="ROTATION_NONE" value="0" enum="RotationMode"> Forbids the PathFollow to rotate. </constant> - <constant name="ROTATION_Y" value="1"> + <constant name="ROTATION_Y" value="1" enum="RotationMode"> Allows the PathFollow to rotate in the Y axis only. </constant> - <constant name="ROTATION_XY" value="2"> + <constant name="ROTATION_XY" value="2" enum="RotationMode"> Allows the PathFollow to rotate in both the X, and Y axes. </constant> - <constant name="ROTATION_XYZ" value="3"> + <constant name="ROTATION_XYZ" value="3" enum="RotationMode"> Allows the PathFollow to rotate in any axis. </constant> </constants> diff --git a/doc/classes/PathFollow2D.xml b/doc/classes/PathFollow2D.xml index 01137d01d0..56bec3d719 100644 --- a/doc/classes/PathFollow2D.xml +++ b/doc/classes/PathFollow2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PathFollow2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="PathFollow2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Point sampler for a [Path2D]. </brief_description> diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index daf1bd62ed..5781d6c604 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Performance" inherits="Object" category="Core" version="3.0-alpha"> +<class name="Performance" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Exposes performance related data. </brief_description> @@ -26,87 +26,87 @@ </method> </methods> <constants> - <constant name="TIME_FPS" value="0"> + <constant name="TIME_FPS" value="0" enum="Monitor"> Frames per second. </constant> - <constant name="TIME_PROCESS" value="1"> + <constant name="TIME_PROCESS" value="1" enum="Monitor"> Time it took to complete one frame. </constant> - <constant name="TIME_PHYSICS_PROCESS" value="2"> + <constant name="TIME_PHYSICS_PROCESS" value="2" enum="Monitor"> Time it took to complete one physics frame. </constant> - <constant name="MEMORY_STATIC" value="3"> + <constant name="MEMORY_STATIC" value="3" enum="Monitor"> Static memory currently used, in bytes. Not available in release builds. </constant> - <constant name="MEMORY_DYNAMIC" value="4"> + <constant name="MEMORY_DYNAMIC" value="4" enum="Monitor"> Dynamic memory currently used, in bytes. Not available in release builds. </constant> - <constant name="MEMORY_STATIC_MAX" value="5"> + <constant name="MEMORY_STATIC_MAX" value="5" enum="Monitor"> Available static memory. Not available in release builds. </constant> - <constant name="MEMORY_DYNAMIC_MAX" value="6"> + <constant name="MEMORY_DYNAMIC_MAX" value="6" enum="Monitor"> Available dynamic memory. Not available in release builds. </constant> - <constant name="MEMORY_MESSAGE_BUFFER_MAX" value="7"> + <constant name="MEMORY_MESSAGE_BUFFER_MAX" value="7" enum="Monitor"> Largest amount of memory the message queue buffer has used, in bytes. The message queue is used for deferred functions calls and notifications. </constant> - <constant name="OBJECT_COUNT" value="8"> + <constant name="OBJECT_COUNT" value="8" enum="Monitor"> Number of objects currently instanced (including nodes). </constant> - <constant name="OBJECT_RESOURCE_COUNT" value="9"> + <constant name="OBJECT_RESOURCE_COUNT" value="9" enum="Monitor"> Number of resources currently used. </constant> - <constant name="OBJECT_NODE_COUNT" value="10"> + <constant name="OBJECT_NODE_COUNT" value="10" enum="Monitor"> Number of nodes currently instanced. This also includes the root node, as well as any nodes not in the scene tree. </constant> - <constant name="RENDER_OBJECTS_IN_FRAME" value="11"> + <constant name="RENDER_OBJECTS_IN_FRAME" value="11" enum="Monitor"> 3D objects drawn per frame. </constant> - <constant name="RENDER_VERTICES_IN_FRAME" value="12"> + <constant name="RENDER_VERTICES_IN_FRAME" value="12" enum="Monitor"> Vertices drawn per frame. 3D only. </constant> - <constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="13"> + <constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="13" enum="Monitor"> Material changes per frame. 3D only </constant> - <constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="14"> + <constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="14" enum="Monitor"> Shader changes per frame. 3D only. </constant> - <constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="15"> + <constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="15" enum="Monitor"> Render surface changes per frame. 3D only. </constant> - <constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16"> + <constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16" enum="Monitor"> Draw calls per frame. 3D only. </constant> - <constant name="RENDER_VIDEO_MEM_USED" value="17"> + <constant name="RENDER_VIDEO_MEM_USED" value="17" enum="Monitor"> Video memory used. Includes both texture and vertex memory. </constant> - <constant name="RENDER_TEXTURE_MEM_USED" value="18"> + <constant name="RENDER_TEXTURE_MEM_USED" value="18" enum="Monitor"> Texture memory used. </constant> - <constant name="RENDER_VERTEX_MEM_USED" value="19"> + <constant name="RENDER_VERTEX_MEM_USED" value="19" enum="Monitor"> Vertex memory used. </constant> - <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20"> + <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20" enum="Monitor"> </constant> - <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21"> + <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21" enum="Monitor"> Number of active [RigidBody2D] nodes in the game. </constant> - <constant name="PHYSICS_2D_COLLISION_PAIRS" value="22"> + <constant name="PHYSICS_2D_COLLISION_PAIRS" value="22" enum="Monitor"> Number of collision pairs in the 2D physics engine. </constant> - <constant name="PHYSICS_2D_ISLAND_COUNT" value="23"> + <constant name="PHYSICS_2D_ISLAND_COUNT" value="23" enum="Monitor"> Number of islands in the 2D physics engine. </constant> - <constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="24"> + <constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="24" enum="Monitor"> Number of active [RigidBody] and [VehicleBody] nodes in the game. </constant> - <constant name="PHYSICS_3D_COLLISION_PAIRS" value="25"> + <constant name="PHYSICS_3D_COLLISION_PAIRS" value="25" enum="Monitor"> Number of collision pairs in the 3D physics engine. </constant> - <constant name="PHYSICS_3D_ISLAND_COUNT" value="26"> + <constant name="PHYSICS_3D_ISLAND_COUNT" value="26" enum="Monitor"> Number of islands in the 3D physics engine. </constant> - <constant name="MONITOR_MAX" value="27"> + <constant name="MONITOR_MAX" value="27" enum="Monitor"> </constant> </constants> </class> diff --git a/doc/classes/Physics2DDirectBodyState.xml b/doc/classes/Physics2DDirectBodyState.xml index 40666d8330..a229ca494d 100644 --- a/doc/classes/Physics2DDirectBodyState.xml +++ b/doc/classes/Physics2DDirectBodyState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DDirectBodyState" inherits="Object" category="Core" version="3.0-alpha"> +<class name="Physics2DDirectBodyState" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Direct access object to a physics body in the [Physics2DServer]. </brief_description> diff --git a/doc/classes/Physics2DDirectBodyStateSW.xml b/doc/classes/Physics2DDirectBodyStateSW.xml index 865fb6a347..0ce51e2cf5 100644 --- a/doc/classes/Physics2DDirectBodyStateSW.xml +++ b/doc/classes/Physics2DDirectBodyStateSW.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DDirectBodyStateSW" inherits="Physics2DDirectBodyState" category="Core" version="3.0-alpha"> +<class name="Physics2DDirectBodyStateSW" inherits="Physics2DDirectBodyState" category="Core" version="3.0-beta"> <brief_description> Software implementation of [Physics2DDirectBodyState]. </brief_description> diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml index ca7dbab8b8..f63b8f17bc 100644 --- a/doc/classes/Physics2DDirectSpaceState.xml +++ b/doc/classes/Physics2DDirectSpaceState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DDirectSpaceState" inherits="Object" category="Core" version="3.0-alpha"> +<class name="Physics2DDirectSpaceState" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Direct access object to a space in the [Physics2DServer]. </brief_description> @@ -18,7 +18,7 @@ </argument> <description> Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide. - If the shape can not move, the array will be empty. + If the shape can not move, the array will be empty. </description> </method> <method name="collide_shape"> @@ -61,8 +61,6 @@ </argument> <argument index="3" name="collision_layer" type="int" default="2147483647"> </argument> - <argument index="4" name="type_mask" type="int" default="15"> - </argument> <description> Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: shape: Shape index within the object the point is in. @@ -70,7 +68,7 @@ collider_id: Id of the object the point is in. collider: Object the point is inside of. rid: [RID] of the object the point is in. - Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. </description> </method> <method name="intersect_ray"> @@ -84,8 +82,6 @@ </argument> <argument index="3" name="collision_layer" type="int" default="2147483647"> </argument> - <argument index="4" name="type_mask" type="int" default="15"> - </argument> <description> Intersect a ray in a given space. The returned object is a dictionary with the following fields: position: Place where ray is stopped. @@ -96,7 +92,7 @@ collider: Object against which the ray was stopped. rid: [RID] of the object against which the ray was stopped. If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. - Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. </description> </method> <method name="intersect_shape"> @@ -118,23 +114,5 @@ </method> </methods> <constants> - <constant name="TYPE_MASK_STATIC_BODY" value="1"> - Check for collisions with static bodies. - </constant> - <constant name="TYPE_MASK_KINEMATIC_BODY" value="2"> - Check for collisions with kinematic bodies. - </constant> - <constant name="TYPE_MASK_RIGID_BODY" value="4"> - Check for collisions with rigid bodies. - </constant> - <constant name="TYPE_MASK_CHARACTER_BODY" value="8"> - Check for collisions with rigid bodies in character mode. - </constant> - <constant name="TYPE_MASK_COLLISION" value="15"> - Check for collisions with any kind of bodies (but not areas). - </constant> - <constant name="TYPE_MASK_AREA" value="16"> - Check for collisions with areas. - </constant> </constants> </class> diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index f3115144fa..67f5f84a49 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DServer" inherits="Object" category="Core" version="3.0-alpha"> +<class name="Physics2DServer" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Physics 2D Server. </brief_description> @@ -989,183 +989,183 @@ </method> </methods> <constants> - <constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0"> + <constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0" enum="SpaceParameter"> Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. </constant> - <constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1"> + <constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1" enum="SpaceParameter"> Constant to set/get the maximum distance a shape can be from another before they are considered separated. </constant> - <constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2"> + <constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2" enum="SpaceParameter"> Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. </constant> - <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3"> + <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3" enum="SpaceParameter"> Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. </constant> - <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4"> + <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4" enum="SpaceParameter"> Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. </constant> - <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5"> + <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5" enum="SpaceParameter"> Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. </constant> - <constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="6"> + <constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="6" enum="SpaceParameter"> Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. </constant> - <constant name="SHAPE_LINE" value="0"> + <constant name="SHAPE_LINE" value="0" enum="ShapeType"> This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks. </constant> - <constant name="SHAPE_RAY" value="1"> + <constant name="SHAPE_RAY" value="1" enum="ShapeType"> </constant> - <constant name="SHAPE_SEGMENT" value="2"> + <constant name="SHAPE_SEGMENT" value="2" enum="ShapeType"> This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections. </constant> - <constant name="SHAPE_CIRCLE" value="3"> + <constant name="SHAPE_CIRCLE" value="3" enum="ShapeType"> This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks. </constant> - <constant name="SHAPE_RECTANGLE" value="4"> + <constant name="SHAPE_RECTANGLE" value="4" enum="ShapeType"> This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks. </constant> - <constant name="SHAPE_CAPSULE" value="5"> + <constant name="SHAPE_CAPSULE" value="5" enum="ShapeType"> This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks. </constant> - <constant name="SHAPE_CONVEX_POLYGON" value="6"> + <constant name="SHAPE_CONVEX_POLYGON" value="6" enum="ShapeType"> This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method [method CollisionPolygon2D.set_polygon], polygons modified with [method shape_set_data] do not verify that the points supplied form is a convex polygon. </constant> - <constant name="SHAPE_CONCAVE_POLYGON" value="7"> + <constant name="SHAPE_CONCAVE_POLYGON" value="7" enum="ShapeType"> This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks. </constant> - <constant name="SHAPE_CUSTOM" value="8"> + <constant name="SHAPE_CUSTOM" value="8" enum="ShapeType"> This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. </constant> - <constant name="AREA_PARAM_GRAVITY" value="0"> + <constant name="AREA_PARAM_GRAVITY" value="0" enum="AreaParameter"> Constant to set/get gravity strength in an area. </constant> - <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1"> + <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1" enum="AreaParameter"> Constant to set/get gravity vector/center in an area. </constant> - <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2"> + <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2" enum="AreaParameter"> Constant to set/get whether the gravity vector of an area is a direction, or a center point. </constant> - <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3"> + <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3" enum="AreaParameter"> Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. </constant> - <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> + <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter"> This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE. </constant> - <constant name="AREA_PARAM_LINEAR_DAMP" value="5"> + <constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter"> Constant to set/get the linear dampening factor of an area. </constant> - <constant name="AREA_PARAM_ANGULAR_DAMP" value="6"> + <constant name="AREA_PARAM_ANGULAR_DAMP" value="6" enum="AreaParameter"> Constant to set/get the angular dampening factor of an area. </constant> - <constant name="AREA_PARAM_PRIORITY" value="7"> + <constant name="AREA_PARAM_PRIORITY" value="7" enum="AreaParameter"> Constant to set/get the priority (order of processing) of an area. </constant> - <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0" enum="AreaSpaceOverrideMode"> This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. </constant> - <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1" enum="AreaSpaceOverrideMode"> This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. </constant> - <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2" enum="AreaSpaceOverrideMode"> This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3" enum="AreaSpaceOverrideMode"> This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4" enum="AreaSpaceOverrideMode"> This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </constant> - <constant name="BODY_MODE_STATIC" value="0"> + <constant name="BODY_MODE_STATIC" value="0" enum="BodyMode"> Constant for static bodies. </constant> - <constant name="BODY_MODE_KINEMATIC" value="1"> + <constant name="BODY_MODE_KINEMATIC" value="1" enum="BodyMode"> Constant for kinematic bodies. </constant> - <constant name="BODY_MODE_RIGID" value="2"> + <constant name="BODY_MODE_RIGID" value="2" enum="BodyMode"> Constant for rigid bodies. </constant> - <constant name="BODY_MODE_CHARACTER" value="3"> + <constant name="BODY_MODE_CHARACTER" value="3" enum="BodyMode"> Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. </constant> - <constant name="BODY_PARAM_BOUNCE" value="0"> + <constant name="BODY_PARAM_BOUNCE" value="0" enum="BodyParameter"> Constant to set/get a body's bounce factor. </constant> - <constant name="BODY_PARAM_FRICTION" value="1"> + <constant name="BODY_PARAM_FRICTION" value="1" enum="BodyParameter"> Constant to set/get a body's friction. </constant> - <constant name="BODY_PARAM_MASS" value="2"> + <constant name="BODY_PARAM_MASS" value="2" enum="BodyParameter"> Constant to set/get a body's mass. </constant> - <constant name="BODY_PARAM_INERTIA" value="3"> + <constant name="BODY_PARAM_INERTIA" value="3" enum="BodyParameter"> Constant to set/get a body's inertia. </constant> - <constant name="BODY_PARAM_GRAVITY_SCALE" value="4"> + <constant name="BODY_PARAM_GRAVITY_SCALE" value="4" enum="BodyParameter"> Constant to set/get a body's gravity multiplier. </constant> - <constant name="BODY_PARAM_LINEAR_DAMP" value="5"> + <constant name="BODY_PARAM_LINEAR_DAMP" value="5" enum="BodyParameter"> Constant to set/get a body's linear dampening factor. </constant> - <constant name="BODY_PARAM_ANGULAR_DAMP" value="6"> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="6" enum="BodyParameter"> Constant to set/get a body's angular dampening factor. </constant> - <constant name="BODY_PARAM_MAX" value="7"> + <constant name="BODY_PARAM_MAX" value="7" enum="BodyParameter"> This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. </constant> - <constant name="BODY_STATE_TRANSFORM" value="0"> + <constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState"> Constant to set/get the current transform matrix of the body. </constant> - <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> + <constant name="BODY_STATE_LINEAR_VELOCITY" value="1" enum="BodyState"> Constant to set/get the current linear velocity of the body. </constant> - <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> + <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2" enum="BodyState"> Constant to set/get the current angular velocity of the body. </constant> - <constant name="BODY_STATE_SLEEPING" value="3"> + <constant name="BODY_STATE_SLEEPING" value="3" enum="BodyState"> Constant to sleep/wake up a body, or to get whether it is sleeping. </constant> - <constant name="BODY_STATE_CAN_SLEEP" value="4"> + <constant name="BODY_STATE_CAN_SLEEP" value="4" enum="BodyState"> Constant to set/get whether the body can sleep. </constant> - <constant name="JOINT_PIN" value="0"> + <constant name="JOINT_PIN" value="0" enum="JointType"> Constant to create pin joints. </constant> - <constant name="JOINT_GROOVE" value="1"> + <constant name="JOINT_GROOVE" value="1" enum="JointType"> Constant to create groove joints. </constant> - <constant name="JOINT_DAMPED_SPRING" value="2"> + <constant name="JOINT_DAMPED_SPRING" value="2" enum="JointType"> Constant to create damped spring joints. </constant> - <constant name="DAMPED_STRING_REST_LENGTH" value="0"> + <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. </constant> - <constant name="DAMPED_STRING_STIFFNESS" value="1"> + <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. </constant> - <constant name="DAMPED_STRING_DAMPING" value="2"> + <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). </constant> - <constant name="CCD_MODE_DISABLED" value="0"> + <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. </constant> - <constant name="CCD_MODE_CAST_RAY" value="1"> + <constant name="CCD_MODE_CAST_RAY" value="1" enum="CCDMode"> Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. </constant> - <constant name="CCD_MODE_CAST_SHAPE" value="2"> + <constant name="CCD_MODE_CAST_SHAPE" value="2" enum="CCDMode"> Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. </constant> - <constant name="AREA_BODY_ADDED" value="0"> + <constant name="AREA_BODY_ADDED" value="0" enum="AreaBodyStatus"> The value of the first parameter and area callback function receives, when an object enters one of its shapes. </constant> - <constant name="AREA_BODY_REMOVED" value="1"> + <constant name="AREA_BODY_REMOVED" value="1" enum="AreaBodyStatus"> The value of the first parameter and area callback function receives, when an object exits one of its shapes. </constant> - <constant name="INFO_ACTIVE_OBJECTS" value="0"> + <constant name="INFO_ACTIVE_OBJECTS" value="0" enum="ProcessInfo"> Constant to get the number of objects that are not sleeping. </constant> - <constant name="INFO_COLLISION_PAIRS" value="1"> + <constant name="INFO_COLLISION_PAIRS" value="1" enum="ProcessInfo"> Constant to get the number of possible collisions. </constant> - <constant name="INFO_ISLAND_COUNT" value="2"> + <constant name="INFO_ISLAND_COUNT" value="2" enum="ProcessInfo"> Constant to get the number of space regions where a collision could occur. </constant> </constants> diff --git a/doc/classes/Physics2DServerSW.xml b/doc/classes/Physics2DServerSW.xml index 6764f1a4f6..09fed88082 100644 --- a/doc/classes/Physics2DServerSW.xml +++ b/doc/classes/Physics2DServerSW.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DServerSW" inherits="Physics2DServer" category="Core" version="3.0-alpha"> +<class name="Physics2DServerSW" inherits="Physics2DServer" category="Core" version="3.0-beta"> <brief_description> Software implementation of [Physics2DServer]. </brief_description> diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 829aec7a25..93165afe60 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Parameters to be sent to a 2D shape physics query. </brief_description> @@ -39,13 +39,6 @@ Return the current movement speed of the shape. </description> </method> - <method name="get_object_type_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the type of object the shape belongs to. - </description> - </method> <method name="get_shape_rid" qualifiers="const"> <return type="RID"> </return> @@ -96,15 +89,6 @@ Set the current movement speed of the shape. </description> </method> - <method name="set_object_type_mask"> - <return type="void"> - </return> - <argument index="0" name="object_type_mask" type="int"> - </argument> - <description> - Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*). - </description> - </method> <method name="set_shape"> <return type="void"> </return> diff --git a/doc/classes/Physics2DShapeQueryResult.xml b/doc/classes/Physics2DShapeQueryResult.xml index d5a29e79fa..5345ad161f 100644 --- a/doc/classes/Physics2DShapeQueryResult.xml +++ b/doc/classes/Physics2DShapeQueryResult.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DShapeQueryResult" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="Physics2DShapeQueryResult" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Physics2DTestMotionResult.xml b/doc/classes/Physics2DTestMotionResult.xml index 6bc4849184..bc7cb68bc9 100644 --- a/doc/classes/Physics2DTestMotionResult.xml +++ b/doc/classes/Physics2DTestMotionResult.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DTestMotionResult" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="Physics2DTestMotionResult" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index 579a074731..79164215c8 100644 --- a/doc/classes/PhysicsBody.xml +++ b/doc/classes/PhysicsBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsBody" inherits="CollisionObject" category="Core" version="3.0-alpha"> +<class name="PhysicsBody" inherits="CollisionObject" category="Core" version="3.0-beta"> <brief_description> Base class for all objects affected by physics in 3D space. </brief_description> @@ -20,12 +20,6 @@ Adds a body to the list of bodies that this body can't collide with. </description> </method> - <method name="get_collision_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_collision_layer_bit" qualifiers="const"> <return type="bool"> </return> @@ -34,12 +28,6 @@ <description> </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> @@ -57,14 +45,6 @@ Removes a body from the list of bodies that this body can't collide with. </description> </method> - <method name="set_collision_layer"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - </description> - </method> <method name="set_collision_layer_bit"> <return type="void"> </return> @@ -75,14 +55,6 @@ <description> </description> </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - </description> - </method> <method name="set_collision_mask_bit"> <return type="void"> </return> diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index bf341692bf..aaf782c245 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core" version="3.0-alpha"> +<class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core" version="3.0-beta"> <brief_description> Base class for all objects affected by physics in 2D space. </brief_description> @@ -20,13 +20,6 @@ Adds a body to the list of bodies that this body can't collide with. </description> </method> - <method name="get_collision_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layer this area is in. - </description> - </method> <method name="get_collision_layer_bit" qualifiers="const"> <return type="bool"> </return> @@ -36,13 +29,6 @@ Return an individual bit on the collision mask. </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layers this area can scan for collisions. - </description> - </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> @@ -61,17 +47,6 @@ Removes a body from the list of bodies that this body can't collide with. </description> </method> - <method name="set_collision_layer"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - Set the physics layers this area is in. - Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - </description> - </method> <method name="set_collision_layer_bit"> <return type="void"> </return> @@ -83,15 +58,6 @@ Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. </description> </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the physics layers this area can scan for collisions. - </description> - </method> <method name="set_collision_mask_bit"> <return type="void"> </return> diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml index 33dafa29f6..1d588ecfff 100644 --- a/doc/classes/PhysicsDirectBodyState.xml +++ b/doc/classes/PhysicsDirectBodyState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsDirectBodyState" inherits="Object" category="Core" version="3.0-alpha"> +<class name="PhysicsDirectBodyState" inherits="Object" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml index b5765b6421..21576646f9 100644 --- a/doc/classes/PhysicsDirectSpaceState.xml +++ b/doc/classes/PhysicsDirectSpaceState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsDirectSpaceState" inherits="Object" category="Core" version="3.0-alpha"> +<class name="PhysicsDirectSpaceState" inherits="Object" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -48,8 +48,6 @@ </argument> <argument index="3" name="collision_layer" type="int" default="2147483647"> </argument> - <argument index="4" name="type_mask" type="int" default="15"> - </argument> <description> </description> </method> @@ -65,17 +63,5 @@ </method> </methods> <constants> - <constant name="TYPE_MASK_STATIC_BODY" value="1"> - </constant> - <constant name="TYPE_MASK_KINEMATIC_BODY" value="2"> - </constant> - <constant name="TYPE_MASK_RIGID_BODY" value="4"> - </constant> - <constant name="TYPE_MASK_CHARACTER_BODY" value="8"> - </constant> - <constant name="TYPE_MASK_COLLISION" value="15"> - </constant> - <constant name="TYPE_MASK_AREA" value="16"> - </constant> </constants> </class> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 76dabd12ba..534449a94b 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsServer" inherits="Object" category="Core" version="3.0-alpha"> +<class name="PhysicsServer" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Server interface for low level physics access. </brief_description> @@ -351,15 +351,6 @@ Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. </description> </method> - <method name="body_get_axis_lock" qualifiers="const"> - <return type="int" enum="PhysicsServer.BodyAxisLock"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - Gets the information, which Axis is locked if any. The can be any calue from the constants BODY_AXIS_LOCK* - </description> - </method> <method name="body_get_collision_layer" qualifiers="const"> <return type="int"> </return> @@ -485,6 +476,16 @@ Returns a body state. </description> </method> + <method name="body_is_axis_locked" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxis"> + </argument> + <description> + </description> + </method> <method name="body_is_continuous_collision_detection_enabled" qualifiers="const"> <return type="bool"> </return> @@ -540,10 +541,11 @@ </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxisLock"> + <argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxis"> + </argument> + <argument index="2" name="lock" type="bool"> </argument> <description> - Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. </description> </method> <method name="body_set_axis_velocity"> @@ -1170,366 +1172,366 @@ </method> </methods> <constants> - <constant name="JOINT_PIN" value="0"> + <constant name="JOINT_PIN" value="0" enum="JointType"> The [Joint] is a [PinJoint]. </constant> - <constant name="JOINT_HINGE" value="1"> + <constant name="JOINT_HINGE" value="1" enum="JointType"> The [Joint] is a [HingeJoint]. </constant> - <constant name="JOINT_SLIDER" value="2"> + <constant name="JOINT_SLIDER" value="2" enum="JointType"> The [Joint] is a [SliderJoint]. </constant> - <constant name="JOINT_CONE_TWIST" value="3"> + <constant name="JOINT_CONE_TWIST" value="3" enum="JointType"> The [Joint] is a [ConeTwistJoint]. </constant> - <constant name="JOINT_6DOF" value="4"> + <constant name="JOINT_6DOF" value="4" enum="JointType"> The [Joint] is a [Generic6DOFJoint]. </constant> - <constant name="PIN_JOINT_BIAS" value="0"> + <constant name="PIN_JOINT_BIAS" value="0" enum="PinJointParam"> The strength with which the pinned objects try to stay in positional relation to each other. The higher, the stronger. </constant> - <constant name="PIN_JOINT_DAMPING" value="1"> + <constant name="PIN_JOINT_DAMPING" value="1" enum="PinJointParam"> The strength with which the pinned objects try to stay in velocity relation to each other. The higher, the stronger. </constant> - <constant name="PIN_JOINT_IMPULSE_CLAMP" value="2"> + <constant name="PIN_JOINT_IMPULSE_CLAMP" value="2" enum="PinJointParam"> If above 0, this value is the maximum value for an impulse that this Joint puts on it's ends. </constant> - <constant name="HINGE_JOINT_BIAS" value="0"> + <constant name="HINGE_JOINT_BIAS" value="0" enum="HingeJointParam"> The speed with wich the two bodies get pulled together when they move in different directions. </constant> - <constant name="HINGE_JOINT_LIMIT_UPPER" value="1"> + <constant name="HINGE_JOINT_LIMIT_UPPER" value="1" enum="HingeJointParam"> The maximum rotation across the Hinge. </constant> - <constant name="HINGE_JOINT_LIMIT_LOWER" value="2"> + <constant name="HINGE_JOINT_LIMIT_LOWER" value="2" enum="HingeJointParam"> The minimum rotation across the Hinge. </constant> - <constant name="HINGE_JOINT_LIMIT_BIAS" value="3"> + <constant name="HINGE_JOINT_LIMIT_BIAS" value="3" enum="HingeJointParam"> The speed with which the rotation across the axis perpendicular to the hinge gets corrected. </constant> - <constant name="HINGE_JOINT_LIMIT_SOFTNESS" value="4"> + <constant name="HINGE_JOINT_LIMIT_SOFTNESS" value="4" enum="HingeJointParam"> </constant> - <constant name="HINGE_JOINT_LIMIT_RELAXATION" value="5"> + <constant name="HINGE_JOINT_LIMIT_RELAXATION" value="5" enum="HingeJointParam"> The lower this value, the more the rotation gets slowed down. </constant> - <constant name="HINGE_JOINT_MOTOR_TARGET_VELOCITY" value="6"> + <constant name="HINGE_JOINT_MOTOR_TARGET_VELOCITY" value="6" enum="HingeJointParam"> Target speed for the motor. </constant> - <constant name="HINGE_JOINT_MOTOR_MAX_IMPULSE" value="7"> + <constant name="HINGE_JOINT_MOTOR_MAX_IMPULSE" value="7" enum="HingeJointParam"> Maximum acceleration for the motor. </constant> - <constant name="HINGE_JOINT_FLAG_USE_LIMIT" value="0"> + <constant name="HINGE_JOINT_FLAG_USE_LIMIT" value="0" enum="HingeJointFlag"> If [code]true[/code] the Hinge has a maximum and a minimum rotation. </constant> - <constant name="HINGE_JOINT_FLAG_ENABLE_MOTOR" value="1"> + <constant name="HINGE_JOINT_FLAG_ENABLE_MOTOR" value="1" enum="HingeJointFlag"> If [code]true[/code] a motor turns the Hinge </constant> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0"> + <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. </constant> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1"> + <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. </constant> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2"> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="SliderJointParam"> A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. </constant> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3"> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3" enum="SliderJointParam"> The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. </constant> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value="4"> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value="4" enum="SliderJointParam"> The amount of damping once the slider limits are surpassed. </constant> - <constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5"> + <constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5" enum="SliderJointParam"> A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. </constant> - <constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6"> + <constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6" enum="SliderJointParam"> The amount of restitution inside the slider limits. </constant> - <constant name="SLIDER_JOINT_LINEAR_MOTION_DAMPING" value="7"> + <constant name="SLIDER_JOINT_LINEAR_MOTION_DAMPING" value="7" enum="SliderJointParam"> The amount of damping inside the slider limits. </constant> - <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> + <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8" enum="SliderJointParam"> A factor applied to the movement accross axes orthogonal to the slider. </constant> - <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> + <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9" enum="SliderJointParam"> The amount of restitution when movement is accross axes orthogonal to the slider. </constant> - <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10"> + <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10" enum="SliderJointParam"> The amount of damping when movement is accross axes orthogonal to the slider. </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11" enum="SliderJointParam"> The upper limit of rotation in the slider. </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value="12"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value="12" enum="SliderJointParam"> The lower limit of rotation in the slider. </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value="13"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value="13" enum="SliderJointParam"> A factor applied to the all rotation once the limit is surpassed. </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value="14"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value="14" enum="SliderJointParam"> The amount of restitution of the rotation when the limit is surpassed. </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value="15"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value="15" enum="SliderJointParam"> The amount of damping of the rotation when the limit is surpassed. </constant> - <constant name="SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value="16"> + <constant name="SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value="16" enum="SliderJointParam"> A factor that gets applied to the all rotation in the limits. </constant> - <constant name="SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value="17"> + <constant name="SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value="17" enum="SliderJointParam"> The amount of restitution of the rotation in the limits. </constant> - <constant name="SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value="18"> + <constant name="SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value="18" enum="SliderJointParam"> The amount of damping of the rotation in the limits. </constant> - <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value="19"> + <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value="19" enum="SliderJointParam"> A factor that gets applied to the all rotation across axes orthogonal to the slider. </constant> - <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value="20"> + <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value="20" enum="SliderJointParam"> The amount of restitution of the rotation across axes orthogonal to the slider. </constant> - <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value="21"> + <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value="21" enum="SliderJointParam"> The amount of damping of the rotation across axes orthogonal to the slider. </constant> - <constant name="SLIDER_JOINT_MAX" value="22"> + <constant name="SLIDER_JOINT_MAX" value="22" enum="SliderJointParam"> End flag of SLIDER_JOINT_* constants, used internally. </constant> - <constant name="CONE_TWIST_JOINT_SWING_SPAN" value="0"> + <constant name="CONE_TWIST_JOINT_SWING_SPAN" value="0" enum="ConeTwistJointParam"> Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected allong the swing axis. Could be defined as looseness in the [ConeTwistJoint]. If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code]. </constant> - <constant name="CONE_TWIST_JOINT_TWIST_SPAN" value="1"> + <constant name="CONE_TWIST_JOINT_TWIST_SPAN" value="1" enum="ConeTwistJointParam"> Twist is the rotation around the twist axis, this value defined how far the joint can twist. Twist is locked if below 0.05. </constant> - <constant name="CONE_TWIST_JOINT_BIAS" value="2"> + <constant name="CONE_TWIST_JOINT_BIAS" value="2" enum="ConeTwistJointParam"> The speed with which the swing or twist will take place. The higher, the faster. </constant> - <constant name="CONE_TWIST_JOINT_SOFTNESS" value="3"> + <constant name="CONE_TWIST_JOINT_SOFTNESS" value="3" enum="ConeTwistJointParam"> The ease with which the Joint twists, if it's too low, it takes more force to twist the joint. </constant> - <constant name="CONE_TWIST_JOINT_RELAXATION" value="4"> + <constant name="CONE_TWIST_JOINT_RELAXATION" value="4" enum="ConeTwistJointParam"> Defines, how fast the swing- and twist-speed-difference on both sides gets synced. </constant> - <constant name="G6DOF_JOINT_LINEAR_LOWER_LIMIT" value="0"> + <constant name="G6DOF_JOINT_LINEAR_LOWER_LIMIT" value="0" enum="G6DOFJointAxisParam"> The minimum difference between the pivot points' axes. </constant> - <constant name="G6DOF_JOINT_LINEAR_UPPER_LIMIT" value="1"> + <constant name="G6DOF_JOINT_LINEAR_UPPER_LIMIT" value="1" enum="G6DOFJointAxisParam"> The maximum difference between the pivot points' axes. </constant> - <constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2"> + <constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="G6DOFJointAxisParam"> A factor that gets applied to the movement accross the axes. The lower, the slower the movement. </constant> - <constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3"> + <constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3" enum="G6DOFJointAxisParam"> The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost. </constant> - <constant name="G6DOF_JOINT_LINEAR_DAMPING" value="4"> + <constant name="G6DOF_JOINT_LINEAR_DAMPING" value="4" enum="G6DOFJointAxisParam"> The amount of damping that happens at the linear motion across the axes. </constant> - <constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="5"> + <constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="5" enum="G6DOFJointAxisParam"> The minimum rotation in negative direction to break loose and rotate arround the axes. </constant> - <constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="6"> + <constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="6" enum="G6DOFJointAxisParam"> The minimum rotation in positive direction to break loose and rotate arround the axes. </constant> - <constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="7"> + <constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="7" enum="G6DOFJointAxisParam"> A factor that gets multiplied onto all rotations accross the axes. </constant> - <constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8"> + <constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8" enum="G6DOFJointAxisParam"> The amount of rotational damping accross the axes. The lower, the more dampening occurs. </constant> - <constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9"> + <constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9" enum="G6DOFJointAxisParam"> The amount of rotational restitution accross the axes. The lower, the more restitution occurs. </constant> - <constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10"> + <constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10" enum="G6DOFJointAxisParam"> The maximum amount of force that can occur, when rotating arround the axes. </constant> - <constant name="G6DOF_JOINT_ANGULAR_ERP" value="11"> + <constant name="G6DOF_JOINT_ANGULAR_ERP" value="11" enum="G6DOFJointAxisParam"> When correcting the crossing of limits in rotation accross the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </constant> - <constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12"> + <constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12" enum="G6DOFJointAxisParam"> Target speed for the motor at the axes. </constant> - <constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13"> + <constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13" enum="G6DOFJointAxisParam"> Maximum acceleration for the motor at the axes. </constant> - <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0"> + <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="G6DOFJointAxisFlag"> If [code]set[/code] there is linear motion possible within the given limits. </constant> - <constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1"> + <constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1" enum="G6DOFJointAxisFlag"> If [code]set[/code] there is rotational motion possible. </constant> - <constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2"> + <constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2" enum="G6DOFJointAxisFlag"> If [code]set[/code] there is a rotational motor across these axes. </constant> - <constant name="SHAPE_PLANE" value="0"> + <constant name="SHAPE_PLANE" value="0" enum="ShapeType"> The [Shape] is a [PlaneShape]. </constant> - <constant name="SHAPE_RAY" value="1"> + <constant name="SHAPE_RAY" value="1" enum="ShapeType"> The [Shape] is a [RayShape]. </constant> - <constant name="SHAPE_SPHERE" value="2"> + <constant name="SHAPE_SPHERE" value="2" enum="ShapeType"> The [Shape] is a [SphereShape]. </constant> - <constant name="SHAPE_BOX" value="3"> + <constant name="SHAPE_BOX" value="3" enum="ShapeType"> The [Shape] is a [BoxShape]. </constant> - <constant name="SHAPE_CAPSULE" value="4"> + <constant name="SHAPE_CAPSULE" value="4" enum="ShapeType"> The [Shape] is a [CapsuleShape]. </constant> - <constant name="SHAPE_CONVEX_POLYGON" value="5"> + <constant name="SHAPE_CONVEX_POLYGON" value="5" enum="ShapeType"> The [Shape] is a [ConvexPolygonShape]. </constant> - <constant name="SHAPE_CONCAVE_POLYGON" value="6"> + <constant name="SHAPE_CONCAVE_POLYGON" value="6" enum="ShapeType"> The [Shape] is a [ConcavePolygonShape]. </constant> - <constant name="SHAPE_HEIGHTMAP" value="7"> + <constant name="SHAPE_HEIGHTMAP" value="7" enum="ShapeType"> The [Shape] is a [HeightMapShape]. </constant> - <constant name="SHAPE_CUSTOM" value="8"> + <constant name="SHAPE_CUSTOM" value="8" enum="ShapeType"> This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. </constant> - <constant name="AREA_PARAM_GRAVITY" value="0"> + <constant name="AREA_PARAM_GRAVITY" value="0" enum="AreaParameter"> Constant to set/get gravity strength in an area. </constant> - <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1"> + <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1" enum="AreaParameter"> Constant to set/get gravity vector/center in an area. </constant> - <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2"> + <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2" enum="AreaParameter"> Constant to set/get whether the gravity vector of an area is a direction, or a center point. </constant> - <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3"> + <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3" enum="AreaParameter"> Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. </constant> - <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> + <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter"> This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE. </constant> - <constant name="AREA_PARAM_LINEAR_DAMP" value="5"> + <constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter"> Constant to set/get the linear dampening factor of an area. </constant> - <constant name="AREA_PARAM_ANGULAR_DAMP" value="6"> + <constant name="AREA_PARAM_ANGULAR_DAMP" value="6" enum="AreaParameter"> Constant to set/get the angular dampening factor of an area. </constant> - <constant name="AREA_PARAM_PRIORITY" value="7"> + <constant name="AREA_PARAM_PRIORITY" value="7" enum="AreaParameter"> Constant to set/get the priority (order of processing) of an area. </constant> - <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0" enum="AreaSpaceOverrideMode"> This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. </constant> - <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1" enum="AreaSpaceOverrideMode"> This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. </constant> - <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2" enum="AreaSpaceOverrideMode"> This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3" enum="AreaSpaceOverrideMode"> This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4" enum="AreaSpaceOverrideMode"> This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </constant> - <constant name="BODY_MODE_STATIC" value="0"> + <constant name="BODY_MODE_STATIC" value="0" enum="BodyMode"> Constant for static bodies. </constant> - <constant name="BODY_MODE_KINEMATIC" value="1"> + <constant name="BODY_MODE_KINEMATIC" value="1" enum="BodyMode"> Constant for kinematic bodies. </constant> - <constant name="BODY_MODE_RIGID" value="2"> + <constant name="BODY_MODE_RIGID" value="2" enum="BodyMode"> Constant for rigid bodies. </constant> - <constant name="BODY_MODE_SOFT" value="3"> + <constant name="BODY_MODE_SOFT" value="3" enum="BodyMode"> </constant> - <constant name="BODY_MODE_CHARACTER" value="4"> + <constant name="BODY_MODE_CHARACTER" value="4" enum="BodyMode"> Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. </constant> - <constant name="BODY_PARAM_BOUNCE" value="0"> + <constant name="BODY_PARAM_BOUNCE" value="0" enum="BodyParameter"> Constant to set/get a body's bounce factor. </constant> - <constant name="BODY_PARAM_FRICTION" value="1"> + <constant name="BODY_PARAM_FRICTION" value="1" enum="BodyParameter"> Constant to set/get a body's friction. </constant> - <constant name="BODY_PARAM_MASS" value="2"> + <constant name="BODY_PARAM_MASS" value="2" enum="BodyParameter"> Constant to set/get a body's mass. </constant> - <constant name="BODY_PARAM_GRAVITY_SCALE" value="3"> + <constant name="BODY_PARAM_GRAVITY_SCALE" value="3" enum="BodyParameter"> Constant to set/get a body's gravity multiplier. </constant> - <constant name="BODY_PARAM_LINEAR_DAMP" value="4"> + <constant name="BODY_PARAM_LINEAR_DAMP" value="4" enum="BodyParameter"> Constant to set/get a body's linear dampening factor. </constant> - <constant name="BODY_PARAM_ANGULAR_DAMP" value="5"> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="5" enum="BodyParameter"> Constant to set/get a body's angular dampening factor. </constant> - <constant name="BODY_PARAM_MAX" value="6"> + <constant name="BODY_PARAM_MAX" value="6" enum="BodyParameter"> This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. </constant> - <constant name="BODY_STATE_TRANSFORM" value="0"> + <constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState"> Constant to set/get the current transform matrix of the body. </constant> - <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> + <constant name="BODY_STATE_LINEAR_VELOCITY" value="1" enum="BodyState"> Constant to set/get the current linear velocity of the body. </constant> - <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> + <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2" enum="BodyState"> Constant to set/get the current angular velocity of the body. </constant> - <constant name="BODY_STATE_SLEEPING" value="3"> + <constant name="BODY_STATE_SLEEPING" value="3" enum="BodyState"> Constant to sleep/wake up a body, or to get whether it is sleeping. </constant> - <constant name="BODY_STATE_CAN_SLEEP" value="4"> + <constant name="BODY_STATE_CAN_SLEEP" value="4" enum="BodyState"> Constant to set/get whether the body can sleep. </constant> - <constant name="AREA_BODY_ADDED" value="0"> + <constant name="AREA_BODY_ADDED" value="0" enum="AreaBodyStatus"> The value of the first parameter and area callback function receives, when an object enters one of its shapes. </constant> - <constant name="AREA_BODY_REMOVED" value="1"> + <constant name="AREA_BODY_REMOVED" value="1" enum="AreaBodyStatus"> The value of the first parameter and area callback function receives, when an object exits one of its shapes. </constant> - <constant name="INFO_ACTIVE_OBJECTS" value="0"> + <constant name="INFO_ACTIVE_OBJECTS" value="0" enum="ProcessInfo"> Constant to get the number of objects that are not sleeping. </constant> - <constant name="INFO_COLLISION_PAIRS" value="1"> + <constant name="INFO_COLLISION_PAIRS" value="1" enum="ProcessInfo"> Constant to get the number of possible collisions. </constant> - <constant name="INFO_ISLAND_COUNT" value="2"> + <constant name="INFO_ISLAND_COUNT" value="2" enum="ProcessInfo"> Constant to get the number of space regions where a collision could occur. </constant> - <constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0"> + <constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0" enum="SpaceParameter"> Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. </constant> - <constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1"> + <constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1" enum="SpaceParameter"> Constant to set/get the maximum distance a shape can be from another before they are considered separated. </constant> - <constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2"> + <constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2" enum="SpaceParameter"> Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. </constant> - <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3"> + <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3" enum="SpaceParameter"> Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. </constant> - <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4"> + <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4" enum="SpaceParameter"> Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. </constant> - <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5"> + <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5" enum="SpaceParameter"> Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. </constant> - <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO" value="6"> + <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO" value="6" enum="SpaceParameter"> </constant> - <constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7"> + <constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7" enum="SpaceParameter"> Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. </constant> - <constant name="BODY_AXIS_LOCK_DISABLED" value="0"> - The [Body] can rotate and move freely. + <constant name="BODY_AXIS_LINEAR_X" value="1" enum="BodyAxis"> + </constant> + <constant name="BODY_AXIS_LINEAR_Y" value="2" enum="BodyAxis"> + </constant> + <constant name="BODY_AXIS_LINEAR_Z" value="4" enum="BodyAxis"> </constant> - <constant name="BODY_AXIS_LOCK_X" value="1"> - The [Body] cannot move across x axis can only rotate across x axis. + <constant name="BODY_AXIS_ANGULAR_X" value="8" enum="BodyAxis"> </constant> - <constant name="BODY_AXIS_LOCK_Y" value="2"> - The [Body] cannot move across y axis can only rotate across y axis. + <constant name="BODY_AXIS_ANGULAR_Y" value="16" enum="BodyAxis"> </constant> - <constant name="BODY_AXIS_LOCK_Z" value="3"> - The [Body] cannot move across z axis can only rotate across z axis. + <constant name="BODY_AXIS_ANGULAR_Z" value="32" enum="BodyAxis"> </constant> </constants> </class> diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index b9023194d7..98d6846b13 100644 --- a/doc/classes/PhysicsShapeQueryParameters.xml +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsShapeQueryParameters" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="PhysicsShapeQueryParameters" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,7 +9,7 @@ <demos> </demos> <methods> - <method name="get_collision_layer" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> @@ -27,12 +27,6 @@ <description> </description> </method> - <method name="get_object_type_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_shape_rid" qualifiers="const"> <return type="RID"> </return> @@ -45,10 +39,10 @@ <description> </description> </method> - <method name="set_collision_layer"> + <method name="set_collision_mask"> <return type="void"> </return> - <argument index="0" name="collision_layer" type="int"> + <argument index="0" name="collision_mask" type="int"> </argument> <description> </description> @@ -69,14 +63,6 @@ <description> </description> </method> - <method name="set_object_type_mask"> - <return type="void"> - </return> - <argument index="0" name="object_type_mask" type="int"> - </argument> - <description> - </description> - </method> <method name="set_shape"> <return type="void"> </return> diff --git a/doc/classes/PhysicsShapeQueryResult.xml b/doc/classes/PhysicsShapeQueryResult.xml index 2e723e96df..d18d09b612 100644 --- a/doc/classes/PhysicsShapeQueryResult.xml +++ b/doc/classes/PhysicsShapeQueryResult.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsShapeQueryResult" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="PhysicsShapeQueryResult" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Result of a shape query in Physics2DServer. </brief_description> diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index bcf69df816..46e3d3c512 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PinJoint" inherits="Joint" category="Core" version="3.0-alpha"> +<class name="PinJoint" inherits="Joint" category="Core" version="3.0-beta"> <brief_description> Pin Joint for 3D Shapes. </brief_description> @@ -11,24 +11,6 @@ <demos> </demos> <methods> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="PinJoint.Param"> - </argument> - <description> - </description> - </method> - <method name="set_param"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="PinJoint.Param"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="params/bias" type="float" setter="set_param" getter="get_param"> @@ -44,15 +26,15 @@ </member> </members> <constants> - <constant name="PARAM_BIAS" value="0"> + <constant name="PARAM_BIAS" value="0" enum="Param"> The force with wich the pinned objects stay in positional relation to each other. The higher, the stronger. </constant> - <constant name="PARAM_DAMPING" value="1"> + <constant name="PARAM_DAMPING" value="1" enum="Param"> The force with wich the pinned objects stay in velocity relation to each other. The higher, the stronger. </constant> - <constant name="PARAM_IMPULSE_CLAMP" value="2"> + <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. </constant> </constants> diff --git a/doc/classes/PinJoint2D.xml b/doc/classes/PinJoint2D.xml index 7f92567ae4..c8a886896e 100644 --- a/doc/classes/PinJoint2D.xml +++ b/doc/classes/PinJoint2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PinJoint2D" inherits="Joint2D" category="Core" version="3.0-alpha"> +<class name="PinJoint2D" inherits="Joint2D" category="Core" version="3.0-beta"> <brief_description> Pin Joint for 2D Shapes. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_softness" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_softness"> - <return type="void"> - </return> - <argument index="0" name="softness" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="softness" type="float" setter="set_softness" getter="get_softness"> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index 2fd02a56c6..c895850a64 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Plane" category="Built-In Types" version="3.0-alpha"> +<class name="Plane" category="Built-In Types" version="3.0-beta"> <brief_description> Plane in hessian form. </brief_description> diff --git a/doc/classes/PlaneMesh.xml b/doc/classes/PlaneMesh.xml index 93bc191e45..760d64d2de 100644 --- a/doc/classes/PlaneMesh.xml +++ b/doc/classes/PlaneMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PlaneMesh" inherits="PrimitiveMesh" category="Core" version="3.0-alpha"> +<class name="PlaneMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> <brief_description> Class representing a planar [PrimitiveMesh]. </brief_description> @@ -11,48 +11,6 @@ <demos> </demos> <methods> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_subdivide_depth" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_subdivide_width" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_subdivide_depth"> - <return type="void"> - </return> - <argument index="0" name="subdivide" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_subdivide_width"> - <return type="void"> - </return> - <argument index="0" name="subdivide" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="size" type="Vector2" setter="set_size" getter="get_size"> diff --git a/doc/classes/PlaneShape.xml b/doc/classes/PlaneShape.xml index d394f781e3..b3adf61d68 100644 --- a/doc/classes/PlaneShape.xml +++ b/doc/classes/PlaneShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PlaneShape" inherits="Shape" category="Core" version="3.0-alpha"> +<class name="PlaneShape" inherits="Shape" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,20 +9,6 @@ <demos> </demos> <methods> - <method name="get_plane" qualifiers="const"> - <return type="Plane"> - </return> - <description> - </description> - </method> - <method name="set_plane"> - <return type="void"> - </return> - <argument index="0" name="plane" type="Plane"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="plane" type="Plane" setter="set_plane" getter="get_plane"> diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index ccf60e4d49..f69010458e 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Polygon2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Polygon2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> A 2D polygon. </brief_description> @@ -11,61 +11,6 @@ <demos> </demos> <methods> - <method name="get_antialiased" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - Return the polygon fill color. - </description> - </method> - <method name="get_invert" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this polygon is inverted or not. - </description> - </method> - <method name="get_invert_border" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the added padding around the bounding box. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the offset for the polygon vertices. - </description> - </method> - <method name="get_polygon" qualifiers="const"> - <return type="PoolVector2Array"> - </return> - <description> - Return the set of vertices that defines this polygon. - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - Return the polygon texture - </description> - </method> - <method name="get_texture_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the polygon texture offset. - </description> - </method> <method name="get_texture_rotation" qualifiers="const"> <return type="float"> </return> @@ -73,103 +18,6 @@ Return the rotation in radians of the texture polygon. </description> </method> - <method name="get_texture_rotation_degrees" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_texture_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the uv coordinate multiplier. - </description> - </method> - <method name="get_uv" qualifiers="const"> - <return type="PoolVector2Array"> - </return> - <description> - Return the texture coordinates associated with every vertex of the polygon. - </description> - </method> - <method name="get_vertex_colors" qualifiers="const"> - <return type="PoolColorArray"> - </return> - <description> - Return the list of vertex colors. - </description> - </method> - <method name="set_antialiased"> - <return type="void"> - </return> - <argument index="0" name="antialiased" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - Set the polygon fill color. If the polygon has a texture defined, the defined texture will be multiplied by the polygon fill color. This, also, is the default color for those vertices that are not defined by [method get_vertex_colors]. - </description> - </method> - <method name="set_invert"> - <return type="void"> - </return> - <argument index="0" name="invert" type="bool"> - </argument> - <description> - Set the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on the square that contains the defined polygon). - </description> - </method> - <method name="set_invert_border"> - <return type="void"> - </return> - <argument index="0" name="invert_border" type="float"> - </argument> - <description> - Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision. - </description> - </method> - <method name="set_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - Set the an offset that will be added to the vertices' position. E.g. if the offset is set to (10,10) then all the polygon points will move 10 units to the right and 10 units to the bottom. - </description> - </method> - <method name="set_polygon"> - <return type="void"> - </return> - <argument index="0" name="polygon" type="PoolVector2Array"> - </argument> - <description> - Define the set of vertices that will represent the polygon. - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_texture_offset"> - <return type="void"> - </return> - <argument index="0" name="texture_offset" type="Vector2"> - </argument> - <description> - Set the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top. - </description> - </method> <method name="set_texture_rotation"> <return type="void"> </return> @@ -179,42 +27,6 @@ Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation. </description> </method> - <method name="set_texture_rotation_degrees"> - <return type="void"> - </return> - <argument index="0" name="texture_rotation" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_texture_scale"> - <return type="void"> - </return> - <argument index="0" name="texture_scale" type="Vector2"> - </argument> - <description> - Set the value that will multiply the uv coordinates ([method get_uv]) when applying the texture. Larger values make the texture smaller, and vice versa. - </description> - </method> - <method name="set_uv"> - <return type="void"> - </return> - <argument index="0" name="uv" type="PoolVector2Array"> - </argument> - <description> - Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored. - </description> - </method> - <method name="set_vertex_colors"> - <return type="void"> - </return> - <argument index="0" name="vertex_colors" type="PoolColorArray"> - </argument> - <description> - Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be [method get_color]. Extra color entries are ignored. - Colors are interpolated between vertices, resulting in smooth gradients when they differ. - </description> - </method> </methods> <members> <member name="antialiased" type="bool" setter="set_antialiased" getter="get_antialiased"> diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml index 213d7c0981..48c5625e6b 100644 --- a/doc/classes/PolygonPathFinder.xml +++ b/doc/classes/PolygonPathFinder.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PolygonPathFinder" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="PolygonPathFinder" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -80,10 +80,6 @@ </description> </method> </methods> - <members> - <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 54efc24725..653ea958a3 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolByteArray" category="Built-In Types" version="3.0-alpha"> +<class name="PoolByteArray" category="Built-In Types" version="3.0-beta"> <brief_description> Raw byte array. </brief_description> diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index f7cf389577..04267e0935 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolColorArray" category="Built-In Types" version="3.0-alpha"> +<class name="PoolColorArray" category="Built-In Types" version="3.0-beta"> <brief_description> Array of Colors </brief_description> diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index 53b2258c58..0baf194b52 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolIntArray" category="Built-In Types" version="3.0-alpha"> +<class name="PoolIntArray" category="Built-In Types" version="3.0-beta"> <brief_description> Integer Array. </brief_description> diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml index cc22c256e7..0a6c855647 100644 --- a/doc/classes/PoolRealArray.xml +++ b/doc/classes/PoolRealArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolRealArray" category="Built-In Types" version="3.0-alpha"> +<class name="PoolRealArray" category="Built-In Types" version="3.0-beta"> <brief_description> Real Array. </brief_description> diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml index 47928281cf..37842c1c85 100644 --- a/doc/classes/PoolStringArray.xml +++ b/doc/classes/PoolStringArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolStringArray" category="Built-In Types" version="3.0-alpha"> +<class name="PoolStringArray" category="Built-In Types" version="3.0-beta"> <brief_description> String Array. </brief_description> diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index 2ece5a6486..a98f3d6d7e 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolVector2Array" category="Built-In Types" version="3.0-alpha"> +<class name="PoolVector2Array" category="Built-In Types" version="3.0-beta"> <brief_description> An Array of Vector2. </brief_description> diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index 59f1c36a9e..f3b3274e47 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolVector3Array" category="Built-In Types" version="3.0-alpha"> +<class name="PoolVector3Array" category="Built-In Types" version="3.0-beta"> <brief_description> An Array of Vector3. </brief_description> diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index 7a93c32ea8..930e646dee 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Popup" inherits="Control" category="Core" version="3.0-alpha"> +<class name="Popup" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Base container control for popups and dialogs. </brief_description> @@ -11,13 +11,6 @@ <demos> </demos> <methods> - <method name="is_exclusive" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether the popup will hide other popups when shown on the screen. - </description> - </method> <method name="popup"> <return type="void"> </return> @@ -54,15 +47,6 @@ Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen. </description> </method> - <method name="set_exclusive"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Make the popup hide other popups when shown on the screen. - </description> - </method> </methods> <members> <member name="popup_exclusive" type="bool" setter="set_exclusive" getter="is_exclusive"> @@ -81,10 +65,10 @@ </signal> </signals> <constants> - <constant name="NOTIFICATION_POST_POPUP" value="80" enum=""> + <constant name="NOTIFICATION_POST_POPUP" value="80"> Notification sent right after the popup is shown. </constant> - <constant name="NOTIFICATION_POPUP_HIDE" value="81" enum=""> + <constant name="NOTIFICATION_POPUP_HIDE" value="81"> Notification sent right after the popup is hidden. </constant> </constants> diff --git a/doc/classes/PopupDialog.xml b/doc/classes/PopupDialog.xml index 82439e9d74..15df0e4ad2 100644 --- a/doc/classes/PopupDialog.xml +++ b/doc/classes/PopupDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PopupDialog" inherits="Popup" category="Core" version="3.0-alpha"> +<class name="PopupDialog" inherits="Popup" category="Core" version="3.0-beta"> <brief_description> Base class for Popup Dialogs. </brief_description> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index f3cd7df796..13cf16d2ee 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PopupMenu" inherits="Popup" category="Core" version="3.0-alpha"> +<class name="PopupMenu" inherits="Popup" category="Core" version="3.0-beta"> <brief_description> PopupMenu displays a list of options. </brief_description> @@ -233,18 +233,10 @@ <description> </description> </method> - <method name="is_hide_on_checkable_item_selection"> + <method name="is_hide_on_state_item_selection" qualifiers="const"> <return type="bool"> </return> <description> - Returns a boolean that indicates whether or not the PopupMenu will hide on checkable item selection. - </description> - </method> - <method name="is_hide_on_item_selection"> - <return type="bool"> - </return> - <description> - Returns a boolean that indicates whether or not the PopupMenu will hide on item selection. </description> </method> <method name="is_item_checkable" qualifiers="const"> @@ -292,22 +284,12 @@ 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. </description> </method> - <method name="set_hide_on_checkable_item_selection"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Sets whether or not the PopupMenu will hide on checkable item selection. - </description> - </method> - <method name="set_hide_on_item_selection"> + <method name="set_hide_on_state_item_selection"> <return type="void"> </return> <argument index="0" name="enable" type="bool"> </argument> <description> - Sets whether or not the PopupMenu will hide on item selection. </description> </method> <method name="set_item_accelerator"> @@ -397,6 +379,16 @@ 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. </description> </method> + <method name="set_item_multistate"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="state" type="int"> + </argument> + <description> + </description> + </method> <method name="set_item_shortcut"> <return type="void"> </return> @@ -449,14 +441,20 @@ <description> </description> </method> + <method name="toggle_item_multistate"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="hide_on_checkable_item_selection" type="bool" setter="set_hide_on_checkable_item_selection" getter="is_hide_on_checkable_item_selection"> </member> <member name="hide_on_item_selection" type="bool" setter="set_hide_on_item_selection" getter="is_hide_on_item_selection"> </member> - <member name="items" type="Array" setter="_set_items" getter="_get_items"> - </member> </members> <signals> <signal name="id_pressed"> diff --git a/doc/classes/PopupPanel.xml b/doc/classes/PopupPanel.xml index 3878e345c9..179f91e74b 100644 --- a/doc/classes/PopupPanel.xml +++ b/doc/classes/PopupPanel.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PopupPanel" inherits="Popup" category="Core" version="3.0-alpha"> +<class name="PopupPanel" inherits="Popup" category="Core" version="3.0-beta"> <brief_description> Class for displaying popups with a panel background. </brief_description> diff --git a/doc/classes/Position2D.xml b/doc/classes/Position2D.xml index 6d282370d4..d222a5dc04 100644 --- a/doc/classes/Position2D.xml +++ b/doc/classes/Position2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Position2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Position2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Generic 2D Position hint for editing. </brief_description> diff --git a/doc/classes/Position3D.xml b/doc/classes/Position3D.xml index cd4c1293ca..a5b8a119ff 100644 --- a/doc/classes/Position3D.xml +++ b/doc/classes/Position3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Position3D" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="Position3D" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Generic 3D Position hint for editing </brief_description> diff --git a/doc/classes/PrimitiveMesh.xml b/doc/classes/PrimitiveMesh.xml index 5c8d467927..e8ad23524f 100644 --- a/doc/classes/PrimitiveMesh.xml +++ b/doc/classes/PrimitiveMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PrimitiveMesh" inherits="Mesh" category="Core" version="3.0-alpha"> +<class name="PrimitiveMesh" inherits="Mesh" category="Core" version="3.0-beta"> <brief_description> Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. </brief_description> @@ -11,26 +11,12 @@ <demos> </demos> <methods> - <method name="get_material" qualifiers="const"> - <return type="Material"> - </return> - <description> - </description> - </method> <method name="get_mesh_arrays" qualifiers="const"> <return type="Array"> </return> <description> </description> </method> - <method name="set_material"> - <return type="void"> - </return> - <argument index="0" name="material" type="Material"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="material" type="Material" setter="set_material" getter="get_material"> diff --git a/doc/classes/PrismMesh.xml b/doc/classes/PrismMesh.xml index fa53717111..38bb3a4eb6 100644 --- a/doc/classes/PrismMesh.xml +++ b/doc/classes/PrismMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PrismMesh" inherits="PrimitiveMesh" category="Core" version="3.0-alpha"> +<class name="PrismMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> <brief_description> Class representing a prism-shaped [PrimitiveMesh]. </brief_description> @@ -11,76 +11,6 @@ <demos> </demos> <methods> - <method name="get_left_to_right" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_subdivide_depth" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_subdivide_height" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_subdivide_width" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_left_to_right"> - <return type="void"> - </return> - <argument index="0" name="left_to_right" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_subdivide_depth"> - <return type="void"> - </return> - <argument index="0" name="segments" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_subdivide_height"> - <return type="void"> - </return> - <argument index="0" name="segments" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_subdivide_width"> - <return type="void"> - </return> - <argument index="0" name="segments" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="left_to_right" type="float" setter="set_left_to_right" getter="get_left_to_right"> diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml index 70e9388058..2abd1104ce 100644 --- a/doc/classes/ProceduralSky.xml +++ b/doc/classes/ProceduralSky.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProceduralSky" inherits="Sky" category="Core" version="3.0-alpha"> +<class name="ProceduralSky" inherits="Sky" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,230 +9,6 @@ <demos> </demos> <methods> - <method name="get_ground_bottom_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_ground_curve" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ground_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ground_horizon_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_sky_curve" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sky_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sky_horizon_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_sky_top_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_sun_angle_max" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sun_angle_min" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sun_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_sun_curve" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sun_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sun_latitude" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_sun_longitude" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_texture_size" qualifiers="const"> - <return type="int" enum="ProceduralSky.TextureSize"> - </return> - <description> - </description> - </method> - <method name="set_ground_bottom_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_ground_curve"> - <return type="void"> - </return> - <argument index="0" name="curve" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ground_energy"> - <return type="void"> - </return> - <argument index="0" name="energy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ground_horizon_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_sky_curve"> - <return type="void"> - </return> - <argument index="0" name="curve" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sky_energy"> - <return type="void"> - </return> - <argument index="0" name="energy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sky_horizon_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_sky_top_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_sun_angle_max"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sun_angle_min"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sun_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_sun_curve"> - <return type="void"> - </return> - <argument index="0" name="curve" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sun_energy"> - <return type="void"> - </return> - <argument index="0" name="energy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sun_latitude"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_sun_longitude"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_texture_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="int" enum="ProceduralSky.TextureSize"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="ground_bottom_color" type="Color" setter="set_ground_bottom_color" getter="get_ground_bottom_color"> @@ -269,17 +45,17 @@ </member> </members> <constants> - <constant name="TEXTURE_SIZE_256" value="0"> + <constant name="TEXTURE_SIZE_256" value="0" enum="TextureSize"> </constant> - <constant name="TEXTURE_SIZE_512" value="1"> + <constant name="TEXTURE_SIZE_512" value="1" enum="TextureSize"> </constant> - <constant name="TEXTURE_SIZE_1024" value="2"> + <constant name="TEXTURE_SIZE_1024" value="2" enum="TextureSize"> </constant> - <constant name="TEXTURE_SIZE_2048" value="3"> + <constant name="TEXTURE_SIZE_2048" value="3" enum="TextureSize"> </constant> - <constant name="TEXTURE_SIZE_4096" value="4"> + <constant name="TEXTURE_SIZE_4096" value="4" enum="TextureSize"> </constant> - <constant name="TEXTURE_SIZE_MAX" value="5"> + <constant name="TEXTURE_SIZE_MAX" value="5" enum="TextureSize"> </constant> </constants> </class> diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index d72b28efc5..7417ddb53e 100644 --- a/doc/classes/ProgressBar.xml +++ b/doc/classes/ProgressBar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProgressBar" inherits="Range" category="Core" version="3.0-alpha"> +<class name="ProgressBar" inherits="Range" category="Core" version="3.0-beta"> <brief_description> General purpose progress bar. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="is_percent_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_percent_visible"> - <return type="void"> - </return> - <argument index="0" name="visible" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="percent_visible" type="bool" setter="set_percent_visible" getter="is_percent_visible"> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 6f670ded64..e28860a577 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProjectSettings" inherits="Object" category="Core" version="3.0-alpha"> +<class name="ProjectSettings" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Contains global variables accessible from everywhere. </brief_description> diff --git a/doc/classes/ProximityGroup.xml b/doc/classes/ProximityGroup.xml index b05d5b95dd..42e2c5e690 100644 --- a/doc/classes/ProximityGroup.xml +++ b/doc/classes/ProximityGroup.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProximityGroup" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="ProximityGroup" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> General purpose proximity-detection node. </brief_description> @@ -21,12 +21,6 @@ <description> </description> </method> - <method name="get_grid_radius" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> <method name="set_dispatch_mode"> <return type="void"> </return> @@ -35,14 +29,6 @@ <description> </description> </method> - <method name="set_grid_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="Vector3"> - </argument> - <description> - </description> - </method> <method name="set_group_name"> <return type="void"> </return> diff --git a/doc/classes/ProxyTexture.xml b/doc/classes/ProxyTexture.xml new file mode 100644 index 0000000000..2cdcac8775 --- /dev/null +++ b/doc/classes/ProxyTexture.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ProxyTexture" inherits="Texture" category="Core" version="3.0-beta"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="base" type="Texture" setter="set_base" getter="get_base"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/QuadMesh.xml b/doc/classes/QuadMesh.xml index 807141a284..78884d5492 100644 --- a/doc/classes/QuadMesh.xml +++ b/doc/classes/QuadMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="QuadMesh" inherits="PrimitiveMesh" category="Core" version="3.0-alpha"> +<class name="QuadMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> <brief_description> Class representing a square mesh. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="size" type="Vector2" setter="set_size" getter="get_size"> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index 1aa30075e4..9fab28c6c8 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Quat" category="Built-In Types" version="3.0-alpha"> +<class name="Quat" category="Built-In Types" version="3.0-beta"> <brief_description> Quaternion. </brief_description> diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index 831a4665c4..0796e654c1 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RID" category="Built-In Types" version="3.0-alpha"> +<class name="RID" category="Built-In Types" version="3.0-beta"> <brief_description> Handle for a [Resource]'s unique ID. </brief_description> diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index d2ea59cbeb..d86ff57661 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Range" inherits="Control" category="Core" version="3.0-alpha"> +<class name="Range" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Abstract base class for range-based controls. </brief_description> @@ -18,52 +18,6 @@ Return value mapped to 0 to 1 range. </description> </method> - <method name="get_max" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the maximum value. - </description> - </method> - <method name="get_min" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the minimum value. - </description> - </method> - <method name="get_page" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the page size, if page is 0, paging is disabled. - </description> - </method> - <method name="get_step" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the stepping, if step is 0, stepping is disabled. - </description> - </method> - <method name="get_value" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="is_ratio_exp" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_using_rounded_values" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="set_as_ratio"> <return type="void"> </return> @@ -73,65 +27,6 @@ Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. </description> </method> - <method name="set_exp_ratio"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_max"> - <return type="void"> - </return> - <argument index="0" name="maximum" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_min"> - <return type="void"> - </return> - <argument index="0" name="minimum" type="float"> - </argument> - <description> - Set minimum value, clamped range value to it if it's less. - </description> - </method> - <method name="set_page"> - <return type="void"> - </return> - <argument index="0" name="pagesize" type="float"> - </argument> - <description> - Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. - </description> - </method> - <method name="set_step"> - <return type="void"> - </return> - <argument index="0" name="step" type="float"> - </argument> - <description> - Set step value. If step is 0, stepping will be disabled. - </description> - </method> - <method name="set_use_rounded_values"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_value"> - <return type="void"> - </return> - <argument index="0" name="value" type="float"> - </argument> - <description> - </description> - </method> <method name="share"> <return type="void"> </return> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index d5f57c43c8..20e262b664 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RayCast" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="RayCast" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Query the closest object intersecting a ray. </brief_description> @@ -47,13 +47,6 @@ 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. </description> </method> - <method name="get_cast_to" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Return the destination point of this ray object. - </description> - </method> <method name="get_collider" qualifiers="const"> <return type="Object"> </return> @@ -78,19 +71,13 @@ [/codeblock] </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the collision mask for this ray. - </description> - </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="bit" type="int"> </argument> <description> + Returns [code]true[/code] if the bit index passed is turned on. Note that bit indexes range from 0-19. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -107,13 +94,6 @@ Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system. </description> </method> - <method name="get_type_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [PhysicsDirectSpaceState]. - </description> - </method> <method name="is_colliding" qualifiers="const"> <return type="bool"> </return> @@ -121,13 +101,6 @@ Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether the ray is enabled or not. - </description> - </method> <method name="remove_exception"> <return type="void"> </return> @@ -146,24 +119,6 @@ Removes a collision exception so the ray does report collisions with the specified [RID]. </description> </method> - <method name="set_cast_to"> - <return type="void"> - </return> - <argument index="0" name="local_point" type="Vector3"> - </argument> - <description> - Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]. - </description> - </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. - </description> - </method> <method name="set_collision_mask_bit"> <return type="void"> </return> @@ -172,24 +127,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> - </description> - </method> - <method name="set_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. - </description> - </method> - <method name="set_type_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [PhysicsDirectSpaceState], eg. [code]PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types. + Sets the bit index passed to the [code]value[/code] passed. Note that bit indexes range from 0-19. </description> </method> </methods> @@ -201,14 +139,10 @@ The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> - If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. + If [code]true[/code] collisions will be reported. Default value: [code]false[/code]. </member> - <member name="type_mask" type="int" setter="set_type_mask" getter="get_type_mask"> - Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState]. - Example: - [codeblock] - RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY - [/codeblock] + <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body"> + If [code]true[/code] collisions will be ignored for this RayCast's immediate parent. Default value: [code]true[/code]. </member> </members> <constants> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index f5828da796..4e93260549 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RayCast2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="RayCast2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Query the closest object intersecting a ray. </brief_description> @@ -46,13 +46,6 @@ 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. </description> </method> - <method name="get_cast_to" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the destination point of this ray object. - </description> - </method> <method name="get_collider" qualifiers="const"> <return type="Object"> </return> @@ -77,13 +70,6 @@ [/codeblock] </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the collision mask for this ray. - </description> - </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> @@ -106,20 +92,6 @@ Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system. </description> </method> - <method name="get_exclude_parent_body" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether this ray should hit your parent node, if it's a body. - </description> - </method> - <method name="get_type_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [Physics2DDirectSpaceState]. - </description> - </method> <method name="is_colliding" qualifiers="const"> <return type="bool"> </return> @@ -127,13 +99,6 @@ Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether this raycast is enabled or not. - </description> - </method> <method name="remove_exception"> <return type="void"> </return> @@ -152,24 +117,6 @@ Removes a collision exception so the ray does report collisions with the specified [RID]. </description> </method> - <method name="set_cast_to"> - <return type="void"> - </return> - <argument index="0" name="local_point" type="Vector2"> - </argument> - <description> - Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] - </description> - </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. - </description> - </method> <method name="set_collision_mask_bit"> <return type="void"> </return> @@ -180,33 +127,6 @@ <description> </description> </method> - <method name="set_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. - </description> - </method> - <method name="set_exclude_parent_body"> - <return type="void"> - </return> - <argument index="0" name="mask" type="bool"> - </argument> - <description> - Toggle whether this ray should hit your parent node, if it's a body. - </description> - </method> - <method name="set_type_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [Physics2DDirectSpaceState], eg. [code]Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types. - </description> - </method> </methods> <members> <member name="cast_to" type="Vector2" setter="set_cast_to" getter="get_cast_to"> @@ -221,13 +141,6 @@ <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body"> If [code]true[/code], the parent node will be excluded from collision detection. Default value: [code]true[/code]. </member> - <member name="type_mask" type="int" setter="set_type_mask" getter="get_type_mask"> - Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState]. - Example: - [codeblock] - RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY - [/codeblock] - </member> </members> <constants> </constants> diff --git a/doc/classes/RayShape.xml b/doc/classes/RayShape.xml index d4826141e8..94129dbafe 100644 --- a/doc/classes/RayShape.xml +++ b/doc/classes/RayShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RayShape" inherits="Shape" category="Core" version="3.0-alpha"> +<class name="RayShape" inherits="Shape" category="Core" version="3.0-beta"> <brief_description> Ray shape for 3D collisions. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_length"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="length" type="float" setter="set_length" getter="get_length"> diff --git a/doc/classes/RayShape2D.xml b/doc/classes/RayShape2D.xml index c9779a4307..748f5ea8b1 100644 --- a/doc/classes/RayShape2D.xml +++ b/doc/classes/RayShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RayShape2D" inherits="Shape2D" category="Core" version="3.0-alpha"> +<class name="RayShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> <brief_description> Ray shape for 2D collisions. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the length of the ray. - </description> - </method> - <method name="set_length"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - Set the length of the ray. - </description> - </method> </methods> <members> <member name="length" type="float" setter="set_length" getter="get_length"> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index e0b8b6ec75..4fc9e5bd71 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Rect2" category="Built-In Types" version="3.0-alpha"> +<class name="Rect2" category="Built-In Types" version="3.0-beta"> <brief_description> 2D Axis-aligned bounding box. </brief_description> @@ -37,6 +37,12 @@ Constructs a [code]Rect2[/code] by x, y, width, and height. </description> </method> + <method name="abs"> + <return type="Rect2"> + </return> + <description> + </description> + </method> <method name="clip"> <return type="Rect2"> </return> diff --git a/doc/classes/RectangleShape2D.xml b/doc/classes/RectangleShape2D.xml index b61344d86f..13994edddf 100644 --- a/doc/classes/RectangleShape2D.xml +++ b/doc/classes/RectangleShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RectangleShape2D" inherits="Shape2D" category="Core" version="3.0-alpha"> +<class name="RectangleShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> <brief_description> Rectangle shape for 2D collisions. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_extents" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the half extents, the actual width and height of this shape is twice the half extents. - </description> - </method> - <method name="set_extents"> - <return type="void"> - </return> - <argument index="0" name="extents" type="Vector2"> - </argument> - <description> - Set the half extents, the actual width and height of this shape is twice the half extents. - </description> - </method> </methods> <members> <member name="extents" type="Vector2" setter="set_extents" getter="get_extents"> diff --git a/doc/classes/Reference.xml b/doc/classes/Reference.xml index 18bd51f675..ec05b43bb0 100644 --- a/doc/classes/Reference.xml +++ b/doc/classes/Reference.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Reference" inherits="Object" category="Core" version="3.0-alpha"> +<class name="Reference" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Base class for anything that keeps a reference count. </brief_description> diff --git a/doc/classes/ReferenceRect.xml b/doc/classes/ReferenceRect.xml index 75b513a147..a0f56e078e 100644 --- a/doc/classes/ReferenceRect.xml +++ b/doc/classes/ReferenceRect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ReferenceRect" inherits="Control" category="Core" version="3.0-alpha"> +<class name="ReferenceRect" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Reference frame for GUI. </brief_description> diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml index 1508323207..21bd087407 100644 --- a/doc/classes/ReflectionProbe.xml +++ b/doc/classes/ReflectionProbe.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ReflectionProbe" inherits="VisualInstance" category="Core" version="3.0-alpha"> +<class name="ReflectionProbe" inherits="VisualInstance" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,174 +9,6 @@ <demos> </demos> <methods> - <method name="are_shadows_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_cull_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_extents" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_intensity" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_interior_ambient" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_interior_ambient_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_interior_ambient_probe_contribution" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_max_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_origin_offset" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_update_mode" qualifiers="const"> - <return type="int" enum="ReflectionProbe.UpdateMode"> - </return> - <description> - </description> - </method> - <method name="is_box_projection_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_set_as_interior" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_as_interior"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_cull_mask"> - <return type="void"> - </return> - <argument index="0" name="layers" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_enable_box_projection"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_enable_shadows"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_extents"> - <return type="void"> - </return> - <argument index="0" name="extents" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_intensity"> - <return type="void"> - </return> - <argument index="0" name="intensity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_interior_ambient"> - <return type="void"> - </return> - <argument index="0" name="ambient" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_interior_ambient_energy"> - <return type="void"> - </return> - <argument index="0" name="ambient_energy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_interior_ambient_probe_contribution"> - <return type="void"> - </return> - <argument index="0" name="ambient_probe_contribution" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_max_distance"> - <return type="void"> - </return> - <argument index="0" name="max_distance" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_origin_offset"> - <return type="void"> - </return> - <argument index="0" name="origin_offset" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_update_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="ReflectionProbe.UpdateMode"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="box_projection" type="bool" setter="set_enable_box_projection" getter="is_box_projection_enabled"> @@ -205,9 +37,9 @@ </member> </members> <constants> - <constant name="UPDATE_ONCE" value="0"> + <constant name="UPDATE_ONCE" value="0" enum="UpdateMode"> </constant> - <constant name="UPDATE_ALWAYS" value="1"> + <constant name="UPDATE_ALWAYS" value="1" enum="UpdateMode"> </constant> </constants> </class> diff --git a/doc/classes/RemoteTransform.xml b/doc/classes/RemoteTransform.xml index 76caea1a94..c5643409ce 100644 --- a/doc/classes/RemoteTransform.xml +++ b/doc/classes/RemoteTransform.xml @@ -1,100 +1,30 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RemoteTransform" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="RemoteTransform" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> - RemoteTransform mirrors the [Transform] of another [Spatial] derived Node in the scene. + RemoteTransform leads the [Transform] of another [Spatial] derived Node in the scene. </brief_description> <description> - RemoteTransform mirrors the [Transform] of another [Spatial] derived Node (called the remote node) in the scene. - It can be set to track another Node's position, rotation and/or scale and update its own accordingly, using either global or local coordinates. + RemoteTransform leads the [Transform] of another [Spatial] derived Node (called the remote node) in the scene. + It can be set to track another Node's position, rotation and/or scale. It can update using either global or local coordinates. </description> <tutorials> </tutorials> <demos> </demos> <methods> - <method name="get_remote_node" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="get_update_position" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_update_rotation" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_update_scale" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_use_global_coordinates" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_remote_node"> - <return type="void"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="set_update_position"> - <return type="void"> - </return> - <argument index="0" name="update_remote_position" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_update_rotation"> - <return type="void"> - </return> - <argument index="0" name="update_remote_rotation" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_update_scale"> - <return type="void"> - </return> - <argument index="0" name="update_remote_scale" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_use_global_coordinates"> - <return type="void"> - </return> - <argument index="0" name="use_global_coordinates" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node"> - The remote node's [NodePath]. + The [NodePath] to the remote node, relative to the RemoteTransform's position in the scene. </member> <member name="update_position" type="bool" setter="set_update_position" getter="get_update_position"> - If [code]true[/code] the remote node's position is mirrored. + If [code]true[/code] the remote node's position is tracked. Default value: [code]true[/code]. </member> <member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation"> - If [code]true[/code] the remote node's rotation is mirrored. + If [code]true[/code] the remote node's rotation is tracked. Default value: [code]true[/code]. </member> <member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale"> - If [code]true[/code] the remote node's scale is mirrored. + If [code]true[/code] the remote node's scale is tracked. Default value: [code]true[/code]. </member> <member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates"> If [code]true[/code] global coordinates are used. If [code]false[/code] local coordinates are used. Default value: [code]true[/code]. diff --git a/doc/classes/RemoteTransform2D.xml b/doc/classes/RemoteTransform2D.xml index d6dcde5742..77308209ea 100644 --- a/doc/classes/RemoteTransform2D.xml +++ b/doc/classes/RemoteTransform2D.xml @@ -1,100 +1,30 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> - RemoteTransform2D mirrors the [Transform2D] of another [CanvasItem] derived Node in the scene. + RemoteTransform2D leads the [Transform2D] of another [CanvasItem] derived Node in the scene. </brief_description> <description> - RemoteTransform2D mirrors the [Transform2D] of another [CanvasItem] derived Node (called the remote node) in the scene. - It can be set to track another Node's position, rotation and/or and update its own accordingly, using either global or local coordinates. + RemoteTransform2D leads the [Transform2D] of another [CanvasItem] derived Node (called the remote node) in the scene. + It can be set to track another Node's position, rotation and/or scale. It can update using either global or local coordinates. </description> <tutorials> </tutorials> <demos> </demos> <methods> - <method name="get_remote_node" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="get_update_position" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_update_rotation" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_update_scale" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_use_global_coordinates" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_remote_node"> - <return type="void"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="set_update_position"> - <return type="void"> - </return> - <argument index="0" name="update_remote_position" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_update_rotation"> - <return type="void"> - </return> - <argument index="0" name="update_remote_rotation" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_update_scale"> - <return type="void"> - </return> - <argument index="0" name="update_remote_scale" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_use_global_coordinates"> - <return type="void"> - </return> - <argument index="0" name="use_global_coordinates" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node"> - The remote node's [NodePath]. + The [NodePath] to the remote node, relative to the RemoteTransform2D's position in the scene. </member> <member name="update_position" type="bool" setter="set_update_position" getter="get_update_position"> - If [code]true[/code] the remote node's position is mirrored. + If [code]true[/code] the remote node's position is tracked. Default value: [code]true[/code]. </member> <member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation"> - If [code]true[/code] the remote node's rotation is mirrored. + If [code]true[/code] the remote node's rotation is tracked. Default value: [code]true[/code]. </member> <member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale"> - If [code]true[/code] the remote node's scale is mirrored. + If [code]true[/code] the remote node's scale is tracked. Default value: [code]true[/code]. </member> <member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates"> If [code]true[/code] global coordinates are used. If [code]false[/code] local coordinates are used. Default value: [code]true[/code]. diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 0044756003..713fcab573 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Resource" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="Resource" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Base class for all resources. </brief_description> @@ -31,20 +31,6 @@ <description> </description> </method> - <method name="get_name" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. - </description> - </method> - <method name="get_path" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. - </description> - </method> <method name="get_rid" qualifiers="const"> <return type="RID"> </return> @@ -52,38 +38,6 @@ Return 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="is_local_to_scene" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_local_to_scene"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_name"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. - </description> - </method> - <method name="set_path"> - <return type="void"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [code]Resource[/code] already has path "path". - </description> - </method> <method name="setup_local_to_scene"> <return type="void"> </return> diff --git a/doc/classes/ResourceImporter.xml b/doc/classes/ResourceImporter.xml index b627438c89..5474f09a7c 100644 --- a/doc/classes/ResourceImporter.xml +++ b/doc/classes/ResourceImporter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceImporter" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="ResourceImporter" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ResourceInteractiveLoader.xml b/doc/classes/ResourceInteractiveLoader.xml index 866347c0bb..13d701f3c6 100644 --- a/doc/classes/ResourceInteractiveLoader.xml +++ b/doc/classes/ResourceInteractiveLoader.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceInteractiveLoader" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="ResourceInteractiveLoader" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Interactive Resource Loader. </brief_description> diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 5940031a76..8d1ab1cd80 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceLoader" inherits="Object" category="Core" version="3.0-alpha"> +<class name="ResourceLoader" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Resource Loader. </brief_description> diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index f4c3334107..c749529a19 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourcePreloader" inherits="Node" category="Core" version="3.0-alpha"> +<class name="ResourcePreloader" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Resource Preloader Node. </brief_description> @@ -67,10 +67,6 @@ </description> </method> </methods> - <members> - <member name="resources" type="Array" setter="_set_resources" getter="_get_resources"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index af9c592ded..c1a5921071 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceSaver" inherits="Object" category="Core" version="3.0-alpha"> +<class name="ResourceSaver" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Resource Saving Interface. </brief_description> @@ -35,17 +35,17 @@ </method> </methods> <constants> - <constant name="FLAG_RELATIVE_PATHS" value="1"> + <constant name="FLAG_RELATIVE_PATHS" value="1" enum="SaverFlags"> </constant> - <constant name="FLAG_BUNDLE_RESOURCES" value="2"> + <constant name="FLAG_BUNDLE_RESOURCES" value="2" enum="SaverFlags"> </constant> - <constant name="FLAG_CHANGE_PATH" value="4"> + <constant name="FLAG_CHANGE_PATH" value="4" enum="SaverFlags"> </constant> - <constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8"> + <constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8" enum="SaverFlags"> </constant> - <constant name="FLAG_SAVE_BIG_ENDIAN" value="16"> + <constant name="FLAG_SAVE_BIG_ENDIAN" value="16" enum="SaverFlags"> </constant> - <constant name="FLAG_COMPRESS" value="32"> + <constant name="FLAG_COMPRESS" value="32" enum="SaverFlags"> </constant> </constants> </class> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 693bd5cf2f..5c04d3406e 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RichTextLabel" inherits="Control" category="Core" version="3.0-alpha"> +<class name="RichTextLabel" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Label that displays rich text. </brief_description> @@ -46,13 +46,6 @@ Clears the tag stack and sets [member bbcode_text] to an empty string. </description> </method> - <method name="get_bbcode" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the bbcode-parsed [member bbcode_text]. - </description> - </method> <method name="get_line_count" qualifiers="const"> <return type="int"> </return> @@ -60,13 +53,6 @@ Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line. </description> </method> - <method name="get_percent_visible" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the text's visibility as a floating point value between 0.0 and 1.0. - </description> - </method> <method name="get_tab_size" qualifiers="const"> <return type="int"> </return> @@ -95,12 +81,6 @@ Returns the vertical scrollbar. </description> </method> - <method name="get_visible_characters" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_visible_line_count" qualifiers="const"> <return type="int"> </return> @@ -115,12 +95,6 @@ Returns [code]true[/code] if the label underlines meta tags such as [url]{text}[/url]. </description> </method> - <method name="is_overriding_selected_font_color" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_scroll_active" qualifiers="const"> <return type="bool"> </return> @@ -142,12 +116,6 @@ Returns [code]true[/code] if the label allows text selection. </description> </method> - <method name="is_using_bbcode" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="newline"> <return type="void"> </return> @@ -266,15 +234,6 @@ Scrolls the window's top line to match [code]line[/code]. </description> </method> - <method name="set_bbcode"> - <return type="void"> - </return> - <argument index="0" name="text" type="String"> - </argument> - <description> - Sets the BBCode text to the label. - </description> - </method> <method name="set_meta_underline"> <return type="void"> </return> @@ -284,23 +243,6 @@ If [code]true[/code] will underline meta tags such as the [url] bbcode. Default value: [code]true[/code]. </description> </method> - <method name="set_override_selected_font_color"> - <return type="void"> - </return> - <argument index="0" name="override" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_percent_visible"> - <return type="void"> - </return> - <argument index="0" name="percent_visible" type="float"> - </argument> - <description> - Sets the text's visibility. Takes a floating point value between 0.0 and 1.0. - </description> - </method> <method name="set_scroll_active"> <return type="void"> </return> @@ -361,22 +303,6 @@ 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]. </description> </method> - <method name="set_use_bbcode"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_visible_characters"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="bbcode_enabled" type="bool" setter="set_use_bbcode" getter="is_using_bbcode"> @@ -403,45 +329,59 @@ Triggered when the user clicks on content between [url] tags. If the meta is defined in text, e.g. [code][url={"data"="hi"}]hi[/url][/code], then the parameter for this signal will be a [String] type. If a particular type or an object is desired, the [method push_meta] method must be used to manually insert the data into the tag stack. </description> </signal> + <signal name="meta_hover_ended"> + <argument index="0" name="meta" type="Nil"> + </argument> + <description> + Triggers when the mouse exits a meta tag. + </description> + </signal> + <signal name="meta_hover_started"> + <argument index="0" name="meta" type="Nil"> + </argument> + <description> + Triggers when the mouse enters a meta tag. + </description> + </signal> </signals> <constants> - <constant name="ALIGN_LEFT" value="0"> + <constant name="ALIGN_LEFT" value="0" enum="Align"> </constant> - <constant name="ALIGN_CENTER" value="1"> + <constant name="ALIGN_CENTER" value="1" enum="Align"> </constant> - <constant name="ALIGN_RIGHT" value="2"> + <constant name="ALIGN_RIGHT" value="2" enum="Align"> </constant> - <constant name="ALIGN_FILL" value="3"> + <constant name="ALIGN_FILL" value="3" enum="Align"> </constant> - <constant name="LIST_NUMBERS" value="0"> + <constant name="LIST_NUMBERS" value="0" enum="ListType"> </constant> - <constant name="LIST_LETTERS" value="1"> + <constant name="LIST_LETTERS" value="1" enum="ListType"> </constant> - <constant name="LIST_DOTS" value="2"> + <constant name="LIST_DOTS" value="2" enum="ListType"> </constant> - <constant name="ITEM_FRAME" value="0"> + <constant name="ITEM_FRAME" value="0" enum="ItemType"> </constant> - <constant name="ITEM_TEXT" value="1"> + <constant name="ITEM_TEXT" value="1" enum="ItemType"> </constant> - <constant name="ITEM_IMAGE" value="2"> + <constant name="ITEM_IMAGE" value="2" enum="ItemType"> </constant> - <constant name="ITEM_NEWLINE" value="3"> + <constant name="ITEM_NEWLINE" value="3" enum="ItemType"> </constant> - <constant name="ITEM_FONT" value="4"> + <constant name="ITEM_FONT" value="4" enum="ItemType"> </constant> - <constant name="ITEM_COLOR" value="5"> + <constant name="ITEM_COLOR" value="5" enum="ItemType"> </constant> - <constant name="ITEM_UNDERLINE" value="6"> + <constant name="ITEM_UNDERLINE" value="6" enum="ItemType"> </constant> - <constant name="ITEM_ALIGN" value="7"> + <constant name="ITEM_ALIGN" value="7" enum="ItemType"> </constant> - <constant name="ITEM_INDENT" value="8"> + <constant name="ITEM_INDENT" value="8" enum="ItemType"> </constant> - <constant name="ITEM_LIST" value="9"> + <constant name="ITEM_LIST" value="9" enum="ItemType"> </constant> - <constant name="ITEM_TABLE" value="10"> + <constant name="ITEM_TABLE" value="10" enum="ItemType"> </constant> - <constant name="ITEM_META" value="11"> + <constant name="ITEM_META" value="11" enum="ItemType"> </constant> </constants> <theme_items> diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index d40f7b4429..3c54f29c15 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RigidBody" inherits="PhysicsBody" category="Core" version="3.0-alpha"> +<class name="RigidBody" inherits="PhysicsBody" category="Core" version="3.0-beta"> <brief_description> Physics Body whose position is determined through physics simulation in 3D space. </brief_description> @@ -35,34 +35,6 @@ Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. </description> </method> - <method name="get_angular_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the current body angular damp. Default is -1. - </description> - </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Return the current body angular velocity. - </description> - </method> - <method name="get_axis_lock" qualifiers="const"> - <return type="int" enum="RigidBody.AxisLock"> - </return> - <description> - Return the current axis lock of the body. One of AXIS_LOCK_* enum. - </description> - </method> - <method name="get_bounce" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the current body bounciness. - </description> - </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> @@ -70,124 +42,6 @@ Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. </description> </method> - <method name="get_friction" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the current body friction, from 0 (frictionless) to 1 (max friction). - </description> - </method> - <method name="get_gravity_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the current body gravity scale. - </description> - </method> - <method name="get_linear_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the current body linear damp. Default is -1. - </description> - </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Return the current body linear velocity. - </description> - </method> - <method name="get_mass" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the current body mass. - </description> - </method> - <method name="get_max_contacts_reported" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int" enum="RigidBody.Mode"> - </return> - <description> - Return the current body mode, see [method set_mode]. - </description> - </method> - <method name="get_weight" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the current body weight, given standard earth-weight (gravity 9.8). - </description> - </method> - <method name="is_able_to_sleep" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the body has the ability to fall asleep when not moving. See [method set_can_sleep]. - </description> - </method> - <method name="is_contact_monitor_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether contact monitoring is enabled. - </description> - </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the body is sleeping. - </description> - </method> - <method name="is_using_continuous_collision_detection" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this body is using continuous collision detection. - </description> - </method> - <method name="is_using_custom_integrator"> - <return type="bool"> - </return> - <description> - Return whether the body is using a custom integrator. - </description> - </method> - <method name="set_angular_damp"> - <return type="void"> - </return> - <argument index="0" name="angular_damp" type="float"> - </argument> - <description> - Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden. - </description> - </method> - <method name="set_angular_velocity"> - <return type="void"> - </return> - <argument index="0" name="angular_velocity" type="Vector3"> - </argument> - <description> - Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. - </description> - </method> - <method name="set_axis_lock"> - <return type="void"> - </return> - <argument index="0" name="axis_lock" type="int" enum="RigidBody.AxisLock"> - </argument> - <description> - Set the axis lock of the body, from the AXIS_LOCK_* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes. - </description> - </method> <method name="set_axis_velocity"> <return type="void"> </return> @@ -197,134 +51,6 @@ Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> - <method name="set_bounce"> - <return type="void"> - </return> - <argument index="0" name="bounce" type="float"> - </argument> - <description> - Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness). - </description> - </method> - <method name="set_can_sleep"> - <return type="void"> - </return> - <argument index="0" name="able_to_sleep" type="bool"> - </argument> - <description> - Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. - Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. - </description> - </method> - <method name="set_contact_monitor"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Enable contact monitoring. This allows the body to emit signals when it collides with another. - </description> - </method> - <method name="set_friction"> - <return type="void"> - </return> - <argument index="0" name="friction" type="float"> - </argument> - <description> - Set the body friction, from 0 (frictionless) to 1 (max friction). - </description> - </method> - <method name="set_gravity_scale"> - <return type="void"> - </return> - <argument index="0" name="gravity_scale" type="float"> - </argument> - <description> - Set the gravity factor. This factor multiplies gravity intensity just for this body. - </description> - </method> - <method name="set_linear_damp"> - <return type="void"> - </return> - <argument index="0" name="linear_damp" type="float"> - </argument> - <description> - Set the linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. - </description> - </method> - <method name="set_linear_velocity"> - <return type="void"> - </return> - <argument index="0" name="linear_velocity" type="Vector3"> - </argument> - <description> - Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. - </description> - </method> - <method name="set_mass"> - <return type="void"> - </return> - <argument index="0" name="mass" type="float"> - </argument> - <description> - Set the body mass. - </description> - </method> - <method name="set_max_contacts_reported"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. - </description> - </method> - <method name="set_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="RigidBody.Mode"> - </argument> - <description> - Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. - </description> - </method> - <method name="set_sleeping"> - <return type="void"> - </return> - <argument index="0" name="sleeping" type="bool"> - </argument> - <description> - Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] wakes them up. Until then, they behave like a static body. - </description> - </method> - <method name="set_use_continuous_collision_detection"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set the continuous collision detection mode from the enum CCD_MODE_*. - Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects. - </description> - </method> - <method name="set_use_custom_integrator"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Pass true to disable the internal force integration (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. - </description> - </method> - <method name="set_weight"> - <return type="void"> - </return> - <argument index="0" name="weight" type="float"> - </argument> - <description> - Set the body weight given standard earth-weight (gravity 9.8). - </description> - </method> </methods> <members> <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp"> @@ -333,8 +59,17 @@ <member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity"> RigidBody's rotational velocity. </member> - <member name="axis_lock" type="int" setter="set_axis_lock" getter="get_axis_lock" enum="RigidBody.AxisLock"> - Locks the rotational forces to a particular axis, preventing rotations on other axes. + <member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + </member> + <member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> RigidBody's bounciness. @@ -430,25 +165,17 @@ </signal> </signals> <constants> - <constant name="MODE_RIGID" value="0"> + <constant name="MODE_RIGID" value="0" enum="Mode"> Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. </constant> - <constant name="MODE_STATIC" value="1"> + <constant name="MODE_STATIC" value="1" enum="Mode"> Static mode. The body behaves like a [StaticBody], and can only move by user code. </constant> - <constant name="MODE_CHARACTER" value="2"> + <constant name="MODE_CHARACTER" value="2" enum="Mode"> Character body. This behaves like a rigid body, but can not rotate. </constant> - <constant name="MODE_KINEMATIC" value="3"> + <constant name="MODE_KINEMATIC" value="3" enum="Mode"> Kinematic body. The body behaves like a [KinematicBody], and can only move by user code. </constant> - <constant name="AXIS_LOCK_DISABLED" value="0"> - </constant> - <constant name="AXIS_LOCK_X" value="1"> - </constant> - <constant name="AXIS_LOCK_Y" value="2"> - </constant> - <constant name="AXIS_LOCK_Z" value="3"> - </constant> </constants> </class> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index af8e59c83b..c11e118df5 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RigidBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-alpha"> +<class name="RigidBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-beta"> <brief_description> A body that is controlled by the 2D physics engine. </brief_description> @@ -49,20 +49,6 @@ Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates. </description> </method> - <method name="get_angular_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the angular damp for this body. - </description> - </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity]. - </description> - </method> <method name="get_applied_force" qualifiers="const"> <return type="Vector2"> </return> @@ -77,13 +63,6 @@ Returns the body's total applied torque. </description> </method> - <method name="get_bounce" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the body bounciness. - </description> - </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> @@ -91,27 +70,6 @@ Returns a list of the bodies colliding with this one. Use [member contacts_reported] to set the maximum number reported. You must also set [member contact_monitor] to [code]true[/code]. </description> </method> - <method name="get_continuous_collision_detection_mode" qualifiers="const"> - <return type="int" enum="RigidBody2D.CCDMode"> - </return> - <description> - Return whether this body is using continuous collision detection. - </description> - </method> - <method name="get_friction" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the body friction. - </description> - </method> - <method name="get_gravity_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the gravity factor. - </description> - </method> <method name="get_inertia" qualifiers="const"> <return type="float"> </return> @@ -119,94 +77,6 @@ Returns the body's moment of inertia, which is computed automatically from the body's mass and assigned [Shape2D]s during the physics frame. Note that it will not yet have a value in the [code]_ready()[/code] function. </description> </method> - <method name="get_linear_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the linear damp for this body. - </description> - </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the body's linear velocity. This changes when a physics frame has passed, not during a normal update. See [method set_linear_velocity]. - </description> - </method> - <method name="get_mass" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the body mass. - </description> - </method> - <method name="get_max_contacts_reported" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int" enum="RigidBody2D.Mode"> - </return> - <description> - Return the current body mode, see [method set_mode]. - </description> - </method> - <method name="get_weight" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the body weight given standard earth-weight (gravity 9.8). - </description> - </method> - <method name="is_able_to_sleep" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep]. - </description> - </method> - <method name="is_contact_monitor_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether contact monitoring is enabled. - </description> - </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the body is sleeping. - </description> - </method> - <method name="is_using_custom_integrator"> - <return type="bool"> - </return> - <description> - Return true if the body is not doing any built-in force integration. - </description> - </method> - <method name="set_angular_damp"> - <return type="void"> - </return> - <argument index="0" name="angular_damp" type="float"> - </argument> - <description> - Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden. - </description> - </method> - <method name="set_angular_velocity"> - <return type="void"> - </return> - <argument index="0" name="angular_velocity" type="float"> - </argument> - <description> - Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. - </description> - </method> <method name="set_applied_force"> <return type="void"> </return> @@ -234,62 +104,6 @@ Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> - <method name="set_bounce"> - <return type="void"> - </return> - <argument index="0" name="bounce" type="float"> - </argument> - <description> - Set the body bounciness, from 0 (no bounce) to 1 (full bounce). - </description> - </method> - <method name="set_can_sleep"> - <return type="void"> - </return> - <argument index="0" name="able_to_sleep" type="bool"> - </argument> - <description> - Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. - Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. - </description> - </method> - <method name="set_contact_monitor"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Enable contact monitoring. This allows the body to emit signals when it collides with another. - </description> - </method> - <method name="set_continuous_collision_detection_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="RigidBody2D.CCDMode"> - </argument> - <description> - Set the continuous collision detection mode from the enum CCD_MODE_*. - Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects. - </description> - </method> - <method name="set_friction"> - <return type="void"> - </return> - <argument index="0" name="friction" type="float"> - </argument> - <description> - Set the body friction, from 0 (frictionless) to 1 (full friction). - </description> - </method> - <method name="set_gravity_scale"> - <return type="void"> - </return> - <argument index="0" name="gravity_scale" type="float"> - </argument> - <description> - Set the gravity factor. This factor multiplies gravity intensity just for this body. - </description> - </method> <method name="set_inertia"> <return type="void"> </return> @@ -299,78 +113,6 @@ Set 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. </description> </method> - <method name="set_linear_damp"> - <return type="void"> - </return> - <argument index="0" name="linear_damp" type="float"> - </argument> - <description> - Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden. - </description> - </method> - <method name="set_linear_velocity"> - <return type="void"> - </return> - <argument index="0" name="linear_velocity" type="Vector2"> - </argument> - <description> - Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. - </description> - </method> - <method name="set_mass"> - <return type="void"> - </return> - <argument index="0" name="mass" type="float"> - </argument> - <description> - Set the body mass. - </description> - </method> - <method name="set_max_contacts_reported"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. - </description> - </method> - <method name="set_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="RigidBody2D.Mode"> - </argument> - <description> - Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. - </description> - </method> - <method name="set_sleeping"> - <return type="void"> - </return> - <argument index="0" name="sleeping" type="bool"> - </argument> - <description> - Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. - </description> - </method> - <method name="set_use_custom_integrator"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Pass true to disable the internal force integration (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. - </description> - </method> - <method name="set_weight"> - <return type="void"> - </return> - <argument index="0" name="weight" type="float"> - </argument> - <description> - Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. - </description> - </method> <method name="test_motion"> <return type="bool"> </return> @@ -484,25 +226,25 @@ </signal> </signals> <constants> - <constant name="MODE_RIGID" value="0"> + <constant name="MODE_RIGID" value="0" enum="Mode"> Rigid mode. The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode. </constant> - <constant name="MODE_STATIC" value="1"> + <constant name="MODE_STATIC" value="1" enum="Mode"> Static mode. The body behaves like a [StaticBody2D] and does not move. </constant> - <constant name="MODE_CHARACTER" value="2"> + <constant name="MODE_CHARACTER" value="2" enum="Mode"> Character mode. Similar to [code]MODE_RIGID[/code], but the body can not rotate. </constant> - <constant name="MODE_KINEMATIC" value="3"> + <constant name="MODE_KINEMATIC" value="3" enum="Mode"> Kinematic mode. The body behaves like a [KinematicBody2D], and must be moved by code. </constant> - <constant name="CCD_MODE_DISABLED" value="0"> + <constant name="CCD_MODE_DISABLED" value="0" enum="CCDMode"> Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. </constant> - <constant name="CCD_MODE_CAST_RAY" value="1"> + <constant name="CCD_MODE_CAST_RAY" value="1" enum="CCDMode"> Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise. </constant> - <constant name="CCD_MODE_CAST_SHAPE" value="2"> + <constant name="CCD_MODE_CAST_SHAPE" value="2" enum="CCDMode"> Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise. </constant> </constants> diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index 61e08336db..4fcaaa23dc 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SceneState" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="SceneState" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> + A script interface to a scene file's data. </brief_description> <description> + Maintains a list of resources, nodes, exported and overridden properties, and built-in scripts associated with a scene. </description> <tutorials> </tutorials> @@ -15,12 +17,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the list of bound parameters for the signal at [code]idx[/code]. </description> </method> <method name="get_connection_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of signal connections in the scene. </description> </method> <method name="get_connection_flags" qualifiers="const"> @@ -29,6 +33,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the flags for the signal at [code]idx[/code]. See [Object]'s [code]CONNECT_*[/code] flags. </description> </method> <method name="get_connection_method" qualifiers="const"> @@ -37,6 +42,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the method connected to the signal at [code]idx[/code]. </description> </method> <method name="get_connection_signal" qualifiers="const"> @@ -45,6 +51,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the name of the signal at [code]idx[/code]. </description> </method> <method name="get_connection_source" qualifiers="const"> @@ -53,6 +60,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the path to the node that owns the signal at [code]idx[/code], relative to the root node. </description> </method> <method name="get_connection_target" qualifiers="const"> @@ -61,12 +69,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the path to the node that owns the method connected to the signal at [code]idx[/code], relative to the root node. </description> </method> <method name="get_node_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of nodes in the scene. </description> </method> <method name="get_node_groups" qualifiers="const"> @@ -75,6 +85,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the list of group names associated with the node at [code]idx[/code]. </description> </method> <method name="get_node_instance" qualifiers="const"> @@ -83,6 +94,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the scene for the node at [code]idx[/code] or [code]null[/code] if the node is not an instance. </description> </method> <method name="get_node_instance_placeholder" qualifiers="const"> @@ -91,6 +103,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the path to the represented scene file if the node at [code]idx[/code] is an [InstancePlaceholder]. </description> </method> <method name="get_node_name" qualifiers="const"> @@ -99,6 +112,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the name of the node at [code]idx[/code]. </description> </method> <method name="get_node_owner_path" qualifiers="const"> @@ -107,6 +121,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the path to the owner of the node at [code]idx[/code], relative to the root node. </description> </method> <method name="get_node_path" qualifiers="const"> @@ -117,6 +132,7 @@ <argument index="1" name="for_parent" type="bool" default="false"> </argument> <description> + Returns the path to the node at [code]idx[/code]. </description> </method> <method name="get_node_property_count" qualifiers="const"> @@ -125,6 +141,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the number of exported or overridden properties for the node at [code]idx[/code]. </description> </method> <method name="get_node_property_name" qualifiers="const"> @@ -135,6 +152,7 @@ <argument index="1" name="prop_idx" type="int"> </argument> <description> + Returns the name of the property at [code]prop_idx[/code] for the node at [code]idx[/code]. </description> </method> <method name="get_node_property_value" qualifiers="const"> @@ -145,6 +163,7 @@ <argument index="1" name="prop_idx" type="int"> </argument> <description> + Returns the value of the property at [code]prop_idx[/code] for the node at [code]idx[/code]. </description> </method> <method name="get_node_type" qualifiers="const"> @@ -153,6 +172,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the type of the node at [code]idx[/code]. </description> </method> <method name="is_node_instance_placeholder" qualifiers="const"> @@ -161,15 +181,19 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns [code]true[/code] if the node at [code]idx[/code] is an [InstancePlaceholder]. </description> </method> </methods> <constants> - <constant name="GEN_EDIT_STATE_DISABLED" value="0"> + <constant name="GEN_EDIT_STATE_DISABLED" value="0" enum="GenEditState"> + If passed to [method PackedScene.instance], blocks edits to the scene state. </constant> - <constant name="GEN_EDIT_STATE_INSTANCE" value="1"> + <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. </constant> - <constant name="GEN_EDIT_STATE_MAIN" value="2"> + <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. </constant> </constants> </class> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 7cfacc737d..f3dd953c6f 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SceneTree" inherits="MainLoop" category="Core" version="3.0-alpha"> +<class name="SceneTree" inherits="MainLoop" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -388,29 +388,29 @@ </signal> </signals> <constants> - <constant name="GROUP_CALL_DEFAULT" value="0"> + <constant name="GROUP_CALL_DEFAULT" value="0" enum="CallGroupFlags"> </constant> - <constant name="GROUP_CALL_REVERSE" value="1"> + <constant name="GROUP_CALL_REVERSE" value="1" enum="CallGroupFlags"> </constant> - <constant name="GROUP_CALL_REALTIME" value="2"> + <constant name="GROUP_CALL_REALTIME" value="2" enum="CallGroupFlags"> </constant> - <constant name="GROUP_CALL_UNIQUE" value="4"> + <constant name="GROUP_CALL_UNIQUE" value="4" enum="CallGroupFlags"> </constant> - <constant name="STRETCH_MODE_DISABLED" value="0"> + <constant name="STRETCH_MODE_DISABLED" value="0" enum="StretchMode"> </constant> - <constant name="STRETCH_MODE_2D" value="1"> + <constant name="STRETCH_MODE_2D" value="1" enum="StretchMode"> </constant> - <constant name="STRETCH_MODE_VIEWPORT" value="2"> + <constant name="STRETCH_MODE_VIEWPORT" value="2" enum="StretchMode"> </constant> - <constant name="STRETCH_ASPECT_IGNORE" value="0"> + <constant name="STRETCH_ASPECT_IGNORE" value="0" enum="StretchAspect"> </constant> - <constant name="STRETCH_ASPECT_KEEP" value="1"> + <constant name="STRETCH_ASPECT_KEEP" value="1" enum="StretchAspect"> </constant> - <constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2"> + <constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2" enum="StretchAspect"> </constant> - <constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3"> + <constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3" enum="StretchAspect"> </constant> - <constant name="STRETCH_ASPECT_EXPAND" value="4"> + <constant name="STRETCH_ASPECT_EXPAND" value="4" enum="StretchAspect"> </constant> </constants> </class> diff --git a/doc/classes/SceneTreeTimer.xml b/doc/classes/SceneTreeTimer.xml index 6c540396e5..0fdcb26e6e 100644 --- a/doc/classes/SceneTreeTimer.xml +++ b/doc/classes/SceneTreeTimer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SceneTreeTimer" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="SceneTreeTimer" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 83e33c4764..d45283c10c 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Script" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Script" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> A class stored as a resource. </brief_description> diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 7a95f1276e..0b035f90d2 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ScriptEditor" inherits="PanelContainer" category="Core" version="3.0-alpha"> +<class name="ScriptEditor" inherits="PanelContainer" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ScrollBar.xml b/doc/classes/ScrollBar.xml index 312baf3bb6..f3c124b1ff 100644 --- a/doc/classes/ScrollBar.xml +++ b/doc/classes/ScrollBar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ScrollBar" inherits="Range" category="Core" version="3.0-alpha"> +<class name="ScrollBar" inherits="Range" category="Core" version="3.0-beta"> <brief_description> Base class for scroll bars. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_custom_step" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_custom_step"> - <return type="void"> - </return> - <argument index="0" name="step" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="custom_step" type="float" setter="set_custom_step" getter="get_custom_step"> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 51bd950cd9..87ad7d57f5 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ScrollContainer" inherits="Container" category="Core" version="3.0-alpha"> +<class name="ScrollContainer" inherits="Container" category="Core" version="3.0-beta"> <brief_description> A helper node for displaying scrollable elements (e.g. lists). </brief_description> @@ -25,38 +25,6 @@ Return current vertical scroll value. </description> </method> - <method name="is_h_scroll_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if horizontal scroll is allowed. - </description> - </method> - <method name="is_v_scroll_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if vertical scroll is allowed. - </description> - </method> - <method name="set_enable_h_scroll"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set allows horizontal scroll. - </description> - </method> - <method name="set_enable_v_scroll"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set allows vertical scroll. - </description> - </method> <method name="set_h_scroll"> <return type="void"> </return> diff --git a/doc/classes/SegmentShape2D.xml b/doc/classes/SegmentShape2D.xml index c59370018d..dc02859251 100644 --- a/doc/classes/SegmentShape2D.xml +++ b/doc/classes/SegmentShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SegmentShape2D" inherits="Shape2D" category="Core" version="3.0-alpha"> +<class name="SegmentShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> <brief_description> Segment shape for 2D collisions. </brief_description> @@ -11,38 +11,6 @@ <demos> </demos> <methods> - <method name="get_a" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the first point's position. - </description> - </method> - <method name="get_b" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the second point's position. - </description> - </method> - <method name="set_a"> - <return type="void"> - </return> - <argument index="0" name="a" type="Vector2"> - </argument> - <description> - Set the first point's position. - </description> - </method> - <method name="set_b"> - <return type="void"> - </return> - <argument index="0" name="b" type="Vector2"> - </argument> - <description> - Set the second point's position. - </description> - </method> </methods> <members> <member name="a" type="Vector2" setter="set_a" getter="get_a"> diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index 0f70ec1bd2..d8deb9651a 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Semaphore" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="Semaphore" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> A synchronization Semaphore. </brief_description> diff --git a/doc/classes/Separator.xml b/doc/classes/Separator.xml index 8754eb566d..ead641f860 100644 --- a/doc/classes/Separator.xml +++ b/doc/classes/Separator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Separator" inherits="Control" category="Core" version="3.0-alpha"> +<class name="Separator" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Base class for separators. </brief_description> diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 53b67c9d38..082c48dfce 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Shader" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Shader" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> To be changed, ignore. </brief_description> @@ -58,16 +58,12 @@ </description> </method> </methods> - <members> - <member name="code" type="String" setter="set_code" getter="get_code"> - </member> - </members> <constants> - <constant name="MODE_SPATIAL" value="0"> + <constant name="MODE_SPATIAL" value="0" enum="Mode"> </constant> - <constant name="MODE_CANVAS_ITEM" value="1"> + <constant name="MODE_CANVAS_ITEM" value="1" enum="Mode"> </constant> - <constant name="MODE_PARTICLES" value="2"> + <constant name="MODE_PARTICLES" value="2" enum="Mode"> </constant> </constants> </class> diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 81dec0cc14..096d6d4332 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ShaderMaterial" inherits="Material" category="Core" version="3.0-alpha"> +<class name="ShaderMaterial" inherits="Material" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml index df39988a35..512961ed75 100644 --- a/doc/classes/Shape.xml +++ b/doc/classes/Shape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Shape" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Shape" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Base class for all 3D shape resources. </brief_description> diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index fcc1ded4f7..d4d043dfd8 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Shape2D" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Shape2D" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Base class for all 2D Shapes. </brief_description> @@ -75,23 +75,6 @@ This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). </description> </method> - <method name="get_custom_solver_bias" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the custom solver bias. - </description> - </method> - <method name="set_custom_solver_bias"> - <return type="void"> - </return> - <argument index="0" name="bias" type="float"> - </argument> - <description> - Use a custom solver bias. No need to change this unless you really know what you are doing. - The solver bias is a factor controlling how much two objects "rebound" off each other, when colliding, to avoid them getting into each other because of numerical imprecision. - </description> - </method> </methods> <members> <member name="custom_solver_bias" type="float" setter="set_custom_solver_bias" getter="get_custom_solver_bias"> diff --git a/doc/classes/ShortCut.xml b/doc/classes/ShortCut.xml index b89c3a65bd..ce6a001279 100644 --- a/doc/classes/ShortCut.xml +++ b/doc/classes/ShortCut.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ShortCut" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="ShortCut" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> + A shortcut for binding input. </brief_description> <description> + A shortcut for binding input. + Shortcuts are commonly used for interacting with a [Control] element from a [InputEvent]. </description> <tutorials> </tutorials> @@ -13,12 +16,7 @@ <return type="String"> </return> <description> - </description> - </method> - <method name="get_shortcut" qualifiers="const"> - <return type="InputEvent"> - </return> - <description> + Returns the Shortcut's [InputEvent] as a [String]. </description> </method> <method name="is_shortcut" qualifiers="const"> @@ -27,25 +25,21 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> + Returns [code]true[/code] if the Shortcut's [InputEvent] equals [code]event[/code]. </description> </method> <method name="is_valid" qualifiers="const"> <return type="bool"> </return> <description> - </description> - </method> - <method name="set_shortcut"> - <return type="void"> - </return> - <argument index="0" name="event" type="InputEvent"> - </argument> - <description> + If [code]true[/code] this Shortcut is valid. </description> </method> </methods> <members> <member name="shortcut" type="InputEvent" setter="set_shortcut" getter="get_shortcut"> + The Shortcut's [InputEvent]. + Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent]. </member> </members> <constants> diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index b32f8bf7f0..8bcc80de32 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Skeleton" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="Skeleton" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Skeleton for characters and animated objects. </brief_description> @@ -215,7 +215,7 @@ </method> </methods> <constants> - <constant name="NOTIFICATION_UPDATE_SKELETON" value="50" enum=""> + <constant name="NOTIFICATION_UPDATE_SKELETON" value="50"> </constant> </constants> </class> diff --git a/doc/classes/Sky.xml b/doc/classes/Sky.xml index a2259df42a..33f4a6059c 100644 --- a/doc/classes/Sky.xml +++ b/doc/classes/Sky.xml @@ -1,49 +1,48 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Sky" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Sky" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> + The base class for [PanoramaSky] and [ProceduralSky]. </brief_description> <description> + The base class for [PanoramaSky] and [ProceduralSky]. </description> <tutorials> </tutorials> <demos> </demos> <methods> - <method name="get_radiance_size" qualifiers="const"> - <return type="int" enum="Sky.RadianceSize"> - </return> - <description> - </description> - </method> - <method name="set_radiance_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="int" enum="Sky.RadianceSize"> - </argument> - <description> - </description> - </method> </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. + See RADIANCE_SIZE_* constants for values. Default size is RADIANCE_SIZE_512. </member> </members> <constants> - <constant name="RADIANCE_SIZE_32" value="0"> + <constant name="RADIANCE_SIZE_32" value="0" enum="RadianceSize"> + Radiance texture size is 32x32 pixels. </constant> - <constant name="RADIANCE_SIZE_64" value="1"> + <constant name="RADIANCE_SIZE_64" value="1" enum="RadianceSize"> + Radiance texture size is 64x64 pixels. </constant> - <constant name="RADIANCE_SIZE_128" value="2"> + <constant name="RADIANCE_SIZE_128" value="2" enum="RadianceSize"> + Radiance texture size is 128x128 pixels. </constant> - <constant name="RADIANCE_SIZE_256" value="3"> + <constant name="RADIANCE_SIZE_256" value="3" enum="RadianceSize"> + Radiance texture size is 256x256 pixels. </constant> - <constant name="RADIANCE_SIZE_512" value="4"> + <constant name="RADIANCE_SIZE_512" value="4" enum="RadianceSize"> + Radiance texture size is 512x512 pixels. </constant> - <constant name="RADIANCE_SIZE_1024" value="5"> + <constant name="RADIANCE_SIZE_1024" value="5" enum="RadianceSize"> + Radiance texture size is 1024x1024 pixels. </constant> - <constant name="RADIANCE_SIZE_2048" value="6"> + <constant name="RADIANCE_SIZE_2048" value="6" enum="RadianceSize"> + Radiance texture size is 2048x2048 pixels. </constant> - <constant name="RADIANCE_SIZE_MAX" value="7"> + <constant name="RADIANCE_SIZE_MAX" value="7" enum="RadianceSize"> + Radiance texture size is the largest size it can be. </constant> </constants> </class> diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml index 649752a8a2..565d10497b 100644 --- a/doc/classes/Slider.xml +++ b/doc/classes/Slider.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Slider" inherits="Range" category="Core" version="3.0-alpha"> +<class name="Slider" inherits="Range" category="Core" version="3.0-beta"> <brief_description> Base class for GUI Sliders. </brief_description> @@ -11,52 +11,6 @@ <demos> </demos> <methods> - <method name="get_ticks" qualifiers="const"> - <return type="int"> - </return> - <description> - Return amounts of ticks to display on slider. - </description> - </method> - <method name="get_ticks_on_borders" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if ticks are visible on borders. - </description> - </method> - <method name="is_editable" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_editable"> - <return type="void"> - </return> - <argument index="0" name="editable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_ticks"> - <return type="void"> - </return> - <argument index="0" name="count" type="int"> - </argument> - <description> - Set amount of ticks to display in slider. - </description> - </method> - <method name="set_ticks_on_borders"> - <return type="void"> - </return> - <argument index="0" name="ticks_on_border" type="bool"> - </argument> - <description> - Set true if ticks are visible on borders. - </description> - </method> </methods> <members> <member name="editable" type="bool" setter="set_editable" getter="is_editable"> diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index 69cdf79c53..4c794306e4 100644 --- a/doc/classes/SliderJoint.xml +++ b/doc/classes/SliderJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SliderJoint" inherits="Joint" category="Core" version="3.0-alpha"> +<class name="SliderJoint" inherits="Joint" category="Core" version="3.0-beta"> <brief_description> Piston kind of slider between two bodies in 3D. </brief_description> @@ -11,24 +11,6 @@ <demos> </demos> <methods> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="param" type="int" enum="SliderJoint.Param"> - </argument> - <description> - </description> - </method> - <method name="set_param"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="SliderJoint.Param"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="angular_limit/damping" type="float" setter="set_param" getter="get_param"> @@ -102,73 +84,73 @@ </member> </members> <constants> - <constant name="PARAM_LINEAR_LIMIT_UPPER" value="0"> + <constant name="PARAM_LINEAR_LIMIT_UPPER" value="0" enum="Param"> The maximum difference between the pivot points on their x-axis before damping happens. </constant> - <constant name="PARAM_LINEAR_LIMIT_LOWER" value="1"> + <constant name="PARAM_LINEAR_LIMIT_LOWER" value="1" enum="Param"> The minimum difference between the pivot points on their x-axis before damping happens. </constant> - <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> + <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2" enum="Param"> A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. </constant> - <constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3"> + <constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3" enum="Param"> The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. </constant> - <constant name="PARAM_LINEAR_LIMIT_DAMPING" value="4"> + <constant name="PARAM_LINEAR_LIMIT_DAMPING" value="4" enum="Param"> The amount of damping once the slider limits are surpassed. </constant> - <constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5"> + <constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5" enum="Param"> A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. </constant> - <constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6"> + <constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6" enum="Param"> The amount of restitution inside the slider limits. </constant> - <constant name="PARAM_LINEAR_MOTION_DAMPING" value="7"> + <constant name="PARAM_LINEAR_MOTION_DAMPING" value="7" enum="Param"> The amount of damping inside the slider limits. </constant> - <constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> + <constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8" enum="Param"> A factor applied to the movement accross axes orthogonal to the slider. </constant> - <constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> + <constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9" enum="Param"> The amount of restitution when movement is accross axes orthogonal to the slider. </constant> - <constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10"> + <constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10" enum="Param"> The amount of damping when movement is accross axes orthogonal to the slider. </constant> - <constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11"> + <constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11" enum="Param"> The upper limit of rotation in the slider. </constant> - <constant name="PARAM_ANGULAR_LIMIT_LOWER" value="12"> + <constant name="PARAM_ANGULAR_LIMIT_LOWER" value="12" enum="Param"> The lower limit of rotation in the slider. </constant> - <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="13"> + <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="13" enum="Param"> A factor applied to the all rotation once the limit is surpassed. </constant> - <constant name="PARAM_ANGULAR_LIMIT_RESTITUTION" value="14"> + <constant name="PARAM_ANGULAR_LIMIT_RESTITUTION" value="14" enum="Param"> The amount of restitution of the rotation when the limit is surpassed. </constant> - <constant name="PARAM_ANGULAR_LIMIT_DAMPING" value="15"> + <constant name="PARAM_ANGULAR_LIMIT_DAMPING" value="15" enum="Param"> The amount of damping of the rotation when the limit is surpassed. </constant> - <constant name="PARAM_ANGULAR_MOTION_SOFTNESS" value="16"> + <constant name="PARAM_ANGULAR_MOTION_SOFTNESS" value="16" enum="Param"> A factor applied to the all rotation in the limits. </constant> - <constant name="PARAM_ANGULAR_MOTION_RESTITUTION" value="17"> + <constant name="PARAM_ANGULAR_MOTION_RESTITUTION" value="17" enum="Param"> The amount of restitution of the rotation in the limits. </constant> - <constant name="PARAM_ANGULAR_MOTION_DAMPING" value="18"> + <constant name="PARAM_ANGULAR_MOTION_DAMPING" value="18" enum="Param"> The amount of damping of the rotation in the limits. </constant> - <constant name="PARAM_ANGULAR_ORTHOGONAL_SOFTNESS" value="19"> + <constant name="PARAM_ANGULAR_ORTHOGONAL_SOFTNESS" value="19" enum="Param"> A factor applied to the all rotation across axes orthogonal to the slider. </constant> - <constant name="PARAM_ANGULAR_ORTHOGONAL_RESTITUTION" value="20"> + <constant name="PARAM_ANGULAR_ORTHOGONAL_RESTITUTION" value="20" enum="Param"> The amount of restitution of the rotation across axes orthogonal to the slider. </constant> - <constant name="PARAM_ANGULAR_ORTHOGONAL_DAMPING" value="21"> + <constant name="PARAM_ANGULAR_ORTHOGONAL_DAMPING" value="21" enum="Param"> The amount of damping of the rotation across axes orthogonal to the slider. </constant> - <constant name="PARAM_MAX" value="22"> + <constant name="PARAM_MAX" value="22" enum="Param"> End flag of PARAM_* constants, used internally. </constant> </constants> diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 726654f91f..ea04192a5e 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Spatial" inherits="Node" category="Core" version="3.0-alpha"> +<class name="Spatial" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Most basic 3D game object, parent of all 3D related nodes. </brief_description> @@ -18,13 +18,6 @@ Returns the SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. </description> </method> - <method name="get_global_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - Returns the global transform, relative to worldspace. - </description> - </method> <method name="get_parent_spatial" qualifiers="const"> <return type="Spatial"> </return> @@ -32,39 +25,6 @@ Returns the parent [code]Spatial[/code], or an empty [Object] if no parent exists or parent is not of type [code]Spatial[/code]. </description> </method> - <method name="get_rotation" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Returns the rotation (in radians). - </description> - </method> - <method name="get_rotation_degrees" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Returns the rotation (in degrees). - </description> - </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - Returns the local transform, relative to the bone parent. - </description> - </method> - <method name="get_translation" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> <method name="get_world" qualifiers="const"> <return type="World"> </return> @@ -120,13 +80,6 @@ Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. </description> </method> - <method name="is_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether the node is set to be visible. - </description> - </method> <method name="is_visible_in_tree" qualifiers="const"> <return type="bool"> </return> @@ -221,15 +174,6 @@ Set [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. </description> </method> - <method name="set_global_transform"> - <return type="void"> - </return> - <argument index="0" name="global" type="Transform"> - </argument> - <description> - Set the transform globally, relative to world space. - </description> - </method> <method name="set_identity"> <return type="void"> </return> @@ -264,58 +208,6 @@ Set whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. </description> </method> - <method name="set_rotation"> - <return type="void"> - </return> - <argument index="0" name="radians" type="Vector3"> - </argument> - <description> - Set the rotation (in radians). - </description> - </method> - <method name="set_rotation_degrees"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="Vector3"> - </argument> - <description> - Set the rotation (in degrees). - </description> - </method> - <method name="set_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector3"> - </argument> - <description> - Set the scale. - </description> - </method> - <method name="set_transform"> - <return type="void"> - </return> - <argument index="0" name="local" type="Transform"> - </argument> - <description> - Set the transform locally, relative to the parent spatial node. - </description> - </method> - <method name="set_translation"> - <return type="void"> - </return> - <argument index="0" name="translation" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_visible"> - <return type="void"> - </return> - <argument index="0" name="visible" type="bool"> - </argument> - <description> - </description> - </method> <method name="show"> <return type="void"> </return> @@ -389,17 +281,17 @@ </signal> </signals> <constants> - <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum=""> + <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29"> Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform. In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true). </constant> - <constant name="NOTIFICATION_ENTER_WORLD" value="41" enum=""> + <constant name="NOTIFICATION_ENTER_WORLD" value="41"> Spatial nodes receives this notification when they are registered to new [World] resource. </constant> - <constant name="NOTIFICATION_EXIT_WORLD" value="42" enum=""> + <constant name="NOTIFICATION_EXIT_WORLD" value="42"> Spatial nodes receives this notification when they are unregistered from current [World] resource. </constant> - <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43" enum=""> + <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43"> Spatial nodes receives this notification when their visibility changes. </constant> </constants> diff --git a/doc/classes/SpatialGizmo.xml b/doc/classes/SpatialGizmo.xml index eaac74fe10..8f614c6737 100644 --- a/doc/classes/SpatialGizmo.xml +++ b/doc/classes/SpatialGizmo.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpatialGizmo" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="SpatialGizmo" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 9f8b563373..cf08b0daae 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpatialMaterial" inherits="Material" category="Core" version="3.0-alpha"> +<class name="SpatialMaterial" inherits="Material" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,788 +9,6 @@ <demos> </demos> <methods> - <method name="get_albedo" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_alpha_scissor_threshold" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_anisotropy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ao_light_affect" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_ao_texture_channel" qualifiers="const"> - <return type="int" enum="SpatialMaterial.TextureChannel"> - </return> - <description> - </description> - </method> - <method name="get_billboard_mode" qualifiers="const"> - <return type="int" enum="SpatialMaterial.BillboardMode"> - </return> - <description> - </description> - </method> - <method name="get_blend_mode" qualifiers="const"> - <return type="int" enum="SpatialMaterial.BlendMode"> - </return> - <description> - </description> - </method> - <method name="get_clearcoat" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_clearcoat_gloss" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_cull_mode" qualifiers="const"> - <return type="int" enum="SpatialMaterial.CullMode"> - </return> - <description> - </description> - </method> - <method name="get_depth_deep_parallax_max_layers" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_depth_deep_parallax_min_layers" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_depth_draw_mode" qualifiers="const"> - <return type="int" enum="SpatialMaterial.DepthDrawMode"> - </return> - <description> - </description> - </method> - <method name="get_depth_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_detail_blend_mode" qualifiers="const"> - <return type="int" enum="SpatialMaterial.BlendMode"> - </return> - <description> - </description> - </method> - <method name="get_detail_uv" qualifiers="const"> - <return type="int" enum="SpatialMaterial.DetailUV"> - </return> - <description> - </description> - </method> - <method name="get_diffuse_mode" qualifiers="const"> - <return type="int" enum="SpatialMaterial.DiffuseMode"> - </return> - <description> - </description> - </method> - <method name="get_distance_fade_max_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_distance_fade_min_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_emission" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_emission_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_emission_operator" qualifiers="const"> - <return type="int" enum="SpatialMaterial.EmissionOperator"> - </return> - <description> - </description> - </method> - <method name="get_feature" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="feature" type="int" enum="SpatialMaterial.Feature"> - </argument> - <description> - </description> - </method> - <method name="get_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int" enum="SpatialMaterial.Flags"> - </argument> - <description> - </description> - </method> - <method name="get_grow" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_line_width" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_metallic" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_metallic_texture_channel" qualifiers="const"> - <return type="int" enum="SpatialMaterial.TextureChannel"> - </return> - <description> - </description> - </method> - <method name="get_normal_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_particles_anim_h_frames" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_particles_anim_loop" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_particles_anim_v_frames" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_point_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_proximity_fade_distance" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_refraction" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_refraction_texture_channel" qualifiers="const"> - <return type="int" enum="SpatialMaterial.TextureChannel"> - </return> - <description> - </description> - </method> - <method name="get_rim" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_rim_tint" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_roughness" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_roughness_texture_channel" qualifiers="const"> - <return type="int" enum="SpatialMaterial.TextureChannel"> - </return> - <description> - </description> - </method> - <method name="get_specular" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_specular_mode" qualifiers="const"> - <return type="int" enum="SpatialMaterial.SpecularMode"> - </return> - <description> - </description> - </method> - <method name="get_subsurface_scattering_strength" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="param" type="int" enum="SpatialMaterial.TextureParam"> - </argument> - <description> - </description> - </method> - <method name="get_transmission" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_uv1_offset" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_uv1_scale" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_uv1_triplanar_blend_sharpness" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_uv2_offset" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_uv2_scale" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_uv2_triplanar_blend_sharpness" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="is_depth_deep_parallax_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_distance_fade_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_grow_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_proximity_fade_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_albedo"> - <return type="void"> - </return> - <argument index="0" name="albedo" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_alpha_scissor_threshold"> - <return type="void"> - </return> - <argument index="0" name="threshold" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_anisotropy"> - <return type="void"> - </return> - <argument index="0" name="anisotropy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ao_light_affect"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_ao_texture_channel"> - <return type="void"> - </return> - <argument index="0" name="channel" type="int" enum="SpatialMaterial.TextureChannel"> - </argument> - <description> - </description> - </method> - <method name="set_billboard_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="SpatialMaterial.BillboardMode"> - </argument> - <description> - </description> - </method> - <method name="set_blend_mode"> - <return type="void"> - </return> - <argument index="0" name="blend_mode" type="int" enum="SpatialMaterial.BlendMode"> - </argument> - <description> - </description> - </method> - <method name="set_clearcoat"> - <return type="void"> - </return> - <argument index="0" name="clearcoat" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_clearcoat_gloss"> - <return type="void"> - </return> - <argument index="0" name="clearcoat_gloss" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_cull_mode"> - <return type="void"> - </return> - <argument index="0" name="cull_mode" type="int" enum="SpatialMaterial.CullMode"> - </argument> - <description> - </description> - </method> - <method name="set_depth_deep_parallax"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_depth_deep_parallax_max_layers"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_depth_deep_parallax_min_layers"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_depth_draw_mode"> - <return type="void"> - </return> - <argument index="0" name="depth_draw_mode" type="int" enum="SpatialMaterial.DepthDrawMode"> - </argument> - <description> - </description> - </method> - <method name="set_depth_scale"> - <return type="void"> - </return> - <argument index="0" name="depth_scale" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_detail_blend_mode"> - <return type="void"> - </return> - <argument index="0" name="detail_blend_mode" type="int" enum="SpatialMaterial.BlendMode"> - </argument> - <description> - </description> - </method> - <method name="set_detail_uv"> - <return type="void"> - </return> - <argument index="0" name="detail_uv" type="int" enum="SpatialMaterial.DetailUV"> - </argument> - <description> - </description> - </method> - <method name="set_diffuse_mode"> - <return type="void"> - </return> - <argument index="0" name="diffuse_mode" type="int" enum="SpatialMaterial.DiffuseMode"> - </argument> - <description> - </description> - </method> - <method name="set_distance_fade"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_distance_fade_max_distance"> - <return type="void"> - </return> - <argument index="0" name="distance" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_distance_fade_min_distance"> - <return type="void"> - </return> - <argument index="0" name="distance" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_emission"> - <return type="void"> - </return> - <argument index="0" name="emission" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_emission_energy"> - <return type="void"> - </return> - <argument index="0" name="emission_energy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_emission_operator"> - <return type="void"> - </return> - <argument index="0" name="operator" type="int" enum="SpatialMaterial.EmissionOperator"> - </argument> - <description> - </description> - </method> - <method name="set_feature"> - <return type="void"> - </return> - <argument index="0" name="feature" type="int" enum="SpatialMaterial.Feature"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_flag"> - <return type="void"> - </return> - <argument index="0" name="flag" type="int" enum="SpatialMaterial.Flags"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_grow"> - <return type="void"> - </return> - <argument index="0" name="amount" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_grow_enabled"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_line_width"> - <return type="void"> - </return> - <argument index="0" name="line_width" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_metallic"> - <return type="void"> - </return> - <argument index="0" name="metallic" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_metallic_texture_channel"> - <return type="void"> - </return> - <argument index="0" name="channel" type="int" enum="SpatialMaterial.TextureChannel"> - </argument> - <description> - </description> - </method> - <method name="set_normal_scale"> - <return type="void"> - </return> - <argument index="0" name="normal_scale" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_particles_anim_h_frames"> - <return type="void"> - </return> - <argument index="0" name="frames" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_particles_anim_loop"> - <return type="void"> - </return> - <argument index="0" name="frames" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_particles_anim_v_frames"> - <return type="void"> - </return> - <argument index="0" name="frames" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_point_size"> - <return type="void"> - </return> - <argument index="0" name="point_size" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_proximity_fade"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_proximity_fade_distance"> - <return type="void"> - </return> - <argument index="0" name="distance" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_refraction"> - <return type="void"> - </return> - <argument index="0" name="refraction" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_refraction_texture_channel"> - <return type="void"> - </return> - <argument index="0" name="channel" type="int" enum="SpatialMaterial.TextureChannel"> - </argument> - <description> - </description> - </method> - <method name="set_rim"> - <return type="void"> - </return> - <argument index="0" name="rim" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_rim_tint"> - <return type="void"> - </return> - <argument index="0" name="rim_tint" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_roughness"> - <return type="void"> - </return> - <argument index="0" name="roughness" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_roughness_texture_channel"> - <return type="void"> - </return> - <argument index="0" name="channel" type="int" enum="SpatialMaterial.TextureChannel"> - </argument> - <description> - </description> - </method> - <method name="set_specular"> - <return type="void"> - </return> - <argument index="0" name="specular" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_specular_mode"> - <return type="void"> - </return> - <argument index="0" name="specular_mode" type="int" enum="SpatialMaterial.SpecularMode"> - </argument> - <description> - </description> - </method> - <method name="set_subsurface_scattering_strength"> - <return type="void"> - </return> - <argument index="0" name="strength" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="param" type="int" enum="SpatialMaterial.TextureParam"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_transmission"> - <return type="void"> - </return> - <argument index="0" name="transmission" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_uv1_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_uv1_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_uv1_triplanar_blend_sharpness"> - <return type="void"> - </return> - <argument index="0" name="sharpness" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_uv2_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_uv2_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_uv2_triplanar_blend_sharpness"> - <return type="void"> - </return> - <argument index="0" name="sharpness" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="albedo_color" type="Color" setter="set_albedo" getter="get_albedo"> @@ -861,6 +79,8 @@ </member> <member name="emission_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> + <member name="flags_albedo_tex_force_srgb" type="bool" setter="set_flag" getter="get_flag"> + </member> <member name="flags_fixed_size" type="bool" setter="set_flag" getter="get_flag"> </member> <member name="flags_no_depth_test" type="bool" setter="set_flag" getter="get_flag"> @@ -979,159 +199,161 @@ </member> </members> <constants> - <constant name="TEXTURE_ALBEDO" value="0"> + <constant name="TEXTURE_ALBEDO" value="0" enum="TextureParam"> + </constant> + <constant name="TEXTURE_METALLIC" value="1" enum="TextureParam"> </constant> - <constant name="TEXTURE_METALLIC" value="1"> + <constant name="TEXTURE_ROUGHNESS" value="2" enum="TextureParam"> </constant> - <constant name="TEXTURE_ROUGHNESS" value="2"> + <constant name="TEXTURE_EMISSION" value="3" enum="TextureParam"> </constant> - <constant name="TEXTURE_EMISSION" value="3"> + <constant name="TEXTURE_NORMAL" value="4" enum="TextureParam"> </constant> - <constant name="TEXTURE_NORMAL" value="4"> + <constant name="TEXTURE_RIM" value="5" enum="TextureParam"> </constant> - <constant name="TEXTURE_RIM" value="5"> + <constant name="TEXTURE_CLEARCOAT" value="6" enum="TextureParam"> </constant> - <constant name="TEXTURE_CLEARCOAT" value="6"> + <constant name="TEXTURE_FLOWMAP" value="7" enum="TextureParam"> </constant> - <constant name="TEXTURE_FLOWMAP" value="7"> + <constant name="TEXTURE_AMBIENT_OCCLUSION" value="8" enum="TextureParam"> </constant> - <constant name="TEXTURE_AMBIENT_OCCLUSION" value="8"> + <constant name="TEXTURE_DEPTH" value="9" enum="TextureParam"> </constant> - <constant name="TEXTURE_DEPTH" value="9"> + <constant name="TEXTURE_SUBSURFACE_SCATTERING" value="10" enum="TextureParam"> </constant> - <constant name="TEXTURE_SUBSURFACE_SCATTERING" value="10"> + <constant name="TEXTURE_TRANSMISSION" value="11" enum="TextureParam"> </constant> - <constant name="TEXTURE_TRANSMISSION" value="11"> + <constant name="TEXTURE_REFRACTION" value="12" enum="TextureParam"> </constant> - <constant name="TEXTURE_REFRACTION" value="12"> + <constant name="TEXTURE_DETAIL_MASK" value="13" enum="TextureParam"> </constant> - <constant name="TEXTURE_DETAIL_MASK" value="13"> + <constant name="TEXTURE_DETAIL_ALBEDO" value="14" enum="TextureParam"> </constant> - <constant name="TEXTURE_DETAIL_ALBEDO" value="14"> + <constant name="TEXTURE_DETAIL_NORMAL" value="15" enum="TextureParam"> </constant> - <constant name="TEXTURE_DETAIL_NORMAL" value="15"> + <constant name="TEXTURE_MAX" value="16" enum="TextureParam"> </constant> - <constant name="TEXTURE_MAX" value="16"> + <constant name="DETAIL_UV_1" value="0" enum="DetailUV"> </constant> - <constant name="DETAIL_UV_1" value="0"> + <constant name="DETAIL_UV_2" value="1" enum="DetailUV"> </constant> - <constant name="DETAIL_UV_2" value="1"> + <constant name="FEATURE_TRANSPARENT" value="0" enum="Feature"> </constant> - <constant name="FEATURE_TRANSPARENT" value="0"> + <constant name="FEATURE_EMISSION" value="1" enum="Feature"> </constant> - <constant name="FEATURE_EMISSION" value="1"> + <constant name="FEATURE_NORMAL_MAPPING" value="2" enum="Feature"> </constant> - <constant name="FEATURE_NORMAL_MAPPING" value="2"> + <constant name="FEATURE_RIM" value="3" enum="Feature"> </constant> - <constant name="FEATURE_RIM" value="3"> + <constant name="FEATURE_CLEARCOAT" value="4" enum="Feature"> </constant> - <constant name="FEATURE_CLEARCOAT" value="4"> + <constant name="FEATURE_ANISOTROPY" value="5" enum="Feature"> </constant> - <constant name="FEATURE_ANISOTROPY" value="5"> + <constant name="FEATURE_AMBIENT_OCCLUSION" value="6" enum="Feature"> </constant> - <constant name="FEATURE_AMBIENT_OCCLUSION" value="6"> + <constant name="FEATURE_DEPTH_MAPPING" value="7" enum="Feature"> </constant> - <constant name="FEATURE_DEPTH_MAPPING" value="7"> + <constant name="FEATURE_SUBSURACE_SCATTERING" value="8" enum="Feature"> </constant> - <constant name="FEATURE_SUBSURACE_SCATTERING" value="8"> + <constant name="FEATURE_TRANSMISSION" value="9" enum="Feature"> </constant> - <constant name="FEATURE_TRANSMISSION" value="9"> + <constant name="FEATURE_REFRACTION" value="10" enum="Feature"> </constant> - <constant name="FEATURE_REFRACTION" value="10"> + <constant name="FEATURE_DETAIL" value="11" enum="Feature"> </constant> - <constant name="FEATURE_DETAIL" value="11"> + <constant name="FEATURE_MAX" value="12" enum="Feature"> </constant> - <constant name="FEATURE_MAX" value="12"> + <constant name="BLEND_MODE_MIX" value="0" enum="BlendMode"> </constant> - <constant name="BLEND_MODE_MIX" value="0"> + <constant name="BLEND_MODE_ADD" value="1" enum="BlendMode"> </constant> - <constant name="BLEND_MODE_ADD" value="1"> + <constant name="BLEND_MODE_SUB" value="2" enum="BlendMode"> </constant> - <constant name="BLEND_MODE_SUB" value="2"> + <constant name="BLEND_MODE_MUL" value="3" enum="BlendMode"> </constant> - <constant name="BLEND_MODE_MUL" value="3"> + <constant name="DEPTH_DRAW_OPAQUE_ONLY" value="0" enum="DepthDrawMode"> </constant> - <constant name="DEPTH_DRAW_OPAQUE_ONLY" value="0"> + <constant name="DEPTH_DRAW_ALWAYS" value="1" enum="DepthDrawMode"> </constant> - <constant name="DEPTH_DRAW_ALWAYS" value="1"> + <constant name="DEPTH_DRAW_DISABLED" value="2" enum="DepthDrawMode"> </constant> - <constant name="DEPTH_DRAW_DISABLED" value="2"> + <constant name="DEPTH_DRAW_ALPHA_OPAQUE_PREPASS" value="3" enum="DepthDrawMode"> </constant> - <constant name="DEPTH_DRAW_ALPHA_OPAQUE_PREPASS" value="3"> + <constant name="CULL_BACK" value="0" enum="CullMode"> </constant> - <constant name="CULL_BACK" value="0"> + <constant name="CULL_FRONT" value="1" enum="CullMode"> </constant> - <constant name="CULL_FRONT" value="1"> + <constant name="CULL_DISABLED" value="2" enum="CullMode"> </constant> - <constant name="CULL_DISABLED" value="2"> + <constant name="FLAG_UNSHADED" value="0" enum="Flags"> </constant> - <constant name="FLAG_UNSHADED" value="0"> + <constant name="FLAG_USE_VERTEX_LIGHTING" value="1" enum="Flags"> </constant> - <constant name="FLAG_USE_VERTEX_LIGHTING" value="1"> + <constant name="FLAG_DISABLE_DEPTH_TEST" value="2" enum="Flags"> </constant> - <constant name="FLAG_DISABLE_DEPTH_TEST" value="2"> + <constant name="FLAG_ALBEDO_FROM_VERTEX_COLOR" value="3" enum="Flags"> </constant> - <constant name="FLAG_ALBEDO_FROM_VERTEX_COLOR" value="3"> + <constant name="FLAG_SRGB_VERTEX_COLOR" value="4" enum="Flags"> </constant> - <constant name="FLAG_SRGB_VERTEX_COLOR" value="4"> + <constant name="FLAG_USE_POINT_SIZE" value="5" enum="Flags"> </constant> - <constant name="FLAG_USE_POINT_SIZE" value="5"> + <constant name="FLAG_FIXED_SIZE" value="6" enum="Flags"> </constant> - <constant name="FLAG_FIXED_SIZE" value="6"> + <constant name="FLAG_UV1_USE_TRIPLANAR" value="7" enum="Flags"> </constant> - <constant name="FLAG_UV1_USE_TRIPLANAR" value="7"> + <constant name="FLAG_UV2_USE_TRIPLANAR" value="8" enum="Flags"> </constant> - <constant name="FLAG_UV2_USE_TRIPLANAR" value="8"> + <constant name="FLAG_AO_ON_UV2" value="10" enum="Flags"> </constant> - <constant name="FLAG_AO_ON_UV2" value="10"> + <constant name="FLAG_USE_ALPHA_SCISSOR" value="11" enum="Flags"> </constant> - <constant name="FLAG_USE_ALPHA_SCISSOR" value="11"> + <constant name="FLAG_TRIPLANAR_USE_WORLD" value="9" enum="Flags"> </constant> - <constant name="FLAG_TRIPLANAR_USE_WORLD" value="9"> + <constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="12" enum="Flags"> </constant> - <constant name="FLAG_MAX" value="12"> + <constant name="FLAG_MAX" value="13" enum="Flags"> </constant> - <constant name="DIFFUSE_BURLEY" value="0"> + <constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode"> </constant> - <constant name="DIFFUSE_LAMBERT" value="1"> + <constant name="DIFFUSE_LAMBERT" value="1" enum="DiffuseMode"> </constant> - <constant name="DIFFUSE_LAMBERT_WRAP" value="2"> + <constant name="DIFFUSE_LAMBERT_WRAP" value="2" enum="DiffuseMode"> </constant> - <constant name="DIFFUSE_OREN_NAYAR" value="3"> + <constant name="DIFFUSE_OREN_NAYAR" value="3" enum="DiffuseMode"> </constant> - <constant name="DIFFUSE_TOON" value="4"> + <constant name="DIFFUSE_TOON" value="4" enum="DiffuseMode"> </constant> - <constant name="SPECULAR_SCHLICK_GGX" value="0"> + <constant name="SPECULAR_SCHLICK_GGX" value="0" enum="SpecularMode"> </constant> - <constant name="SPECULAR_BLINN" value="1"> + <constant name="SPECULAR_BLINN" value="1" enum="SpecularMode"> </constant> - <constant name="SPECULAR_PHONG" value="2"> + <constant name="SPECULAR_PHONG" value="2" enum="SpecularMode"> </constant> - <constant name="SPECULAR_TOON" value="3"> + <constant name="SPECULAR_TOON" value="3" enum="SpecularMode"> </constant> - <constant name="SPECULAR_DISABLED" value="4"> + <constant name="SPECULAR_DISABLED" value="4" enum="SpecularMode"> </constant> - <constant name="BILLBOARD_DISABLED" value="0"> + <constant name="BILLBOARD_DISABLED" value="0" enum="BillboardMode"> </constant> - <constant name="BILLBOARD_ENABLED" value="1"> + <constant name="BILLBOARD_ENABLED" value="1" enum="BillboardMode"> </constant> - <constant name="BILLBOARD_FIXED_Y" value="2"> + <constant name="BILLBOARD_FIXED_Y" value="2" enum="BillboardMode"> </constant> - <constant name="BILLBOARD_PARTICLES" value="3"> + <constant name="BILLBOARD_PARTICLES" value="3" enum="BillboardMode"> </constant> - <constant name="TEXTURE_CHANNEL_RED" value="0"> + <constant name="TEXTURE_CHANNEL_RED" value="0" enum="TextureChannel"> </constant> - <constant name="TEXTURE_CHANNEL_GREEN" value="1"> + <constant name="TEXTURE_CHANNEL_GREEN" value="1" enum="TextureChannel"> </constant> - <constant name="TEXTURE_CHANNEL_BLUE" value="2"> + <constant name="TEXTURE_CHANNEL_BLUE" value="2" enum="TextureChannel"> </constant> - <constant name="TEXTURE_CHANNEL_ALPHA" value="3"> + <constant name="TEXTURE_CHANNEL_ALPHA" value="3" enum="TextureChannel"> </constant> - <constant name="TEXTURE_CHANNEL_GRAYSCALE" value="4"> + <constant name="TEXTURE_CHANNEL_GRAYSCALE" value="4" enum="TextureChannel"> </constant> - <constant name="EMISSION_OP_ADD" value="0"> + <constant name="EMISSION_OP_ADD" value="0" enum="EmissionOperator"> </constant> - <constant name="EMISSION_OP_MULTIPLY" value="1"> + <constant name="EMISSION_OP_MULTIPLY" value="1" enum="EmissionOperator"> </constant> </constants> </class> diff --git a/doc/classes/SpatialVelocityTracker.xml b/doc/classes/SpatialVelocityTracker.xml index 62d3f02c89..a58049a141 100644 --- a/doc/classes/SpatialVelocityTracker.xml +++ b/doc/classes/SpatialVelocityTracker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpatialVelocityTracker" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="SpatialVelocityTracker" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/SphereMesh.xml b/doc/classes/SphereMesh.xml index 42af9cd6b8..25ebaf1aaa 100644 --- a/doc/classes/SphereMesh.xml +++ b/doc/classes/SphereMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SphereMesh" inherits="PrimitiveMesh" category="Core" version="3.0-alpha"> +<class name="SphereMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> <brief_description> Class representing a spherical [PrimitiveMesh]. </brief_description> @@ -11,76 +11,6 @@ <demos> </demos> <methods> - <method name="get_height" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_is_hemisphere" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_radial_segments" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_rings" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_height"> - <return type="void"> - </return> - <argument index="0" name="height" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_is_hemisphere"> - <return type="void"> - </return> - <argument index="0" name="is_hemisphere" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_radial_segments"> - <return type="void"> - </return> - <argument index="0" name="radial_segments" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_rings"> - <return type="void"> - </return> - <argument index="0" name="rings" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="height" type="float" setter="set_height" getter="get_height"> diff --git a/doc/classes/SphereShape.xml b/doc/classes/SphereShape.xml index 28f96b0028..c26d069310 100644 --- a/doc/classes/SphereShape.xml +++ b/doc/classes/SphereShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SphereShape" inherits="Shape" category="Core" version="3.0-alpha"> +<class name="SphereShape" inherits="Shape" category="Core" version="3.0-beta"> <brief_description> Sphere shape for 3D collisions. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_radius"> - <return type="void"> - </return> - <argument index="0" name="radius" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="radius" type="float" setter="set_radius" getter="get_radius"> diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index e0c0a88148..806d36717a 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpinBox" inherits="Range" category="Core" version="3.0-alpha"> +<class name="SpinBox" inherits="Range" category="Core" version="3.0-beta"> <brief_description> Numerical input text field. </brief_description> @@ -17,53 +17,6 @@ <description> </description> </method> - <method name="get_prefix" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_suffix" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the specific suffix. - </description> - </method> - <method name="is_editable" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return if the spinbox is editable. - </description> - </method> - <method name="set_editable"> - <return type="void"> - </return> - <argument index="0" name="editable" type="bool"> - </argument> - <description> - Set whether the spinbox is editable. - </description> - </method> - <method name="set_prefix"> - <return type="void"> - </return> - <argument index="0" name="prefix" type="String"> - </argument> - <description> - Set a prefix. - </description> - </method> - <method name="set_suffix"> - <return type="void"> - </return> - <argument index="0" name="suffix" type="String"> - </argument> - <description> - Set a specific suffix. - </description> - </method> </methods> <members> <member name="editable" type="bool" setter="set_editable" getter="is_editable"> diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index 50ed6a5f64..835a226a50 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SplitContainer" inherits="Container" category="Core" version="3.0-alpha"> +<class name="SplitContainer" inherits="Container" category="Core" version="3.0-beta"> <brief_description> Container for splitting and adjusting. </brief_description> @@ -11,54 +11,6 @@ <demos> </demos> <methods> - <method name="get_dragger_visibility" qualifiers="const"> - <return type="int" enum="SplitContainer.DraggerVisibility"> - </return> - <description> - Return visibility of the split dragger (one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). - </description> - </method> - <method name="get_split_offset" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the split offset. - </description> - </method> - <method name="is_collapsed" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the split is collapsed. - </description> - </method> - <method name="set_collapsed"> - <return type="void"> - </return> - <argument index="0" name="collapsed" type="bool"> - </argument> - <description> - Set if the split must be collapsed. - </description> - </method> - <method name="set_dragger_visibility"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="SplitContainer.DraggerVisibility"> - </argument> - <description> - Set visibility of the split dragger ([i]mode[/i] must be one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). - </description> - </method> - <method name="set_split_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="int"> - </argument> - <description> - Set the split offset. - </description> - </method> </methods> <members> <member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed"> @@ -78,13 +30,13 @@ </signal> </signals> <constants> - <constant name="DRAGGER_VISIBLE" value="0"> + <constant name="DRAGGER_VISIBLE" value="0" enum="DraggerVisibility"> The split dragger is visible. </constant> - <constant name="DRAGGER_HIDDEN" value="1"> + <constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility"> The split dragger is invisible. </constant> - <constant name="DRAGGER_HIDDEN_COLLAPSED" value="2"> + <constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility"> The split dragger is invisible and collapsed. </constant> </constants> diff --git a/doc/classes/SpotLight.xml b/doc/classes/SpotLight.xml index ce58791171..c66646114f 100644 --- a/doc/classes/SpotLight.xml +++ b/doc/classes/SpotLight.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpotLight" inherits="Light" category="Core" version="3.0-alpha"> +<class name="SpotLight" inherits="Light" category="Core" version="3.0-beta"> <brief_description> Spotlight [Light], such as a reflector spotlight or a lantern. </brief_description> diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index 7996adab51..655e98b3ed 100644 --- a/doc/classes/Sprite.xml +++ b/doc/classes/Sprite.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Sprite" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="Sprite" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> General purpose Sprite node. </brief_description> @@ -11,194 +11,6 @@ <demos> </demos> <methods> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. - </description> - </method> - <method name="get_hframes" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the amount of horizontal frames. See [method set_hframes]. - </description> - </method> - <method name="get_normal_map" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return sprite draw offset. - </description> - </method> - <method name="get_region_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - Return the region rect to read from. - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - Return the base texture for the sprite. - </description> - </method> - <method name="get_vframes" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the amount of vertical frames. See [method set_vframes]. - </description> - </method> - <method name="is_centered" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return if the sprite is centered at the local origin. - </description> - </method> - <method name="is_flipped_h" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the sprite is flipped horizontally. - </description> - </method> - <method name="is_flipped_v" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the sprite is flipped vertically. - </description> - </method> - <method name="is_region" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return if the sprite reads from a region. - </description> - </method> - <method name="is_region_filter_clip_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_centered"> - <return type="void"> - </return> - <argument index="0" name="centered" type="bool"> - </argument> - <description> - Set whether the sprite should be centered on the origin. - </description> - </method> - <method name="set_flip_h"> - <return type="void"> - </return> - <argument index="0" name="flip_h" type="bool"> - </argument> - <description> - Set true to flip the sprite horizontally. - </description> - </method> - <method name="set_flip_v"> - <return type="void"> - </return> - <argument index="0" name="flip_v" type="bool"> - </argument> - <description> - Set true to flip the sprite vertically. - </description> - </method> - <method name="set_frame"> - <return type="void"> - </return> - <argument index="0" name="frame" type="int"> - </argument> - <description> - Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. - </description> - </method> - <method name="set_hframes"> - <return type="void"> - </return> - <argument index="0" name="hframes" type="int"> - </argument> - <description> - Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. - </description> - </method> - <method name="set_normal_map"> - <return type="void"> - </return> - <argument index="0" name="normal_map" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - Set the sprite draw offset, useful for setting rotation pivots. - </description> - </method> - <method name="set_region"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. - </description> - </method> - <method name="set_region_filter_clip"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_region_rect"> - <return type="void"> - </return> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - Set the region rect to read from. - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - Set the base texture for the sprite. - </description> - </method> - <method name="set_vframes"> - <return type="void"> - </return> - <argument index="0" name="vframes" type="int"> - </argument> - <description> - Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. - </description> - </method> </methods> <members> <member name="centered" type="bool" setter="set_centered" getter="is_centered"> diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml index 5354d8c819..d727725a95 100644 --- a/doc/classes/Sprite3D.xml +++ b/doc/classes/Sprite3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Sprite3D" inherits="SpriteBase3D" category="Core" version="3.0-alpha"> +<class name="Sprite3D" inherits="SpriteBase3D" category="Core" version="3.0-beta"> <brief_description> 2D Sprite node in 3D world. </brief_description> @@ -11,90 +11,6 @@ <demos> </demos> <methods> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_hframes" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_region_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_vframes" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="is_region" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_frame"> - <return type="void"> - </return> - <argument index="0" name="frame" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_hframes"> - <return type="void"> - </return> - <argument index="0" name="hframes" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_region"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_region_rect"> - <return type="void"> - </return> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_vframes"> - <return type="void"> - </return> - <argument index="0" name="vframes" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="frame" type="int" setter="set_frame" getter="get_frame"> diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 69537cd884..580a467d6b 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpriteBase3D" inherits="GeometryInstance" category="Core" version="3.0-alpha"> +<class name="SpriteBase3D" inherits="GeometryInstance" category="Core" version="3.0-beta"> <brief_description> 2D Sprite node in 3D environment. </brief_description> @@ -11,156 +11,12 @@ <demos> </demos> <methods> - <method name="get_alpha_cut_mode" qualifiers="const"> - <return type="int" enum="SpriteBase3D.AlphaCutMode"> - </return> - <description> - </description> - </method> - <method name="get_axis" qualifiers="const"> - <return type="int" enum="Vector3.Axis"> - </return> - <description> - </description> - </method> - <method name="get_draw_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags"> - </argument> - <description> - </description> - </method> <method name="get_item_rect" qualifiers="const"> <return type="Rect2"> </return> <description> </description> </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_opacity" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_pixel_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="is_centered" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_flipped_h" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_flipped_v" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_alpha_cut_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="SpriteBase3D.AlphaCutMode"> - </argument> - <description> - </description> - </method> - <method name="set_axis"> - <return type="void"> - </return> - <argument index="0" name="axis" type="int" enum="Vector3.Axis"> - </argument> - <description> - </description> - </method> - <method name="set_centered"> - <return type="void"> - </return> - <argument index="0" name="centered" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_draw_flag"> - <return type="void"> - </return> - <argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags"> - </argument> - <argument index="1" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_flip_h"> - <return type="void"> - </return> - <argument index="0" name="flip_h" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_flip_v"> - <return type="void"> - </return> - <argument index="0" name="flip_v" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_modulate"> - <return type="void"> - </return> - <argument index="0" name="modulate" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_opacity"> - <return type="void"> - </return> - <argument index="0" name="opacity" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_pixel_size"> - <return type="void"> - </return> - <argument index="0" name="pixel_size" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="alpha_cut" type="int" setter="set_alpha_cut_mode" getter="get_alpha_cut_mode" enum="SpriteBase3D.AlphaCutMode"> @@ -200,23 +56,23 @@ </member> </members> <constants> - <constant name="FLAG_TRANSPARENT" value="0"> + <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. </constant> - <constant name="FLAG_SHADED" value="1"> + <constant name="FLAG_SHADED" value="1" enum="DrawFlags"> If set, the Light in the Environment has effects on the Sprite. </constant> - <constant name="FLAG_DOUBLE_SIDED" value="2"> + <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. </constant> - <constant name="FLAG_MAX" value="3"> + <constant name="FLAG_MAX" value="3" enum="DrawFlags"> Used internally to mark the end of the Flags section. </constant> - <constant name="ALPHA_CUT_DISABLED" value="0"> + <constant name="ALPHA_CUT_DISABLED" value="0" enum="AlphaCutMode"> </constant> - <constant name="ALPHA_CUT_DISCARD" value="1"> + <constant name="ALPHA_CUT_DISCARD" value="1" enum="AlphaCutMode"> </constant> - <constant name="ALPHA_CUT_OPAQUE_PREPASS" value="2"> + <constant name="ALPHA_CUT_OPAQUE_PREPASS" value="2" enum="AlphaCutMode"> </constant> </constants> </class> diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index 336b155689..883a6d4fa8 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpriteFrames" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="SpriteFrames" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Sprite frame library for AnimatedSprite. </brief_description> @@ -164,9 +164,6 @@ </method> </methods> <members> - <member name="animations" type="Array" setter="_set_animations" getter="_get_animations"> - An [Array] containing the [code]name[/code], [code]speed[/code], [code]loop[/code], and [code]frames[/code] of each animation. - </member> <member name="frames" type="Array" setter="_set_frames" getter="_get_frames"> </member> </members> diff --git a/doc/classes/StaticBody.xml b/doc/classes/StaticBody.xml index a008f0b99c..dd105589a6 100644 --- a/doc/classes/StaticBody.xml +++ b/doc/classes/StaticBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StaticBody" inherits="PhysicsBody" category="Core" version="3.0-alpha"> +<class name="StaticBody" inherits="PhysicsBody" category="Core" version="3.0-beta"> <brief_description> Static body for 3D Physics. </brief_description> @@ -13,70 +13,6 @@ <demos> </demos> <methods> - <method name="get_bounce" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the body bounciness. - </description> - </method> - <method name="get_constant_angular_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Return the constant angular velocity for the body. - </description> - </method> - <method name="get_constant_linear_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Return the constant linear velocity for the body. - </description> - </method> - <method name="get_friction" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the body friction. - </description> - </method> - <method name="set_bounce"> - <return type="void"> - </return> - <argument index="0" name="bounce" type="float"> - </argument> - <description> - Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). - </description> - </method> - <method name="set_constant_angular_velocity"> - <return type="void"> - </return> - <argument index="0" name="vel" type="Vector3"> - </argument> - <description> - Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. - </description> - </method> - <method name="set_constant_linear_velocity"> - <return type="void"> - </return> - <argument index="0" name="vel" type="Vector3"> - </argument> - <description> - Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. - </description> - </method> - <method name="set_friction"> - <return type="void"> - </return> - <argument index="0" name="friction" type="float"> - </argument> - <description> - Set the body friction, from 0 (frictionless) to 1 (full friction). - </description> - </method> </methods> <members> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml index 9f1f79ad59..bf670a344f 100644 --- a/doc/classes/StaticBody2D.xml +++ b/doc/classes/StaticBody2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StaticBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-alpha"> +<class name="StaticBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-beta"> <brief_description> Static body for 2D Physics. </brief_description> @@ -12,70 +12,6 @@ <demos> </demos> <methods> - <method name="get_bounce" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the body bounciness. - </description> - </method> - <method name="get_constant_angular_velocity" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the constant angular velocity for the body. - </description> - </method> - <method name="get_constant_linear_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the constant linear velocity for the body. - </description> - </method> - <method name="get_friction" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the body friction. - </description> - </method> - <method name="set_bounce"> - <return type="void"> - </return> - <argument index="0" name="bounce" type="float"> - </argument> - <description> - Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). - </description> - </method> - <method name="set_constant_angular_velocity"> - <return type="void"> - </return> - <argument index="0" name="vel" type="float"> - </argument> - <description> - Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. - </description> - </method> - <method name="set_constant_linear_velocity"> - <return type="void"> - </return> - <argument index="0" name="vel" type="Vector2"> - </argument> - <description> - Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. - </description> - </method> - <method name="set_friction"> - <return type="void"> - </return> - <argument index="0" name="friction" type="float"> - </argument> - <description> - Set the body friction, from 0 (frictionless) to 1 (full friction). - </description> - </method> </methods> <members> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index 4f92a524b1..d757b6f2d8 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamPeer" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="StreamPeer" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Abstraction and base class for stream-based protocols. </brief_description> diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index 5c67598285..66696ed416 100644 --- a/doc/classes/StreamPeerBuffer.xml +++ b/doc/classes/StreamPeerBuffer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamPeerBuffer" inherits="StreamPeer" category="Core" version="3.0-alpha"> +<class name="StreamPeerBuffer" inherits="StreamPeer" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 59d0e492e4..55cb39e137 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamPeerSSL" inherits="StreamPeer" category="Core" version="3.0-alpha"> +<class name="StreamPeerSSL" inherits="StreamPeer" category="Core" version="3.0-beta"> <brief_description> SSL Stream peer. </brief_description> @@ -48,16 +48,16 @@ </method> </methods> <constants> - <constant name="STATUS_DISCONNECTED" value="0"> + <constant name="STATUS_DISCONNECTED" value="0" enum="Status"> A status representing a [code]StreamPeerSSL[/code] that is disconnected. </constant> - <constant name="STATUS_CONNECTED" value="1"> + <constant name="STATUS_CONNECTED" value="1" enum="Status"> A status representing a [code]StreamPeerSSL[/code] that is connected to a host. </constant> - <constant name="STATUS_ERROR_NO_CERTIFICATE" value="2"> + <constant name="STATUS_ERROR_NO_CERTIFICATE" value="2" enum="Status"> An errot status that shows the peer did not present a SSL certificate and validation was requested. </constant> - <constant name="STATUS_ERROR_HOSTNAME_MISMATCH" value="3"> + <constant name="STATUS_ERROR_HOSTNAME_MISMATCH" value="3" enum="Status"> An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. </constant> </constants> diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 3df68d0926..4c9812587a 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamPeerTCP" inherits="StreamPeer" category="Core" version="3.0-alpha"> +<class name="StreamPeerTCP" inherits="StreamPeer" category="Core" version="3.0-beta"> <brief_description> TCP Stream peer. </brief_description> @@ -58,16 +58,16 @@ </method> </methods> <constants> - <constant name="STATUS_NONE" value="0"> + <constant name="STATUS_NONE" value="0" enum="Status"> The initial status of the [code]StreamPeerTCP[/code], also the status after a disconnect. </constant> - <constant name="STATUS_CONNECTING" value="1"> + <constant name="STATUS_CONNECTING" value="1" enum="Status"> A status representing a [code]StreamPeerTCP[/code] that is connecting to a host. </constant> - <constant name="STATUS_CONNECTED" value="2"> + <constant name="STATUS_CONNECTED" value="2" enum="Status"> A status representing a [code]StreamPeerTCP[/code] that is connected to a host. </constant> - <constant name="STATUS_ERROR" value="3"> + <constant name="STATUS_ERROR" value="3" enum="Status"> A staus representing a [code]StreamPeerTCP[/code] in error state. </constant> </constants> diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture.xml index 2a5ad36b25..2e15070a8f 100644 --- a/doc/classes/StreamTexture.xml +++ b/doc/classes/StreamTexture.xml @@ -1,31 +1,20 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamTexture" inherits="Texture" category="Core" version="3.0-alpha"> +<class name="StreamTexture" inherits="Texture" category="Core" version="3.0-beta"> <brief_description> + A .stex texture. </brief_description> <description> + A texture that is loaded from a .stex file. </description> <tutorials> </tutorials> <demos> </demos> <methods> - <method name="get_load_path" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="load"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="load_path" type="String" setter="load" getter="get_load_path"> + The StreamTexture's filepath to a .stex file. </member> </members> <constants> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index ecf9e54ee7..8bbd52b417 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="String" category="Built-In Types" version="3.0-alpha"> +<class name="String" category="Built-In Types" version="3.0-beta"> <brief_description> Built-in string class. </brief_description> @@ -95,10 +95,10 @@ <method name="String"> <return type="String"> </return> - <argument index="0" name="from" type="Rect3"> + <argument index="0" name="from" type="AABB"> </argument> <description> - Constructs a new String from the given [Rect3]. + Constructs a new String from the given [AABB]. </description> </method> <method name="String"> @@ -662,8 +662,11 @@ </argument> <argument index="1" name="allow_empty" type="bool" default="True"> </argument> + <argument index="2" name="maxsplit" type="int" default="0"> + </argument> <description> Splits the string by a divisor string and returns an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". + If [code]maxsplit[/code] is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements) </description> </method> <method name="split_floats"> diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index c904522c7f..2759b5f430 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBox" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="StyleBox" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Base class for drawing stylized boxes for the UI. </brief_description> @@ -27,15 +27,6 @@ <description> </description> </method> - <method name="get_default_margin" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return the default offset of the margin "margin" (see MARGIN_* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. - </description> - </method> <method name="get_margin" qualifiers="const"> <return type="float"> </return> @@ -59,17 +50,6 @@ Return 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]. </description> </method> - <method name="set_default_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="offset" type="float"> - </argument> - <description> - Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. - </description> - </method> <method name="test_mask" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/StyleBoxEmpty.xml b/doc/classes/StyleBoxEmpty.xml index fd0e256e36..70d801e699 100644 --- a/doc/classes/StyleBoxEmpty.xml +++ b/doc/classes/StyleBoxEmpty.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBoxEmpty" inherits="StyleBox" category="Core" version="3.0-alpha"> +<class name="StyleBoxEmpty" inherits="StyleBox" category="Core" version="3.0-beta"> <brief_description> Empty stylebox (does not display anything). </brief_description> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index ab1f733c5c..16a1e72fce 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBoxFlat" inherits="StyleBox" category="Core" version="3.0-alpha"> +<class name="StyleBoxFlat" inherits="StyleBox" category="Core" version="3.0-beta"> <brief_description> Customizable Stylebox with a given set of parameters. (no texture required) </brief_description> @@ -27,140 +27,12 @@ <demos> </demos> <methods> - <method name="get_aa_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_bg_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_border_blend" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_border_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_border_width" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - </description> - </method> <method name="get_border_width_min" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="get_corner_detail" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_corner_radius" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="corner" type="int" enum="Corner"> - </argument> - <description> - </description> - </method> - <method name="get_expand_margin" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - </description> - </method> - <method name="get_shadow_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_shadow_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="is_anti_aliased" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_draw_center_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_aa_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_anti_aliased"> - <return type="void"> - </return> - <argument index="0" name="anti_aliased" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_bg_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_border_blend"> - <return type="void"> - </return> - <argument index="0" name="blend" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_border_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_border_width"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="width" type="int"> - </argument> - <description> - </description> - </method> <method name="set_border_width_all"> <return type="void"> </return> @@ -169,24 +41,6 @@ <description> </description> </method> - <method name="set_corner_detail"> - <return type="void"> - </return> - <argument index="0" name="detail" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_corner_radius"> - <return type="void"> - </return> - <argument index="0" name="corner" type="int" enum="Corner"> - </argument> - <argument index="1" name="radius" type="int"> - </argument> - <description> - </description> - </method> <method name="set_corner_radius_all"> <return type="void"> </return> @@ -209,24 +63,6 @@ <description> </description> </method> - <method name="set_draw_center"> - <return type="void"> - </return> - <argument index="0" name="draw_center" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_expand_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="size" type="float"> - </argument> - <description> - </description> - </method> <method name="set_expand_margin_all"> <return type="void"> </return> @@ -249,22 +85,6 @@ <description> </description> </method> - <method name="set_shadow_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_shadow_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="anti_aliasing" type="bool" setter="set_anti_aliased" getter="is_anti_aliased"> diff --git a/doc/classes/StyleBoxLine.xml b/doc/classes/StyleBoxLine.xml index 669d74416f..e18af2334c 100644 --- a/doc/classes/StyleBoxLine.xml +++ b/doc/classes/StyleBoxLine.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBoxLine" inherits="StyleBox" category="Core" version="3.0-alpha"> +<class name="StyleBoxLine" inherits="StyleBox" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,38 +9,12 @@ <demos> </demos> <methods> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> <method name="get_grow" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="get_thickness" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="is_vertical" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> <method name="set_grow"> <return type="void"> </return> @@ -49,22 +23,6 @@ <description> </description> </method> - <method name="set_thickness"> - <return type="void"> - </return> - <argument index="0" name="thickness" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_vertical"> - <return type="void"> - </return> - <argument index="0" name="vertical" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="color" type="Color" setter="set_color" getter="get_color"> diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index 2b64b5d6bf..2a7077bbff 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.0-alpha"> +<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.0-beta"> <brief_description> Texture Based 3x3 scale style. </brief_description> @@ -11,72 +11,6 @@ <demos> </demos> <methods> - <method name="get_expand_margin_size" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - </description> - </method> - <method name="get_h_axis_stretch_mode" qualifiers="const"> - <return type="int" enum="StyleBoxTexture.AxisStretchMode"> - </return> - <description> - </description> - </method> - <method name="get_margin_size" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - </description> - </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="get_normal_map" qualifiers="const"> - <return type="Resource"> - </return> - <description> - </description> - </method> - <method name="get_region_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Resource"> - </return> - <description> - </description> - </method> - <method name="get_v_axis_stretch_mode" qualifiers="const"> - <return type="int" enum="StyleBoxTexture.AxisStretchMode"> - </return> - <description> - </description> - </method> - <method name="is_draw_center_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_draw_center"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> <method name="set_expand_margin_all"> <return type="void"> </return> @@ -99,74 +33,6 @@ <description> </description> </method> - <method name="set_expand_margin_size"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="size" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_h_axis_stretch_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="StyleBoxTexture.AxisStretchMode"> - </argument> - <description> - </description> - </method> - <method name="set_margin_size"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="size" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_modulate"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_normal_map"> - <return type="void"> - </return> - <argument index="0" name="normal_map" type="Resource"> - </argument> - <description> - </description> - </method> - <method name="set_region_rect"> - <return type="void"> - </return> - <argument index="0" name="region" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Resource"> - </argument> - <description> - </description> - </method> - <method name="set_v_axis_stretch_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="StyleBoxTexture.AxisStretchMode"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode"> @@ -207,11 +73,11 @@ </signal> </signals> <constants> - <constant name="AXIS_STRETCH_MODE_STRETCH" value="0"> + <constant name="AXIS_STRETCH_MODE_STRETCH" value="0" enum="AxisStretchMode"> </constant> - <constant name="AXIS_STRETCH_MODE_TILE" value="1"> + <constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode"> </constant> - <constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2"> + <constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode"> </constant> </constants> </class> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 93090d9d2e..0916d0b928 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SurfaceTool" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="SurfaceTool" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Helper tool to create geometry. </brief_description> @@ -170,6 +170,8 @@ </return> <argument index="0" name="existing" type="ArrayMesh" default="null"> </argument> + <argument index="1" name="flags" type="int" default="97792"> + </argument> <description> Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. </description> diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index 20cdbe4231..d3715ff545 100644 --- a/doc/classes/TCP_Server.xml +++ b/doc/classes/TCP_Server.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TCP_Server" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="TCP_Server" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> TCP Server. </brief_description> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 4921690074..350dd11e4d 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TabContainer" inherits="Control" category="Core" version="3.0-alpha"> +<class name="TabContainer" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Tabbed Container. </brief_description> @@ -14,20 +14,6 @@ <demos> </demos> <methods> - <method name="are_tabs_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the tabs are visible. - </description> - </method> - <method name="get_current_tab" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the currently visible tab's index. - </description> - </method> <method name="get_current_tab_control" qualifiers="const"> <return type="Control"> </return> @@ -49,13 +35,6 @@ Returns the previously active tab index. </description> </method> - <method name="get_tab_align" qualifiers="const"> - <return type="int" enum="TabContainer.TabAlign"> - </return> - <description> - Returns the tab alignment. See the [code]ALIGN_*[/code] constants. - </description> - </method> <method name="get_tab_control" qualifiers="const"> <return type="Control"> </return> @@ -99,15 +78,6 @@ Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. </description> </method> - <method name="set_current_tab"> - <return type="void"> - </return> - <argument index="0" name="tab_idx" type="int"> - </argument> - <description> - Sets to [code]false[/code] the [code]visible[/code] property for all [Control] children except for the tab at [code]tab_idx[/code]. - </description> - </method> <method name="set_popup"> <return type="void"> </return> @@ -117,15 +87,6 @@ If set on a [Popup] node instance, a popup menu icon appears in the top-right corner of the [code]TabContainer[/code]. Clicking it will expand the [Popup] node. </description> </method> - <method name="set_tab_align"> - <return type="void"> - </return> - <argument index="0" name="align" type="int" enum="TabContainer.TabAlign"> - </argument> - <description> - Sets tab alignment, from the [code]ALIGN_*[/code] constants. Moves tabs to the left, right, or center. - </description> - </method> <method name="set_tab_disabled"> <return type="void"> </return> @@ -159,15 +120,6 @@ Sets a title for the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. </description> </method> - <method name="set_tabs_visible"> - <return type="void"> - </return> - <argument index="0" name="visible" type="bool"> - </argument> - <description> - If [code]true[/code] tabs are visible. If [code]false[/code] tabs' content and titles are hidden. Default value: [code]true[/code]. - </description> - </method> </methods> <members> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> @@ -202,11 +154,11 @@ </signal> </signals> <constants> - <constant name="ALIGN_LEFT" value="0"> + <constant name="ALIGN_LEFT" value="0" enum="TabAlign"> </constant> - <constant name="ALIGN_CENTER" value="1"> + <constant name="ALIGN_CENTER" value="1" enum="TabAlign"> </constant> - <constant name="ALIGN_RIGHT" value="2"> + <constant name="ALIGN_RIGHT" value="2" enum="TabAlign"> </constant> </constants> <theme_items> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index e007decf47..fbda1aedb4 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Tabs" inherits="Control" category="Core" version="3.0-alpha"> +<class name="Tabs" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Tabs Control. </brief_description> @@ -29,8 +29,8 @@ <description> </description> </method> - <method name="get_current_tab" qualifiers="const"> - <return type="int"> + <method name="get_offset_buttons_visible" qualifiers="const"> + <return type="bool"> </return> <description> </description> @@ -41,12 +41,6 @@ <description> </description> </method> - <method name="get_tab_close_display_policy" qualifiers="const"> - <return type="int" enum="Tabs.CloseButtonDisplayPolicy"> - </return> - <description> - </description> - </method> <method name="get_tab_count" qualifiers="const"> <return type="int"> </return> @@ -69,6 +63,12 @@ <description> </description> </method> + <method name="get_tab_offset" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_tab_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -105,14 +105,6 @@ <description> </description> </method> - <method name="set_current_tab"> - <return type="void"> - </return> - <argument index="0" name="tab_idx" type="int"> - </argument> - <description> - </description> - </method> <method name="set_tab_align"> <return type="void"> </return> @@ -121,14 +113,6 @@ <description> </description> </method> - <method name="set_tab_close_display_policy"> - <return type="void"> - </return> - <argument index="0" name="policy" type="int" enum="Tabs.CloseButtonDisplayPolicy"> - </argument> - <description> - </description> - </method> <method name="set_tab_disabled"> <return type="void"> </return> @@ -163,6 +147,8 @@ <members> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> </member> + <member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled"> + </member> <member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="Tabs.CloseButtonDisplayPolicy"> </member> </members> @@ -205,21 +191,21 @@ </signal> </signals> <constants> - <constant name="ALIGN_LEFT" value="0"> + <constant name="ALIGN_LEFT" value="0" enum="TabAlign"> </constant> - <constant name="ALIGN_CENTER" value="1"> + <constant name="ALIGN_CENTER" value="1" enum="TabAlign"> </constant> - <constant name="ALIGN_RIGHT" value="2"> + <constant name="ALIGN_RIGHT" value="2" enum="TabAlign"> </constant> - <constant name="ALIGN_MAX" value="3"> + <constant name="ALIGN_MAX" value="3" enum="TabAlign"> </constant> - <constant name="CLOSE_BUTTON_SHOW_NEVER" value="0"> + <constant name="CLOSE_BUTTON_SHOW_NEVER" value="0" enum="CloseButtonDisplayPolicy"> </constant> - <constant name="CLOSE_BUTTON_SHOW_ACTIVE_ONLY" value="1"> + <constant name="CLOSE_BUTTON_SHOW_ACTIVE_ONLY" value="1" enum="CloseButtonDisplayPolicy"> </constant> - <constant name="CLOSE_BUTTON_SHOW_ALWAYS" value="2"> + <constant name="CLOSE_BUTTON_SHOW_ALWAYS" value="2" enum="CloseButtonDisplayPolicy"> </constant> - <constant name="CLOSE_BUTTON_MAX" value="3"> + <constant name="CLOSE_BUTTON_MAX" value="3" enum="CloseButtonDisplayPolicy"> </constant> </constants> <theme_items> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 0e862a7903..da30c4c7bd 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextEdit" inherits="Control" category="Core" version="3.0-alpha"> +<class name="TextEdit" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Multiline text editing control. </brief_description> @@ -37,6 +37,14 @@ Add a keyword and its color. </description> </method> + <method name="can_fold" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="line" type="int"> + </argument> + <description> + </description> + </method> <method name="clear_colors"> <return type="void"> </return> @@ -58,20 +66,6 @@ Copy the current selection. </description> </method> - <method name="cursor_get_blink_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Gets whether the text editor caret is blinking. - </description> - </method> - <method name="cursor_get_blink_speed" qualifiers="const"> - <return type="float"> - </return> - <description> - Gets the text editor caret blink speed. - </description> - </method> <method name="cursor_get_column" qualifiers="const"> <return type="int"> </return> @@ -86,67 +80,49 @@ Return the line the editing cursor is at. </description> </method> - <method name="cursor_is_block_mode" qualifiers="const"> - <return type="bool"> - </return> - <description> - Gets whether the text editor caret is in block mode. - </description> - </method> - <method name="cursor_set_blink_enabled"> + <method name="cursor_set_column"> <return type="void"> </return> - <argument index="0" name="enable" type="bool"> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="adjust_viewport" type="bool" default="true"> </argument> <description> - Set the text editor caret to blink. </description> </method> - <method name="cursor_set_blink_speed"> + <method name="cursor_set_line"> <return type="void"> </return> - <argument index="0" name="blink_speed" type="float"> + <argument index="0" name="line" type="int"> + </argument> + <argument index="1" name="adjust_viewport" type="bool" default="true"> + </argument> + <argument index="2" name="can_be_hidden" type="bool" default="true"> </argument> <description> - Set the text editor caret blink speed. Cannot be less then or equal to 0. </description> </method> - <method name="cursor_set_block_mode"> + <method name="cut"> <return type="void"> </return> - <argument index="0" name="enable" type="bool"> - </argument> <description> - Set the text editor caret to block mode. + Cut the current selection. </description> </method> - <method name="cursor_set_column"> + <method name="fold_all_lines"> <return type="void"> </return> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="adjust_viewport" type="bool" default="true"> - </argument> <description> </description> </method> - <method name="cursor_set_line"> + <method name="fold_line"> <return type="void"> </return> <argument index="0" name="line" type="int"> </argument> - <argument index="1" name="adjust_viewport" type="bool" default="true"> - </argument> <description> </description> </method> - <method name="cut"> - <return type="void"> - </return> - <description> - Cut the current selection. - </description> - </method> <method name="get_line" qualifiers="const"> <return type="String"> </return> @@ -204,19 +180,6 @@ Return the selection end line. </description> </method> - <method name="get_text"> - <return type="String"> - </return> - <description> - Return the whole text. - </description> - </method> - <method name="get_v_scroll_speed" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_word_under_cursor" qualifiers="const"> <return type="String"> </return> @@ -232,37 +195,20 @@ Insert a given text at the cursor position. </description> </method> - <method name="is_context_menu_enabled"> - <return type="bool"> - </return> - <description> - Returns true if the context menu is enabled. - </description> - </method> - <method name="is_highlight_all_occurrences_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns true if highlight all occurrences is enabled. - </description> - </method> - <method name="is_highlight_current_line_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_overriding_selected_font_color" qualifiers="const"> + <method name="is_folded" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="line" type="int"> + </argument> <description> </description> </method> - <method name="is_readonly" qualifiers="const"> + <method name="is_line_hidden" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="arg0" type="int"> + </argument> <description> - Return true if the text editor is in read-only mode (see [method set_readonly]). </description> </method> <method name="is_selection_active" qualifiers="const"> @@ -272,26 +218,6 @@ Return true if the selection is active. </description> </method> - <method name="is_show_line_numbers_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns true if line numbers are enabled. - </description> - </method> - <method name="is_smooth_scroll_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_syntax_coloring_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the syntax coloring is enabled. - </description> - </method> <method name="menu_option"> <return type="void"> </return> @@ -351,28 +277,12 @@ Select all the text. </description> </method> - <method name="set_context_menu_enabled"> + <method name="set_line_as_hidden"> <return type="void"> </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set the status of the context menu. When enabled, the context menu will appear when the [code]TextEdit[/code] is right clicked. - </description> - </method> - <method name="set_highlight_all_occurrences"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> + <argument index="0" name="line" type="int"> </argument> - <description> - Set to enable highlighting all occurrences of the current selection. - </description> - </method> - <method name="set_highlight_current_line"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> + <argument index="1" name="enable" type="bool"> </argument> <description> </description> @@ -386,80 +296,43 @@ Set the maximum amount of characters editable. </description> </method> - <method name="set_override_selected_font_color"> - <return type="void"> - </return> - <argument index="0" name="override" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_readonly"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set the text editor as read-only. Text can be displayed but not edited. - </description> - </method> - <method name="set_show_line_numbers"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set to enable showing line numbers. - </description> - </method> - <method name="set_smooth_scroll_enable"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_syntax_coloring"> + <method name="set_wrap"> <return type="void"> </return> <argument index="0" name="enable" type="bool"> </argument> <description> - Set to enable the syntax coloring. + Enable text wrapping when it goes beyond he edge of what is visible. </description> </method> - <method name="set_text"> + <method name="toggle_fold_line"> <return type="void"> </return> - <argument index="0" name="text" type="String"> + <argument index="0" name="line" type="int"> </argument> <description> - Set the entire text. + Toggle the folding of the code block at the given line. </description> </method> - <method name="set_v_scroll_speed"> + <method name="undo"> <return type="void"> </return> - <argument index="0" name="speed" type="float"> - </argument> <description> + Perform undo operation. </description> </method> - <method name="set_wrap"> + <method name="unfold_line"> <return type="void"> </return> - <argument index="0" name="enable" type="bool"> + <argument index="0" name="line" type="int"> </argument> <description> - Enable text wrapping when it goes beyond he edge of what is visible. </description> </method> - <method name="undo"> + <method name="unhide_all_lines"> <return type="void"> </return> <description> - Perform undo operation. </description> </method> </methods> @@ -472,6 +345,8 @@ </member> <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled"> </member> + <member name="hiding_enabled" type="int" setter="set_hiding_enabled" getter="is_hiding_enabled"> + </member> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled"> </member> <member name="highlight_current_line" type="bool" setter="set_highlight_current_line" getter="is_highlight_current_line_enabled"> @@ -527,28 +402,28 @@ </signal> </signals> <constants> - <constant name="SEARCH_MATCH_CASE" value="1"> + <constant name="SEARCH_MATCH_CASE" value="1" enum="SearchFlags"> Match case when searching. </constant> - <constant name="SEARCH_WHOLE_WORDS" value="2"> + <constant name="SEARCH_WHOLE_WORDS" value="2" enum="SearchFlags"> Match whole words when searching. </constant> - <constant name="SEARCH_BACKWARDS" value="4"> + <constant name="SEARCH_BACKWARDS" value="4" enum="SearchFlags"> Search from end to beginning. </constant> - <constant name="MENU_CUT" value="0"> + <constant name="MENU_CUT" value="0" enum="MenuItems"> </constant> - <constant name="MENU_COPY" value="1"> + <constant name="MENU_COPY" value="1" enum="MenuItems"> </constant> - <constant name="MENU_PASTE" value="2"> + <constant name="MENU_PASTE" value="2" enum="MenuItems"> </constant> - <constant name="MENU_CLEAR" value="3"> + <constant name="MENU_CLEAR" value="3" enum="MenuItems"> </constant> - <constant name="MENU_SELECT_ALL" value="4"> + <constant name="MENU_SELECT_ALL" value="4" enum="MenuItems"> </constant> - <constant name="MENU_UNDO" value="5"> + <constant name="MENU_UNDO" value="5" enum="MenuItems"> </constant> - <constant name="MENU_MAX" value="6"> + <constant name="MENU_MAX" value="6" enum="MenuItems"> </constant> </constants> <theme_items> @@ -562,6 +437,8 @@ </theme_item> <theme_item name="caret_color" type="Color"> </theme_item> + <theme_item name="code_folding_color" type="Color"> + </theme_item> <theme_item name="completion" type="StyleBox"> </theme_item> <theme_item name="completion_background_color" type="Color"> @@ -604,6 +481,8 @@ </theme_item> <theme_item name="number_color" type="Color"> </theme_item> + <theme_item name="read_only" type="StyleBox"> + </theme_item> <theme_item name="selection_color" type="Color"> </theme_item> <theme_item name="symbol_color" type="Color"> diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index a856eb64ad..bf27bc4768 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Texture" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Texture" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Texture for 2D and 3D. </brief_description> @@ -116,25 +116,29 @@ </method> </methods> <constants> - <constant name="FLAG_MIPMAPS" value="1"> - Generate mipmaps, to enable smooth zooming out of the texture. + <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. </constant> - <constant name="FLAG_REPEAT" value="2"> - Repeat (instead of clamp to edge). + <constant name="FLAG_REPEAT" value="2" enum="Flags"> + Repeats texture (instead of clamp to edge). </constant> - <constant name="FLAG_FILTER" value="4"> - Turn on magnifying filter, to enable smooth zooming in of the texture. + <constant name="FLAG_FILTER" value="4" enum="Flags"> + Magnifying filter, to enable smooth zooming in of the texture. </constant> - <constant name="FLAGS_DEFAULT" value="7"> + <constant name="FLAGS_DEFAULT" value="7" enum="Flags"> Default flags. Generate mipmaps, repeat, and filter are enabled. </constant> - <constant name="FLAG_ANISOTROPIC_FILTER" value="8"> + <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. </constant> - <constant name="FLAG_CONVERT_TO_LINEAR" value="16"> + <constant name="FLAG_CONVERT_TO_LINEAR" value="16" enum="Flags"> + Converts texture to SRGB color space. </constant> - <constant name="FLAG_MIRRORED_REPEAT" value="32"> + <constant name="FLAG_MIRRORED_REPEAT" value="32" enum="Flags"> + Repeats texture with alternate sections mirrored. </constant> - <constant name="FLAG_VIDEO_SURFACE" value="4096"> + <constant name="FLAG_VIDEO_SURFACE" value="4096" enum="Flags"> Texture is a video surface. </constant> </constants> diff --git a/doc/classes/TextureButton.xml b/doc/classes/TextureButton.xml index a6d935376a..9074966f4f 100644 --- a/doc/classes/TextureButton.xml +++ b/doc/classes/TextureButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextureButton" inherits="BaseButton" category="Core" version="3.0-alpha"> +<class name="TextureButton" inherits="BaseButton" category="Core" version="3.0-beta"> <brief_description> Texture-based button. Supports Pressed, Hover, Disabled and Focused states. </brief_description> @@ -12,118 +12,6 @@ <demos> </demos> <methods> - <method name="get_click_mask" qualifiers="const"> - <return type="BitMap"> - </return> - <description> - </description> - </method> - <method name="get_disabled_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_expand" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_focused_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_hover_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_normal_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_pressed_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_stretch_mode" qualifiers="const"> - <return type="int" enum="TextureButton.StretchMode"> - </return> - <description> - </description> - </method> - <method name="set_click_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="BitMap"> - </argument> - <description> - </description> - </method> - <method name="set_disabled_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_expand"> - <return type="void"> - </return> - <argument index="0" name="p_expand" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_focused_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_hover_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_normal_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_pressed_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_stretch_mode"> - <return type="void"> - </return> - <argument index="0" name="p_mode" type="int" enum="TextureButton.StretchMode"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="expand" type="bool" setter="set_expand" getter="get_expand"> @@ -152,25 +40,25 @@ </member> </members> <constants> - <constant name="STRETCH_SCALE" value="0"> + <constant name="STRETCH_SCALE" value="0" enum="StretchMode"> Scale to fit the node's bounding rectangle. </constant> - <constant name="STRETCH_TILE" value="1"> + <constant name="STRETCH_TILE" value="1" enum="StretchMode"> Tile inside the node's bounding rectangle. </constant> - <constant name="STRETCH_KEEP" value="2"> + <constant name="STRETCH_KEEP" value="2" enum="StretchMode"> The texture keeps its original size and stays in the bounding rectangle's top-left corner. </constant> - <constant name="STRETCH_KEEP_CENTERED" value="3"> + <constant name="STRETCH_KEEP_CENTERED" value="3" enum="StretchMode"> The texture keeps its original size and stays centered in the node's bounding rectangle. </constant> - <constant name="STRETCH_KEEP_ASPECT" value="4"> + <constant name="STRETCH_KEEP_ASPECT" value="4" enum="StretchMode"> Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio. </constant> - <constant name="STRETCH_KEEP_ASPECT_CENTERED" value="5"> + <constant name="STRETCH_KEEP_ASPECT_CENTERED" value="5" enum="StretchMode"> Scale the texture to fit the node's bounding rectangle, center it, and maintain its aspect ratio. </constant> - <constant name="STRETCH_KEEP_ASPECT_COVERED" value="6"> + <constant name="STRETCH_KEEP_ASPECT_COVERED" value="6" enum="StretchMode"> Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits. </constant> </constants> diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml index 550c38920a..c3046d7877 100644 --- a/doc/classes/TextureProgress.xml +++ b/doc/classes/TextureProgress.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextureProgress" inherits="Range" category="Core" version="3.0-alpha"> +<class name="TextureProgress" inherits="Range" category="Core" version="3.0-beta"> <brief_description> Texture-based progress bar. Useful for loading screens and life or stamina bars. </brief_description> @@ -11,140 +11,6 @@ <demos> </demos> <methods> - <method name="get_fill_degrees"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_fill_mode"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_nine_patch_stretch" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns true if textures are stretched as nine-patches or false otherwise. - </description> - </method> - <method name="get_over_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_progress_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_radial_center_offset"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_radial_initial_angle"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_stretch_margin" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). - </description> - </method> - <method name="get_under_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="set_fill_degrees"> - <return type="void"> - </return> - <argument index="0" name="mode" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_fill_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_nine_patch_stretch"> - <return type="void"> - </return> - <argument index="0" name="stretch" type="bool"> - </argument> - <description> - Set if textures should be stretched as nine-patches. - </description> - </method> - <method name="set_over_texture"> - <return type="void"> - </return> - <argument index="0" name="tex" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_progress_texture"> - <return type="void"> - </return> - <argument index="0" name="tex" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_radial_center_offset"> - <return type="void"> - </return> - <argument index="0" name="mode" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_radial_initial_angle"> - <return type="void"> - </return> - <argument index="0" name="mode" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_stretch_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="value" type="int"> - </argument> - <description> - Set nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). - </description> - </method> - <method name="set_under_texture"> - <return type="void"> - </return> - <argument index="0" name="tex" type="Texture"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="fill_mode" type="int" setter="set_fill_mode" getter="get_fill_mode"> @@ -187,22 +53,22 @@ </member> </members> <constants> - <constant name="FILL_LEFT_TO_RIGHT" value="0"> + <constant name="FILL_LEFT_TO_RIGHT" value="0" enum="FillMode"> The [member texture_progress] fills from left to right. </constant> - <constant name="FILL_RIGHT_TO_LEFT" value="1"> + <constant name="FILL_RIGHT_TO_LEFT" value="1" enum="FillMode"> The [member texture_progress] fills from right to left. </constant> - <constant name="FILL_TOP_TO_BOTTOM" value="2"> + <constant name="FILL_TOP_TO_BOTTOM" value="2" enum="FillMode"> The [member texture_progress] fills from top to bototm. </constant> - <constant name="FILL_BOTTOM_TO_TOP" value="3"> + <constant name="FILL_BOTTOM_TO_TOP" value="3" enum="FillMode"> The [member texture_progress] fills from bottom to top. </constant> - <constant name="FILL_CLOCKWISE" value="4"> + <constant name="FILL_CLOCKWISE" value="4" enum="FillMode"> 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 refine its behavior. </constant> - <constant name="FILL_COUNTER_CLOCKWISE" value="5"> + <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 refine its behavior. </constant> </constants> diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml index cef102e8ae..c1a5902448 100644 --- a/doc/classes/TextureRect.xml +++ b/doc/classes/TextureRect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextureRect" inherits="Control" category="Core" version="3.0-alpha"> +<class name="TextureRect" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Draws a sprite or a texture inside a User Interface. The texture can tile or not. </brief_description> @@ -11,48 +11,6 @@ <demos> </demos> <methods> - <method name="get_stretch_mode" qualifiers="const"> - <return type="int" enum="TextureRect.StretchMode"> - </return> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="has_expand" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_expand"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_stretch_mode"> - <return type="void"> - </return> - <argument index="0" name="stretch_mode" type="int" enum="TextureRect.StretchMode"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="expand" type="bool" setter="set_expand" getter="has_expand"> @@ -66,28 +24,28 @@ </member> </members> <constants> - <constant name="STRETCH_SCALE_ON_EXPAND" value="0"> + <constant name="STRETCH_SCALE_ON_EXPAND" value="0" enum="StretchMode"> Scale to fit the node's bounding rectangle, only if [code]expand[/code] is [code]true[/code]. Default [code]stretch_mode[/code], for backwards compatibility. Until you set [code]expand[/code] to [code]true[/code], the texture will behave like [code]STRETCH_KEEP[/code]. </constant> - <constant name="STRETCH_SCALE" value="1"> + <constant name="STRETCH_SCALE" value="1" enum="StretchMode"> Scale to fit the node's bounding rectangle. </constant> - <constant name="STRETCH_TILE" value="2"> + <constant name="STRETCH_TILE" value="2" enum="StretchMode"> Tile inside the node's bounding rectangle. </constant> - <constant name="STRETCH_KEEP" value="3"> + <constant name="STRETCH_KEEP" value="3" enum="StretchMode"> The texture keeps its original size and stays in the bounding rectangle's top-left corner. </constant> - <constant name="STRETCH_KEEP_CENTERED" value="4"> + <constant name="STRETCH_KEEP_CENTERED" value="4" enum="StretchMode"> The texture keeps its original size and stays centered in the node's bounding rectangle. </constant> - <constant name="STRETCH_KEEP_ASPECT" value="5"> + <constant name="STRETCH_KEEP_ASPECT" value="5" enum="StretchMode"> Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio. </constant> - <constant name="STRETCH_KEEP_ASPECT_CENTERED" value="6"> + <constant name="STRETCH_KEEP_ASPECT_CENTERED" value="6" enum="StretchMode"> Scale the texture to fit the node's bounding rectangle, center it and maintain its aspect ratio. </constant> - <constant name="STRETCH_KEEP_ASPECT_COVERED" value="7"> + <constant name="STRETCH_KEEP_ASPECT_COVERED" value="7" enum="StretchMode"> Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits. </constant> </constants> diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index 0a95a52e4f..f6d3b97181 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Theme" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Theme" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Theme for controls. </brief_description> @@ -20,6 +20,7 @@ <argument index="1" name="type" type="String"> </argument> <description> + Clears theme [Color] at [code]name[/code] if Theme has [code]type[/code]. </description> </method> <method name="clear_constant"> @@ -30,6 +31,7 @@ <argument index="1" name="type" type="String"> </argument> <description> + Clears theme constant at [code]name[/code] if Theme has [code]type[/code]. </description> </method> <method name="clear_font"> @@ -40,6 +42,7 @@ <argument index="1" name="type" type="String"> </argument> <description> + Clears [Font] at [code]name[/code] if Theme has [code]type[/code]. </description> </method> <method name="clear_icon"> @@ -50,6 +53,7 @@ <argument index="1" name="type" type="String"> </argument> <description> + Clears icon at [code]name[/code] if Theme has [code]type[/code]. </description> </method> <method name="clear_stylebox"> @@ -60,12 +64,14 @@ <argument index="1" name="type" type="String"> </argument> <description> + Clears [StyleBox] at [code]name[/code] if 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. </description> </method> <method name="get_color" qualifiers="const"> @@ -76,6 +82,7 @@ <argument index="1" name="type" type="String"> </argument> <description> + Returns the [Color] at [code]name[/code] if Theme has [code]type[/code]. </description> </method> <method name="get_color_list" qualifiers="const"> @@ -84,6 +91,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]. </description> </method> <method name="get_constant" qualifiers="const"> @@ -94,6 +102,7 @@ <argument index="1" name="type" type="String"> </argument> <description> + Returns the constant at [code]name[/code] if Theme has [code]type[/code]. </description> </method> <method name="get_constant_list" qualifiers="const"> @@ -102,12 +111,7 @@ <argument index="0" name="type" type="String"> </argument> <description> - </description> - </method> - <method name="get_default_font" qualifiers="const"> - <return type="Font"> - </return> - <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]. </description> </method> <method name="get_font" qualifiers="const"> @@ -118,6 +122,7 @@ <argument index="1" name="type" type="String"> </argument> <description> + Returns the [Font] at [code]name[/code] if Theme has [code]type[/code]. </description> </method> <method name="get_font_list" qualifiers="const"> @@ -126,6 +131,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]. </description> </method> <method name="get_icon" qualifiers="const"> @@ -136,6 +142,7 @@ <argument index="1" name="type" type="String"> </argument> <description> + Returns the icon [Texture] at [code]name[/code] if Theme has [code]type[/code]. </description> </method> <method name="get_icon_list" qualifiers="const"> @@ -144,6 +151,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]. </description> </method> <method name="get_stylebox" qualifiers="const"> @@ -154,6 +162,7 @@ <argument index="1" name="type" type="String"> </argument> <description> + Returns the icon [StyleBox] at [code]name[/code] if Theme has [code]type[/code]. </description> </method> <method name="get_stylebox_list" qualifiers="const"> @@ -162,12 +171,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]. </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]. </description> </method> <method name="get_type_list" qualifiers="const"> @@ -176,6 +187,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]. </description> </method> <method name="has_color" qualifiers="const"> @@ -186,6 +198,8 @@ <argument index="1" name="type" type="String"> </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]. </description> </method> <method name="has_constant" qualifiers="const"> @@ -196,6 +210,8 @@ <argument index="1" name="type" type="String"> </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]. </description> </method> <method name="has_font" qualifiers="const"> @@ -206,6 +222,8 @@ <argument index="1" name="type" type="String"> </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]. </description> </method> <method name="has_icon" qualifiers="const"> @@ -216,6 +234,8 @@ <argument index="1" name="type" type="String"> </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]. </description> </method> <method name="has_stylebox" qualifiers="const"> @@ -226,6 +246,8 @@ <argument index="1" name="type" type="String"> </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]. </description> </method> <method name="set_color"> @@ -238,6 +260,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]. </description> </method> <method name="set_constant"> @@ -250,14 +274,8 @@ <argument index="2" name="constant" type="int"> </argument> <description> - </description> - </method> - <method name="set_default_font"> - <return type="void"> - </return> - <argument index="0" name="font" type="Font"> - </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]. </description> </method> <method name="set_font"> @@ -270,6 +288,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]. </description> </method> <method name="set_icon"> @@ -282,6 +302,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]. </description> </method> <method name="set_stylebox"> @@ -294,11 +316,14 @@ <argument index="2" name="texture" type="StyleBox"> </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]. </description> </method> </methods> <members> <member name="default_font" type="Font" setter="set_default_font" getter="get_default_font"> + The theme's default font. </member> </members> <constants> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 24bc4bb985..c9b1d872bc 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Thread" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="Thread" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> A unit of execution in a process. </brief_description> @@ -50,11 +50,11 @@ </method> </methods> <constants> - <constant name="PRIORITY_LOW" value="0"> + <constant name="PRIORITY_LOW" value="0" enum="Priority"> </constant> - <constant name="PRIORITY_NORMAL" value="1"> + <constant name="PRIORITY_NORMAL" value="1" enum="Priority"> </constant> - <constant name="PRIORITY_HIGH" value="2"> + <constant name="PRIORITY_HIGH" value="2" enum="Priority"> </constant> </constants> </class> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index c48f58f123..72cd56dc55 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TileMap" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="TileMap" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Node for 2D tile-based maps. </brief_description> @@ -29,13 +29,6 @@ Return the tile index of the referenced cell. </description> </method> - <method name="get_cell_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the cell size. - </description> - </method> <method name="get_cellv" qualifiers="const"> <return type="int"> </return> @@ -45,47 +38,6 @@ Return the tile index of the cell referenced by a Vector2. </description> </method> - <method name="get_center_x" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner). - </description> - </method> - <method name="get_center_y" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). - </description> - </method> - <method name="get_clip_uv" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_collision_bounce" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the collision bounce parameter. - </description> - </method> - <method name="get_collision_friction" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the collision friction parameter. - </description> - </method> - <method name="get_collision_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the collision layer. - </description> - </method> <method name="get_collision_layer_bit" qualifiers="const"> <return type="bool"> </return> @@ -94,13 +46,6 @@ <description> </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the collision mask. - </description> - </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> @@ -109,61 +54,6 @@ <description> </description> </method> - <method name="get_collision_use_kinematic" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the tilemap handles collisions as a kinematic body. - </description> - </method> - <method name="get_custom_transform" qualifiers="const"> - <return type="Transform2D"> - </return> - <description> - Return the custom transform matrix. - </description> - </method> - <method name="get_half_offset" qualifiers="const"> - <return type="int" enum="TileMap.HalfOffset"> - </return> - <description> - Return the current half offset configuration. - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int" enum="TileMap.Mode"> - </return> - <description> - Return the orientation mode. - </description> - </method> - <method name="get_occluder_light_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_quadrant_size" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the quadrant size. - </description> - </method> - <method name="get_tile_origin" qualifiers="const"> - <return type="int" enum="TileMap.TileOrigin"> - </return> - <description> - Return the tile origin configuration. - </description> - </method> - <method name="get_tileset" qualifiers="const"> - <return type="TileSet"> - </return> - <description> - Return the current tileset. - </description> - </method> <method name="get_used_cells" qualifiers="const"> <return type="Array"> </return> @@ -218,13 +108,6 @@ Return whether the referenced cell is flipped over the Y axis. </description> </method> - <method name="is_y_sort_mode_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return the Y sort mode. - </description> - </method> <method name="map_to_world" qualifiers="const"> <return type="Vector2"> </return> @@ -252,19 +135,12 @@ </argument> <argument index="5" name="transpose" type="bool" default="false"> </argument> + <argument index="6" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )"> + </argument> <description> Set the tile index for the cell referenced by its grid-based X and Y coordinates. A tile index of -1 clears the cell. - Optionally, the tile can also be flipped over the X and Y coordinates or transposed. - </description> - </method> - <method name="set_cell_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - Set the cell size. + Optionally, the tile can also be flipped over the X and Y coordinates, transposed, or be given autotile coordinates. </description> </method> <method name="set_cellv"> @@ -286,60 +162,6 @@ Optionally, the tile can also be flipped over the X and Y axes or transposed. </description> </method> - <method name="set_center_x"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). - </description> - </method> - <method name="set_center_y"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). - </description> - </method> - <method name="set_clip_uv"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_collision_bounce"> - <return type="void"> - </return> - <argument index="0" name="value" type="float"> - </argument> - <description> - Set the collision bounce parameter. Allowable values range from 0 to 1. - </description> - </method> - <method name="set_collision_friction"> - <return type="void"> - </return> - <argument index="0" name="value" type="float"> - </argument> - <description> - Set the collision friction parameter. Allowable values range from 0 to 1. - </description> - </method> - <method name="set_collision_layer"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - Set the collision layer. - Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. - </description> - </method> <method name="set_collision_layer_bit"> <return type="void"> </return> @@ -350,16 +172,6 @@ <description> </description> </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the collision masks. - Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. - </description> - </method> <method name="set_collision_mask_bit"> <return type="void"> </return> @@ -370,89 +182,6 @@ <description> </description> </method> - <method name="set_collision_use_kinematic"> - <return type="void"> - </return> - <argument index="0" name="use_kinematic" type="bool"> - </argument> - <description> - Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). - </description> - </method> - <method name="set_custom_transform"> - <return type="void"> - </return> - <argument index="0" name="custom_transform" type="Transform2D"> - </argument> - <description> - Set custom transform matrix, to use in combination with the custom orientation mode. - </description> - </method> - <method name="set_half_offset"> - <return type="void"> - </return> - <argument index="0" name="half_offset" type="int" enum="TileMap.HalfOffset"> - </argument> - <description> - Set a half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument). - Half offset sets every other tile off by a half tile size in the specified direction. - </description> - </method> - <method name="set_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="TileMap.Mode"> - </argument> - <description> - Set the orientation mode as square, isometric or custom (use MODE_* constants as argument). - </description> - </method> - <method name="set_occluder_light_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_quadrant_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="int"> - </argument> - <description> - Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. - Allowed values are integers ranging from 1 to 128. - </description> - </method> - <method name="set_tile_origin"> - <return type="void"> - </return> - <argument index="0" name="origin" type="int" enum="TileMap.TileOrigin"> - </argument> - <description> - Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument). - </description> - </method> - <method name="set_tileset"> - <return type="void"> - </return> - <argument index="0" name="tileset" type="TileSet"> - </argument> - <description> - Set the current tileset. - </description> - </method> - <method name="set_y_sort_mode"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate. - A tile with a higher Y coordinate will therefore be drawn later, potentially covering up the tile(s) above it if its sprite is higher than its cell size. - </description> - </method> <method name="world_to_map" qualifiers="const"> <return type="Vector2"> </return> @@ -505,9 +234,6 @@ <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). </member> - <member name="tile_data" type="PoolIntArray" setter="_set_tile_data" getter="_get_tile_data"> - A [PoolIntArray] containing - </member> <member name="tile_set" type="TileSet" setter="set_tileset" getter="get_tileset"> The assigned [TileSet]. </member> @@ -520,34 +246,34 @@ </signal> </signals> <constants> - <constant name="INVALID_CELL" value="-1" enum=""> + <constant name="INVALID_CELL" value="-1"> Returned when a cell doesn't exist. </constant> - <constant name="MODE_SQUARE" value="0"> + <constant name="MODE_SQUARE" value="0" enum="Mode"> Orthogonal orientation mode. </constant> - <constant name="MODE_ISOMETRIC" value="1"> + <constant name="MODE_ISOMETRIC" value="1" enum="Mode"> Isometric orientation mode. </constant> - <constant name="MODE_CUSTOM" value="2"> + <constant name="MODE_CUSTOM" value="2" enum="Mode"> Custom orientation mode. </constant> - <constant name="HALF_OFFSET_X" value="0"> + <constant name="HALF_OFFSET_X" value="0" enum="HalfOffset"> Half offset on the X coordinate. </constant> - <constant name="HALF_OFFSET_Y" value="1"> + <constant name="HALF_OFFSET_Y" value="1" enum="HalfOffset"> Half offset on the Y coordinate. </constant> - <constant name="HALF_OFFSET_DISABLED" value="2"> + <constant name="HALF_OFFSET_DISABLED" value="2" enum="HalfOffset"> Half offset disabled. </constant> - <constant name="TILE_ORIGIN_TOP_LEFT" value="0"> + <constant name="TILE_ORIGIN_TOP_LEFT" value="0" enum="TileOrigin"> Tile origin at its top-left corner. </constant> - <constant name="TILE_ORIGIN_CENTER" value="1"> + <constant name="TILE_ORIGIN_CENTER" value="1" enum="TileOrigin"> Tile origin at its center. </constant> - <constant name="TILE_ORIGIN_BOTTOM_LEFT" value="2"> + <constant name="TILE_ORIGIN_BOTTOM_LEFT" value="2" enum="TileOrigin"> </constant> </constants> </class> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index a1063567f8..3dbf172c5a 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TileSet" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="TileSet" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Tile library for tilemaps. </brief_description> @@ -12,6 +12,48 @@ <demos> </demos> <methods> + <method name="_forward_subtile_selection" qualifiers="virtual"> + <return type="Vector2"> + </return> + <argument index="0" name="autotile_id" type="int"> + </argument> + <argument index="1" name="bitmask" type="int"> + </argument> + <argument index="2" name="tilemap" type="Object"> + </argument> + <argument index="3" name="tile_location" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="_is_tile_bound" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="drawn_id" type="int"> + </argument> + <argument index="1" name="neighbor_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="autotile_get_bitmask_mode" qualifiers="const"> + <return type="int" enum="TileSet.BitmaskMode"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <description> + </description> + </method> + <method name="autotile_set_bitmask_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int"> + </argument> + <argument index="1" name="arg1" type="int" enum="TileSet.BitmaskMode"> + </argument> + <description> + </description> + </method> <method name="clear"> <return type="void"> </return> @@ -71,6 +113,8 @@ </argument> <argument index="3" name="one_way" type="bool" default="false"> </argument> + <argument index="4" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )"> + </argument> <description> </description> </method> @@ -368,5 +412,25 @@ </method> </methods> <constants> + <constant name="BITMASK_2X2" value="0" enum="BitmaskMode"> + </constant> + <constant name="BITMASK_3X3" value="1" enum="BitmaskMode"> + </constant> + <constant name="BIND_TOPLEFT" value="1" enum="AutotileBindings"> + </constant> + <constant name="BIND_TOP" value="2" enum="AutotileBindings"> + </constant> + <constant name="BIND_TOPRIGHT" value="4" enum="AutotileBindings"> + </constant> + <constant name="BIND_LEFT" value="8" enum="AutotileBindings"> + </constant> + <constant name="BIND_RIGHT" value="32" enum="AutotileBindings"> + </constant> + <constant name="BIND_BOTTOMLEFT" value="64" enum="AutotileBindings"> + </constant> + <constant name="BIND_BOTTOM" value="128" enum="AutotileBindings"> + </constant> + <constant name="BIND_BOTTOMRIGHT" value="256" enum="AutotileBindings"> + </constant> </constants> </class> diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 8d834537a7..7ea83b0b22 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Timer" inherits="Node" category="Core" version="3.0-alpha"> +<class name="Timer" inherits="Node" category="Core" version="3.0-beta"> <brief_description> A countdown timer. </brief_description> @@ -18,34 +18,6 @@ Return the time left for timeout in seconds if the timer is active, 0 otherwise. </description> </method> - <method name="get_timer_process_mode" qualifiers="const"> - <return type="int" enum="Timer.TimerProcessMode"> - </return> - <description> - Return the timer's processing mode. - </description> - </method> - <method name="get_wait_time" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the wait time in seconds. - </description> - </method> - <method name="has_autostart" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if set to automatically start when entering the scene. - </description> - </method> - <method name="is_one_shot" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if configured as one-shot. - </description> - </method> <method name="is_paused" qualifiers="const"> <return type="bool"> </return> @@ -59,24 +31,6 @@ <description> </description> </method> - <method name="set_autostart"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set to automatically start when entering the scene. - </description> - </method> - <method name="set_one_shot"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. - </description> - </method> <method name="set_paused"> <return type="void"> </return> @@ -86,24 +40,6 @@ Set whether the timer is paused or not. A paused timer will be inactive until it is unpaused again. </description> </method> - <method name="set_timer_process_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Timer.TimerProcessMode"> - </argument> - <description> - Set the timer's processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument). - </description> - </method> - <method name="set_wait_time"> - <return type="void"> - </return> - <argument index="0" name="time_sec" type="float"> - </argument> - <description> - Set wait time in seconds. When the time is over, it will emit the timeout signal. - </description> - </method> <method name="start"> <return type="void"> </return> @@ -141,10 +77,10 @@ </signal> </signals> <constants> - <constant name="TIMER_PROCESS_PHYSICS" value="0"> + <constant name="TIMER_PROCESS_PHYSICS" value="0" enum="TimerProcessMode"> Update the Timer during the physics step at each frame (fixed framerate processing). </constant> - <constant name="TIMER_PROCESS_IDLE" value="1"> + <constant name="TIMER_PROCESS_IDLE" value="1" enum="TimerProcessMode"> Update the Timer during the idle time at each frame. </constant> </constants> diff --git a/doc/classes/ToolButton.xml b/doc/classes/ToolButton.xml index b541d00d2f..512bbbf3f0 100644 --- a/doc/classes/ToolButton.xml +++ b/doc/classes/ToolButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ToolButton" inherits="Button" category="Core" version="3.0-alpha"> +<class name="ToolButton" inherits="Button" category="Core" version="3.0-beta"> <brief_description> Flat button helper class. </brief_description> diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml index 283ead1b1b..776765f84d 100644 --- a/doc/classes/TouchScreenButton.xml +++ b/doc/classes/TouchScreenButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TouchScreenButton" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="TouchScreenButton" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Button for touch screen devices. </brief_description> @@ -11,54 +11,6 @@ <demos> </demos> <methods> - <method name="get_action" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the button's action. - </description> - </method> - <method name="get_bitmask" qualifiers="const"> - <return type="BitMap"> - </return> - <description> - Returns the button's bitmask. - </description> - </method> - <method name="get_shape" qualifiers="const"> - <return type="Shape2D"> - </return> - <description> - Returns the button's shape. - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - Returns the button's texture for the normal state. - </description> - </method> - <method name="get_texture_pressed" qualifiers="const"> - <return type="Texture"> - </return> - <description> - Returns the button's texture for the pressed state. - </description> - </method> - <method name="get_visibility_mode" qualifiers="const"> - <return type="int" enum="TouchScreenButton.VisibilityMode"> - </return> - <description> - Sets the button's visibility mode. See [code]VISIBILITY_*[/code] constants. - </description> - </method> - <method name="is_passby_press_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> @@ -66,99 +18,6 @@ Returns [code]true[/code] if this button is currently pressed. </description> </method> - <method name="is_shape_centered" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_shape_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_action"> - <return type="void"> - </return> - <argument index="0" name="action" type="String"> - </argument> - <description> - Sets the button's action. - </description> - </method> - <method name="set_bitmask"> - <return type="void"> - </return> - <argument index="0" name="bitmask" type="BitMap"> - </argument> - <description> - Sets the button's [BitMap] bitmask. - </description> - </method> - <method name="set_passby_press"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - If [code]true[/code] passby presses are enabled for this button. - </description> - </method> - <method name="set_shape"> - <return type="void"> - </return> - <argument index="0" name="shape" type="Shape2D"> - </argument> - <description> - Sets the button's shape. - </description> - </method> - <method name="set_shape_centered"> - <return type="void"> - </return> - <argument index="0" name="bool" type="bool"> - </argument> - <description> - If [code]true[/code] the button's shape is centered. - </description> - </method> - <method name="set_shape_visible"> - <return type="void"> - </return> - <argument index="0" name="bool" type="bool"> - </argument> - <description> - If [code]true[/code] the button's shape is visible. - </description> - </method> - <method name="set_texture"> - <return type="void"> - </return> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - Sets the button's [Texture] for the normal state. - </description> - </method> - <method name="set_texture_pressed"> - <return type="void"> - </return> - <argument index="0" name="texture_pressed" type="Texture"> - </argument> - <description> - Sets the button's [Texture] for the pressed state. - </description> - </method> - <method name="set_visibility_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="TouchScreenButton.VisibilityMode"> - </argument> - <description> - Sets the button's visibility mode. See the [code]VISIBILITY_*[/code] constants. - </description> - </method> </methods> <members> <member name="action" type="String" setter="set_action" getter="get_action"> @@ -202,10 +61,10 @@ </signal> </signals> <constants> - <constant name="VISIBILITY_ALWAYS" value="0"> + <constant name="VISIBILITY_ALWAYS" value="0" enum="VisibilityMode"> Always visible. </constant> - <constant name="VISIBILITY_TOUCHSCREEN_ONLY" value="1"> + <constant name="VISIBILITY_TOUCHSCREEN_ONLY" value="1" enum="VisibilityMode"> Visible on touch screens only. </constant> </constants> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 9e1672e6f5..83003cb357 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Transform" category="Built-In Types" version="3.0-alpha"> +<class name="Transform" category="Built-In Types" version="3.0-beta"> <brief_description> 3D Transformation. 3x4 matrix. </brief_description> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index d17063b550..17576f33ed 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Transform2D" category="Built-In Types" version="3.0-alpha"> +<class name="Transform2D" category="Built-In Types" version="3.0-beta"> <brief_description> 2D Transformation. 3x2 matrix. </brief_description> diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index dc2609b3e1..cb49c66383 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Translation" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="Translation" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Language Translation. </brief_description> @@ -31,13 +31,6 @@ Erase a message. </description> </method> - <method name="get_locale" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the locale of the translation. - </description> - </method> <method name="get_message" qualifiers="const"> <return type="String"> </return> @@ -60,21 +53,10 @@ Return all the messages (keys). </description> </method> - <method name="set_locale"> - <return type="void"> - </return> - <argument index="0" name="locale" type="String"> - </argument> - <description> - Set the locale of the translation. - </description> - </method> </methods> <members> <member name="locale" type="String" setter="set_locale" getter="get_locale"> </member> - <member name="messages" type="PoolStringArray" setter="_set_messages" getter="_get_messages"> - </member> </members> <constants> </constants> diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index 8b50bf027b..c9b5b46525 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TranslationServer" inherits="Object" category="Core" version="3.0-alpha"> +<class name="TranslationServer" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Server that manages all translations. Translations can be set to it and removed from it. </brief_description> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 508a0ec194..11bd3b3b86 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Tree" inherits="Control" category="Core" version="3.0-alpha"> +<class name="Tree" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Control to show a tree of items. </brief_description> @@ -405,21 +405,25 @@ Emitted instead of [code]item_selected[/code] when [code]select_mode[/code] is [code]SELECT_MULTI[/code]. </description> </signal> + <signal name="nothing_selected"> + <description> + </description> + </signal> </signals> <constants> - <constant name="SELECT_SINGLE" value="0"> + <constant name="SELECT_SINGLE" value="0" enum="SelectMode"> Allow selection of a single item at a time. </constant> - <constant name="SELECT_ROW" value="1"> + <constant name="SELECT_ROW" value="1" enum="SelectMode"> </constant> - <constant name="SELECT_MULTI" value="2"> + <constant name="SELECT_MULTI" value="2" enum="SelectMode"> Allow selection of multiple items at the same time. </constant> - <constant name="DROP_MODE_DISABLED" value="0"> + <constant name="DROP_MODE_DISABLED" value="0" enum="DropModeFlags"> </constant> - <constant name="DROP_MODE_ON_ITEM" value="1"> + <constant name="DROP_MODE_ON_ITEM" value="1" enum="DropModeFlags"> </constant> - <constant name="DROP_MODE_INBETWEEN" value="2"> + <constant name="DROP_MODE_INBETWEEN" value="2" enum="DropModeFlags"> </constant> </constants> <theme_items> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index b463ef7bbb..421185fe51 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TreeItem" inherits="Object" category="Core" version="3.0-alpha"> +<class name="TreeItem" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Control for a single item inside a [Tree]. </brief_description> @@ -586,30 +586,30 @@ </method> </methods> <constants> - <constant name="CELL_MODE_STRING" value="0"> + <constant name="CELL_MODE_STRING" value="0" enum="TreeCellMode"> Cell contains a string. </constant> - <constant name="CELL_MODE_CHECK" value="1"> + <constant name="CELL_MODE_CHECK" value="1" enum="TreeCellMode"> Cell can be checked. </constant> - <constant name="CELL_MODE_RANGE" value="2"> + <constant name="CELL_MODE_RANGE" value="2" enum="TreeCellMode"> Cell contains a range. </constant> - <constant name="CELL_MODE_RANGE_EXPRESSION" value="3"> + <constant name="CELL_MODE_RANGE_EXPRESSION" value="3" enum="TreeCellMode"> Cell contains a range expression. </constant> - <constant name="CELL_MODE_ICON" value="4"> + <constant name="CELL_MODE_ICON" value="4" enum="TreeCellMode"> Cell contains an icon. </constant> - <constant name="CELL_MODE_CUSTOM" value="5"> + <constant name="CELL_MODE_CUSTOM" value="5" enum="TreeCellMode"> </constant> - <constant name="ALIGN_LEFT" value="0"> + <constant name="ALIGN_LEFT" value="0" enum="TextAlign"> Align text to the left. See [code]set_text_align()[/code]. </constant> - <constant name="ALIGN_CENTER" value="1"> + <constant name="ALIGN_CENTER" value="1" enum="TextAlign"> Center text. See [code]set_text_align()[/code]. </constant> - <constant name="ALIGN_RIGHT" value="2"> + <constant name="ALIGN_RIGHT" value="2" enum="TextAlign"> Align text to the right. See [code]set_text_align()[/code]. </constant> </constants> diff --git a/doc/classes/TriangleMesh.xml b/doc/classes/TriangleMesh.xml index 21a37913c8..adc9e00536 100644 --- a/doc/classes/TriangleMesh.xml +++ b/doc/classes/TriangleMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TriangleMesh" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="TriangleMesh" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 822eee5838..a11580860a 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Tween" inherits="Node" category="Core" version="3.0-alpha"> +<class name="Tween" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Node useful for animations with unknown start and end points. </brief_description> @@ -50,13 +50,13 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="property" type="String"> + <argument index="1" name="property" type="NodePath"> </argument> <argument index="2" name="initial_val" type="Variant"> </argument> <argument index="3" name="target" type="Object"> </argument> - <argument index="4" name="target_property" type="String"> + <argument index="4" name="target_property" type="NodePath"> </argument> <argument index="5" name="duration" type="float"> </argument> @@ -85,13 +85,6 @@ Returns the speed that has been set from editor GUI or [method set_repeat]. </description> </method> - <method name="get_tween_process_mode" qualifiers="const"> - <return type="int" enum="Tween.TweenProcessMode"> - </return> - <description> - Returns the process mode that has been set from editor GUI or [method set_tween_process_mode] - </description> - </method> <method name="interpolate_callback"> <return type="bool"> </return> @@ -167,7 +160,7 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="property" type="String"> + <argument index="1" name="property" type="NodePath"> </argument> <argument index="2" name="initial_val" type="Variant"> </argument> @@ -290,15 +283,6 @@ Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this. </description> </method> - <method name="set_tween_process_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Tween.TweenProcessMode"> - </argument> - <description> - Set whether the Tween uses [code]_process[/code] or [code]_physics_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_PHYSICS constants, respectively). - </description> - </method> <method name="start"> <return type="bool"> </return> @@ -355,11 +339,11 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="property" type="String"> + <argument index="1" name="property" type="NodePath"> </argument> <argument index="2" name="initial" type="Object"> </argument> - <argument index="3" name="initial_val" type="String"> + <argument index="3" name="initial_val" type="NodePath"> </argument> <argument index="4" name="final_val" type="Variant"> </argument> @@ -422,55 +406,55 @@ </signal> </signals> <constants> - <constant name="TWEEN_PROCESS_PHYSICS" value="0"> + <constant name="TWEEN_PROCESS_PHYSICS" value="0" enum="TweenProcessMode"> The [code]Tween[/code] should use [code]_physics_process[/code] for timekeeping when this is enabled. </constant> - <constant name="TWEEN_PROCESS_IDLE" value="1"> + <constant name="TWEEN_PROCESS_IDLE" value="1" enum="TweenProcessMode"> The [code]Tween[/code] should use [code]_process[/code] for timekeeping when this is enabled (default). </constant> - <constant name="TRANS_LINEAR" value="0"> + <constant name="TRANS_LINEAR" value="0" enum="TransitionType"> Means that the animation is interpolated linearly. </constant> - <constant name="TRANS_SINE" value="1"> + <constant name="TRANS_SINE" value="1" enum="TransitionType"> Means that the animation is interpolated using a sine wave. </constant> - <constant name="TRANS_QUINT" value="2"> + <constant name="TRANS_QUINT" value="2" enum="TransitionType"> Means that the animation is interpolated with a quinary (to the power of 5) function. </constant> - <constant name="TRANS_QUART" value="3"> + <constant name="TRANS_QUART" value="3" enum="TransitionType"> Means that the animation is interpolated with a quartic (to the power of 4) function. </constant> - <constant name="TRANS_QUAD" value="4"> + <constant name="TRANS_QUAD" value="4" enum="TransitionType"> Means that the animation is interpolated with a quadratic (to the power of 2) function. </constant> - <constant name="TRANS_EXPO" value="5"> + <constant name="TRANS_EXPO" value="5" enum="TransitionType"> Means that the animation is interpolated with an exponential (some number to the power of x) function. </constant> - <constant name="TRANS_ELASTIC" value="6"> + <constant name="TRANS_ELASTIC" value="6" enum="TransitionType"> Means that the animation is interpolated with elasticity, wiggling around the edges. </constant> - <constant name="TRANS_CUBIC" value="7"> + <constant name="TRANS_CUBIC" value="7" enum="TransitionType"> Means that the animation is interpolated with a cubic (to the power of 3) function. </constant> - <constant name="TRANS_CIRC" value="8"> + <constant name="TRANS_CIRC" value="8" enum="TransitionType"> Means that the animation is interpolated with a function using square roots. </constant> - <constant name="TRANS_BOUNCE" value="9"> + <constant name="TRANS_BOUNCE" value="9" enum="TransitionType"> Means that the animation is interpolated by bouncing at, but never surpassing, the end. </constant> - <constant name="TRANS_BACK" value="10"> + <constant name="TRANS_BACK" value="10" enum="TransitionType"> Means that the animation is interpolated backing out at edges. </constant> - <constant name="EASE_IN" value="0"> + <constant name="EASE_IN" value="0" enum="EaseType"> Signifies that the interpolation should be focused in the beginning. </constant> - <constant name="EASE_OUT" value="1"> + <constant name="EASE_OUT" value="1" enum="EaseType"> Signifies that the interpolation should be focused in the end. </constant> - <constant name="EASE_IN_OUT" value="2"> + <constant name="EASE_IN_OUT" value="2" enum="EaseType"> Signifies that the interpolation should be focused in both ends. </constant> - <constant name="EASE_OUT_IN" value="3"> + <constant name="EASE_OUT_IN" value="3" enum="EaseType"> Signifies that the interpolation should be focused in both ends, but they should be switched (a bit hard to explain, try it for yourself to be sure). </constant> </constants> diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 718522aa57..f0d69b9b7f 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="UndoRedo" inherits="Object" category="Core" version="3.0-alpha"> +<class name="UndoRedo" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Helper to manage UndoRedo in the editor or custom tools. </brief_description> @@ -144,11 +144,11 @@ </method> </methods> <constants> - <constant name="MERGE_DISABLE" value="0"> + <constant name="MERGE_DISABLE" value="0" enum="MergeMode"> </constant> - <constant name="MERGE_ENDS" value="1"> + <constant name="MERGE_ENDS" value="1" enum="MergeMode"> </constant> - <constant name="MERGE_ALL" value="2"> + <constant name="MERGE_ALL" value="2" enum="MergeMode"> </constant> </constants> </class> diff --git a/doc/classes/VBoxContainer.xml b/doc/classes/VBoxContainer.xml index b64b04437a..7c943d5e5d 100644 --- a/doc/classes/VBoxContainer.xml +++ b/doc/classes/VBoxContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VBoxContainer" inherits="BoxContainer" category="Core" version="3.0-alpha"> +<class name="VBoxContainer" inherits="BoxContainer" category="Core" version="3.0-beta"> <brief_description> Vertical box container. </brief_description> diff --git a/doc/classes/VScrollBar.xml b/doc/classes/VScrollBar.xml index 5e5ed6f211..23ded3a4b7 100644 --- a/doc/classes/VScrollBar.xml +++ b/doc/classes/VScrollBar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VScrollBar" inherits="ScrollBar" category="Core" version="3.0-alpha"> +<class name="VScrollBar" inherits="ScrollBar" category="Core" version="3.0-beta"> <brief_description> Vertical version of [ScrollBar], which goes from left (min) to right (max). </brief_description> diff --git a/doc/classes/VSeparator.xml b/doc/classes/VSeparator.xml index 88c043f9ca..931560855b 100644 --- a/doc/classes/VSeparator.xml +++ b/doc/classes/VSeparator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VSeparator" inherits="Separator" category="Core" version="3.0-alpha"> +<class name="VSeparator" inherits="Separator" category="Core" version="3.0-beta"> <brief_description> Vertical version of [Separator]. </brief_description> diff --git a/doc/classes/VSlider.xml b/doc/classes/VSlider.xml index bc0a3a25b6..ed8940ed4e 100644 --- a/doc/classes/VSlider.xml +++ b/doc/classes/VSlider.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VSlider" inherits="Slider" category="Core" version="3.0-alpha"> +<class name="VSlider" inherits="Slider" category="Core" version="3.0-beta"> <brief_description> Vertical slider. </brief_description> diff --git a/doc/classes/VSplitContainer.xml b/doc/classes/VSplitContainer.xml index e5a8981aaf..22f6bb449b 100644 --- a/doc/classes/VSplitContainer.xml +++ b/doc/classes/VSplitContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VSplitContainer" inherits="SplitContainer" category="Core" version="3.0-alpha"> +<class name="VSplitContainer" inherits="SplitContainer" category="Core" version="3.0-beta"> <brief_description> Vertical split container. </brief_description> diff --git a/doc/classes/Variant.xml b/doc/classes/Variant.xml index 14df6f050f..12cbd276a1 100644 --- a/doc/classes/Variant.xml +++ b/doc/classes/Variant.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Variant" category="Core" version="3.0-alpha"> +<class name="Variant" category="Core" version="3.0-beta"> <brief_description> The most important data type in Godot. </brief_description> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 3afad1d6fa..976cdbbd90 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Vector2" category="Built-In Types" version="3.0-alpha"> +<class name="Vector2" category="Built-In Types" version="3.0-beta"> <brief_description> Vector used for 2D Math. </brief_description> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index cec5970f06..acb41297a7 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Vector3" category="Built-In Types" version="3.0-alpha"> +<class name="Vector3" category="Built-In Types" version="3.0-beta"> <brief_description> Vector class, which performs basic 3D vector math operations. </brief_description> @@ -241,13 +241,13 @@ </member> </members> <constants> - <constant name="AXIS_X" value="0" enum=""> + <constant name="AXIS_X" value="0"> Enumerated value for the X axis. Returned by functions like max_axis or min_axis. </constant> - <constant name="AXIS_Y" value="1" enum=""> + <constant name="AXIS_Y" value="1"> Enumerated value for the Y axis. </constant> - <constant name="AXIS_Z" value="2" enum=""> + <constant name="AXIS_Z" value="2"> Enumerated value for the Z axis. </constant> </constants> diff --git a/doc/classes/VehicleBody.xml b/doc/classes/VehicleBody.xml index f9f3590385..77916a7e9f 100644 --- a/doc/classes/VehicleBody.xml +++ b/doc/classes/VehicleBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VehicleBody" inherits="PhysicsBody" category="Core" version="3.0-alpha"> +<class name="VehicleBody" inherits="PhysicsBody" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,24 +9,6 @@ <demos> </demos> <methods> - <method name="get_brake" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_engine_force" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_friction" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_linear_velocity" qualifiers="const"> <return type="Vector3"> </return> @@ -38,60 +20,6 @@ [/codeblock] </description> </method> - <method name="get_mass" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_steering" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the steering angle (in radians). - </description> - </method> - <method name="set_brake"> - <return type="void"> - </return> - <argument index="0" name="brake" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_engine_force"> - <return type="void"> - </return> - <argument index="0" name="engine_force" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_friction"> - <return type="void"> - </return> - <argument index="0" name="friction" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_mass"> - <return type="void"> - </return> - <argument index="0" name="mass" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_steering"> - <return type="void"> - </return> - <argument index="0" name="steering" type="float"> - </argument> - <description> - Set the steering angle (in radians). - </description> - </method> </methods> <members> <member name="brake" type="float" setter="set_brake" getter="get_brake"> diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml index f04c33cc5a..7c384886cb 100644 --- a/doc/classes/VehicleWheel.xml +++ b/doc/classes/VehicleWheel.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VehicleWheel" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="VehicleWheel" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,172 +9,18 @@ <demos> </demos> <methods> - <method name="get_damping_compression" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_damping_relaxation" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_friction_slip" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_radius" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_roll_influence" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_skidinfo" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="get_suspension_max_force" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_suspension_rest_length" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_suspension_stiffness" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_suspension_travel" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="is_in_contact" qualifiers="const"> <return type="bool"> </return> <description> </description> </method> - <method name="is_used_as_steering" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_used_as_traction" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_damping_compression"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_damping_relaxation"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_friction_slip"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_radius"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_roll_influence"> - <return type="void"> - </return> - <argument index="0" name="roll_influence" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_suspension_max_force"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_suspension_rest_length"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_suspension_stiffness"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_suspension_travel"> - <return type="void"> - </return> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_use_as_steering"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_use_as_traction"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="damping_compression" type="float" setter="set_damping_compression" getter="get_damping_compression"> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 340b162727..281dc1f071 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VideoPlayer" inherits="Control" category="Core" version="3.0-alpha"> +<class name="VideoPlayer" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Control to play video files. </brief_description> @@ -11,13 +11,6 @@ <demos> </demos> <methods> - <method name="get_audio_track" qualifiers="const"> - <return type="int"> - </return> - <description> - Get the selected audio track (for multitrack videos). - </description> - </method> <method name="get_buffering_msec" qualifiers="const"> <return type="int"> </return> @@ -25,19 +18,6 @@ Get the amount of milliseconds to store in buffer while playing. </description> </method> - <method name="get_bus" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_stream" qualifiers="const"> - <return type="VideoStream"> - </return> - <description> - Get the video stream. - </description> - </method> <method name="get_stream_name" qualifiers="const"> <return type="String"> </return> @@ -66,34 +46,6 @@ Get the volume of the audio track as a linear value. </description> </method> - <method name="get_volume_db" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the volume of the audio track in decibels. - </description> - </method> - <method name="has_autoplay" qualifiers="const"> - <return type="bool"> - </return> - <description> - Get whether or not the video is set as autoplay. - </description> - </method> - <method name="has_expand" qualifiers="const"> - <return type="bool"> - </return> - <description> - Get whether or not the expand property is set. - </description> - </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> - </return> - <description> - Get whether or not the video is paused. - </description> - </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> @@ -108,24 +60,6 @@ Start the video playback. </description> </method> - <method name="set_audio_track"> - <return type="void"> - </return> - <argument index="0" name="track" type="int"> - </argument> - <description> - Set the audio track (for multitrack videos). - </description> - </method> - <method name="set_autoplay"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set whether this node should start playing automatically. - </description> - </method> <method name="set_buffering_msec"> <return type="void"> </return> @@ -135,41 +69,6 @@ Set the amount of milliseconds to buffer during playback. </description> </method> - <method name="set_bus"> - <return type="void"> - </return> - <argument index="0" name="bus" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_expand"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set the expand property. If enabled, the video will grow or shrink to fit the player size, otherwise it will play at the stream resolution. - </description> - </method> - <method name="set_paused"> - <return type="void"> - </return> - <argument index="0" name="paused" type="bool"> - </argument> - <description> - Set whether the video should pause the playback. - </description> - </method> - <method name="set_stream"> - <return type="void"> - </return> - <argument index="0" name="stream" type="VideoStream"> - </argument> - <description> - Set the video stream for this player. - </description> - </method> <method name="set_stream_position"> <return type="void"> </return> @@ -188,15 +87,6 @@ Set the audio volume as a linear value. </description> </method> - <method name="set_volume_db"> - <return type="void"> - </return> - <argument index="0" name="db" type="float"> - </argument> - <description> - Set the audio volume in decibels. - </description> - </method> <method name="stop"> <return type="void"> </return> diff --git a/doc/classes/VideoStream.xml b/doc/classes/VideoStream.xml index 00607b0f0a..9f0d9afa43 100644 --- a/doc/classes/VideoStream.xml +++ b/doc/classes/VideoStream.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VideoStream" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="VideoStream" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 9bd229ef26..ad3903d549 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Viewport" inherits="Node" category="Core" version="3.0-alpha"> +<class name="Viewport" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Creates a sub-view into the screen. </brief_description> @@ -44,18 +44,6 @@ Get the canvas transform of the viewport. </description> </method> - <method name="get_clear_mode" qualifiers="const"> - <return type="int" enum="Viewport.ClearMode"> - </return> - <description> - </description> - </method> - <method name="get_debug_draw" qualifiers="const"> - <return type="int" enum="Viewport.DebugDraw"> - </return> - <description> - </description> - </method> <method name="get_final_transform" qualifiers="const"> <return type="Transform2D"> </return> @@ -70,13 +58,6 @@ Get the global canvas transform of the viewport. </description> </method> - <method name="get_hdr" qualifiers="const"> - <return type="bool"> - </return> - <description> - Get whether the rendered texture has filters enabled. - </description> - </method> <method name="get_mouse_position" qualifiers="const"> <return type="Vector2"> </return> @@ -84,19 +65,6 @@ Get the mouse position, relative to the viewport. </description> </method> - <method name="get_msaa" qualifiers="const"> - <return type="int" enum="Viewport.MSAA"> - </return> - <description> - </description> - </method> - <method name="get_physics_object_picking"> - <return type="bool"> - </return> - <description> - Get whether picking for all physics objects inside the viewport is enabled. - </description> - </method> <method name="get_render_info"> <return type="int"> </return> @@ -105,27 +73,6 @@ <description> </description> </method> - <method name="get_shadow_atlas_quadrant_subdiv" qualifiers="const"> - <return type="int" enum="Viewport.ShadowAtlasQuadrantSubdiv"> - </return> - <argument index="0" name="quadrant" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_shadow_atlas_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. - </description> - </method> <method name="get_size_override" qualifiers="const"> <return type="Vector2"> </return> @@ -140,26 +87,6 @@ Get the viewport's texture, for use with various objects that you want to texture with the viewport. </description> </method> - <method name="get_update_mode" qualifiers="const"> - <return type="int" enum="Viewport.UpdateMode"> - </return> - <description> - Get when the viewport would be updated, will be one of the [code]UPDATE_*[/code] constants. - </description> - </method> - <method name="get_usage" qualifiers="const"> - <return type="int" enum="Viewport.Usage"> - </return> - <description> - </description> - </method> - <method name="get_vflip" qualifiers="const"> - <return type="bool"> - </return> - <description> - Set whether the render target is flipped on the Y axis. - </description> - </method> <method name="get_viewport_rid" qualifiers="const"> <return type="RID"> </return> @@ -174,13 +101,6 @@ Return the final, visible rect in global screen coordinates. </description> </method> - <method name="get_world" qualifiers="const"> - <return type="World"> - </return> - <description> - Return the 3D world of the viewport. - </description> - </method> <method name="get_world_2d" qualifiers="const"> <return type="World2D"> </return> @@ -202,13 +122,6 @@ Returns whether there are shown modals on-screen. </description> </method> - <method name="has_transparent_background" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the viewport lets whatever is behind it to show. - </description> - </method> <method name="input"> <return type="void"> </return> @@ -217,33 +130,6 @@ <description> </description> </method> - <method name="is_3d_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_audio_listener" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether the viewport sends sounds to the speakers. - </description> - </method> - <method name="is_audio_listener_2d" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether the viewport sends soundsfrom 2D emitters to the speakers. - </description> - </method> - <method name="is_input_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether input to the viewport is disabled. - </description> - </method> <method name="is_size_override_enabled" qualifiers="const"> <return type="bool"> </return> @@ -258,37 +144,6 @@ Get the enabled status of the size strech override set with [method set_size_override_stretch]. </description> </method> - <method name="is_snap_controls_to_pixels_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_using_own_world" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the viewport is using a world separate from the parent viewport's world. - </description> - </method> - <method name="set_as_audio_listener"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Makes the viewport send sounds to the speakers. - </description> - </method> - <method name="set_as_audio_listener_2d"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Makes the viewport send sounds from 2D emitters to the speakers. - </description> - </method> <method name="set_attach_to_screen_rect"> <return type="void"> </return> @@ -306,39 +161,6 @@ Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. </description> </method> - <method name="set_clear_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Viewport.ClearMode"> - </argument> - <description> - </description> - </method> - <method name="set_debug_draw"> - <return type="void"> - </return> - <argument index="0" name="debug_draw" type="int" enum="Viewport.DebugDraw"> - </argument> - <description> - </description> - </method> - <method name="set_disable_3d"> - <return type="void"> - </return> - <argument index="0" name="disable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_disable_input"> - <return type="void"> - </return> - <argument index="0" name="disable" type="bool"> - </argument> - <description> - Set whether input to the viewport is disabled. - </description> - </method> <method name="set_global_canvas_transform"> <return type="void"> </return> @@ -348,58 +170,6 @@ Set the global canvas transform of the viewport. The canvas transform is relative to this. </description> </method> - <method name="set_hdr"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_msaa"> - <return type="void"> - </return> - <argument index="0" name="msaa" type="int" enum="Viewport.MSAA"> - </argument> - <description> - </description> - </method> - <method name="set_physics_object_picking"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Enable/disable picking for all physics objects inside the viewport. - </description> - </method> - <method name="set_shadow_atlas_quadrant_subdiv"> - <return type="void"> - </return> - <argument index="0" name="quadrant" type="int"> - </argument> - <argument index="1" name="subdiv" type="int" enum="Viewport.ShadowAtlasQuadrantSubdiv"> - </argument> - <description> - </description> - </method> - <method name="set_shadow_atlas_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - Set the size of the viewport. - </description> - </method> <method name="set_size_override"> <return type="void"> </return> @@ -422,79 +192,6 @@ Set whether the size override affects stretch as well. </description> </method> - <method name="set_snap_controls_to_pixels"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_transparent_background"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - If this viewport is a child of another viewport, keep the previously drawn background visible. - </description> - </method> - <method name="set_update_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Viewport.UpdateMode"> - </argument> - <description> - Set when the render target would be updated, using the [code]UPDATE_*[/code] constants - </description> - </method> - <method name="set_usage"> - <return type="void"> - </return> - <argument index="0" name="usage" type="int" enum="Viewport.Usage"> - </argument> - <description> - </description> - </method> - <method name="set_use_arvr"> - <return type="void"> - </return> - <argument index="0" name="use" type="bool"> - </argument> - <description> - If true this viewport will be bound to our ARVR Server. - If this is our main Godot viewport our AR/VR output will be displayed on screen. - If output is redirected to an HMD we'll see the output of just one of the eyes without any distortion applied else we'll see the stereo buffer with distortion applied if applicable - If this is an extra viewport output will only work if redirection to an HMD is supported by the interface. The render target will allow you to use the undistorted output for the right eye in the display. - </description> - </method> - <method name="set_use_own_world"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Make the viewport use a world separate from the parent viewport's world. - </description> - </method> - <method name="set_vflip"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set whether the viewport is flipped on the Y axis. - </description> - </method> - <method name="set_world"> - <return type="void"> - </return> - <argument index="0" name="world" type="World"> - </argument> - <description> - Change the 3D world of the viewport. - </description> - </method> <method name="set_world_2d"> <return type="void"> </return> @@ -518,13 +215,6 @@ Force update of the 2D and 3D worlds. </description> </method> - <method name="use_arvr"> - <return type="bool"> - </return> - <description> - Returns whether this viewport is using our ARVR Server - </description> - </method> <method name="warp_mouse"> <return type="void"> </return> @@ -591,78 +281,78 @@ </signal> </signals> <constants> - <constant name="UPDATE_DISABLED" value="0"> + <constant name="UPDATE_DISABLED" value="0" enum="UpdateMode"> Do not update the render target. </constant> - <constant name="UPDATE_ONCE" value="1"> + <constant name="UPDATE_ONCE" value="1" enum="UpdateMode"> Update the render target once, then switch to [code]UPDATE_DISABLED[/code] </constant> - <constant name="UPDATE_WHEN_VISIBLE" value="2"> + <constant name="UPDATE_WHEN_VISIBLE" value="2" enum="UpdateMode"> Update the render target only when it is visible. This is the default value. </constant> - <constant name="UPDATE_ALWAYS" value="3"> + <constant name="UPDATE_ALWAYS" value="3" enum="UpdateMode"> </constant> - <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED" value="0"> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED" value="0" enum="ShadowAtlasQuadrantSubdiv"> </constant> - <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1" value="1"> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1" value="1" enum="ShadowAtlasQuadrantSubdiv"> </constant> - <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_4" value="2"> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_4" value="2" enum="ShadowAtlasQuadrantSubdiv"> </constant> - <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_16" value="3"> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_16" value="3" enum="ShadowAtlasQuadrantSubdiv"> </constant> - <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_64" value="4"> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_64" value="4" enum="ShadowAtlasQuadrantSubdiv"> </constant> - <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_256" value="5"> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_256" value="5" enum="ShadowAtlasQuadrantSubdiv"> </constant> - <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1024" value="6"> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1024" value="6" enum="ShadowAtlasQuadrantSubdiv"> </constant> - <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_MAX" value="7"> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_MAX" value="7" enum="ShadowAtlasQuadrantSubdiv"> </constant> - <constant name="RENDER_INFO_OBJECTS_IN_FRAME" value="0"> + <constant name="RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="RenderInfo"> </constant> - <constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1"> + <constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo"> </constant> - <constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + <constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo"> </constant> - <constant name="RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3"> + <constant name="RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="RenderInfo"> </constant> - <constant name="RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + <constant name="RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="RenderInfo"> </constant> - <constant name="RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5"> + <constant name="RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5" enum="RenderInfo"> </constant> - <constant name="RENDER_INFO_MAX" value="6"> + <constant name="RENDER_INFO_MAX" value="6" enum="RenderInfo"> </constant> - <constant name="DEBUG_DRAW_DISABLED" value="0"> + <constant name="DEBUG_DRAW_DISABLED" value="0" enum="DebugDraw"> </constant> - <constant name="DEBUG_DRAW_UNSHADED" value="1"> + <constant name="DEBUG_DRAW_UNSHADED" value="1" enum="DebugDraw"> </constant> - <constant name="DEBUG_DRAW_OVERDRAW" value="2"> + <constant name="DEBUG_DRAW_OVERDRAW" value="2" enum="DebugDraw"> </constant> - <constant name="DEBUG_DRAW_WIREFRAME" value="3"> + <constant name="DEBUG_DRAW_WIREFRAME" value="3" enum="DebugDraw"> </constant> - <constant name="MSAA_DISABLED" value="0"> + <constant name="MSAA_DISABLED" value="0" enum="MSAA"> </constant> - <constant name="MSAA_2X" value="1"> + <constant name="MSAA_2X" value="1" enum="MSAA"> </constant> - <constant name="MSAA_4X" value="2"> + <constant name="MSAA_4X" value="2" enum="MSAA"> </constant> - <constant name="MSAA_8X" value="3"> + <constant name="MSAA_8X" value="3" enum="MSAA"> </constant> - <constant name="MSAA_16X" value="4"> + <constant name="MSAA_16X" value="4" enum="MSAA"> </constant> - <constant name="USAGE_2D" value="0"> + <constant name="USAGE_2D" value="0" enum="Usage"> </constant> - <constant name="USAGE_2D_NO_SAMPLING" value="1"> + <constant name="USAGE_2D_NO_SAMPLING" value="1" enum="Usage"> </constant> - <constant name="USAGE_3D" value="2"> + <constant name="USAGE_3D" value="2" enum="Usage"> </constant> - <constant name="USAGE_3D_NO_EFFECTS" value="3"> + <constant name="USAGE_3D_NO_EFFECTS" value="3" enum="Usage"> </constant> - <constant name="CLEAR_MODE_ALWAYS" value="0"> + <constant name="CLEAR_MODE_ALWAYS" value="0" enum="ClearMode"> </constant> - <constant name="CLEAR_MODE_NEVER" value="1"> + <constant name="CLEAR_MODE_NEVER" value="1" enum="ClearMode"> </constant> - <constant name="CLEAR_MODE_ONLY_NEXT_FRAME" value="2"> + <constant name="CLEAR_MODE_ONLY_NEXT_FRAME" value="2" enum="ClearMode"> </constant> </constants> </class> diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml index 5a4c3af1f6..19d4e462c9 100644 --- a/doc/classes/ViewportContainer.xml +++ b/doc/classes/ViewportContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ViewportContainer" inherits="Container" category="Core" version="3.0-alpha"> +<class name="ViewportContainer" inherits="Container" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,34 +9,6 @@ <demos> </demos> <methods> - <method name="get_stretch_shrink" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="is_stretch_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_stretch"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_stretch_shrink"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="stretch" type="bool" setter="set_stretch" getter="is_stretch_enabled"> diff --git a/doc/classes/ViewportTexture.xml b/doc/classes/ViewportTexture.xml index 1eace840a8..e6a2b212bf 100644 --- a/doc/classes/ViewportTexture.xml +++ b/doc/classes/ViewportTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ViewportTexture" inherits="Texture" category="Core" version="3.0-alpha"> +<class name="ViewportTexture" inherits="Texture" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -9,20 +9,6 @@ <demos> </demos> <methods> - <method name="get_viewport_path_in_scene" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="set_viewport_path_in_scene"> - <return type="void"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="viewport_path" type="NodePath" setter="set_viewport_path_in_scene" getter="get_viewport_path_in_scene"> diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 95bcbd6816..67137e1408 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.0-alpha"> +<class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.0-beta"> <brief_description> Enable certain nodes only when visible. </brief_description> @@ -11,26 +11,6 @@ <demos> </demos> <methods> - <method name="is_enabler_enabled" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="enabler" type="int" enum="VisibilityEnabler.Enabler"> - </argument> - <description> - Returns whether the specified enabler was set to true or not. - </description> - </method> - <method name="set_enabler"> - <return type="void"> - </return> - <argument index="0" name="enabler" type="int" enum="VisibilityEnabler.Enabler"> - </argument> - <argument index="1" name="enabled" type="bool"> - </argument> - <description> - Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler is not in view. See the constants for enablers and what they affect. - </description> - </method> </methods> <members> <member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled"> @@ -39,13 +19,13 @@ </member> </members> <constants> - <constant name="ENABLER_PAUSE_ANIMATIONS" value="0"> + <constant name="ENABLER_PAUSE_ANIMATIONS" value="0" enum="Enabler"> This enabler will pause [AnimationPlayer] nodes. </constant> - <constant name="ENABLER_FREEZE_BODIES" value="1"> + <constant name="ENABLER_FREEZE_BODIES" value="1" enum="Enabler"> This enabler will freeze [RigidBody] nodes. </constant> - <constant name="ENABLER_MAX" value="2"> + <constant name="ENABLER_MAX" value="2" enum="Enabler"> </constant> </constants> </class> diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index f23d54a544..45e15eb4b3 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.0-alpha"> +<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.0-beta"> <brief_description> Enable certain nodes only when visible. </brief_description> @@ -11,26 +11,6 @@ <demos> </demos> <methods> - <method name="is_enabler_enabled" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler"> - </argument> - <description> - Returns whether the specified enabler was set to true or not. - </description> - </method> - <method name="set_enabler"> - <return type="void"> - </return> - <argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler"> - </argument> - <argument index="1" name="enabled" type="bool"> - </argument> - <description> - Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect. - </description> - </method> </methods> <members> <member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled"> @@ -47,24 +27,24 @@ </member> </members> <constants> - <constant name="ENABLER_PAUSE_ANIMATIONS" value="0"> + <constant name="ENABLER_PAUSE_ANIMATIONS" value="0" enum="Enabler"> This enabler will pause [AnimationPlayer] nodes. </constant> - <constant name="ENABLER_FREEZE_BODIES" value="1"> + <constant name="ENABLER_FREEZE_BODIES" value="1" enum="Enabler"> This enabler will freeze [RigidBody2D] nodes. </constant> - <constant name="ENABLER_PAUSE_PARTICLES" value="2"> + <constant name="ENABLER_PAUSE_PARTICLES" value="2" enum="Enabler"> This enabler will stop [Particles2D] nodes. </constant> - <constant name="ENABLER_PARENT_PROCESS" value="3"> + <constant name="ENABLER_PARENT_PROCESS" value="3" enum="Enabler"> This enabler will stop the parent's _process function. </constant> - <constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4"> + <constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4" enum="Enabler"> This enabler will stop the parent's _physics_process function. </constant> - <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5"> + <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5" enum="Enabler"> </constant> - <constant name="ENABLER_MAX" value="6"> + <constant name="ENABLER_MAX" value="6" enum="Enabler"> </constant> </constants> </class> diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index 1dfa60a5ac..9e1c326633 100644 --- a/doc/classes/VisibilityNotifier.xml +++ b/doc/classes/VisibilityNotifier.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Detects when the node is visible on screen. </brief_description> @@ -11,13 +11,6 @@ <demos> </demos> <methods> - <method name="get_aabb" qualifiers="const"> - <return type="Rect3"> - </return> - <description> - Returns the bounding box of the VisibilityNotifier. - </description> - </method> <method name="is_on_screen" qualifiers="const"> <return type="bool"> </return> @@ -25,18 +18,9 @@ If [code]true[/code] the bounding box is on the screen. </description> </method> - <method name="set_aabb"> - <return type="void"> - </return> - <argument index="0" name="rect" type="Rect3"> - </argument> - <description> - Set the visibility bounding box of the VisibilityNotifier. - </description> - </method> </methods> <members> - <member name="aabb" type="Rect3" setter="set_aabb" getter="get_aabb"> + <member name="aabb" type="AABB" setter="set_aabb" getter="get_aabb"> The VisibilityNotifier's bounding box. </member> </members> diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml index b8db14e583..327812db23 100644 --- a/doc/classes/VisibilityNotifier2D.xml +++ b/doc/classes/VisibilityNotifier2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Detects when the node is visible on screen. </brief_description> @@ -11,13 +11,6 @@ <demos> </demos> <methods> - <method name="get_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - Returns the bounding rectangle of the VisibilityNotifier2D. - </description> - </method> <method name="is_on_screen" qualifiers="const"> <return type="bool"> </return> @@ -25,15 +18,6 @@ If [code]true[/code] the bounding rectangle is on the screen. </description> </method> - <method name="set_rect"> - <return type="void"> - </return> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - Set the visibility bounding rectangle of the VisibilityNotifier2D. - </description> - </method> </methods> <members> <member name="rect" type="Rect2" setter="set_rect" getter="get_rect"> diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index be2d38bf9f..bd66880719 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualInstance" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="VisualInstance" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -10,21 +10,18 @@ </demos> <methods> <method name="get_aabb" qualifiers="const"> - <return type="Rect3"> - </return> - <description> - </description> - </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> + <return type="AABB"> </return> <description> + Returns the [AABB] (also known as the bounding box) for this VisualInstance. </description> </method> <method name="get_transformed_aabb" qualifiers="const"> - <return type="Rect3"> + <return type="AABB"> </return> <description> + Returns the transformed [AABB] (also known as the bounding box) for this VisualInstance. + Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]s [Transform] </description> </method> <method name="set_base"> @@ -33,19 +30,15 @@ <argument index="0" name="base" type="RID"> </argument> <description> - </description> - </method> - <method name="set_layer_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </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. </description> </method> </methods> <members> <member name="layers" type="int" setter="set_layer_mask" getter="get_layer_mask"> + The render layer(s) this VisualInstance is drawn on. + This object will only be visible for [Camera]s whose cull mask includes the render object this VisualInstance is set to. </member> </members> <constants> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 1030e4ecc0..1a9dc3a669 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualServer" inherits="Object" category="Core" version="3.0-alpha"> +<class name="VisualServer" inherits="Object" category="Core" version="3.0-beta"> <brief_description> Server for anything visible. </brief_description> @@ -24,6 +24,7 @@ <argument index="3" name="bottom" type="RID"> </argument> <description> + Sets images to be rendered in the window margin. </description> </method> <method name="black_bars_set_margins"> @@ -38,12 +39,14 @@ <argument index="3" name="bottom" type="int"> </argument> <description> + Sets margin size, where black bars (or images, if [method black_bars_set_images] was used) are rendered. </description> </method> <method name="canvas_create"> <return type="RID"> </return> <description> + Creates a canvas and returns the assigned [RID]. </description> </method> <method name="canvas_item_add_circle"> @@ -58,6 +61,7 @@ <argument index="3" name="color" type="Color"> </argument> <description> + Adds a circle command to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_clip_ignore"> @@ -68,6 +72,7 @@ <argument index="1" name="ignore" type="bool"> </argument> <description> + If ignore is [code]true[/code], the VisualServer does not perform clipping. </description> </method> <method name="canvas_item_add_line"> @@ -86,6 +91,7 @@ <argument index="5" name="antialiased" type="bool" default="false"> </argument> <description> + Adds a line command to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_mesh"> @@ -98,6 +104,7 @@ <argument index="2" name="skeleton" type="RID"> </argument> <description> + Adds a [Mesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment. </description> </method> <method name="canvas_item_add_multimesh"> @@ -110,6 +117,7 @@ <argument index="2" name="skeleton" type="RID"> </argument> <description> + Adds a [MultiMesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment. </description> </method> <method name="canvas_item_add_nine_patch"> @@ -138,6 +146,8 @@ <argument index="10" name="normal_map" type="RID"> </argument> <description> + Adds a nine patch image to the [CanvasItem]'s draw commands. + See [NinePatchRect] for more explanation. </description> </method> <method name="canvas_item_add_particles"> @@ -156,6 +166,7 @@ <argument index="5" name="v_frames" type="int"> </argument> <description> + Adds a particles system to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_polygon"> @@ -176,6 +187,7 @@ <argument index="6" name="antialiased" type="bool" default="false"> </argument> <description> + Adds a polygon to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_polyline"> @@ -192,6 +204,7 @@ <argument index="4" name="antialiased" type="bool" default="false"> </argument> <description> + Adds a polyline, which is a line from mutliple points with a width, to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_primitive"> @@ -212,6 +225,7 @@ <argument index="6" name="normal_map" type="RID"> </argument> <description> + Adds a primitive to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_rect"> @@ -224,6 +238,7 @@ <argument index="2" name="color" type="Color"> </argument> <description> + Adds a rectangle to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_set_transform"> @@ -234,6 +249,8 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Adds a [Transform2D] command to the [CanvasItem]'s draw commands. + This sets the extra_matrix uniform when executed. This affects the later command's of the canvas item. </description> </method> <method name="canvas_item_add_texture_rect"> @@ -254,6 +271,7 @@ <argument index="6" name="normal_map" type="RID"> </argument> <description> + Adds a textured rect to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_texture_rect_region"> @@ -276,6 +294,7 @@ <argument index="7" name="clip_uv" type="bool" default="true"> </argument> <description> + Adds a texture rect with region setting to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_triangle_array"> @@ -298,6 +317,7 @@ <argument index="7" name="normal_map" type="RID"> </argument> <description> + Adds a triangle array to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_clear"> @@ -306,12 +326,14 @@ <argument index="0" name="item" type="RID"> </argument> <description> + Clears the [CanvasItem] and removes all commands in it. </description> </method> <method name="canvas_item_create"> <return type="RID"> </return> <description> + Creates a new [CanvasItem] and returns its [RID]. </description> </method> <method name="canvas_item_set_clip"> @@ -322,6 +344,7 @@ <argument index="1" name="clip" type="bool"> </argument> <description> + Sets clipping for the [CanvasItem]. </description> </method> <method name="canvas_item_set_copy_to_backbuffer"> @@ -334,6 +357,7 @@ <argument index="2" name="rect" type="Rect2"> </argument> <description> + Sets the [CanvasItem] to copy a rect to the backbuffer. </description> </method> <method name="canvas_item_set_custom_rect"> @@ -346,6 +370,7 @@ <argument index="2" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )"> </argument> <description> + Defines a custom drawing rectangle for the [CanvasItem]. </description> </method> <method name="canvas_item_set_distance_field_mode"> @@ -366,6 +391,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Sets [CanvasItem] to be drawn behind its parent. </description> </method> <method name="canvas_item_set_draw_index"> @@ -376,6 +402,7 @@ <argument index="1" name="index" type="int"> </argument> <description> + Sets the index for the [CanvasItem]. </description> </method> <method name="canvas_item_set_light_mask"> @@ -386,6 +413,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + The light mask. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_item_set_material"> @@ -396,6 +424,7 @@ <argument index="1" name="material" type="RID"> </argument> <description> + Sets a new material to the [CanvasItem]. </description> </method> <method name="canvas_item_set_modulate"> @@ -406,6 +435,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the color that modulates the [CanvasItem] and its children. </description> </method> <method name="canvas_item_set_parent"> @@ -416,6 +446,7 @@ <argument index="1" name="parent" type="RID"> </argument> <description> + Sets the parent for the [CanvasItem]. </description> </method> <method name="canvas_item_set_self_modulate"> @@ -426,6 +457,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the color that modulates the [CanvasItem] without children. </description> </method> <method name="canvas_item_set_sort_children_by_y"> @@ -436,6 +468,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Sets if [CanvasItem]'s children should be sorted by y-position. </description> </method> <method name="canvas_item_set_transform"> @@ -446,6 +479,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Sets the [CanvasItem]'s [Transform2D]. </description> </method> <method name="canvas_item_set_use_parent_material"> @@ -456,6 +490,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Sets if the [CanvasItem] uses its parent's material. </description> </method> <method name="canvas_item_set_visible"> @@ -466,6 +501,7 @@ <argument index="1" name="visible" type="bool"> </argument> <description> + Sets if the canvas item (including its children) is visible. </description> </method> <method name="canvas_item_set_z"> @@ -476,6 +512,7 @@ <argument index="1" name="z" type="int"> </argument> <description> + Sets the [CanvasItem]'s z order position. </description> </method> <method name="canvas_item_set_z_as_relative_to_parent"> @@ -486,6 +523,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + If this is enabled, the z-position of the parent will be added to the childrens z-position. </description> </method> <method name="canvas_light_attach_to_canvas"> @@ -496,12 +534,14 @@ <argument index="1" name="canvas" type="RID"> </argument> <description> + Attaches the canvas light to the canvas. Removes it from its previous canvas. </description> </method> <method name="canvas_light_create"> <return type="RID"> </return> <description> + Creates a canvas light. </description> </method> <method name="canvas_light_occluder_attach_to_canvas"> @@ -512,12 +552,14 @@ <argument index="1" name="canvas" type="RID"> </argument> <description> + Attaches a light occluder to the canvas. Removes it from its previous canvas. </description> </method> <method name="canvas_light_occluder_create"> <return type="RID"> </return> <description> + Creates a light occluder. </description> </method> <method name="canvas_light_occluder_set_enabled"> @@ -528,6 +570,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Enables or disables light occluder. </description> </method> <method name="canvas_light_occluder_set_light_mask"> @@ -538,6 +581,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + The light mask. See [LightOccluder2D] for more information on light masks </description> </method> <method name="canvas_light_occluder_set_polygon"> @@ -548,6 +592,7 @@ <argument index="1" name="polygon" type="RID"> </argument> <description> + Sets a light occluder's polygon. </description> </method> <method name="canvas_light_occluder_set_transform"> @@ -558,6 +603,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Sets a light occluder's [Transform2D]. </description> </method> <method name="canvas_light_set_color"> @@ -568,6 +614,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the color for a light. </description> </method> <method name="canvas_light_set_enabled"> @@ -578,6 +625,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Enables or disables a canvas light. </description> </method> <method name="canvas_light_set_energy"> @@ -588,6 +636,7 @@ <argument index="1" name="energy" type="float"> </argument> <description> + Sets a canvas light's energy. </description> </method> <method name="canvas_light_set_height"> @@ -598,6 +647,7 @@ <argument index="1" name="height" type="float"> </argument> <description> + Sets a canvas light's height. </description> </method> <method name="canvas_light_set_item_cull_mask"> @@ -608,6 +658,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + The light mask. See [LightOccluder2D] for more information on light masks </description> </method> <method name="canvas_light_set_item_shadow_cull_mask"> @@ -618,6 +669,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + The shadow mask. binary about wich layers this canvas light affects wich canvas item's shadows. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_set_layer_range"> @@ -630,6 +682,7 @@ <argument index="2" name="max_layer" type="int"> </argument> <description> + The layer range that gets rendered with this light. </description> </method> <method name="canvas_light_set_mode"> @@ -640,6 +693,7 @@ <argument index="1" name="mode" type="int" enum="VisualServer.CanvasLightMode"> </argument> <description> + The mode of the light, see CANVAS_LIGHT_MODE_* constants. </description> </method> <method name="canvas_light_set_scale"> @@ -660,6 +714,7 @@ <argument index="1" name="size" type="int"> </argument> <description> + Sets the width of the shadow buffer, size gets scaled to the next power of two for this. </description> </method> <method name="canvas_light_set_shadow_color"> @@ -670,6 +725,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the color of the canvas light's shadow. </description> </method> <method name="canvas_light_set_shadow_enabled"> @@ -680,6 +736,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Enables or disables the canvas light's shadow. </description> </method> <method name="canvas_light_set_shadow_filter"> @@ -690,6 +747,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. </description> </method> <method name="canvas_light_set_shadow_gradient_length"> @@ -700,6 +758,7 @@ <argument index="1" name="length" type="float"> </argument> <description> + Sets the length of the shadow's gradient. </description> </method> <method name="canvas_light_set_shadow_smooth"> @@ -710,6 +769,7 @@ <argument index="1" name="smooth" type="float"> </argument> <description> + Smoothens the shadow. The lower, the more smooth. </description> </method> <method name="canvas_light_set_texture"> @@ -740,6 +800,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Sets the canvas light's [Transform2D]. </description> </method> <method name="canvas_light_set_z_range"> @@ -758,6 +819,7 @@ <return type="RID"> </return> <description> + Creates a new light occluder polygon. </description> </method> <method name="canvas_occluder_polygon_set_cull_mode"> @@ -768,6 +830,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. </description> </method> <method name="canvas_occluder_polygon_set_shape"> @@ -780,6 +843,7 @@ <argument index="2" name="closed" type="bool"> </argument> <description> + Sets the shape of the occluder polygon. </description> </method> <method name="canvas_occluder_polygon_set_shape_as_lines"> @@ -790,6 +854,7 @@ <argument index="1" name="shape" type="PoolVector2Array"> </argument> <description> + Sets the shape of the occluder polygon as lines. </description> </method> <method name="canvas_set_item_mirroring"> @@ -802,6 +867,7 @@ <argument index="2" name="mirroring" type="Vector2"> </argument> <description> + A copy of the canvas item will be drawn with a local offset of the mirroring [Vector2]. </description> </method> <method name="canvas_set_modulate"> @@ -812,30 +878,39 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Modulates all colors in the given canvas. </description> </method> <method name="draw"> <return type="void"> </return> + <argument index="0" name="swap_buffers" type="bool" default="true"> + </argument> <description> + Draws a frame. </description> </method> <method name="finish"> <return type="void"> </return> <description> + Removes buffers and clears testcubes. </description> </method> <method name="force_draw"> <return type="void"> </return> + <argument index="0" name="swap_buffers" type="bool" default="true"> + </argument> <description> + Draws a frame. Same as [method draw]. </description> </method> <method name="force_sync"> <return type="void"> </return> <description> + Syncronizes threads. </description> </method> <method name="free"> @@ -844,6 +919,7 @@ <argument index="0" name="rid" type="RID"> </argument> <description> + Tries to free an object in the VisualServer. </description> </method> <method name="get_render_info"> @@ -852,30 +928,35 @@ <argument index="0" name="info" type="int" enum="VisualServer.RenderInfo"> </argument> <description> + Returns a certain information, see RENDER_INFO_* for options. </description> </method> <method name="get_test_cube"> <return type="RID"> </return> <description> + Returns the id of the test cube. Creates one if none exists. </description> </method> <method name="get_test_texture"> <return type="RID"> </return> <description> + Returns the id of the test texture. Creates one if none exists. </description> </method> <method name="get_white_texture"> <return type="RID"> </return> <description> + Returns the id of a white texture. Creates one if none exists. </description> </method> <method name="has_changed" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if changes have been made to the VisualServer's data. [method draw] is usually called if this happens. </description> </method> <method name="has_feature" qualifiers="const"> @@ -892,12 +973,14 @@ <argument index="0" name="feature" type="String"> </argument> <description> + Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, </description> </method> <method name="init"> <return type="void"> </return> <description> + Initializes the visual server. </description> </method> <method name="make_sphere_mesh"> @@ -910,12 +993,14 @@ <argument index="2" name="radius" type="float"> </argument> <description> + Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions. </description> </method> <method name="material_create"> <return type="RID"> </return> <description> + Returns an empty material. </description> </method> <method name="material_get_param" qualifiers="const"> @@ -926,6 +1011,7 @@ <argument index="1" name="parameter" type="String"> </argument> <description> + Returns the value of a certain material's parameter. </description> </method> <method name="material_get_shader" qualifiers="const"> @@ -934,6 +1020,7 @@ <argument index="0" name="shader_material" type="RID"> </argument> <description> + Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader. </description> </method> <method name="material_set_line_width"> @@ -944,6 +1031,7 @@ <argument index="1" name="width" type="float"> </argument> <description> + Sets a materials line width. </description> </method> <method name="material_set_next_pass"> @@ -954,6 +1042,7 @@ <argument index="1" name="next_material" type="RID"> </argument> <description> + Sets an objects next material. </description> </method> <method name="material_set_param"> @@ -966,6 +1055,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> + Sets a materials parameter. </description> </method> <method name="material_set_render_priority"> @@ -976,6 +1066,7 @@ <argument index="1" name="priority" type="int"> </argument> <description> + Sets a material's render priority. </description> </method> <method name="material_set_shader"> @@ -986,6 +1077,7 @@ <argument index="1" name="shader" type="RID"> </argument> <description> + Sets a shader material's shader. </description> </method> <method name="mesh_add_surface_from_arrays"> @@ -1002,6 +1094,7 @@ <argument index="4" name="compress_format" type="int" default="97792"> </argument> <description> + Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE_* constants for types. </description> </method> <method name="mesh_clear"> @@ -1010,12 +1103,14 @@ <argument index="0" name="mesh" type="RID"> </argument> <description> + Removes all surfaces from a mesh. </description> </method> <method name="mesh_create"> <return type="RID"> </return> <description> + Creates a new mesh. </description> </method> <method name="mesh_get_blend_shape_count" qualifiers="const"> @@ -1024,6 +1119,7 @@ <argument index="0" name="mesh" type="RID"> </argument> <description> + Returns a mesh's blend shape count. </description> </method> <method name="mesh_get_blend_shape_mode" qualifiers="const"> @@ -1032,14 +1128,16 @@ <argument index="0" name="mesh" type="RID"> </argument> <description> + Returns a mesh's blend shape mode. </description> </method> <method name="mesh_get_custom_aabb" qualifiers="const"> - <return type="Rect3"> + <return type="AABB"> </return> <argument index="0" name="mesh" type="RID"> </argument> <description> + Returns a mesh's custom aabb. </description> </method> <method name="mesh_get_surface_count" qualifiers="const"> @@ -1048,6 +1146,7 @@ <argument index="0" name="mesh" type="RID"> </argument> <description> + Returns a mesh's number of surfaces. </description> </method> <method name="mesh_remove_surface"> @@ -1058,6 +1157,7 @@ <argument index="1" name="index" type="int"> </argument> <description> + Removes a mesh's surface. </description> </method> <method name="mesh_set_blend_shape_count"> @@ -1068,6 +1168,7 @@ <argument index="1" name="amount" type="int"> </argument> <description> + Sets a mesh's blend shape count. </description> </method> <method name="mesh_set_blend_shape_mode"> @@ -1078,6 +1179,7 @@ <argument index="1" name="mode" type="int" enum="VisualServer.BlendShapeMode"> </argument> <description> + Sets a mesh's blend shape mode. </description> </method> <method name="mesh_set_custom_aabb"> @@ -1085,19 +1187,21 @@ </return> <argument index="0" name="mesh" type="RID"> </argument> - <argument index="1" name="aabb" type="Rect3"> + <argument index="1" name="aabb" type="AABB"> </argument> <description> + Sets a mesh's custom aabb. </description> </method> <method name="mesh_surface_get_aabb" qualifiers="const"> - <return type="Rect3"> + <return type="AABB"> </return> <argument index="0" name="mesh" type="RID"> </argument> <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's aabb. </description> </method> <method name="mesh_surface_get_array" qualifiers="const"> @@ -1108,6 +1212,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's vertex buffer. </description> </method> <method name="mesh_surface_get_array_index_len" qualifiers="const"> @@ -1118,6 +1223,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's amount of indices. </description> </method> <method name="mesh_surface_get_array_len" qualifiers="const"> @@ -1128,6 +1234,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's amount of vertices. </description> </method> <method name="mesh_surface_get_arrays" qualifiers="const"> @@ -1138,6 +1245,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's buffer arrays. </description> </method> <method name="mesh_surface_get_blend_shape_arrays" qualifiers="const"> @@ -1148,6 +1256,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's arrays for blend shapes </description> </method> <method name="mesh_surface_get_format" qualifiers="const"> @@ -1158,6 +1267,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns the format of a mesh's surface. </description> </method> <method name="mesh_surface_get_index_array" qualifiers="const"> @@ -1168,6 +1278,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's index buffer. </description> </method> <method name="mesh_surface_get_material" qualifiers="const"> @@ -1178,6 +1289,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's material. </description> </method> <method name="mesh_surface_get_primitive_type" qualifiers="const"> @@ -1188,6 +1300,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns the primitive type of a mesh's surface. </description> </method> <method name="mesh_surface_get_skeleton_aabb" qualifiers="const"> @@ -1198,6 +1311,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns the aabb of a mesh's surface's skeleton. </description> </method> <method name="mesh_surface_set_material"> @@ -1210,6 +1324,7 @@ <argument index="2" name="material" type="RID"> </argument> <description> + Sets a mesh's surface's material. </description> </method> <method name="request_frame_drawn_callback"> @@ -1236,6 +1351,7 @@ <argument index="2" name="scale" type="bool"> </argument> <description> + Sets a boot image. The color defines the background color and if scale is [code]true[/code], the image will be scaled to fit the screen size. </description> </method> <method name="set_debug_generate_wireframes"> @@ -1258,6 +1374,7 @@ <return type="RID"> </return> <description> + Creates an empty shader. </description> </method> <method name="shader_get_code" qualifiers="const"> @@ -1266,6 +1383,7 @@ <argument index="0" name="shader" type="RID"> </argument> <description> + Returns a shader's code. </description> </method> <method name="shader_get_default_texture_param" qualifiers="const"> @@ -1276,6 +1394,7 @@ <argument index="1" name="name" type="String"> </argument> <description> + Returns a default texture from a shader searched by name. </description> </method> <method name="shader_get_param_list" qualifiers="const"> @@ -1284,6 +1403,7 @@ <argument index="0" name="shader" type="RID"> </argument> <description> + Returns the parameters of a shader. </description> </method> <method name="shader_set_code"> @@ -1294,6 +1414,7 @@ <argument index="1" name="code" type="String"> </argument> <description> + Sets a shader's code. </description> </method> <method name="shader_set_default_texture_param"> @@ -1306,12 +1427,14 @@ <argument index="2" name="texture" type="RID"> </argument> <description> + Sets a shader's default texture. Overwrites the texture given by name. </description> </method> <method name="sky_create"> <return type="RID"> </return> <description> + Creates an empty sky. </description> </method> <method name="sky_set_texture"> @@ -1324,6 +1447,7 @@ <argument index="2" name="radiance_size" type="int"> </argument> <description> + Sets a sky's texture. </description> </method> <method name="sync"> @@ -1346,12 +1470,14 @@ <argument index="4" name="flags" type="int" default="7"> </argument> <description> + Allocates space for a texture's image or video. </description> </method> <method name="texture_create"> <return type="RID"> </return> <description> + Creates an empty texture. </description> </method> <method name="texture_create_from_image"> @@ -1362,12 +1488,14 @@ <argument index="1" name="flags" type="int" default="7"> </argument> <description> + Creates a texture, allocates the space for an image, and fills in the image. </description> </method> <method name="texture_debug_usage"> <return type="Array"> </return> <description> + Returns a list of all the textures and their information. </description> </method> <method name="texture_get_data" qualifiers="const"> @@ -1378,6 +1506,7 @@ <argument index="1" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> </argument> <description> + Returns a copy of a texture's image unless it's a CubeMap, in wich case it returns the [RID] of the image at one of the cubes sides. </description> </method> <method name="texture_get_flags" qualifiers="const"> @@ -1386,6 +1515,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the flags of a texture. </description> </method> <method name="texture_get_format" qualifiers="const"> @@ -1394,6 +1524,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the format of the texture's image. </description> </method> <method name="texture_get_height" qualifiers="const"> @@ -1402,6 +1533,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the texture's height. </description> </method> <method name="texture_get_path" qualifiers="const"> @@ -1410,6 +1542,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the texture's path. </description> </method> <method name="texture_get_texid" qualifiers="const"> @@ -1418,6 +1551,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the opengl id of the texture's image. </description> </method> <method name="texture_get_width" qualifiers="const"> @@ -1426,6 +1560,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the texture's width. </description> </method> <method name="texture_set_data"> @@ -1438,6 +1573,7 @@ <argument index="2" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> </argument> <description> + Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. </description> </method> <method name="texture_set_flags"> @@ -1448,6 +1584,7 @@ <argument index="1" name="flags" type="int"> </argument> <description> + Sets the texture's flags. See [enum TextureFlags] for options </description> </method> <method name="texture_set_path"> @@ -1458,6 +1595,7 @@ <argument index="1" name="path" type="String"> </argument> <description> + Sets the texture's path. </description> </method> <method name="texture_set_shrink_all_x2_on_set_data"> @@ -1466,6 +1604,7 @@ <argument index="0" name="shrink" type="bool"> </argument> <description> + If [code]true[/code], sets internal processes to shrink all image data to half the size. </description> </method> <method name="texture_set_size_override"> @@ -1478,6 +1617,7 @@ <argument index="2" name="height" type="int"> </argument> <description> + Overwrites the texture's width and height. </description> </method> <method name="textures_keep_original"> @@ -1486,6 +1626,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + If [code]true[/code], the image will be stored in the texture's images array if overwritten. </description> </method> <method name="viewport_attach_camera"> @@ -1496,6 +1637,7 @@ <argument index="1" name="camera" type="RID"> </argument> <description> + Sets a viewport's camera. </description> </method> <method name="viewport_attach_canvas"> @@ -1506,6 +1648,7 @@ <argument index="1" name="canvas" type="RID"> </argument> <description> + Sets a viewport's canvas. </description> </method> <method name="viewport_attach_to_screen"> @@ -1518,12 +1661,14 @@ <argument index="2" name="screen" type="int" default="0"> </argument> <description> + Attaches a viewport to a screen. </description> </method> <method name="viewport_create"> <return type="RID"> </return> <description> + Creates an empty viewport. </description> </method> <method name="viewport_detach"> @@ -1532,6 +1677,7 @@ <argument index="0" name="viewport" type="RID"> </argument> <description> + Detaches the viewport from the screen. </description> </method> <method name="viewport_get_render_info"> @@ -1542,6 +1688,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. </description> </method> <method name="viewport_get_texture" qualifiers="const"> @@ -1550,6 +1697,7 @@ <argument index="0" name="viewport" type="RID"> </argument> <description> + Returns the viewport's last rendered frame. </description> </method> <method name="viewport_remove_canvas"> @@ -1560,6 +1708,7 @@ <argument index="1" name="canvas" type="RID"> </argument> <description> + Detaches a viewport from a canvas and vice versa. </description> </method> <method name="viewport_set_active"> @@ -1570,6 +1719,7 @@ <argument index="1" name="active" type="bool"> </argument> <description> + If [code]true[/code], sets the viewport active, else sets it inactive. </description> </method> <method name="viewport_set_canvas_layer"> @@ -1582,6 +1732,7 @@ <argument index="2" name="layer" type="int"> </argument> <description> + Sets the renderlayer for a viewport's canvas. </description> </method> <method name="viewport_set_canvas_transform"> @@ -1594,6 +1745,7 @@ <argument index="2" name="offset" type="Transform2D"> </argument> <description> + Sets the transformation of a viewport's canvas. </description> </method> <method name="viewport_set_clear_mode"> @@ -1604,6 +1756,7 @@ <argument index="1" name="clear_mode" type="int" enum="VisualServer.ViewportClearMode"> </argument> <description> + Sets the clear mode of a viewport. See VIEWPORT_CLEAR_MODE_* constants for options. </description> </method> <method name="viewport_set_debug_draw"> @@ -1614,6 +1767,7 @@ <argument index="1" name="draw" type="int" enum="VisualServer.ViewportDebugDraw"> </argument> <description> + Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW_* constants for options. </description> </method> <method name="viewport_set_disable_3d"> @@ -1624,6 +1778,7 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> + If [code]true[/code] a viewport's 3D rendering should be disabled. </description> </method> <method name="viewport_set_disable_environment"> @@ -1634,6 +1789,7 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> + If [code]true[/code] rendering of a viewport's environment should be disabled. </description> </method> <method name="viewport_set_global_canvas_transform"> @@ -1644,6 +1800,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Sets the viewport's global transformation matrix. </description> </method> <method name="viewport_set_hdr"> @@ -1654,6 +1811,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the viewport should render to hdr. </description> </method> <method name="viewport_set_hide_canvas"> @@ -1664,6 +1822,7 @@ <argument index="1" name="hidden" type="bool"> </argument> <description> + If [code]true[/code] the viewport's canvas should not be rendered. </description> </method> <method name="viewport_set_hide_scenario"> @@ -1684,6 +1843,7 @@ <argument index="1" name="msaa" type="int" enum="VisualServer.ViewportMSAA"> </argument> <description> + Sets the anti-aliasing mode. see [enum ViewportMSAA] for options. </description> </method> <method name="viewport_set_parent_viewport"> @@ -1694,6 +1854,7 @@ <argument index="1" name="parent_viewport" type="RID"> </argument> <description> + Sets the viewport's parent to another viewport. </description> </method> <method name="viewport_set_scenario"> @@ -1704,6 +1865,8 @@ <argument index="1" name="scenario" type="RID"> </argument> <description> + Sets a viewport's scenario. + The scenario contains information about the [enum ScenarioDebugMode], environment information, reflection atlas etc. </description> </method> <method name="viewport_set_shadow_atlas_quadrant_subdivision"> @@ -1716,6 +1879,7 @@ <argument index="2" name="subdivision" type="int"> </argument> <description> + Sets the shadow atlas quadrant's subdivision. </description> </method> <method name="viewport_set_shadow_atlas_size"> @@ -1726,6 +1890,7 @@ <argument index="1" name="size" type="int"> </argument> <description> + Sets the size of the shadow atlas's images. </description> </method> <method name="viewport_set_size"> @@ -1738,6 +1903,7 @@ <argument index="2" name="height" type="int"> </argument> <description> + Sets the viewport's width and height. </description> </method> <method name="viewport_set_transparent_background"> @@ -1748,6 +1914,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the viewport should render its background as transparent. </description> </method> <method name="viewport_set_update_mode"> @@ -1758,6 +1925,7 @@ <argument index="1" name="update_mode" type="int" enum="VisualServer.ViewportUpdateMode"> </argument> <description> + Sets when the viewport should be updated. See VIEWPORT_UPDATE_MODE_* constants for options. </description> </method> <method name="viewport_set_usage"> @@ -1768,6 +1936,7 @@ <argument index="1" name="usage" type="int" enum="VisualServer.ViewportUsage"> </argument> <description> + Sets what should be rendered in the viewport. See VIEWPORT_USAGE_* constants for options. </description> </method> <method name="viewport_set_use_arvr"> @@ -1778,6 +1947,7 @@ <argument index="1" name="use_arvr" type="bool"> </argument> <description> + If [code]true[/code] the viewport should use augmented or virtual reality technologies. See [ARVRInterface]. </description> </method> <method name="viewport_set_vflip"> @@ -1788,6 +1958,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the viewport's rendering should be flipped vertically. </description> </method> </methods> @@ -1798,315 +1969,432 @@ </signal> </signals> <constants> - <constant name="NO_INDEX_ARRAY" value="-1" enum=""> + <constant name="NO_INDEX_ARRAY" value="-1"> + Marks an error that shows that the index array is empty. </constant> - <constant name="ARRAY_WEIGHTS_SIZE" value="4" enum=""> + <constant name="ARRAY_WEIGHTS_SIZE" value="4"> </constant> - <constant name="CANVAS_ITEM_Z_MIN" value="-4096" enum=""> + <constant name="CANVAS_ITEM_Z_MIN" value="-4096"> + The minimum Z-layer for canvas items. </constant> - <constant name="CANVAS_ITEM_Z_MAX" value="4096" enum=""> + <constant name="CANVAS_ITEM_Z_MAX" value="4096"> + The maximum Z-layer for canvas items. </constant> - <constant name="MAX_GLOW_LEVELS" value="7" enum=""> + <constant name="MAX_GLOW_LEVELS" value="7"> </constant> - <constant name="MAX_CURSORS" value="8" enum=""> + <constant name="MAX_CURSORS" value="8"> </constant> - <constant name="MATERIAL_RENDER_PRIORITY_MIN" value="-128" enum=""> + <constant name="MATERIAL_RENDER_PRIORITY_MIN" value="-128"> + The minimum renderpriority of all materials. </constant> - <constant name="MATERIAL_RENDER_PRIORITY_MAX" value="127" enum=""> + <constant name="MATERIAL_RENDER_PRIORITY_MAX" value="127"> + The maximum renderpriority of all materials. </constant> - <constant name="CUBEMAP_LEFT" value="0"> + <constant name="CUBEMAP_LEFT" value="0" enum="CubeMapSide"> + Marks the left side of a cubemap. </constant> - <constant name="CUBEMAP_RIGHT" value="1"> + <constant name="CUBEMAP_RIGHT" value="1" enum="CubeMapSide"> + Marks the right side of a cubemap. </constant> - <constant name="CUBEMAP_BOTTOM" value="2"> + <constant name="CUBEMAP_BOTTOM" value="2" enum="CubeMapSide"> + Marks the bottom side of a cubemap. </constant> - <constant name="CUBEMAP_TOP" value="3"> + <constant name="CUBEMAP_TOP" value="3" enum="CubeMapSide"> + Marks the top side of a cubemap. </constant> - <constant name="CUBEMAP_FRONT" value="4"> + <constant name="CUBEMAP_FRONT" value="4" enum="CubeMapSide"> + Marks the front side of a cubemap. </constant> - <constant name="CUBEMAP_BACK" value="5"> + <constant name="CUBEMAP_BACK" value="5" enum="CubeMapSide"> + Marks the back side of a cubemap. </constant> - <constant name="TEXTURE_FLAG_MIPMAPS" value="1"> + <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. </constant> - <constant name="TEXTURE_FLAG_REPEAT" value="2"> + <constant name="TEXTURE_FLAG_REPEAT" value="2" enum="TextureFlags"> + Repeat (instead of clamp to edge). </constant> - <constant name="TEXTURE_FLAG_FILTER" value="4"> + <constant name="TEXTURE_FLAG_FILTER" value="4" enum="TextureFlags"> + Turn on magnifying filter, to enable smooth zooming in of the texture. </constant> - <constant name="TEXTURE_FLAG_ANISOTROPIC_FILTER" value="8"> + <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. </constant> - <constant name="TEXTURE_FLAG_CONVERT_TO_LINEAR" value="16"> + <constant name="TEXTURE_FLAG_CONVERT_TO_LINEAR" value="16" enum="TextureFlags"> + Converts texture to SRGB color space. </constant> - <constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32"> + <constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32" enum="TextureFlags"> + Repeat texture with alternate sections mirrored. </constant> - <constant name="TEXTURE_FLAG_CUBEMAP" value="2048"> + <constant name="TEXTURE_FLAG_CUBEMAP" value="2048" enum="TextureFlags"> + Texture is a cubemap. </constant> - <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="4096"> + <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="4096" enum="TextureFlags"> + Texture is a video surface. </constant> - <constant name="TEXTURE_FLAGS_DEFAULT" value="7"> + <constant name="TEXTURE_FLAGS_DEFAULT" value="7" enum="TextureFlags"> + Default flags. Generate mipmaps, repeat, and filter are enabled. </constant> - <constant name="SHADER_SPATIAL" value="0"> + <constant name="SHADER_SPATIAL" value="0" enum="ShaderMode"> + Shader is a 3D shader. </constant> - <constant name="SHADER_CANVAS_ITEM" value="1"> + <constant name="SHADER_CANVAS_ITEM" value="1" enum="ShaderMode"> + Shader is a 2D shader. </constant> - <constant name="SHADER_PARTICLES" value="2"> + <constant name="SHADER_PARTICLES" value="2" enum="ShaderMode"> + Shader is a particle shader. </constant> - <constant name="SHADER_MAX" value="3"> + <constant name="SHADER_MAX" value="3" enum="ShaderMode"> + Marks maximum of the shader types array. used internally. </constant> - <constant name="ARRAY_VERTEX" value="0"> + <constant name="ARRAY_VERTEX" value="0" enum="ArrayType"> + Array is a vertex array. </constant> - <constant name="ARRAY_NORMAL" value="1"> + <constant name="ARRAY_NORMAL" value="1" enum="ArrayType"> + Array is a normal array. </constant> - <constant name="ARRAY_TANGENT" value="2"> + <constant name="ARRAY_TANGENT" value="2" enum="ArrayType"> + Array is a tangent array. </constant> - <constant name="ARRAY_COLOR" value="3"> + <constant name="ARRAY_COLOR" value="3" enum="ArrayType"> + Array is a color array. </constant> - <constant name="ARRAY_TEX_UV" value="4"> + <constant name="ARRAY_TEX_UV" value="4" enum="ArrayType"> + Array is a uv coordinates array. </constant> - <constant name="ARRAY_TEX_UV2" value="5"> + <constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType"> + Array is a uv coordinates array for the second uv coordinates. </constant> - <constant name="ARRAY_BONES" value="6"> + <constant name="ARRAY_BONES" value="6" enum="ArrayType"> + Array contains bone information. </constant> - <constant name="ARRAY_WEIGHTS" value="7"> + <constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType"> + Array is weight information. </constant> - <constant name="ARRAY_INDEX" value="8"> + <constant name="ARRAY_INDEX" value="8" enum="ArrayType"> + Array is index array. </constant> - <constant name="ARRAY_MAX" value="9"> + <constant name="ARRAY_MAX" value="9" enum="ArrayType"> + Marks the maximum of the array types. Used internally. </constant> - <constant name="ARRAY_FORMAT_VERTEX" value="1"> + <constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat"> + Flag used to mark a vertex array. </constant> - <constant name="ARRAY_FORMAT_NORMAL" value="2"> + <constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat"> + Flag used to mark a normal array. </constant> - <constant name="ARRAY_FORMAT_TANGENT" value="4"> + <constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat"> + Flag used to mark a tangent array. </constant> - <constant name="ARRAY_FORMAT_COLOR" value="8"> + <constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat"> + Flag used to mark a color array. </constant> - <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + <constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat"> + Flag used to mark a uv coordinates array. </constant> - <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> + <constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat"> + Flag used to mark a uv coordinates array for the second uv coordinates. </constant> - <constant name="ARRAY_FORMAT_BONES" value="64"> + <constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat"> + Flag used to mark a bone information array. </constant> - <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128" enum="ArrayFormat"> + Flag used to mark a weights array. </constant> - <constant name="ARRAY_FORMAT_INDEX" value="256"> + <constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat"> + Flag used to mark a index array. </constant> - <constant name="ARRAY_COMPRESS_VERTEX" value="512"> + <constant name="ARRAY_COMPRESS_VERTEX" value="512" enum="ArrayFormat"> + Flag used to mark a compressed (half float) vertex array. </constant> - <constant name="ARRAY_COMPRESS_NORMAL" value="1024"> + <constant name="ARRAY_COMPRESS_NORMAL" value="1024" enum="ArrayFormat"> + Flag used to mark a compressed (half float) normal array. </constant> - <constant name="ARRAY_COMPRESS_TANGENT" value="2048"> + <constant name="ARRAY_COMPRESS_TANGENT" value="2048" enum="ArrayFormat"> + Flag used to mark a compressed (half float) tangent array. </constant> - <constant name="ARRAY_COMPRESS_COLOR" value="4096"> + <constant name="ARRAY_COMPRESS_COLOR" value="4096" enum="ArrayFormat"> + Flag used to mark a compressed (half float) color array. </constant> - <constant name="ARRAY_COMPRESS_TEX_UV" value="8192"> + <constant name="ARRAY_COMPRESS_TEX_UV" value="8192" enum="ArrayFormat"> + Flag used to mark a compressed (half float) uv coordinates array. </constant> - <constant name="ARRAY_COMPRESS_TEX_UV2" value="16384"> + <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. </constant> - <constant name="ARRAY_COMPRESS_BONES" value="32768"> + <constant name="ARRAY_COMPRESS_BONES" value="32768" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_WEIGHTS" value="65536"> + <constant name="ARRAY_COMPRESS_WEIGHTS" value="65536" enum="ArrayFormat"> + Flag used to mark a compressed (half float) weight array. </constant> - <constant name="ARRAY_COMPRESS_INDEX" value="131072"> + <constant name="ARRAY_COMPRESS_INDEX" value="131072" enum="ArrayFormat"> </constant> - <constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144"> + <constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144" enum="ArrayFormat"> + Flag used to mark that the array contains 2D vertices. </constant> - <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288"> + <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. </constant> - <constant name="ARRAY_COMPRESS_DEFAULT" value="97792"> + <constant name="ARRAY_COMPRESS_DEFAULT" value="97792" 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. </constant> - <constant name="PRIMITIVE_POINTS" value="0"> + <constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType"> + Primitive to draw consists of points. </constant> - <constant name="PRIMITIVE_LINES" value="1"> + <constant name="PRIMITIVE_LINES" value="1" enum="PrimitiveType"> + Primitive to draw consists of lines. </constant> - <constant name="PRIMITIVE_LINE_STRIP" value="2"> + <constant name="PRIMITIVE_LINE_STRIP" value="2" enum="PrimitiveType"> + Primitive to draw consists of a line strip from start to end. </constant> - <constant name="PRIMITIVE_LINE_LOOP" value="3"> + <constant name="PRIMITIVE_LINE_LOOP" value="3" enum="PrimitiveType"> + Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex). </constant> - <constant name="PRIMITIVE_TRIANGLES" value="4"> + <constant name="PRIMITIVE_TRIANGLES" value="4" enum="PrimitiveType"> + Primitive to draw consists of triangles. </constant> - <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> + <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5" enum="PrimitiveType"> + Primitive to draw consists of a triangle strip (the last 3 verticies are always combined to make a triangle). </constant> - <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> + <constant name="PRIMITIVE_TRIANGLE_FAN" value="6" enum="PrimitiveType"> + Primitive to draw consists of a triangle strip (the last 2 verticies are always combined with the first to make a triangle). </constant> - <constant name="PRIMITIVE_MAX" value="7"> + <constant name="PRIMITIVE_MAX" value="7" enum="PrimitiveType"> + Marks the primitive types endpoint. used internally. </constant> - <constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0"> + <constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode"> </constant> - <constant name="BLEND_SHAPE_MODE_RELATIVE" value="1"> + <constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode"> </constant> - <constant name="LIGHT_DIRECTIONAL" value="0"> + <constant name="LIGHT_DIRECTIONAL" value="0" enum="LightType"> + Is a directional (sun) light. </constant> - <constant name="LIGHT_OMNI" value="1"> + <constant name="LIGHT_OMNI" value="1" enum="LightType"> + is an omni light. </constant> - <constant name="LIGHT_SPOT" value="2"> + <constant name="LIGHT_SPOT" value="2" enum="LightType"> + is an spot light. </constant> - <constant name="LIGHT_PARAM_ENERGY" value="0"> + <constant name="LIGHT_PARAM_ENERGY" value="0" enum="LightParam"> + The light's energy. </constant> - <constant name="LIGHT_PARAM_SPECULAR" value="1"> + <constant name="LIGHT_PARAM_SPECULAR" value="2" enum="LightParam"> + The light's influence on specularity. </constant> - <constant name="LIGHT_PARAM_RANGE" value="2"> + <constant name="LIGHT_PARAM_RANGE" value="3" enum="LightParam"> + The light's range. </constant> - <constant name="LIGHT_PARAM_ATTENUATION" value="3"> + <constant name="LIGHT_PARAM_ATTENUATION" value="4" enum="LightParam"> + The light's attenuation. </constant> - <constant name="LIGHT_PARAM_SPOT_ANGLE" value="4"> + <constant name="LIGHT_PARAM_SPOT_ANGLE" value="5" enum="LightParam"> + The spotlight's angle. </constant> - <constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="5"> + <constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="6" enum="LightParam"> + The spotlight's attenuation. </constant> - <constant name="LIGHT_PARAM_CONTACT_SHADOW_SIZE" value="6"> + <constant name="LIGHT_PARAM_CONTACT_SHADOW_SIZE" value="7" enum="LightParam"> + Scales the shadow color. </constant> - <constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="7"> + <constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="8" enum="LightParam"> </constant> - <constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="8"> + <constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="9" enum="LightParam"> </constant> - <constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="9"> + <constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="10" enum="LightParam"> </constant> - <constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="10"> + <constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="11" enum="LightParam"> </constant> - <constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="11"> + <constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="12" enum="LightParam"> </constant> - <constant name="LIGHT_PARAM_SHADOW_BIAS" value="12"> + <constant name="LIGHT_PARAM_SHADOW_BIAS" value="13" enum="LightParam"> </constant> - <constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="13"> + <constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14" enum="LightParam"> </constant> - <constant name="LIGHT_PARAM_MAX" value="14"> + <constant name="LIGHT_PARAM_MAX" value="15" enum="LightParam"> + The light parameters endpoint. Used internally. </constant> - <constant name="VIEWPORT_UPDATE_DISABLED" value="0"> + <constant name="VIEWPORT_UPDATE_DISABLED" value="0" enum="ViewportUpdateMode"> </constant> - <constant name="VIEWPORT_UPDATE_ONCE" value="1"> + <constant name="VIEWPORT_UPDATE_ONCE" value="1" enum="ViewportUpdateMode"> </constant> - <constant name="VIEWPORT_UPDATE_WHEN_VISIBLE" value="2"> + <constant name="VIEWPORT_UPDATE_WHEN_VISIBLE" value="2" enum="ViewportUpdateMode"> </constant> - <constant name="VIEWPORT_UPDATE_ALWAYS" value="3"> + <constant name="VIEWPORT_UPDATE_ALWAYS" value="3" enum="ViewportUpdateMode"> </constant> - <constant name="VIEWPORT_CLEAR_ALWAYS" value="0"> + <constant name="VIEWPORT_CLEAR_ALWAYS" value="0" enum="ViewportClearMode"> + The viewport is always cleared before drawing. </constant> - <constant name="VIEWPORT_CLEAR_NEVER" value="1"> + <constant name="VIEWPORT_CLEAR_NEVER" value="1" enum="ViewportClearMode"> + The viewport is never cleared before drawing. </constant> - <constant name="VIEWPORT_CLEAR_ONLY_NEXT_FRAME" value="2"> + <constant name="VIEWPORT_CLEAR_ONLY_NEXT_FRAME" value="2" enum="ViewportClearMode"> + The viewport is cleared once, then the clear mode is set to [VIEWPORT_CLEAR_NEVER]. </constant> - <constant name="VIEWPORT_MSAA_DISABLED" value="0"> + <constant name="VIEWPORT_MSAA_DISABLED" value="0" enum="ViewportMSAA"> + Multisample antialiasing is disabled. </constant> - <constant name="VIEWPORT_MSAA_2X" value="1"> + <constant name="VIEWPORT_MSAA_2X" value="1" enum="ViewportMSAA"> + Multisample antialiasing is set to 2X. </constant> - <constant name="VIEWPORT_MSAA_4X" value="2"> + <constant name="VIEWPORT_MSAA_4X" value="2" enum="ViewportMSAA"> + Multisample antialiasing is set to 4X. </constant> - <constant name="VIEWPORT_MSAA_8X" value="3"> + <constant name="VIEWPORT_MSAA_8X" value="3" enum="ViewportMSAA"> + Multisample antialiasing is set to 8X. </constant> - <constant name="VIEWPORT_MSAA_16X" value="4"> + <constant name="VIEWPORT_MSAA_16X" value="4" enum="ViewportMSAA"> + Multisample antialiasing is set to 16X. </constant> - <constant name="VIEWPORT_USAGE_2D" value="0"> + <constant name="VIEWPORT_USAGE_2D" value="0" enum="ViewportUsage"> + The Viewport does not render 3D but samples. </constant> - <constant name="VIEWPORT_USAGE_2D_NO_SAMPLING" value="1"> + <constant name="VIEWPORT_USAGE_2D_NO_SAMPLING" value="1" enum="ViewportUsage"> + The Viewport does not render 3D and does not sample. </constant> - <constant name="VIEWPORT_USAGE_3D" value="2"> + <constant name="VIEWPORT_USAGE_3D" value="2" enum="ViewportUsage"> + The Viewport renders 3D with effects. </constant> - <constant name="VIEWPORT_USAGE_3D_NO_EFFECTS" value="3"> + <constant name="VIEWPORT_USAGE_3D_NO_EFFECTS" value="3" enum="ViewportUsage"> + The Viewport renders 3D but without effects. </constant> - <constant name="VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME" value="0"> + <constant name="VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="ViewportRenderInfo"> </constant> - <constant name="VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME" value="1"> + <constant name="VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="ViewportRenderInfo"> </constant> - <constant name="VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + <constant name="VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="ViewportRenderInfo"> </constant> - <constant name="VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3"> + <constant name="VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="ViewportRenderInfo"> </constant> - <constant name="VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + <constant name="VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="ViewportRenderInfo"> </constant> - <constant name="VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5"> + <constant name="VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5" enum="ViewportRenderInfo"> </constant> - <constant name="VIEWPORT_RENDER_INFO_MAX" value="6"> + <constant name="VIEWPORT_RENDER_INFO_MAX" value="6" enum="ViewportRenderInfo"> + Marks end of VIEWPORT_RENDER_INFO* constants. Used internally. </constant> - <constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0"> + <constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0" enum="ViewportDebugDraw"> + Debug draw is disabled. Default setting. </constant> - <constant name="VIEWPORT_DEBUG_DRAW_UNSHADED" value="1"> + <constant name="VIEWPORT_DEBUG_DRAW_UNSHADED" value="1" enum="ViewportDebugDraw"> + Debug draw sets objects to unshaded. </constant> - <constant name="VIEWPORT_DEBUG_DRAW_OVERDRAW" value="2"> + <constant name="VIEWPORT_DEBUG_DRAW_OVERDRAW" value="2" enum="ViewportDebugDraw"> + Overwrites clear color to [code](0,0,0,0)[/code]. </constant> - <constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="3"> + <constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="3" enum="ViewportDebugDraw"> + Debug draw draws objects in wireframe. </constant> - <constant name="SCENARIO_DEBUG_DISABLED" value="0"> + <constant name="SCENARIO_DEBUG_DISABLED" value="0" enum="ScenarioDebugMode"> </constant> - <constant name="SCENARIO_DEBUG_WIREFRAME" value="1"> + <constant name="SCENARIO_DEBUG_WIREFRAME" value="1" enum="ScenarioDebugMode"> </constant> - <constant name="SCENARIO_DEBUG_OVERDRAW" value="2"> + <constant name="SCENARIO_DEBUG_OVERDRAW" value="2" enum="ScenarioDebugMode"> </constant> - <constant name="SCENARIO_DEBUG_SHADELESS" value="3"> + <constant name="SCENARIO_DEBUG_SHADELESS" value="3" enum="ScenarioDebugMode"> </constant> - <constant name="INSTANCE_NONE" value="0"> + <constant name="INSTANCE_NONE" value="0" enum="InstanceType"> + The instance does not have a type. </constant> - <constant name="INSTANCE_MESH" value="1"> + <constant name="INSTANCE_MESH" value="1" enum="InstanceType"> + The instance is a mesh. </constant> - <constant name="INSTANCE_MULTIMESH" value="2"> + <constant name="INSTANCE_MULTIMESH" value="2" enum="InstanceType"> + The instance is a multimesh. </constant> - <constant name="INSTANCE_IMMEDIATE" value="3"> + <constant name="INSTANCE_IMMEDIATE" value="3" enum="InstanceType"> + The instance is an immediate geometry. </constant> - <constant name="INSTANCE_PARTICLES" value="4"> + <constant name="INSTANCE_PARTICLES" value="4" enum="InstanceType"> + The instance is a particle emitter. </constant> - <constant name="INSTANCE_LIGHT" value="5"> + <constant name="INSTANCE_LIGHT" value="5" enum="InstanceType"> + The instance is a light. </constant> - <constant name="INSTANCE_REFLECTION_PROBE" value="6"> + <constant name="INSTANCE_REFLECTION_PROBE" value="6" enum="InstanceType"> </constant> - <constant name="INSTANCE_GI_PROBE" value="7"> + <constant name="INSTANCE_GI_PROBE" value="7" enum="InstanceType"> </constant> - <constant name="INSTANCE_MAX" value="8"> + <constant name="INSTANCE_MAX" value="8" enum="InstanceType"> + The max value for INSTANCE_* constants, used internally. </constant> - <constant name="INSTANCE_GEOMETRY_MASK" value="30"> + <constant name="INSTANCE_GEOMETRY_MASK" value="30" enum="InstanceType"> + A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). </constant> - <constant name="NINE_PATCH_STRETCH" value="0"> + <constant name="NINE_PATCH_STRETCH" value="0" enum="NinePatchAxisMode"> + The nine patch gets stretched where needed. </constant> - <constant name="NINE_PATCH_TILE" value="1"> + <constant name="NINE_PATCH_TILE" value="1" enum="NinePatchAxisMode"> + The nine patch gets filled with tiles where needed. </constant> - <constant name="NINE_PATCH_TILE_FIT" value="2"> + <constant name="NINE_PATCH_TILE_FIT" value="2" enum="NinePatchAxisMode"> + The nine patch gets filled with tiles where needed and stretches them a bit if needed. </constant> - <constant name="CANVAS_LIGHT_MODE_ADD" value="0"> + <constant name="CANVAS_LIGHT_MODE_ADD" value="0" enum="CanvasLightMode"> + Adds light color additive to the canvas. </constant> - <constant name="CANVAS_LIGHT_MODE_SUB" value="1"> + <constant name="CANVAS_LIGHT_MODE_SUB" value="1" enum="CanvasLightMode"> + Adds light color subtractive to the canvas. </constant> - <constant name="CANVAS_LIGHT_MODE_MIX" value="2"> + <constant name="CANVAS_LIGHT_MODE_MIX" value="2" enum="CanvasLightMode"> + The light adds color depending on transparency. </constant> - <constant name="CANVAS_LIGHT_MODE_MASK" value="3"> + <constant name="CANVAS_LIGHT_MODE_MASK" value="3" enum="CanvasLightMode"> + The light adds color depending on mask. </constant> - <constant name="CANVAS_LIGHT_FILTER_NONE" value="0"> + <constant name="CANVAS_LIGHT_FILTER_NONE" value="0" enum="CanvasLightShadowFilter"> </constant> - <constant name="CANVAS_LIGHT_FILTER_PCF3" value="1"> + <constant name="CANVAS_LIGHT_FILTER_PCF3" value="1" enum="CanvasLightShadowFilter"> </constant> - <constant name="CANVAS_LIGHT_FILTER_PCF5" value="2"> + <constant name="CANVAS_LIGHT_FILTER_PCF5" value="2" enum="CanvasLightShadowFilter"> </constant> - <constant name="CANVAS_LIGHT_FILTER_PCF7" value="3"> + <constant name="CANVAS_LIGHT_FILTER_PCF7" value="3" enum="CanvasLightShadowFilter"> </constant> - <constant name="CANVAS_LIGHT_FILTER_PCF9" value="4"> + <constant name="CANVAS_LIGHT_FILTER_PCF9" value="4" enum="CanvasLightShadowFilter"> </constant> - <constant name="CANVAS_LIGHT_FILTER_PCF13" value="5"> + <constant name="CANVAS_LIGHT_FILTER_PCF13" value="5" enum="CanvasLightShadowFilter"> </constant> - <constant name="CANVAS_OCCLUDER_POLYGON_CULL_DISABLED" value="0"> + <constant name="CANVAS_OCCLUDER_POLYGON_CULL_DISABLED" value="0" enum="CanvasOccluderPolygonCullMode"> + Culling of the canvas occluder is disabled. </constant> - <constant name="CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE" value="1"> + <constant name="CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE" value="1" enum="CanvasOccluderPolygonCullMode"> + Culling of the canvas occluder is clockwise. </constant> - <constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2"> + <constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2" enum="CanvasOccluderPolygonCullMode"> + Culling of the canvas occluder is counterclockwise. </constant> - <constant name="INFO_OBJECTS_IN_FRAME" value="0"> + <constant name="INFO_OBJECTS_IN_FRAME" value="0" enum="RenderInfo"> + The amount of objects in the frame. </constant> - <constant name="INFO_VERTICES_IN_FRAME" value="1"> + <constant name="INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo"> + The amount of vertices in the frame. </constant> - <constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + <constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo"> + The amount of modified materials in the frame. </constant> - <constant name="INFO_SHADER_CHANGES_IN_FRAME" value="3"> + <constant name="INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="RenderInfo"> + The amount of shader rebinds in the frame. </constant> - <constant name="INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + <constant name="INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="RenderInfo"> + The amount of surface changes in the frame. </constant> - <constant name="INFO_DRAW_CALLS_IN_FRAME" value="5"> + <constant name="INFO_DRAW_CALLS_IN_FRAME" value="5" enum="RenderInfo"> + The amount of draw calls in frame. </constant> - <constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="6"> + <constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="6" enum="RenderInfo"> </constant> - <constant name="INFO_VIDEO_MEM_USED" value="7"> + <constant name="INFO_VIDEO_MEM_USED" value="7" enum="RenderInfo"> + The amount of vertex memory and texture memory used. </constant> - <constant name="INFO_TEXTURE_MEM_USED" value="8"> + <constant name="INFO_TEXTURE_MEM_USED" value="8" enum="RenderInfo"> + The amount of texture memory used. </constant> - <constant name="INFO_VERTEX_MEM_USED" value="9"> + <constant name="INFO_VERTEX_MEM_USED" value="9" enum="RenderInfo"> + The amount of vertex memory used. </constant> - <constant name="FEATURE_SHADERS" value="0"> + <constant name="FEATURE_SHADERS" value="0" enum="Features"> </constant> - <constant name="FEATURE_MULTITHREADED" value="1"> + <constant name="FEATURE_MULTITHREADED" value="1" enum="Features"> </constant> </constants> </class> diff --git a/doc/classes/WeakRef.xml b/doc/classes/WeakRef.xml index 00e5bdfd2c..0641dc1349 100644 --- a/doc/classes/WeakRef.xml +++ b/doc/classes/WeakRef.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="WeakRef" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="WeakRef" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Holds an [Object], but does not contribute to the reference count if the object is a reference. </brief_description> diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index a6ebd45a76..5bdcfe238d 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="WindowDialog" inherits="Popup" category="Core" version="3.0-alpha"> +<class name="WindowDialog" inherits="Popup" category="Core" version="3.0-beta"> <brief_description> Base class for window dialogs. </brief_description> @@ -18,41 +18,13 @@ Return the close [TextureButton]. </description> </method> - <method name="get_resizable" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_title" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the title of the window. - </description> - </method> - <method name="set_resizable"> - <return type="void"> - </return> - <argument index="0" name="resizable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_title"> - <return type="void"> - </return> - <argument index="0" name="title" type="String"> - </argument> - <description> - Set the title of the window. - </description> - </method> </methods> <members> <member name="resizable" type="bool" setter="set_resizable" getter="get_resizable"> + If [code]true[/code] the user can resize the window. Default value: [code]false[/code]. </member> <member name="window_title" type="String" setter="set_title" getter="get_title"> + The text displayed in the window's title bar. Default value: "Save a File". </member> </members> <constants> diff --git a/doc/classes/World.xml b/doc/classes/World.xml index 6d243f26a5..9011d39669 100644 --- a/doc/classes/World.xml +++ b/doc/classes/World.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="World" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="World" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Class that has everything pertaining to a world. </brief_description> @@ -15,53 +15,30 @@ <return type="PhysicsDirectSpaceState"> </return> <description> - </description> - </method> - <method name="get_environment" qualifiers="const"> - <return type="Environment"> - </return> - <description> - </description> - </method> - <method name="get_fallback_environment" qualifiers="const"> - <return type="Environment"> - </return> - <description> + Returns the World's physics space. </description> </method> <method name="get_scenario" qualifiers="const"> <return type="RID"> </return> <description> + Returns the World's visual scenario. </description> </method> <method name="get_space" qualifiers="const"> <return type="RID"> </return> <description> - </description> - </method> - <method name="set_environment"> - <return type="void"> - </return> - <argument index="0" name="env" type="Environment"> - </argument> - <description> - </description> - </method> - <method name="set_fallback_environment"> - <return type="void"> - </return> - <argument index="0" name="env" type="Environment"> - </argument> - <description> + Returns the World's sound space. </description> </method> </methods> <members> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> + The World's [Environment]. </member> <member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment"> + The World's fallback_environment will be used if the World's [Environment] fails or is missing. </member> </members> <constants> diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml index bf3cc9f24b..93c88968ac 100644 --- a/doc/classes/World2D.xml +++ b/doc/classes/World2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="World2D" inherits="Resource" category="Core" version="3.0-alpha"> +<class name="World2D" inherits="Resource" category="Core" version="3.0-beta"> <brief_description> Class that has everything pertaining to a 2D world. </brief_description> diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml index 13922b4987..44f2086e51 100644 --- a/doc/classes/WorldEnvironment.xml +++ b/doc/classes/WorldEnvironment.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="WorldEnvironment" inherits="Node" category="Core" version="3.0-alpha"> +<class name="WorldEnvironment" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Sets environment properties for the entire scene </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_environment" qualifiers="const"> - <return type="Environment"> - </return> - <description> - Return the [Environment] currently bound. - </description> - </method> - <method name="set_environment"> - <return type="void"> - </return> - <argument index="0" name="env" type="Environment"> - </argument> - <description> - Set the currently bound [Environment] to the one specified. - </description> - </method> </methods> <members> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 5e7ba3b4bf..2665e594e0 100644 --- a/doc/classes/XMLParser.xml +++ b/doc/classes/XMLParser.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="XMLParser" inherits="Reference" category="Core" version="3.0-alpha"> +<class name="XMLParser" inherits="Reference" category="Core" version="3.0-beta"> <brief_description> Low-level class for creating parsers for XML files. </brief_description> @@ -148,25 +148,25 @@ </method> </methods> <constants> - <constant name="NODE_NONE" value="0"> + <constant name="NODE_NONE" value="0" enum="NodeType"> There's no node (no file or buffer opened) </constant> - <constant name="NODE_ELEMENT" value="1"> + <constant name="NODE_ELEMENT" value="1" enum="NodeType"> Element (tag) </constant> - <constant name="NODE_ELEMENT_END" value="2"> + <constant name="NODE_ELEMENT_END" value="2" enum="NodeType"> End of element </constant> - <constant name="NODE_TEXT" value="3"> + <constant name="NODE_TEXT" value="3" enum="NodeType"> Text node </constant> - <constant name="NODE_COMMENT" value="4"> + <constant name="NODE_COMMENT" value="4" enum="NodeType"> Comment node </constant> - <constant name="NODE_CDATA" value="5"> + <constant name="NODE_CDATA" value="5" enum="NodeType"> CDATA content </constant> - <constant name="NODE_UNKNOWN" value="6"> + <constant name="NODE_UNKNOWN" value="6" enum="NodeType"> Unknown node </constant> </constants> diff --git a/doc/classes/YSort.xml b/doc/classes/YSort.xml index de4c8be11a..b1a8980141 100644 --- a/doc/classes/YSort.xml +++ b/doc/classes/YSort.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="YSort" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="YSort" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Sort all child nodes based on their Y positions. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="is_sort_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns true if the children nodes are being sorted. - </description> - </method> - <method name="set_sort_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set whether the children nodes are sorted or not. (default true) - </description> - </method> </methods> <members> <member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled"> diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index f596180bcf..2437d53bda 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="bool" category="Built-In Types" version="3.0-alpha"> +<class name="bool" category="Built-In Types" version="3.0-beta"> <brief_description> Boolean built-in type </brief_description> diff --git a/doc/classes/float.xml b/doc/classes/float.xml index 703ca55be8..e7c46beb37 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="float" category="Built-In Types" version="3.0-alpha"> +<class name="float" category="Built-In Types" version="3.0-beta"> <brief_description> Float built-in type </brief_description> diff --git a/doc/classes/int.xml b/doc/classes/int.xml index 79a198b198..a59bce0309 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="int" category="Built-In Types" version="3.0-alpha"> +<class name="int" category="Built-In Types" version="3.0-beta"> <brief_description> Integer built-in type. </brief_description> diff --git a/doc/tools/doc_status.py b/doc/tools/doc_status.py index 170ded9f50..ab74c0b9d6 100644 --- a/doc/tools/doc_status.py +++ b/doc/tools/doc_status.py @@ -245,21 +245,6 @@ class ClassStatus: status = ClassStatus() status.name = c.attrib['name'] - # setgets do not count - methods = [] - for tag in list(c): - if tag.tag in ['methods']: - for sub_tag in list(tag): - methods.append(sub_tag.attrib['name']) - if tag.tag in ['members']: - for sub_tag in list(tag): - try: - if(sub_tag.attrib['setter'].startswith('_') == False): - methods.remove(sub_tag.attrib['setter']) - if(sub_tag.attrib['getter'].startswith('_') == False): - methods.remove(sub_tag.attrib['getter']) - except: - pass for tag in list(c): if tag.tag == 'brief_description': @@ -270,9 +255,8 @@ class ClassStatus: elif tag.tag in ['methods', 'signals']: for sub_tag in list(tag): - if sub_tag.attrib['name'] in methods or tag.tag == 'signals': - descr = sub_tag.find('description') - status.progresses[tag.tag].increment(len(descr.text.strip()) > 0) + descr = sub_tag.find('description') + status.progresses[tag.tag].increment(len(descr.text.strip()) > 0) elif tag.tag in ['constants', 'members']: for sub_tag in list(tag): status.progresses[tag.tag].increment(len(sub_tag.text.strip()) > 0) diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py index dc015d781b..cd0108019b 100644 --- a/doc/tools/makerst.py +++ b/doc/tools/makerst.py @@ -7,6 +7,7 @@ import os import xml.etree.ElementTree as ET input_list = [] +cur_file = "" for arg in sys.argv[1:]: if arg.endswith(os.sep): @@ -206,6 +207,7 @@ def rstize_text(text, cclass): elif cmd == '/code': tag_text = '``' inside_code = False + escape_post = True elif inside_code: tag_text = '[' + tag_text + ']' elif cmd.find('html') == 0: @@ -217,7 +219,10 @@ def rstize_text(text, cclass): param = tag_text[space_pos + 1:] if param.find('.') != -1: - (class_param, method_param) = param.split('.') + ss = param.split('.') + if len(ss) > 2: + sys.exit("Bad reference: '" + param + "' in file: " + cur_file) + (class_param, method_param) = ss tag_text = ':ref:`' + class_param + '.' + method_param + '<class_' + class_param + '_' + method_param + '>`' else: tag_text = ':ref:`' + param + '<class_' + cclass + "_" + param + '>`' @@ -519,8 +524,8 @@ for path in input_list: elif os.path.isfile(path) and path.endswith('.xml'): file_list.append(path) -for file in file_list: - tree = ET.parse(file) +for cur_file in file_list: + tree = ET.parse(cur_file) doc = tree.getroot() if 'version' not in doc.attrib: |