From b50cfabe37d2025fa576232b7b5c8d47e8345fe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 27 Dec 2018 14:08:45 +0100 Subject: [PATCH] Sync classref with godotengine/godot#24607 deterministic sorting --- classes/class_@globalscope.rst | 896 +++++++++++----------- classes/class_animation.rst | 44 +- classes/class_animationnode.rst | 2 +- classes/class_animationrootnode.rst | 2 +- classes/class_animationtreeplayer.rst | 16 +- classes/class_arraymesh.rst | 44 +- classes/class_arvrinterface.rst | 28 +- classes/class_arvrserver.rst | 20 +- classes/class_audioeffect.rst | 2 +- classes/class_audioeffecteq.rst | 2 +- classes/class_audioeffectfilter.rst | 2 +- classes/class_audiostream.rst | 2 +- classes/class_audiostreamplayer3d.rst | 36 +- classes/class_audiostreamsample.rst | 20 +- classes/class_bakedlightmap.rst | 16 +- classes/class_basebutton.rst | 18 +- classes/class_boxcontainer.rst | 2 +- classes/class_button.rst | 2 +- classes/class_camera.rst | 22 +- classes/class_canvasitem.rst | 2 +- classes/class_canvasitemmaterial.rst | 20 +- classes/class_collisionobject.rst | 2 +- classes/class_collisionobject2d.rst | 2 +- classes/class_confirmationdialog.rst | 2 +- classes/class_container.rst | 2 +- classes/class_control.rst | 84 +- classes/class_cpuparticles.rst | 30 +- classes/class_cpuparticles2d.rst | 24 +- classes/class_csgprimitive.rst | 2 +- classes/class_cubemap.rst | 24 +- classes/class_directionallight.rst | 16 +- classes/class_editorfiledialog.rst | 28 +- classes/class_editorplugin.rst | 44 +- classes/class_environment.rst | 20 +- classes/class_file.rst | 24 +- classes/class_filedialog.rst | 20 +- classes/class_font.rst | 2 +- classes/class_generic6dofjoint.rst | 36 +- classes/class_geometryinstance.rst | 22 +- classes/class_hingejoint.rst | 20 +- classes/class_httpclient.rst | 48 +- classes/class_image.rst | 104 +-- classes/class_inputevent.rst | 2 +- classes/class_inputeventgesture.rst | 2 +- classes/class_inputeventmouse.rst | 2 +- classes/class_inputeventwithmodifiers.rst | 2 +- classes/class_joint.rst | 2 +- classes/class_joint2d.rst | 2 +- classes/class_light.rst | 22 +- classes/class_line2d.rst | 20 +- classes/class_material.rst | 2 +- classes/class_mesh.rst | 66 +- classes/class_node.rst | 2 +- classes/class_node2d.rst | 2 +- classes/class_object.rst | 2 +- classes/class_omnilight.rst | 16 +- classes/class_os.rst | 104 +-- classes/class_packetpeer.rst | 2 +- classes/class_particlesmaterial.rst | 20 +- classes/class_physics2dserver.rst | 146 ++-- classes/class_physicsbody.rst | 2 +- classes/class_physicsbody2d.rst | 2 +- classes/class_physicsserver.rst | 430 +++++------ classes/class_popup.rst | 2 +- classes/class_primitivemesh.rst | 2 +- classes/class_range.rst | 2 +- classes/class_reference.rst | 2 +- classes/class_resource.rst | 2 +- classes/class_resourceformatloader.rst | 2 +- classes/class_resourceformatsaver.rst | 2 +- classes/class_richtextlabel.rst | 20 +- classes/class_rigidbody2d.rst | 20 +- classes/class_script.rst | 2 +- classes/class_shape.rst | 2 +- classes/class_shape2d.rst | 2 +- classes/class_spatial.rst | 2 +- classes/class_spatialmaterial.rst | 140 ++-- classes/class_spritebase3d.rst | 20 +- classes/class_streampeer.rst | 2 +- classes/class_stylebox.rst | 2 +- classes/class_tabs.rst | 24 +- classes/class_textedit.rst | 20 +- classes/class_texture.rst | 2 +- classes/class_texturelayered.rst | 2 +- classes/class_tilemap.rst | 20 +- classes/class_tileset.rst | 20 +- classes/class_tree.rst | 20 +- classes/class_tween.rst | 24 +- classes/class_videostream.rst | 2 +- classes/class_viewport.rst | 132 ++-- classes/class_visualinstance.rst | 2 +- classes/class_visualscriptnode.rst | 2 +- classes/class_visualserver.rst | 768 +++++++++---------- classes/class_visualshadernode.rst | 2 +- classes/class_visualshadernodeuniform.rst | 2 +- 95 files changed, 1936 insertions(+), 1936 deletions(-) diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index b4c3de70b..8dac0173c 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -64,437 +64,17 @@ Properties Enumerations ------------ -.. _enum_@GlobalScope_Variant.Operator: +.. _enum_@GlobalScope_Margin: -enum **Variant.Operator**: +enum **Margin**: -- **OP_EQUAL** = **0** +- **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. -- **OP_NOT_EQUAL** = **1** +- **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. -- **OP_LESS** = **2** +- **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. -- **OP_LESS_EQUAL** = **3** - -- **OP_GREATER** = **4** - -- **OP_GREATER_EQUAL** = **5** - -- **OP_ADD** = **6** - -- **OP_SUBTRACT** = **7** - -- **OP_MULTIPLY** = **8** - -- **OP_DIVIDE** = **9** - -- **OP_NEGATE** = **10** - -- **OP_POSITIVE** = **11** - -- **OP_MODULE** = **12** - -- **OP_STRING_CONCAT** = **13** - -- **OP_SHIFT_LEFT** = **14** - -- **OP_SHIFT_RIGHT** = **15** - -- **OP_BIT_AND** = **16** - -- **OP_BIT_OR** = **17** - -- **OP_BIT_XOR** = **18** - -- **OP_BIT_NEGATE** = **19** - -- **OP_AND** = **20** - -- **OP_OR** = **21** - -- **OP_XOR** = **22** - -- **OP_NOT** = **23** - -- **OP_IN** = **24** - -- **OP_MAX** = **25** - -.. _enum_@GlobalScope_MethodFlags: - -enum **MethodFlags**: - -- **METHOD_FLAG_NORMAL** = **1** --- Flag for normal method - -- **METHOD_FLAG_EDITOR** = **2** --- Flag for editor method - -- **METHOD_FLAG_NOSCRIPT** = **4** - -- **METHOD_FLAG_CONST** = **8** --- Flag for constant method - -- **METHOD_FLAG_REVERSE** = **16** - -- **METHOD_FLAG_VIRTUAL** = **32** --- Flag for virtual method - -- **METHOD_FLAG_FROM_SCRIPT** = **64** --- Flag for method from script - -- **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags - -.. _enum_@GlobalScope_Orientation: - -enum **Orientation**: - -- **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. - -- **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. - -.. _enum_@GlobalScope_PropertyUsageFlags: - -enum **PropertyUsageFlags**: - -- **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default). - -- **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default). - -- **PROPERTY_USAGE_NETWORK** = **4** - -- **PROPERTY_USAGE_EDITOR_HELPER** = **8** - -- **PROPERTY_USAGE_CHECKABLE** = **16** - -- **PROPERTY_USAGE_CHECKED** = **32** - -- **PROPERTY_USAGE_INTERNATIONALIZED** = **64** - -- **PROPERTY_USAGE_GROUP** = **128** - -- **PROPERTY_USAGE_CATEGORY** = **256** - -- **PROPERTY_USAGE_NO_INSTANCE_STATE** = **2048** - -- **PROPERTY_USAGE_RESTART_IF_CHANGED** = **4096** - -- **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192** - -- **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor). - -- **PROPERTY_USAGE_DEFAULT_INTL** = **71** - -- **PROPERTY_USAGE_NOEDITOR** = **5** - -.. _enum_@GlobalScope_JoystickList: - -enum **JoystickList**: - -- **JOY_BUTTON_0** = **0** --- Joypad Button 0 - -- **JOY_BUTTON_1** = **1** --- Joypad Button 1 - -- **JOY_BUTTON_2** = **2** --- Joypad Button 2 - -- **JOY_BUTTON_3** = **3** --- Joypad Button 3 - -- **JOY_BUTTON_4** = **4** --- Joypad Button 4 - -- **JOY_BUTTON_5** = **5** --- Joypad Button 5 - -- **JOY_BUTTON_6** = **6** --- Joypad Button 6 - -- **JOY_BUTTON_7** = **7** --- Joypad Button 7 - -- **JOY_BUTTON_8** = **8** --- Joypad Button 8 - -- **JOY_BUTTON_9** = **9** --- Joypad Button 9 - -- **JOY_BUTTON_10** = **10** --- Joypad Button 10 - -- **JOY_BUTTON_11** = **11** --- Joypad Button 11 - -- **JOY_BUTTON_12** = **12** --- Joypad Button 12 - -- **JOY_BUTTON_13** = **13** --- Joypad Button 13 - -- **JOY_BUTTON_14** = **14** --- Joypad Button 14 - -- **JOY_BUTTON_15** = **15** --- Joypad Button 15 - -- **JOY_BUTTON_MAX** = **16** --- Joypad Button 16 - -- **JOY_SONY_CIRCLE** = **1** --- DUALSHOCK circle button - -- **JOY_SONY_X** = **0** --- DUALSHOCK X button - -- **JOY_SONY_SQUARE** = **2** --- DUALSHOCK square button - -- **JOY_SONY_TRIANGLE** = **3** --- DUALSHOCK triangle button - -- **JOY_XBOX_B** = **1** --- XBOX controller B button - -- **JOY_XBOX_A** = **0** --- XBOX controller A button - -- **JOY_XBOX_X** = **2** --- XBOX controller X button - -- **JOY_XBOX_Y** = **3** --- XBOX controller Y button - -- **JOY_DS_A** = **1** --- DualShock controller A button - -- **JOY_DS_B** = **0** --- DualShock controller B button - -- **JOY_DS_X** = **3** --- DualShock controller X button - -- **JOY_DS_Y** = **2** --- DualShock controller Y button - -- **JOY_SELECT** = **10** --- Joypad Button Select - -- **JOY_START** = **11** --- Joypad Button Start - -- **JOY_DPAD_UP** = **12** --- Joypad DPad Up - -- **JOY_DPAD_DOWN** = **13** --- Joypad DPad Down - -- **JOY_DPAD_LEFT** = **14** --- Joypad DPad Left - -- **JOY_DPAD_RIGHT** = **15** --- Joypad DPad Right - -- **JOY_L** = **4** --- Joypad Left Shoulder Button - -- **JOY_L2** = **6** --- Joypad Left Trigger - -- **JOY_L3** = **8** --- Joypad Left Stick Click - -- **JOY_R** = **5** --- Joypad Right Shoulder Button - -- **JOY_R2** = **7** --- Joypad Right Trigger - -- **JOY_R3** = **9** --- Joypad Right Stick Click - -- **JOY_AXIS_0** = **0** --- Joypad Left Stick Horizontal Axis - -- **JOY_AXIS_1** = **1** --- Joypad Left Stick Vertical Axis - -- **JOY_AXIS_2** = **2** --- Joypad Right Stick Horizontal Axis - -- **JOY_AXIS_3** = **3** --- Joypad Right Stick Vertical Axis - -- **JOY_AXIS_4** = **4** - -- **JOY_AXIS_5** = **5** - -- **JOY_AXIS_6** = **6** --- Joypad Left Trigger Analog Axis - -- **JOY_AXIS_7** = **7** --- Joypad Right Trigger Analog Axis - -- **JOY_AXIS_8** = **8** - -- **JOY_AXIS_9** = **9** - -- **JOY_AXIS_MAX** = **10** - -- **JOY_ANALOG_LX** = **0** --- Joypad Left Stick Horizontal Axis - -- **JOY_ANALOG_LY** = **1** --- Joypad Left Stick Vertical Axis - -- **JOY_ANALOG_RX** = **2** --- Joypad Right Stick Horizontal Axis - -- **JOY_ANALOG_RY** = **3** --- Joypad Right Stick Vertical Axis - -- **JOY_ANALOG_L2** = **6** --- Joypad Left Analog Trigger - -- **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger - -.. _enum_@GlobalScope_MidiMessageList: - -enum **MidiMessageList**: - -- **MIDI_MESSAGE_NOTE_OFF** = **8** - -- **MIDI_MESSAGE_NOTE_ON** = **9** - -- **MIDI_MESSAGE_AFTERTOUCH** = **10** - -- **MIDI_MESSAGE_CONTROL_CHANGE** = **11** - -- **MIDI_MESSAGE_PROGRAM_CHANGE** = **12** - -- **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13** - -- **MIDI_MESSAGE_PITCH_BEND** = **14** - -.. _enum_@GlobalScope_KeyModifierMask: - -enum **KeyModifierMask**: - -- **KEY_CODE_MASK** = **33554431** --- Key Code Mask - -- **KEY_MODIFIER_MASK** = **-16777216** --- Modifier Key Mask - -- **KEY_MASK_SHIFT** = **33554432** --- Shift Key Mask - -- **KEY_MASK_ALT** = **67108864** --- Alt Key Mask - -- **KEY_MASK_META** = **134217728** --- Meta Key Mask - -- **KEY_MASK_CTRL** = **268435456** --- CTRL Key Mask - -- **KEY_MASK_CMD** = **268435456** --- CMD Key Mask - -- **KEY_MASK_KPAD** = **536870912** --- Keypad Key Mask - -- **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask - -.. _enum_@GlobalScope_HAlign: - -enum **HAlign**: - -- **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes. - -- **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes. - -- **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes. - -.. _enum_@GlobalScope_Error: - -enum **Error**: - -- **OK** = **0** --- Functions that return Error return OK when no error occurred. Most functions don't return errors and/or just print errors to STDOUT. - -- **FAILED** = **1** --- Generic error. - -- **ERR_UNAVAILABLE** = **2** --- Unavailable error - -- **ERR_UNCONFIGURED** = **3** --- Unconfigured error - -- **ERR_UNAUTHORIZED** = **4** --- Unauthorized error - -- **ERR_PARAMETER_RANGE_ERROR** = **5** --- Parameter range error - -- **ERR_OUT_OF_MEMORY** = **6** --- Out of memory (OOM) error - -- **ERR_FILE_NOT_FOUND** = **7** --- File: Not found error - -- **ERR_FILE_BAD_DRIVE** = **8** --- File: Bad drive error - -- **ERR_FILE_BAD_PATH** = **9** --- File: Bad path error - -- **ERR_FILE_NO_PERMISSION** = **10** --- File: No permission error - -- **ERR_FILE_ALREADY_IN_USE** = **11** --- File: Already in use error - -- **ERR_FILE_CANT_OPEN** = **12** --- File: Can't open error - -- **ERR_FILE_CANT_WRITE** = **13** --- File: Can't write error - -- **ERR_FILE_CANT_READ** = **14** --- File: Can't read error - -- **ERR_FILE_UNRECOGNIZED** = **15** --- File: Unrecognized error - -- **ERR_FILE_CORRUPT** = **16** --- File: Corrupt error - -- **ERR_FILE_MISSING_DEPENDENCIES** = **17** --- File: Missing dependencies error - -- **ERR_FILE_EOF** = **18** --- File: End of file (EOF) error - -- **ERR_CANT_OPEN** = **19** --- Can't open error - -- **ERR_CANT_CREATE** = **20** --- Can't create error - -- **ERR_PARSE_ERROR** = **43** --- Parse error - -- **ERR_QUERY_FAILED** = **21** --- Query failed error - -- **ERR_ALREADY_IN_USE** = **22** --- Already in use error - -- **ERR_LOCKED** = **23** --- Locked error - -- **ERR_TIMEOUT** = **24** --- Timeout error - -- **ERR_CANT_ACQUIRE_RESOURCE** = **28** --- Can't acquire resource error - -- **ERR_INVALID_DATA** = **30** --- Invalid data error - -- **ERR_INVALID_PARAMETER** = **31** --- Invalid parameter error - -- **ERR_ALREADY_EXISTS** = **32** --- Already exists error - -- **ERR_DOES_NOT_EXIST** = **33** --- Does not exist error - -- **ERR_DATABASE_CANT_READ** = **34** --- Database: Read error - -- **ERR_DATABASE_CANT_WRITE** = **35** --- Database: Write error - -- **ERR_COMPILATION_FAILED** = **36** --- Compilation failed error - -- **ERR_METHOD_NOT_FOUND** = **37** --- Method not found error - -- **ERR_LINK_FAILED** = **38** --- Linking failed error - -- **ERR_SCRIPT_FAILED** = **39** --- Script failed error - -- **ERR_CYCLIC_LINK** = **40** --- Cycling link (import cycle) error - -- **ERR_BUSY** = **44** --- Busy error - -- **ERR_HELP** = **46** --- Help error - -- **ERR_BUG** = **47** --- Bug error - -.. _enum_@GlobalScope_VAlign: - -enum **VAlign**: - -- **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes. - -- **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes. - -- **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes. - -.. _enum_@GlobalScope_PropertyHint: - -enum **PropertyHint**: - -- **PROPERTY_HINT_NONE** = **0** --- No hint for edited property. - -- **PROPERTY_HINT_RANGE** = **1** --- Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats. - -- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. - -- **PROPERTY_HINT_ENUM** = **3** --- Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties. - -- **PROPERTY_HINT_EXP_EASING** = **4** - -- **PROPERTY_HINT_LENGTH** = **5** - -- **PROPERTY_HINT_KEY_ACCEL** = **7** - -- **PROPERTY_HINT_FLAGS** = **8** --- Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. - -- **PROPERTY_HINT_LAYERS_2D_RENDER** = **9** - -- **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10** - -- **PROPERTY_HINT_LAYERS_3D_RENDER** = **11** - -- **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12** - -- **PROPERTY_HINT_FILE** = **13** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "\*.doc". - -- **PROPERTY_HINT_DIR** = **14** --- String property is a directory (so pop up a file dialog when edited). - -- **PROPERTY_HINT_GLOBAL_FILE** = **15** - -- **PROPERTY_HINT_GLOBAL_DIR** = **16** - -- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- String property is a resource, so open the resource popup menu when edited. - -- **PROPERTY_HINT_MULTILINE_TEXT** = **18** - -- **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19** - -- **PROPERTY_HINT_COLOR_NO_ALPHA** = **20** - -- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that the image is compressed using lossy compression. - -- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that the image is compressed using lossless compression. +- **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. .. _enum_@GlobalScope_Corner: @@ -508,6 +88,34 @@ enum **Corner**: - **CORNER_BOTTOM_LEFT** = **3** +.. _enum_@GlobalScope_Orientation: + +enum **Orientation**: + +- **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. + +- **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. + +.. _enum_@GlobalScope_HAlign: + +enum **HAlign**: + +- **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes. + +- **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes. + +- **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes. + +.. _enum_@GlobalScope_VAlign: + +enum **VAlign**: + +- **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes. + +- **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes. + +- **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes. + .. _enum_@GlobalScope_KeyList: enum **KeyList**: @@ -996,6 +604,386 @@ enum **KeyList**: - **KEY_YDIAERESIS** = **255** --- ΓΏ key +.. _enum_@GlobalScope_KeyModifierMask: + +enum **KeyModifierMask**: + +- **KEY_CODE_MASK** = **33554431** --- Key Code Mask + +- **KEY_MODIFIER_MASK** = **-16777216** --- Modifier Key Mask + +- **KEY_MASK_SHIFT** = **33554432** --- Shift Key Mask + +- **KEY_MASK_ALT** = **67108864** --- Alt Key Mask + +- **KEY_MASK_META** = **134217728** --- Meta Key Mask + +- **KEY_MASK_CTRL** = **268435456** --- CTRL Key Mask + +- **KEY_MASK_CMD** = **268435456** --- CMD Key Mask + +- **KEY_MASK_KPAD** = **536870912** --- Keypad Key Mask + +- **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask + +.. _enum_@GlobalScope_ButtonList: + +enum **ButtonList**: + +- **BUTTON_LEFT** = **1** --- Left Mouse Button + +- **BUTTON_RIGHT** = **2** --- Right Mouse Button + +- **BUTTON_MIDDLE** = **3** --- Middle Mouse Button + +- **BUTTON_XBUTTON1** = **8** --- Extra Mouse Button 1 + +- **BUTTON_XBUTTON2** = **9** --- Extra Mouse Button 2 + +- **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up + +- **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down + +- **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button + +- **BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button + +- **BUTTON_MASK_LEFT** = **1** --- Left Mouse Button Mask + +- **BUTTON_MASK_RIGHT** = **2** --- Right Mouse Button Mask + +- **BUTTON_MASK_MIDDLE** = **4** --- Middle Mouse Button Mask + +- **BUTTON_MASK_XBUTTON1** = **128** --- Extra Mouse Button 1 Mask + +- **BUTTON_MASK_XBUTTON2** = **256** --- Extra Mouse Button 2 Mask + +.. _enum_@GlobalScope_JoystickList: + +enum **JoystickList**: + +- **JOY_BUTTON_0** = **0** --- Joypad Button 0 + +- **JOY_BUTTON_1** = **1** --- Joypad Button 1 + +- **JOY_BUTTON_2** = **2** --- Joypad Button 2 + +- **JOY_BUTTON_3** = **3** --- Joypad Button 3 + +- **JOY_BUTTON_4** = **4** --- Joypad Button 4 + +- **JOY_BUTTON_5** = **5** --- Joypad Button 5 + +- **JOY_BUTTON_6** = **6** --- Joypad Button 6 + +- **JOY_BUTTON_7** = **7** --- Joypad Button 7 + +- **JOY_BUTTON_8** = **8** --- Joypad Button 8 + +- **JOY_BUTTON_9** = **9** --- Joypad Button 9 + +- **JOY_BUTTON_10** = **10** --- Joypad Button 10 + +- **JOY_BUTTON_11** = **11** --- Joypad Button 11 + +- **JOY_BUTTON_12** = **12** --- Joypad Button 12 + +- **JOY_BUTTON_13** = **13** --- Joypad Button 13 + +- **JOY_BUTTON_14** = **14** --- Joypad Button 14 + +- **JOY_BUTTON_15** = **15** --- Joypad Button 15 + +- **JOY_BUTTON_MAX** = **16** --- Joypad Button 16 + +- **JOY_SONY_CIRCLE** = **1** --- DUALSHOCK circle button + +- **JOY_SONY_X** = **0** --- DUALSHOCK X button + +- **JOY_SONY_SQUARE** = **2** --- DUALSHOCK square button + +- **JOY_SONY_TRIANGLE** = **3** --- DUALSHOCK triangle button + +- **JOY_XBOX_B** = **1** --- XBOX controller B button + +- **JOY_XBOX_A** = **0** --- XBOX controller A button + +- **JOY_XBOX_X** = **2** --- XBOX controller X button + +- **JOY_XBOX_Y** = **3** --- XBOX controller Y button + +- **JOY_DS_A** = **1** --- DualShock controller A button + +- **JOY_DS_B** = **0** --- DualShock controller B button + +- **JOY_DS_X** = **3** --- DualShock controller X button + +- **JOY_DS_Y** = **2** --- DualShock controller Y button + +- **JOY_SELECT** = **10** --- Joypad Button Select + +- **JOY_START** = **11** --- Joypad Button Start + +- **JOY_DPAD_UP** = **12** --- Joypad DPad Up + +- **JOY_DPAD_DOWN** = **13** --- Joypad DPad Down + +- **JOY_DPAD_LEFT** = **14** --- Joypad DPad Left + +- **JOY_DPAD_RIGHT** = **15** --- Joypad DPad Right + +- **JOY_L** = **4** --- Joypad Left Shoulder Button + +- **JOY_L2** = **6** --- Joypad Left Trigger + +- **JOY_L3** = **8** --- Joypad Left Stick Click + +- **JOY_R** = **5** --- Joypad Right Shoulder Button + +- **JOY_R2** = **7** --- Joypad Right Trigger + +- **JOY_R3** = **9** --- Joypad Right Stick Click + +- **JOY_AXIS_0** = **0** --- Joypad Left Stick Horizontal Axis + +- **JOY_AXIS_1** = **1** --- Joypad Left Stick Vertical Axis + +- **JOY_AXIS_2** = **2** --- Joypad Right Stick Horizontal Axis + +- **JOY_AXIS_3** = **3** --- Joypad Right Stick Vertical Axis + +- **JOY_AXIS_4** = **4** + +- **JOY_AXIS_5** = **5** + +- **JOY_AXIS_6** = **6** --- Joypad Left Trigger Analog Axis + +- **JOY_AXIS_7** = **7** --- Joypad Right Trigger Analog Axis + +- **JOY_AXIS_8** = **8** + +- **JOY_AXIS_9** = **9** + +- **JOY_AXIS_MAX** = **10** + +- **JOY_ANALOG_LX** = **0** --- Joypad Left Stick Horizontal Axis + +- **JOY_ANALOG_LY** = **1** --- Joypad Left Stick Vertical Axis + +- **JOY_ANALOG_RX** = **2** --- Joypad Right Stick Horizontal Axis + +- **JOY_ANALOG_RY** = **3** --- Joypad Right Stick Vertical Axis + +- **JOY_ANALOG_L2** = **6** --- Joypad Left Analog Trigger + +- **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger + +.. _enum_@GlobalScope_MidiMessageList: + +enum **MidiMessageList**: + +- **MIDI_MESSAGE_NOTE_OFF** = **8** + +- **MIDI_MESSAGE_NOTE_ON** = **9** + +- **MIDI_MESSAGE_AFTERTOUCH** = **10** + +- **MIDI_MESSAGE_CONTROL_CHANGE** = **11** + +- **MIDI_MESSAGE_PROGRAM_CHANGE** = **12** + +- **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13** + +- **MIDI_MESSAGE_PITCH_BEND** = **14** + +.. _enum_@GlobalScope_Error: + +enum **Error**: + +- **OK** = **0** --- Functions that return Error return OK when no error occurred. Most functions don't return errors and/or just print errors to STDOUT. + +- **FAILED** = **1** --- Generic error. + +- **ERR_UNAVAILABLE** = **2** --- Unavailable error + +- **ERR_UNCONFIGURED** = **3** --- Unconfigured error + +- **ERR_UNAUTHORIZED** = **4** --- Unauthorized error + +- **ERR_PARAMETER_RANGE_ERROR** = **5** --- Parameter range error + +- **ERR_OUT_OF_MEMORY** = **6** --- Out of memory (OOM) error + +- **ERR_FILE_NOT_FOUND** = **7** --- File: Not found error + +- **ERR_FILE_BAD_DRIVE** = **8** --- File: Bad drive error + +- **ERR_FILE_BAD_PATH** = **9** --- File: Bad path error + +- **ERR_FILE_NO_PERMISSION** = **10** --- File: No permission error + +- **ERR_FILE_ALREADY_IN_USE** = **11** --- File: Already in use error + +- **ERR_FILE_CANT_OPEN** = **12** --- File: Can't open error + +- **ERR_FILE_CANT_WRITE** = **13** --- File: Can't write error + +- **ERR_FILE_CANT_READ** = **14** --- File: Can't read error + +- **ERR_FILE_UNRECOGNIZED** = **15** --- File: Unrecognized error + +- **ERR_FILE_CORRUPT** = **16** --- File: Corrupt error + +- **ERR_FILE_MISSING_DEPENDENCIES** = **17** --- File: Missing dependencies error + +- **ERR_FILE_EOF** = **18** --- File: End of file (EOF) error + +- **ERR_CANT_OPEN** = **19** --- Can't open error + +- **ERR_CANT_CREATE** = **20** --- Can't create error + +- **ERR_PARSE_ERROR** = **43** --- Parse error + +- **ERR_QUERY_FAILED** = **21** --- Query failed error + +- **ERR_ALREADY_IN_USE** = **22** --- Already in use error + +- **ERR_LOCKED** = **23** --- Locked error + +- **ERR_TIMEOUT** = **24** --- Timeout error + +- **ERR_CANT_ACQUIRE_RESOURCE** = **28** --- Can't acquire resource error + +- **ERR_INVALID_DATA** = **30** --- Invalid data error + +- **ERR_INVALID_PARAMETER** = **31** --- Invalid parameter error + +- **ERR_ALREADY_EXISTS** = **32** --- Already exists error + +- **ERR_DOES_NOT_EXIST** = **33** --- Does not exist error + +- **ERR_DATABASE_CANT_READ** = **34** --- Database: Read error + +- **ERR_DATABASE_CANT_WRITE** = **35** --- Database: Write error + +- **ERR_COMPILATION_FAILED** = **36** --- Compilation failed error + +- **ERR_METHOD_NOT_FOUND** = **37** --- Method not found error + +- **ERR_LINK_FAILED** = **38** --- Linking failed error + +- **ERR_SCRIPT_FAILED** = **39** --- Script failed error + +- **ERR_CYCLIC_LINK** = **40** --- Cycling link (import cycle) error + +- **ERR_BUSY** = **44** --- Busy error + +- **ERR_HELP** = **46** --- Help error + +- **ERR_BUG** = **47** --- Bug error + +.. _enum_@GlobalScope_PropertyHint: + +enum **PropertyHint**: + +- **PROPERTY_HINT_NONE** = **0** --- No hint for edited property. + +- **PROPERTY_HINT_RANGE** = **1** --- Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats. + +- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. + +- **PROPERTY_HINT_ENUM** = **3** --- Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties. + +- **PROPERTY_HINT_EXP_EASING** = **4** + +- **PROPERTY_HINT_LENGTH** = **5** + +- **PROPERTY_HINT_KEY_ACCEL** = **7** + +- **PROPERTY_HINT_FLAGS** = **8** --- Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. + +- **PROPERTY_HINT_LAYERS_2D_RENDER** = **9** + +- **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10** + +- **PROPERTY_HINT_LAYERS_3D_RENDER** = **11** + +- **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12** + +- **PROPERTY_HINT_FILE** = **13** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "\*.doc". + +- **PROPERTY_HINT_DIR** = **14** --- String property is a directory (so pop up a file dialog when edited). + +- **PROPERTY_HINT_GLOBAL_FILE** = **15** + +- **PROPERTY_HINT_GLOBAL_DIR** = **16** + +- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- String property is a resource, so open the resource popup menu when edited. + +- **PROPERTY_HINT_MULTILINE_TEXT** = **18** + +- **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19** + +- **PROPERTY_HINT_COLOR_NO_ALPHA** = **20** + +- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that the image is compressed using lossy compression. + +- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that the image is compressed using lossless compression. + +.. _enum_@GlobalScope_PropertyUsageFlags: + +enum **PropertyUsageFlags**: + +- **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default). + +- **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default). + +- **PROPERTY_USAGE_NETWORK** = **4** + +- **PROPERTY_USAGE_EDITOR_HELPER** = **8** + +- **PROPERTY_USAGE_CHECKABLE** = **16** + +- **PROPERTY_USAGE_CHECKED** = **32** + +- **PROPERTY_USAGE_INTERNATIONALIZED** = **64** + +- **PROPERTY_USAGE_GROUP** = **128** + +- **PROPERTY_USAGE_CATEGORY** = **256** + +- **PROPERTY_USAGE_NO_INSTANCE_STATE** = **2048** + +- **PROPERTY_USAGE_RESTART_IF_CHANGED** = **4096** + +- **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192** + +- **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor). + +- **PROPERTY_USAGE_DEFAULT_INTL** = **71** + +- **PROPERTY_USAGE_NOEDITOR** = **5** + +.. _enum_@GlobalScope_MethodFlags: + +enum **MethodFlags**: + +- **METHOD_FLAG_NORMAL** = **1** --- Flag for normal method + +- **METHOD_FLAG_EDITOR** = **2** --- Flag for editor method + +- **METHOD_FLAG_NOSCRIPT** = **4** + +- **METHOD_FLAG_CONST** = **8** --- Flag for constant method + +- **METHOD_FLAG_REVERSE** = **16** + +- **METHOD_FLAG_VIRTUAL** = **32** --- Flag for virtual method + +- **METHOD_FLAG_FROM_SCRIPT** = **64** --- Flag for method from script + +- **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags + .. _enum_@GlobalScope_Variant.Type: enum **Variant.Type**: @@ -1056,49 +1044,61 @@ enum **Variant.Type**: - **TYPE_MAX** = **27** --- Marker for end of type constants. -.. _enum_@GlobalScope_Margin: +.. _enum_@GlobalScope_Variant.Operator: -enum **Margin**: +enum **Variant.Operator**: -- **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. +- **OP_EQUAL** = **0** -- **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. +- **OP_NOT_EQUAL** = **1** -- **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. +- **OP_LESS** = **2** -- **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. +- **OP_LESS_EQUAL** = **3** -.. _enum_@GlobalScope_ButtonList: +- **OP_GREATER** = **4** -enum **ButtonList**: +- **OP_GREATER_EQUAL** = **5** -- **BUTTON_LEFT** = **1** --- Left Mouse Button +- **OP_ADD** = **6** -- **BUTTON_RIGHT** = **2** --- Right Mouse Button +- **OP_SUBTRACT** = **7** -- **BUTTON_MIDDLE** = **3** --- Middle Mouse Button +- **OP_MULTIPLY** = **8** -- **BUTTON_XBUTTON1** = **8** --- Extra Mouse Button 1 +- **OP_DIVIDE** = **9** -- **BUTTON_XBUTTON2** = **9** --- Extra Mouse Button 2 +- **OP_NEGATE** = **10** -- **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up +- **OP_POSITIVE** = **11** -- **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down +- **OP_MODULE** = **12** -- **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button +- **OP_STRING_CONCAT** = **13** -- **BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button +- **OP_SHIFT_LEFT** = **14** -- **BUTTON_MASK_LEFT** = **1** --- Left Mouse Button Mask +- **OP_SHIFT_RIGHT** = **15** -- **BUTTON_MASK_RIGHT** = **2** --- Right Mouse Button Mask +- **OP_BIT_AND** = **16** -- **BUTTON_MASK_MIDDLE** = **4** --- Middle Mouse Button Mask +- **OP_BIT_OR** = **17** -- **BUTTON_MASK_XBUTTON1** = **128** --- Extra Mouse Button 1 Mask +- **OP_BIT_XOR** = **18** -- **BUTTON_MASK_XBUTTON2** = **256** --- Extra Mouse Button 2 Mask +- **OP_BIT_NEGATE** = **19** + +- **OP_AND** = **20** + +- **OP_OR** = **21** + +- **OP_XOR** = **22** + +- **OP_NOT** = **23** + +- **OP_IN** = **24** + +- **OP_MAX** = **25** Constants --------- diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 2236c665a..48cd2b915 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -147,28 +147,6 @@ Methods Enumerations ------------ -.. _enum_Animation_UpdateMode: - -enum **UpdateMode**: - -- **UPDATE_CONTINUOUS** = **0** --- Update between keyframes. - -- **UPDATE_DISCRETE** = **1** --- Update at the keyframes and hold the value. - -- **UPDATE_TRIGGER** = **2** --- Update at the keyframes. - -- **UPDATE_CAPTURE** = **3** - -.. _enum_Animation_InterpolationType: - -enum **InterpolationType**: - -- **INTERPOLATION_NEAREST** = **0** --- No interpolation (nearest value). - -- **INTERPOLATION_LINEAR** = **1** --- Linear interpolation. - -- **INTERPOLATION_CUBIC** = **2** --- Cubic interpolation. - .. _enum_Animation_TrackType: enum **TrackType**: @@ -185,6 +163,28 @@ enum **TrackType**: - **TYPE_ANIMATION** = **5** +.. _enum_Animation_InterpolationType: + +enum **InterpolationType**: + +- **INTERPOLATION_NEAREST** = **0** --- No interpolation (nearest value). + +- **INTERPOLATION_LINEAR** = **1** --- Linear interpolation. + +- **INTERPOLATION_CUBIC** = **2** --- Cubic interpolation. + +.. _enum_Animation_UpdateMode: + +enum **UpdateMode**: + +- **UPDATE_CONTINUOUS** = **0** --- Update between keyframes. + +- **UPDATE_DISCRETE** = **1** --- Update at the keyframes and hold the value. + +- **UPDATE_TRIGGER** = **2** --- Update at the keyframes. + +- **UPDATE_CAPTURE** = **3** + Description ----------- diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index f7c5edef5..607d105c5 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -9,7 +9,7 @@ AnimationNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AnimationNodeAdd2`, :ref:`AnimationNodeAdd3`, :ref:`AnimationNodeTimeScale`, :ref:`AnimationRootNode`, :ref:`AnimationNodeBlend2`, :ref:`AnimationNodeBlend3`, :ref:`AnimationNodeTimeSeek`, :ref:`AnimationNodeOneShot`, :ref:`AnimationNodeTransition`, :ref:`AnimationNodeOutput` +**Inherited By:** :ref:`AnimationNodeAdd2`, :ref:`AnimationNodeAdd3`, :ref:`AnimationNodeBlend2`, :ref:`AnimationNodeBlend3`, :ref:`AnimationNodeOneShot`, :ref:`AnimationNodeOutput`, :ref:`AnimationNodeTimeScale`, :ref:`AnimationNodeTimeSeek`, :ref:`AnimationNodeTransition`, :ref:`AnimationRootNode` **Category:** Core diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index 6c4bda15f..e94f78ccd 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -9,7 +9,7 @@ AnimationRootNode **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AnimationNodeAnimation`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendTree` +**Inherited By:** :ref:`AnimationNodeAnimation`, :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeBlendTree`, :ref:`AnimationNodeStateMachine` **Category:** Core diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index fbdc4a083..f6d9307ed 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -151,14 +151,6 @@ Methods Enumerations ------------ -.. _enum_AnimationTreePlayer_AnimationProcessMode: - -enum **AnimationProcessMode**: - -- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. - -- **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process. - .. _enum_AnimationTreePlayer_NodeType: enum **NodeType**: @@ -183,6 +175,14 @@ enum **NodeType**: - **NODE_TRANSITION** = **9** --- Transition node. +.. _enum_AnimationTreePlayer_AnimationProcessMode: + +enum **AnimationProcessMode**: + +- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. + +- **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process. + Description ----------- diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 4d46aa117..d5feeb2b2 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -69,28 +69,6 @@ Methods Enumerations ------------ -.. _enum_ArrayMesh_ArrayFormat: - -enum **ArrayFormat**: - -- **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory). - -- **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals - -- **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents - -- **ARRAY_FORMAT_COLOR** = **8** --- Array format will include a color array. - -- **ARRAY_FORMAT_TEX_UV** = **16** --- Array format will include UVs. - -- **ARRAY_FORMAT_TEX_UV2** = **32** --- Array format will include another set of UVs. - -- **ARRAY_FORMAT_BONES** = **64** --- Array format will include bone indices. - -- **ARRAY_FORMAT_WEIGHTS** = **128** --- Array format will include bone weights. - -- **ARRAY_FORMAT_INDEX** = **256** --- Index array will be used. - .. _enum_ArrayMesh_ArrayType: enum **ArrayType**: @@ -117,6 +95,28 @@ For triangles, the index array is interpreted as triples, referring to the verti - **ARRAY_MAX** = **9** +.. _enum_ArrayMesh_ArrayFormat: + +enum **ArrayFormat**: + +- **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory). + +- **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals + +- **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents + +- **ARRAY_FORMAT_COLOR** = **8** --- Array format will include a color array. + +- **ARRAY_FORMAT_TEX_UV** = **16** --- Array format will include UVs. + +- **ARRAY_FORMAT_TEX_UV2** = **32** --- Array format will include another set of UVs. + +- **ARRAY_FORMAT_BONES** = **64** --- Array format will include bone indices. + +- **ARRAY_FORMAT_WEIGHTS** = **128** --- Array format will include bone weights. + +- **ARRAY_FORMAT_INDEX** = **256** --- Index array will be used. + Constants --------- diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index ca671d6e6..7c9c4afea 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -51,6 +51,20 @@ Methods Enumerations ------------ +.. _enum_ARVRInterface_Capabilities: + +enum **Capabilities**: + +- **ARVR_NONE** = **0** --- No ARVR capabilities. + +- **ARVR_MONO** = **1** --- This interface can work with normal rendering output (non-HMD based AR). + +- **ARVR_STEREO** = **2** --- This interface supports stereoscopic rendering. + +- **ARVR_AR** = **4** --- This interface support AR (video background and real world tracking). + +- **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes. + .. _enum_ARVRInterface_Eyes: enum **Eyes**: @@ -75,20 +89,6 @@ enum **Tracking_status**: - **ARVR_NOT_TRACKING** = **4** --- Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.) -.. _enum_ARVRInterface_Capabilities: - -enum **Capabilities**: - -- **ARVR_NONE** = **0** --- No ARVR capabilities. - -- **ARVR_MONO** = **1** --- This interface can work with normal rendering output (non-HMD based AR). - -- **ARVR_STEREO** = **2** --- This interface supports stereoscopic rendering. - -- **ARVR_AR** = **4** --- This interface support AR (video background and real world tracking). - -- **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes. - Description ----------- diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index f53a988f4..bc4de6bdc 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -84,16 +84,6 @@ Signal send when a tracker is removed, you should remove any ARVRController or A Enumerations ------------ -.. _enum_ARVRServer_RotationMode: - -enum **RotationMode**: - -- **RESET_FULL_ROTATION** = **0** --- Fully reset the orientation of the HMD. Regardless of what direction the user is looking to in the real world. The user will look dead ahead in the virtual world. - -- **RESET_BUT_KEEP_TILT** = **1** --- Resets the orientation but keeps the tilt of the device. So if we're looking down, we keep looking down but heading will be reset. - -- **DONT_RESET_ROTATION** = **2** --- Does not reset the orientation of the HMD, only the position of the player gets centered. - .. _enum_ARVRServer_TrackerType: enum **TrackerType**: @@ -110,6 +100,16 @@ enum **TrackerType**: - **TRACKER_ANY** = **255** --- Used internally to select all trackers. +.. _enum_ARVRServer_RotationMode: + +enum **RotationMode**: + +- **RESET_FULL_ROTATION** = **0** --- Fully reset the orientation of the HMD. Regardless of what direction the user is looking to in the real world. The user will look dead ahead in the virtual world. + +- **RESET_BUT_KEEP_TILT** = **1** --- Resets the orientation but keeps the tilt of the device. So if we're looking down, we keep looking down but heading will be reset. + +- **DONT_RESET_ROTATION** = **2** --- Does not reset the orientation of the HMD, only the position of the player gets centered. + Description ----------- diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 16cca9a0b..3a1ead4cb 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -9,7 +9,7 @@ AudioEffect **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectRecord`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectPhaser` +**Inherited By:** :ref:`AudioEffectAmplify`, :ref:`AudioEffectChorus`, :ref:`AudioEffectCompressor`, :ref:`AudioEffectDelay`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectEQ`, :ref:`AudioEffectFilter`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectPanner`, :ref:`AudioEffectPhaser`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectRecord`, :ref:`AudioEffectReverb`, :ref:`AudioEffectStereoEnhance` **Category:** Core diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index b74d8bbd2..215acbca7 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -9,7 +9,7 @@ AudioEffectEQ **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`, :ref:`AudioEffectEQ10` +**Inherited By:** :ref:`AudioEffectEQ10`, :ref:`AudioEffectEQ21`, :ref:`AudioEffectEQ6` **Category:** Core diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 6b7c0aa6c..31b27152f 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -9,7 +9,7 @@ AudioEffectFilter **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioEffectHighPassFilter`, :ref:`AudioEffectBandLimitFilter`, :ref:`AudioEffectLowShelfFilter`, :ref:`AudioEffectHighShelfFilter`, :ref:`AudioEffectBandPassFilter`, :ref:`AudioEffectNotchFilter`, :ref:`AudioEffectLowPassFilter` +**Inherited By:** :ref:`AudioEffectBandLimitFilter`, :ref:`AudioEffectBandPassFilter`, :ref:`AudioEffectHighPassFilter`, :ref:`AudioEffectHighShelfFilter`, :ref:`AudioEffectLowPassFilter`, :ref:`AudioEffectLowShelfFilter`, :ref:`AudioEffectNotchFilter` **Category:** Core diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index da446dd2a..f08e527d4 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -9,7 +9,7 @@ AudioStream **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioStreamMicrophone`, :ref:`AudioStreamSample`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamOGGVorbis` +**Inherited By:** :ref:`AudioStreamMicrophone`, :ref:`AudioStreamOGGVorbis`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamSample` **Category:** Core diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 51c57ccfb..dd2ed387e 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -84,24 +84,6 @@ Fires when the audio stops playing. Enumerations ------------ -.. _enum_AudioStreamPlayer3D_DopplerTracking: - -enum **DopplerTracking**: - -- **DOPPLER_TRACKING_DISABLED** = **0** --- Disables doppler tracking. - -- **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Executes doppler tracking in idle step. - -- **DOPPLER_TRACKING_PHYSICS_STEP** = **2** --- Executes doppler tracking in physics step. - -.. _enum_AudioStreamPlayer3D_OutOfRangeMode: - -enum **OutOfRangeMode**: - -- **OUT_OF_RANGE_MIX** = **0** --- Mix this audio in, even when it's out of range. - -- **OUT_OF_RANGE_PAUSE** = **1** --- Pause this audio when it gets out of range. - .. _enum_AudioStreamPlayer3D_AttenuationModel: enum **AttenuationModel**: @@ -112,6 +94,24 @@ enum **AttenuationModel**: - **ATTENUATION_LOGARITHMIC** = **2** --- Logarithmic dampening of loudness according to distance. +.. _enum_AudioStreamPlayer3D_OutOfRangeMode: + +enum **OutOfRangeMode**: + +- **OUT_OF_RANGE_MIX** = **0** --- Mix this audio in, even when it's out of range. + +- **OUT_OF_RANGE_PAUSE** = **1** --- Pause this audio when it gets out of range. + +.. _enum_AudioStreamPlayer3D_DopplerTracking: + +enum **DopplerTracking**: + +- **DOPPLER_TRACKING_DISABLED** = **0** --- Disables doppler tracking. + +- **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Executes doppler tracking in idle step. + +- **DOPPLER_TRACKING_PHYSICS_STEP** = **2** --- Executes doppler tracking in physics step. + Description ----------- diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 83c9cd866..712fa5dfe 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -45,6 +45,16 @@ Methods Enumerations ------------ +.. _enum_AudioStreamSample_Format: + +enum **Format**: + +- **FORMAT_8_BITS** = **0** --- Audio codec 8 bit. + +- **FORMAT_16_BITS** = **1** --- Audio codec 16 bit. + +- **FORMAT_IMA_ADPCM** = **2** --- Audio codec IMA ADPCM. + .. _enum_AudioStreamSample_LoopMode: enum **LoopMode**: @@ -57,16 +67,6 @@ enum **LoopMode**: - **LOOP_BACKWARD** = **3** --- Audio loops the data between loop_begin and loop_end playing backward only. -.. _enum_AudioStreamSample_Format: - -enum **Format**: - -- **FORMAT_8_BITS** = **0** --- Audio codec 8 bit. - -- **FORMAT_16_BITS** = **1** --- Audio codec 16 bit. - -- **FORMAT_IMA_ADPCM** = **2** --- Audio codec IMA ADPCM. - Description ----------- diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index bd9b2fc82..1d0b78391 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -63,6 +63,14 @@ enum **BakeQuality**: - **BAKE_QUALITY_HIGH** = **2** --- Highest bake quality mode. Takes longer to calculate. +.. _enum_BakedLightmap_BakeMode: + +enum **BakeMode**: + +- **BAKE_MODE_CONE_TRACE** = **0** --- Less precise but faster bake mode. + +- **BAKE_MODE_RAY_TRACE** = **1** --- More precise bake mode but can take considerably longer to bake. + .. _enum_BakedLightmap_BakeError: enum **BakeError**: @@ -77,14 +85,6 @@ enum **BakeError**: - **BAKE_ERROR_USER_ABORTED** = **4** -.. _enum_BakedLightmap_BakeMode: - -enum **BakeMode**: - -- **BAKE_MODE_CONE_TRACE** = **0** --- Less precise but faster bake mode. - -- **BAKE_MODE_RAY_TRACE** = **1** --- More precise bake mode but can take considerably longer to bake. - Description ----------- diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 4119cbbd3..8ce8cf0cb 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -9,7 +9,7 @@ BaseButton **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`LinkButton`, :ref:`TextureButton`, :ref:`Button` +**Inherited By:** :ref:`Button`, :ref:`LinkButton`, :ref:`TextureButton` **Category:** Core @@ -84,14 +84,6 @@ This signal is emitted when the button was just toggled between pressed and norm Enumerations ------------ -.. _enum_BaseButton_ActionMode: - -enum **ActionMode**: - -- **ACTION_MODE_BUTTON_PRESS** = **0** --- Require just a press to consider the button clicked. - -- **ACTION_MODE_BUTTON_RELEASE** = **1** --- Require a press and a subsequent release before considering the button clicked. - .. _enum_BaseButton_DrawMode: enum **DrawMode**: @@ -106,6 +98,14 @@ enum **DrawMode**: - **DRAW_HOVER_PRESSED** = **4** +.. _enum_BaseButton_ActionMode: + +enum **ActionMode**: + +- **ACTION_MODE_BUTTON_PRESS** = **0** --- Require just a press to consider the button clicked. + +- **ACTION_MODE_BUTTON_RELEASE** = **1** --- Require a press and a subsequent release before considering the button clicked. + Description ----------- diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 3e2cd9c49..8809d13bd 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -9,7 +9,7 @@ BoxContainer **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`VBoxContainer`, :ref:`HBoxContainer`, :ref:`ColorPicker` +**Inherited By:** :ref:`ColorPicker`, :ref:`HBoxContainer`, :ref:`VBoxContainer` **Category:** Core diff --git a/classes/class_button.rst b/classes/class_button.rst index 95e661906..9e044147f 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -9,7 +9,7 @@ Button **Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`OptionButton`, :ref:`ColorPickerButton`, :ref:`CheckButton`, :ref:`MenuButton`, :ref:`ToolButton`, :ref:`CheckBox` +**Inherited By:** :ref:`CheckBox`, :ref:`CheckButton`, :ref:`ColorPickerButton`, :ref:`MenuButton`, :ref:`OptionButton`, :ref:`ToolButton` **Category:** Core diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 964db363d..9357046ff 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -9,7 +9,7 @@ Camera **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`InterpolatedCamera`, :ref:`ClippedCamera`, :ref:`ARVRCamera` +**Inherited By:** :ref:`ARVRCamera`, :ref:`ClippedCamera`, :ref:`InterpolatedCamera` **Category:** Core @@ -81,16 +81,6 @@ Methods Enumerations ------------ -.. _enum_Camera_DopplerTracking: - -enum **DopplerTracking**: - -- **DOPPLER_TRACKING_DISABLED** = **0** --- Disable Doppler effect simulation (default). - -- **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Simulate Doppler effect by tracking positions of objects that are changed in ``_process``. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's ``pitch shift``). - -- **DOPPLER_TRACKING_PHYSICS_STEP** = **2** --- Simulate Doppler effect by tracking positions of objects that are changed in ``_physics_process``. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's ``pitch shift``). - .. _enum_Camera_Projection: enum **Projection**: @@ -107,6 +97,16 @@ enum **KeepAspect**: - **KEEP_HEIGHT** = **1** --- Preserves the vertical aspect ratio. +.. _enum_Camera_DopplerTracking: + +enum **DopplerTracking**: + +- **DOPPLER_TRACKING_DISABLED** = **0** --- Disable Doppler effect simulation (default). + +- **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Simulate Doppler effect by tracking positions of objects that are changed in ``_process``. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's ``pitch shift``). + +- **DOPPLER_TRACKING_PHYSICS_STEP** = **2** --- Simulate Doppler effect by tracking positions of objects that are changed in ``_physics_process``. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's ``pitch shift``). + Description ----------- diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index f54d7899b..454ef307e 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -9,7 +9,7 @@ CanvasItem **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Node2D`, :ref:`Control` +**Inherited By:** :ref:`Control`, :ref:`Node2D` **Category:** Core diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 72542a662..6feb46a08 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -36,16 +36,6 @@ Properties Enumerations ------------ -.. _enum_CanvasItemMaterial_LightMode: - -enum **LightMode**: - -- **LIGHT_MODE_NORMAL** = **0** --- Render the material using both light and non-light sensitive material properties. - -- **LIGHT_MODE_UNSHADED** = **1** --- Render the material as if there were no light. - -- **LIGHT_MODE_LIGHT_ONLY** = **2** --- Render the material as if there were only light. - .. _enum_CanvasItemMaterial_BlendMode: enum **BlendMode**: @@ -60,6 +50,16 @@ enum **BlendMode**: - **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. +.. _enum_CanvasItemMaterial_LightMode: + +enum **LightMode**: + +- **LIGHT_MODE_NORMAL** = **0** --- Render the material using both light and non-light sensitive material properties. + +- **LIGHT_MODE_UNSHADED** = **1** --- Render the material as if there were no light. + +- **LIGHT_MODE_LIGHT_ONLY** = **2** --- Render the material as if there were only light. + Description ----------- diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 5b4aa3bba..c8a5b597f 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -9,7 +9,7 @@ CollisionObject **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PhysicsBody`, :ref:`Area` +**Inherited By:** :ref:`Area`, :ref:`PhysicsBody` **Category:** Core diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index d995b508e..9ebab8250 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -9,7 +9,7 @@ CollisionObject2D **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PhysicsBody2D`, :ref:`Area2D` +**Inherited By:** :ref:`Area2D`, :ref:`PhysicsBody2D` **Category:** Core diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index e2318d41a..255e9f607 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -9,7 +9,7 @@ ConfirmationDialog **Inherits:** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`ScriptCreateDialog`, :ref:`EditorFileDialog`, :ref:`FileDialog` +**Inherited By:** :ref:`EditorFileDialog`, :ref:`FileDialog`, :ref:`ScriptCreateDialog` **Category:** Core diff --git a/classes/class_container.rst b/classes/class_container.rst index 4b435b218..4891e49e3 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -9,7 +9,7 @@ Container **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PanelContainer`, :ref:`EditorProperty`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer`, :ref:`TabContainer` +**Inherited By:** :ref:`BoxContainer`, :ref:`CenterContainer`, :ref:`EditorProperty`, :ref:`GraphNode`, :ref:`GridContainer`, :ref:`MarginContainer`, :ref:`PanelContainer`, :ref:`ScrollContainer`, :ref:`SplitContainer`, :ref:`TabContainer`, :ref:`ViewportContainer` **Category:** Core diff --git a/classes/class_control.rst b/classes/class_control.rst index 17c0bc257..6b8dc6f35 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -9,7 +9,7 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` +**Inherited By:** :ref:`BaseButton`, :ref:`ColorRect`, :ref:`Container`, :ref:`GraphEdit`, :ref:`ItemList`, :ref:`Label`, :ref:`LineEdit`, :ref:`NinePatchRect`, :ref:`Panel`, :ref:`Popup`, :ref:`Range`, :ref:`ReferenceRect`, :ref:`RichTextLabel`, :ref:`Separator`, :ref:`Tabs`, :ref:`TextEdit`, :ref:`TextureRect`, :ref:`Tree`, :ref:`VideoPlayer` **Category:** Core @@ -274,19 +274,15 @@ Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` to expand the bounds of this node to fill all the available space without pushing any other node. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **FOCUS_NONE** = **0** --- The node cannot grab focus. Use with :ref:`focus_mode`. -- **SIZE_EXPAND** = **2** --- Tells the parent :ref:`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 :ref:`size_flags_stretch_ratio`. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **FOCUS_CLICK** = **1** --- The node can only grab focus on mouse clicks. Use with :ref:`focus_mode`. -- **SIZE_EXPAND_FILL** = **3** --- Sets the node's size flags to both fill and expand. See the 2 constants above for more information. - -- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. - -- **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`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 :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`focus_mode`. .. _enum_Control_CursorShape: @@ -326,38 +322,6 @@ enum **CursorShape**: - **CURSOR_HELP** = **16** --- Show the system's help mouse cursor when the user hovers the node, a question mark. -.. _enum_Control_FocusMode: - -enum **FocusMode**: - -- **FOCUS_NONE** = **0** --- The node cannot grab focus. Use with :ref:`focus_mode`. - -- **FOCUS_CLICK** = **1** --- The node can only grab focus on mouse clicks. Use with :ref:`focus_mode`. - -- **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`focus_mode`. - -.. _enum_Control_GrowDirection: - -enum **GrowDirection**: - -- **GROW_DIRECTION_BEGIN** = **0** - -- **GROW_DIRECTION_END** = **1** - -- **GROW_DIRECTION_BOTH** = **2** - -.. _enum_Control_LayoutPresetMode: - -enum **LayoutPresetMode**: - -- **PRESET_MODE_MINSIZE** = **0** - -- **PRESET_MODE_KEEP_WIDTH** = **1** - -- **PRESET_MODE_KEEP_HEIGHT** = **2** - -- **PRESET_MODE_KEEP_SIZE** = **3** - .. _enum_Control_LayoutPreset: enum **LayoutPreset**: @@ -394,6 +358,32 @@ enum **LayoutPreset**: - **PRESET_WIDE** = **15** --- 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 ``Control`` will fit its parent container. Use with :ref:`set_anchors_preset`. +.. _enum_Control_LayoutPresetMode: + +enum **LayoutPresetMode**: + +- **PRESET_MODE_MINSIZE** = **0** + +- **PRESET_MODE_KEEP_WIDTH** = **1** + +- **PRESET_MODE_KEEP_HEIGHT** = **2** + +- **PRESET_MODE_KEEP_SIZE** = **3** + +.. _enum_Control_SizeFlags: + +enum **SizeFlags**: + +- **SIZE_FILL** = **1** --- Tells the parent :ref:`Container` to expand the bounds of this node to fill all the available space without pushing any other node. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. + +- **SIZE_EXPAND** = **2** --- Tells the parent :ref:`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 :ref:`size_flags_stretch_ratio`. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. + +- **SIZE_EXPAND_FILL** = **3** --- Sets the node's size flags to both fill and expand. See the 2 constants above for more information. + +- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. + +- **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`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 :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. + .. _enum_Control_MouseFilter: enum **MouseFilter**: @@ -404,6 +394,16 @@ enum **MouseFilter**: - **MOUSE_FILTER_IGNORE** = **2** --- The control will not receive mouse button input events through :ref:`_gui_input` and will not block other controls from receiving these events. These events will also not be handled automatically. +.. _enum_Control_GrowDirection: + +enum **GrowDirection**: + +- **GROW_DIRECTION_BEGIN** = **0** + +- **GROW_DIRECTION_END** = **1** + +- **GROW_DIRECTION_BOTH** = **2** + .. _enum_Control_Anchor: enum **Anchor**: diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index f399da619..ddb19c3a2 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -151,15 +151,15 @@ Methods Enumerations ------------ -.. _enum_CPUParticles_Flags: +.. _enum_CPUParticles_DrawOrder: -enum **Flags**: +enum **DrawOrder**: -- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** +- **DRAW_ORDER_INDEX** = **0** -- **FLAG_ROTATE_Y** = **1** +- **DRAW_ORDER_LIFETIME** = **1** -- **FLAG_MAX** = **3** +- **DRAW_ORDER_VIEW_DEPTH** = **2** .. _enum_CPUParticles_Parameter: @@ -189,6 +189,16 @@ enum **Parameter**: - **PARAM_MAX** = **11** +.. _enum_CPUParticles_Flags: + +enum **Flags**: + +- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** + +- **FLAG_ROTATE_Y** = **1** + +- **FLAG_MAX** = **3** + .. _enum_CPUParticles_EmissionShape: enum **EmissionShape**: @@ -203,16 +213,6 @@ enum **EmissionShape**: - **EMISSION_SHAPE_DIRECTED_POINTS** = **4** -.. _enum_CPUParticles_DrawOrder: - -enum **DrawOrder**: - -- **DRAW_ORDER_INDEX** = **0** - -- **DRAW_ORDER_LIFETIME** = **1** - -- **DRAW_ORDER_VIEW_DEPTH** = **2** - Property Descriptions --------------------- diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index c0102443b..cb501f0fb 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -149,13 +149,13 @@ Methods Enumerations ------------ -.. _enum_CPUParticles2D_Flags: +.. _enum_CPUParticles2D_DrawOrder: -enum **Flags**: +enum **DrawOrder**: -- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** +- **DRAW_ORDER_INDEX** = **0** -- **FLAG_MAX** = **1** +- **DRAW_ORDER_LIFETIME** = **1** .. _enum_CPUParticles2D_Parameter: @@ -187,6 +187,14 @@ enum **Parameter**: - **PARAM_MAX** = **12** +.. _enum_CPUParticles2D_Flags: + +enum **Flags**: + +- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** + +- **FLAG_MAX** = **1** + .. _enum_CPUParticles2D_EmissionShape: enum **EmissionShape**: @@ -201,14 +209,6 @@ enum **EmissionShape**: - **EMISSION_SHAPE_DIRECTED_POINTS** = **4** -.. _enum_CPUParticles2D_DrawOrder: - -enum **DrawOrder**: - -- **DRAW_ORDER_INDEX** = **0** - -- **DRAW_ORDER_LIFETIME** = **1** - Property Descriptions --------------------- diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index d09d4fbfc..b24271d22 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -9,7 +9,7 @@ CSGPrimitive **Inherits:** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`CSGSphere`, :ref:`CSGPolygon`, :ref:`CSGCylinder`, :ref:`CSGBox`, :ref:`CSGTorus`, :ref:`CSGMesh` +**Inherited By:** :ref:`CSGBox`, :ref:`CSGCylinder`, :ref:`CSGMesh`, :ref:`CSGPolygon`, :ref:`CSGSphere`, :ref:`CSGTorus` **Category:** Core diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 98824faca..2742c7978 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -43,18 +43,6 @@ Methods Enumerations ------------ -.. _enum_CubeMap_Flags: - -enum **Flags**: - -- **FLAG_MIPMAPS** = **1** --- Generate mipmaps, to enable smooth zooming out of the texture. - -- **FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge). - -- **FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture. - -- **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. - .. _enum_CubeMap_Storage: enum **Storage**: @@ -81,6 +69,18 @@ enum **Side**: - **SIDE_BACK** = **5** --- Identifier for the back face of the ``CubeMap``. +.. _enum_CubeMap_Flags: + +enum **Flags**: + +- **FLAG_MIPMAPS** = **1** --- Generate mipmaps, to enable smooth zooming out of the texture. + +- **FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge). + +- **FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture. + +- **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. + Description ----------- diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index dc9ac38f0..1f6d0d472 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -42,14 +42,6 @@ Properties Enumerations ------------ -.. _enum_DirectionalLight_ShadowDepthRange: - -enum **ShadowDepthRange**: - -- **SHADOW_DEPTH_RANGE_STABLE** = **0** --- Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value. - -- **SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** --- Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. - .. _enum_DirectionalLight_ShadowMode: enum **ShadowMode**: @@ -60,6 +52,14 @@ enum **ShadowMode**: - **SHADOW_PARALLEL_4_SPLITS** = **2** --- Splits the view frustum in 4 areas, each with its own shadow map. +.. _enum_DirectionalLight_ShadowDepthRange: + +enum **ShadowDepthRange**: + +- **SHADOW_DEPTH_RANGE_STABLE** = **0** --- Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value. + +- **SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** --- Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. + Description ----------- diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index ee7193b85..f3220eed0 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -74,6 +74,20 @@ Emitted when multiple files are selected. Enumerations ------------ +.. _enum_EditorFileDialog_Mode: + +enum **Mode**: + +- **MODE_OPEN_FILE** = **0** --- The ``EditorFileDialog`` can select only one file. Accepting the window will open the file. + +- **MODE_OPEN_FILES** = **1** --- The ``EditorFileDialog`` can select multiple files. Accepting the window will open all files. + +- **MODE_OPEN_DIR** = **2** --- The ``EditorFileDialog`` can select only one directory. Accepting the window will open the directory. + +- **MODE_OPEN_ANY** = **3** --- The ``EditorFileDialog`` can select a file or directory. Accepting the window will open it. + +- **MODE_SAVE_FILE** = **4** --- The ``EditorFileDialog`` can select only one file. Accepting the window will save the file. + .. _enum_EditorFileDialog_Access: enum **Access**: @@ -92,20 +106,6 @@ enum **DisplayMode**: - **DISPLAY_LIST** = **1** --- The ``EditorFileDialog`` displays resources as a list of filenames. -.. _enum_EditorFileDialog_Mode: - -enum **Mode**: - -- **MODE_OPEN_FILE** = **0** --- The ``EditorFileDialog`` can select only one file. Accepting the window will open the file. - -- **MODE_OPEN_FILES** = **1** --- The ``EditorFileDialog`` can select multiple files. Accepting the window will open all files. - -- **MODE_OPEN_DIR** = **2** --- The ``EditorFileDialog`` can select only one directory. Accepting the window will open the directory. - -- **MODE_OPEN_ANY** = **3** --- The ``EditorFileDialog`` can select a file or directory. Accepting the window will open it. - -- **MODE_SAVE_FILE** = **4** --- The ``EditorFileDialog`` can select only one file. Accepting the window will save the file. - Property Descriptions --------------------- diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 2caa77f91..fe1638889 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -151,28 +151,6 @@ Emitted when user closes a scene. The argument is file path to a closed scene. Enumerations ------------ -.. _enum_EditorPlugin_DockSlot: - -enum **DockSlot**: - -- **DOCK_SLOT_LEFT_UL** = **0** - -- **DOCK_SLOT_LEFT_BL** = **1** - -- **DOCK_SLOT_LEFT_UR** = **2** - -- **DOCK_SLOT_LEFT_BR** = **3** - -- **DOCK_SLOT_RIGHT_UL** = **4** - -- **DOCK_SLOT_RIGHT_BL** = **5** - -- **DOCK_SLOT_RIGHT_UR** = **6** - -- **DOCK_SLOT_RIGHT_BR** = **7** - -- **DOCK_SLOT_MAX** = **8** - .. _enum_EditorPlugin_CustomControlContainer: enum **CustomControlContainer**: @@ -197,6 +175,28 @@ enum **CustomControlContainer**: - **CONTAINER_PROPERTY_EDITOR_BOTTOM** = **9** +.. _enum_EditorPlugin_DockSlot: + +enum **DockSlot**: + +- **DOCK_SLOT_LEFT_UL** = **0** + +- **DOCK_SLOT_LEFT_BL** = **1** + +- **DOCK_SLOT_LEFT_UR** = **2** + +- **DOCK_SLOT_LEFT_BR** = **3** + +- **DOCK_SLOT_RIGHT_UL** = **4** + +- **DOCK_SLOT_RIGHT_BL** = **5** + +- **DOCK_SLOT_RIGHT_UR** = **6** + +- **DOCK_SLOT_RIGHT_BR** = **7** + +- **DOCK_SLOT_MAX** = **8** + Description ----------- diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 3a61efe24..069713b95 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -208,16 +208,6 @@ enum **BGMode**: - **BG_MAX** = **6** --- Helper constant keeping track of the enum's size, has no direct usage in API calls. -.. _enum_Environment_DOFBlurQuality: - -enum **DOFBlurQuality**: - -- **DOF_BLUR_QUALITY_LOW** = **0** --- Low depth-of-field blur quality. - -- **DOF_BLUR_QUALITY_MEDIUM** = **1** --- Medium depth-of-field blur quality. - -- **DOF_BLUR_QUALITY_HIGH** = **2** --- High depth-of-field blur quality. - .. _enum_Environment_GlowBlendMode: enum **GlowBlendMode**: @@ -242,6 +232,16 @@ enum **ToneMapper**: - **TONE_MAPPER_ACES** = **3** --- Academy Color Encoding System tonemapper operator. +.. _enum_Environment_DOFBlurQuality: + +enum **DOFBlurQuality**: + +- **DOF_BLUR_QUALITY_LOW** = **0** --- Low depth-of-field blur quality. + +- **DOF_BLUR_QUALITY_MEDIUM** = **1** --- Medium depth-of-field blur quality. + +- **DOF_BLUR_QUALITY_HIGH** = **2** --- High depth-of-field blur quality. + .. _enum_Environment_SSAOBlur: enum **SSAOBlur**: diff --git a/classes/class_file.rst b/classes/class_file.rst index 509249261..dbbf8e945 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -119,18 +119,6 @@ Methods Enumerations ------------ -.. _enum_File_CompressionMode: - -enum **CompressionMode**: - -- **COMPRESSION_FASTLZ** = **0** --- Uses the FastLZ compression method. - -- **COMPRESSION_DEFLATE** = **1** --- Uses the Deflate compression method. - -- **COMPRESSION_ZSTD** = **2** --- Uses the Zstd compression method. - -- **COMPRESSION_GZIP** = **3** --- Uses the gzip compression method. - .. _enum_File_ModeFlags: enum **ModeFlags**: @@ -143,6 +131,18 @@ enum **ModeFlags**: - **WRITE_READ** = **7** --- Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists. +.. _enum_File_CompressionMode: + +enum **CompressionMode**: + +- **COMPRESSION_FASTLZ** = **0** --- Uses the FastLZ compression method. + +- **COMPRESSION_DEFLATE** = **1** --- Uses the Deflate compression method. + +- **COMPRESSION_ZSTD** = **2** --- Uses the Zstd compression method. + +- **COMPRESSION_GZIP** = **3** --- Uses the gzip compression method. + Description ----------- diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 6619bff5d..f9891a2c3 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -91,16 +91,6 @@ Event emitted when the user selects multiple files. Enumerations ------------ -.. _enum_FileDialog_Access: - -enum **Access**: - -- **ACCESS_RESOURCES** = **0** --- The dialog allows the selection of file and directory. - -- **ACCESS_USERDATA** = **1** --- The dialog allows access files under :ref:`Resource` path(res://) . - -- **ACCESS_FILESYSTEM** = **2** --- The dialog allows access files in whole file system. - .. _enum_FileDialog_Mode: enum **Mode**: @@ -115,6 +105,16 @@ enum **Mode**: - **MODE_SAVE_FILE** = **4** --- The dialog will warn when a file exists. +.. _enum_FileDialog_Access: + +enum **Access**: + +- **ACCESS_RESOURCES** = **0** --- The dialog allows the selection of file and directory. + +- **ACCESS_USERDATA** = **1** --- The dialog allows access files under :ref:`Resource` path(res://) . + +- **ACCESS_FILESYSTEM** = **2** --- The dialog allows access files in whole file system. + Description ----------- diff --git a/classes/class_font.rst b/classes/class_font.rst index b6632b56d..20c861477 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -9,7 +9,7 @@ Font **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`DynamicFont`, :ref:`BitmapFont` +**Inherited By:** :ref:`BitmapFont`, :ref:`DynamicFont` **Category:** Core diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 8aa96503e..d9fb8d04c 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -194,24 +194,6 @@ Properties Enumerations ------------ -.. _enum_Generic6DOFJoint_Flag: - -enum **Flag**: - -- **FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. - -- **FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible. - -- **FLAG_ENABLE_LINEAR_SPRING** = **3** - -- **FLAG_ENABLE_ANGULAR_SPRING** = **2** - -- **FLAG_ENABLE_MOTOR** = **4** --- If ``set`` there is a rotational motor across these axes. - -- **FLAG_ENABLE_LINEAR_MOTOR** = **5** - -- **FLAG_MAX** = **6** --- End flag of FLAG\_\* constants, used internally. - .. _enum_Generic6DOFJoint_Param: enum **Param**: @@ -250,6 +232,24 @@ enum **Param**: - **PARAM_MAX** = **22** --- End flag of PARAM\_\* constants, used internally. +.. _enum_Generic6DOFJoint_Flag: + +enum **Flag**: + +- **FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. + +- **FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible. + +- **FLAG_ENABLE_LINEAR_SPRING** = **3** + +- **FLAG_ENABLE_ANGULAR_SPRING** = **2** + +- **FLAG_ENABLE_MOTOR** = **4** --- If ``set`` there is a rotational motor across these axes. + +- **FLAG_ENABLE_LINEAR_MOTOR** = **5** + +- **FLAG_MAX** = **6** --- End flag of FLAG\_\* constants, used internally. + Description ----------- diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index e9f175b59..7a3ba47c0 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -9,7 +9,7 @@ GeometryInstance **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`MultiMeshInstance`, :ref:`Particles`, :ref:`MeshInstance`, :ref:`SpriteBase3D`, :ref:`ImmediateGeometry`, :ref:`CPUParticles` +**Inherited By:** :ref:`CPUParticles`, :ref:`ImmediateGeometry`, :ref:`MeshInstance`, :ref:`MultiMeshInstance`, :ref:`Particles`, :ref:`SpriteBase3D` **Category:** Core @@ -42,16 +42,6 @@ Properties Enumerations ------------ -.. _enum_GeometryInstance_Flags: - -enum **Flags**: - -- **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. - -Added documentation for GeometryInstance and VisualInstance - -- **FLAG_MAX** = **2** - .. _enum_GeometryInstance_ShadowCastingSetting: enum **ShadowCastingSetting**: @@ -70,6 +60,16 @@ Will not take culling into account, so all faces will be taken into account when In other words: The actual mesh will not be visible, only the shadows casted from the mesh. +.. _enum_GeometryInstance_Flags: + +enum **Flags**: + +- **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. + +Added documentation for GeometryInstance and VisualInstance + +- **FLAG_MAX** = **2** + Description ----------- diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index efabb37c7..65ed66ffe 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -44,16 +44,6 @@ Properties Enumerations ------------ -.. _enum_HingeJoint_Flag: - -enum **Flag**: - -- **FLAG_USE_LIMIT** = **0** --- If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. - -- **FLAG_ENABLE_MOTOR** = **1** --- When activated, a motor turns the hinge. - -- **FLAG_MAX** = **2** --- End flag of FLAG\_\* constants, used internally. - .. _enum_HingeJoint_Param: enum **Param**: @@ -76,6 +66,16 @@ enum **Param**: - **PARAM_MAX** = **8** --- End flag of PARAM\_\* constants, used internally. +.. _enum_HingeJoint_Flag: + +enum **Flag**: + +- **FLAG_USE_LIMIT** = **0** --- If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. + +- **FLAG_ENABLE_MOTOR** = **1** --- When activated, a motor turns the hinge. + +- **FLAG_MAX** = **2** --- End flag of FLAG\_\* constants, used internally. + Description ----------- diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 013ec47a2..cb39aa437 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -63,30 +63,6 @@ Methods Enumerations ------------ -.. _enum_HTTPClient_Status: - -enum **Status**: - -- **STATUS_DISCONNECTED** = **0** --- Status: Disconnected from the server. - -- **STATUS_RESOLVING** = **1** --- Status: Currently resolving the hostname for the given URL into an IP. - -- **STATUS_CANT_RESOLVE** = **2** --- Status: DNS failure: Can't resolve the hostname for the given URL. - -- **STATUS_CONNECTING** = **3** --- Status: Currently connecting to server. - -- **STATUS_CANT_CONNECT** = **4** --- Status: Can't connect to the server. - -- **STATUS_CONNECTED** = **5** --- Status: Connection established. - -- **STATUS_REQUESTING** = **6** --- Status: Currently sending request. - -- **STATUS_BODY** = **7** --- Status: HTTP body received. - -- **STATUS_CONNECTION_ERROR** = **8** --- Status: Error in HTTP connection. - -- **STATUS_SSL_HANDSHAKE_ERROR** = **9** --- Status: Error in SSL handshake. - .. _enum_HTTPClient_Method: enum **Method**: @@ -111,6 +87,30 @@ enum **Method**: - **METHOD_MAX** = **9** --- Marker for end of ``METHOD_*`` enum. Not used. +.. _enum_HTTPClient_Status: + +enum **Status**: + +- **STATUS_DISCONNECTED** = **0** --- Status: Disconnected from the server. + +- **STATUS_RESOLVING** = **1** --- Status: Currently resolving the hostname for the given URL into an IP. + +- **STATUS_CANT_RESOLVE** = **2** --- Status: DNS failure: Can't resolve the hostname for the given URL. + +- **STATUS_CONNECTING** = **3** --- Status: Currently connecting to server. + +- **STATUS_CANT_CONNECT** = **4** --- Status: Can't connect to the server. + +- **STATUS_CONNECTED** = **5** --- Status: Connection established. + +- **STATUS_REQUESTING** = **6** --- Status: Currently sending request. + +- **STATUS_BODY** = **7** --- Status: HTTP body received. + +- **STATUS_CONNECTION_ERROR** = **8** --- Status: Error in HTTP connection. + +- **STATUS_SSL_HANDSHAKE_ERROR** = **9** --- Status: Error in SSL handshake. + .. _enum_HTTPClient_ResponseCode: enum **ResponseCode**: diff --git a/classes/class_image.rst b/classes/class_image.rst index ac64f502e..98e616ac7 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -131,58 +131,6 @@ Methods Enumerations ------------ -.. _enum_Image_CompressMode: - -enum **CompressMode**: - -- **COMPRESS_S3TC** = **0** - -- **COMPRESS_PVRTC2** = **1** - -- **COMPRESS_PVRTC4** = **2** - -- **COMPRESS_ETC** = **3** - -- **COMPRESS_ETC2** = **4** - -.. _enum_Image_Interpolation: - -enum **Interpolation**: - -- **INTERPOLATE_NEAREST** = **0** - -- **INTERPOLATE_BILINEAR** = **1** - -- **INTERPOLATE_CUBIC** = **2** - -- **INTERPOLATE_TRILINEAR** = **3** --- Performs bilinear separately on the two most suited mipmap levels, then linearly interpolates between them. - -It's slower than ``INTERPOLATE_BILINEAR``, but produces higher quality results, with much less aliasing artifacts. - -If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image. (Note that if you intend to scale multiple copies of the original image, it's better to call ``generate_mipmaps`` on it in advance, to avoid wasting processing power in generating them again and again.) - -On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image. - -.. _enum_Image_AlphaMode: - -enum **AlphaMode**: - -- **ALPHA_NONE** = **0** - -- **ALPHA_BIT** = **1** - -- **ALPHA_BLEND** = **2** - -.. _enum_Image_CompressSource: - -enum **CompressSource**: - -- **COMPRESS_SOURCE_GENERIC** = **0** - -- **COMPRESS_SOURCE_SRGB** = **1** - -- **COMPRESS_SOURCE_NORMAL** = **2** - .. _enum_Image_Format: enum **Format**: @@ -263,6 +211,58 @@ enum **Format**: - **FORMAT_MAX** = **37** +.. _enum_Image_Interpolation: + +enum **Interpolation**: + +- **INTERPOLATE_NEAREST** = **0** + +- **INTERPOLATE_BILINEAR** = **1** + +- **INTERPOLATE_CUBIC** = **2** + +- **INTERPOLATE_TRILINEAR** = **3** --- Performs bilinear separately on the two most suited mipmap levels, then linearly interpolates between them. + +It's slower than ``INTERPOLATE_BILINEAR``, but produces higher quality results, with much less aliasing artifacts. + +If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image. (Note that if you intend to scale multiple copies of the original image, it's better to call ``generate_mipmaps`` on it in advance, to avoid wasting processing power in generating them again and again.) + +On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image. + +.. _enum_Image_AlphaMode: + +enum **AlphaMode**: + +- **ALPHA_NONE** = **0** + +- **ALPHA_BIT** = **1** + +- **ALPHA_BLEND** = **2** + +.. _enum_Image_CompressMode: + +enum **CompressMode**: + +- **COMPRESS_S3TC** = **0** + +- **COMPRESS_PVRTC2** = **1** + +- **COMPRESS_PVRTC4** = **2** + +- **COMPRESS_ETC** = **3** + +- **COMPRESS_ETC2** = **4** + +.. _enum_Image_CompressSource: + +enum **CompressSource**: + +- **COMPRESS_SOURCE_GENERIC** = **0** + +- **COMPRESS_SOURCE_SRGB** = **1** + +- **COMPRESS_SOURCE_NORMAL** = **2** + Description ----------- diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index ae5793f69..dbb37dd0b 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -9,7 +9,7 @@ InputEvent **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`InputEventScreenTouch`, :ref:`InputEventWithModifiers`, :ref:`InputEventScreenDrag`, :ref:`InputEventJoypadMotion`, :ref:`InputEventJoypadButton`, :ref:`InputEventAction` +**Inherited By:** :ref:`InputEventAction`, :ref:`InputEventJoypadButton`, :ref:`InputEventJoypadMotion`, :ref:`InputEventScreenDrag`, :ref:`InputEventScreenTouch`, :ref:`InputEventWithModifiers` **Category:** Core diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index a750511e1..04256fffa 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -9,7 +9,7 @@ InputEventGesture **Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`InputEventPanGesture`, :ref:`InputEventMagnifyGesture` +**Inherited By:** :ref:`InputEventMagnifyGesture`, :ref:`InputEventPanGesture` **Category:** Core diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index e648fbd06..c6214eef8 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -9,7 +9,7 @@ InputEventMouse **Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`InputEventMouseMotion`, :ref:`InputEventMouseButton` +**Inherited By:** :ref:`InputEventMouseButton`, :ref:`InputEventMouseMotion` **Category:** Core diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index d0d95132e..02a53073d 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -9,7 +9,7 @@ InputEventWithModifiers **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`InputEventKey`, :ref:`InputEventMouse`, :ref:`InputEventGesture` +**Inherited By:** :ref:`InputEventGesture`, :ref:`InputEventKey`, :ref:`InputEventMouse` **Category:** Core diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 2306d5472..5891b87c5 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -9,7 +9,7 @@ Joint **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`ConeTwistJoint`, :ref:`Generic6DOFJoint`, :ref:`SliderJoint`, :ref:`HingeJoint`, :ref:`PinJoint` +**Inherited By:** :ref:`ConeTwistJoint`, :ref:`Generic6DOFJoint`, :ref:`HingeJoint`, :ref:`PinJoint`, :ref:`SliderJoint` **Category:** Core diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 218931369..47641b4b4 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -9,7 +9,7 @@ Joint2D **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PinJoint2D`, :ref:`DampedSpringJoint2D`, :ref:`GrooveJoint2D` +**Inherited By:** :ref:`DampedSpringJoint2D`, :ref:`GrooveJoint2D`, :ref:`PinJoint2D` **Category:** Core diff --git a/classes/class_light.rst b/classes/class_light.rst index 9cd66baa7..26450962b 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -9,7 +9,7 @@ Light **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`SpotLight`, :ref:`OmniLight`, :ref:`DirectionalLight` +**Inherited By:** :ref:`DirectionalLight`, :ref:`OmniLight`, :ref:`SpotLight` **Category:** Core @@ -52,16 +52,6 @@ Properties Enumerations ------------ -.. _enum_Light_BakeMode: - -enum **BakeMode**: - -- **BAKE_DISABLED** = **0** --- Light is ignored when baking. Note: hiding a light does *not* affect baking. - -- **BAKE_INDIRECT** = **1** --- Only indirect lighting will be baked. Default value. - -- **BAKE_ALL** = **2** --- Both direct and indirect light will be baked. Note: you should hide the light if you don't want it to appear twice (dynamic and baked). - .. _enum_Light_Param: enum **Param**: @@ -98,6 +88,16 @@ enum **Param**: - **PARAM_MAX** = **15** +.. _enum_Light_BakeMode: + +enum **BakeMode**: + +- **BAKE_DISABLED** = **0** --- Light is ignored when baking. Note: hiding a light does *not* affect baking. + +- **BAKE_INDIRECT** = **1** --- Only indirect lighting will be baked. Default value. + +- **BAKE_ALL** = **2** --- Both direct and indirect light will be baked. Note: you should hide the light if you don't want it to appear twice (dynamic and baked). + Description ----------- diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index d85ccd8b7..f38551dff 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -61,6 +61,16 @@ Methods Enumerations ------------ +.. _enum_Line2D_LineJointMode: + +enum **LineJointMode**: + +- **LINE_JOINT_SHARP** = **0** --- The line's joints will be pointy. If ``sharp_limit`` is greater than the rotation of a joint, it becomes a bevel joint instead. + +- **LINE_JOINT_BEVEL** = **1** --- The line's joints will be bevelled/chamfered. + +- **LINE_JOINT_ROUND** = **2** --- The line's joints will be rounded. + .. _enum_Line2D_LineCapMode: enum **LineCapMode**: @@ -81,16 +91,6 @@ enum **LineTextureMode**: - **LINE_TEXTURE_STRETCH** = **2** --- Stretches the texture across the line. Import the texture with Repeat Disabled for best results. -.. _enum_Line2D_LineJointMode: - -enum **LineJointMode**: - -- **LINE_JOINT_SHARP** = **0** --- The line's joints will be pointy. If ``sharp_limit`` is greater than the rotation of a joint, it becomes a bevel joint instead. - -- **LINE_JOINT_BEVEL** = **1** --- The line's joints will be bevelled/chamfered. - -- **LINE_JOINT_ROUND** = **2** --- The line's joints will be rounded. - Description ----------- diff --git a/classes/class_material.rst b/classes/class_material.rst index d4edf4a76..b239c93d9 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -9,7 +9,7 @@ Material **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial`, :ref:`CanvasItemMaterial` +**Inherited By:** :ref:`CanvasItemMaterial`, :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial` **Category:** Core diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index e27560e53..4def16cae 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -51,6 +51,24 @@ Methods Enumerations ------------ +.. _enum_Mesh_PrimitiveType: + +enum **PrimitiveType**: + +- **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point). + +- **PRIMITIVE_LINES** = **1** --- Render array as lines (every two vertices a line is created). + +- **PRIMITIVE_LINE_STRIP** = **2** --- Render array as line strip. + +- **PRIMITIVE_LINE_LOOP** = **3** --- Render array as line loop (like line strip, but closed). + +- **PRIMITIVE_TRIANGLES** = **4** --- Render array as triangles (every three vertices a triangle is created). + +- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips. + +- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans. + .. _enum_Mesh_BlendShapeMode: enum **BlendShapeMode**: @@ -59,30 +77,6 @@ enum **BlendShapeMode**: - **BLEND_SHAPE_MODE_RELATIVE** = **1** -.. _enum_Mesh_ArrayType: - -enum **ArrayType**: - -- **ARRAY_VERTEX** = **0** --- Array of vertices. - -- **ARRAY_NORMAL** = **1** --- Array of normals. - -- **ARRAY_TANGENT** = **2** --- Array of tangents as an array of floats, 4 floats per tangent. - -- **ARRAY_COLOR** = **3** --- Array of colors. - -- **ARRAY_TEX_UV** = **4** --- Array of UV coordinates. - -- **ARRAY_TEX_UV2** = **5** --- Array of second set of UV coordinates. - -- **ARRAY_BONES** = **6** --- Array of bone data. - -- **ARRAY_WEIGHTS** = **7** --- Array of weights. - -- **ARRAY_INDEX** = **8** --- Array of indices. - -- **ARRAY_MAX** = **9** - .. _enum_Mesh_ArrayFormat: enum **ArrayFormat**: @@ -131,23 +125,29 @@ enum **ArrayFormat**: - **ARRAY_COMPRESS_DEFAULT** = **97280** -.. _enum_Mesh_PrimitiveType: +.. _enum_Mesh_ArrayType: -enum **PrimitiveType**: +enum **ArrayType**: -- **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point). +- **ARRAY_VERTEX** = **0** --- Array of vertices. -- **PRIMITIVE_LINES** = **1** --- Render array as lines (every two vertices a line is created). +- **ARRAY_NORMAL** = **1** --- Array of normals. -- **PRIMITIVE_LINE_STRIP** = **2** --- Render array as line strip. +- **ARRAY_TANGENT** = **2** --- Array of tangents as an array of floats, 4 floats per tangent. -- **PRIMITIVE_LINE_LOOP** = **3** --- Render array as line loop (like line strip, but closed). +- **ARRAY_COLOR** = **3** --- Array of colors. -- **PRIMITIVE_TRIANGLES** = **4** --- Render array as triangles (every three vertices a triangle is created). +- **ARRAY_TEX_UV** = **4** --- Array of UV coordinates. -- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips. +- **ARRAY_TEX_UV2** = **5** --- Array of second set of UV coordinates. -- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans. +- **ARRAY_BONES** = **6** --- Array of bone data. + +- **ARRAY_WEIGHTS** = **7** --- Array of weights. + +- **ARRAY_INDEX** = **8** --- Array of indices. + +- **ARRAY_MAX** = **9** Description ----------- diff --git a/classes/class_node.rst b/classes/class_node.rst index 27c403247..80aa45fbc 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -9,7 +9,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`Viewport`, :ref:`AudioStreamPlayer`, :ref:`EditorFileSystem`, :ref:`SkeletonIK`, :ref:`CanvasLayer`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`AnimationTree`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorInterface`, :ref:`EditorResourcePreview`, :ref:`CanvasItem`, :ref:`Timer`, :ref:`Tween` +**Inherited By:** :ref:`AnimationPlayer`, :ref:`AnimationTree`, :ref:`AnimationTreePlayer`, :ref:`AudioStreamPlayer`, :ref:`CanvasItem`, :ref:`CanvasLayer`, :ref:`EditorFileSystem`, :ref:`EditorInterface`, :ref:`EditorPlugin`, :ref:`EditorResourcePreview`, :ref:`HTTPRequest`, :ref:`InstancePlaceholder`, :ref:`ResourcePreloader`, :ref:`SkeletonIK`, :ref:`Spatial`, :ref:`Timer`, :ref:`Tween`, :ref:`Viewport`, :ref:`WorldEnvironment` **Category:** Core diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index af5b0fa6a..879ad75fa 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -9,7 +9,7 @@ Node2D **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`Skeleton2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`RayCast2D`, :ref:`Light2D`, :ref:`Path2D`, :ref:`Line2D`, :ref:`AudioStreamPlayer2D`, :ref:`CanvasModulate`, :ref:`Sprite`, :ref:`CPUParticles2D`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`ParallaxLayer`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`MeshInstance2D`, :ref:`YSort`, :ref:`TileMap`, :ref:`Bone2D`, :ref:`Camera2D` +**Inherited By:** :ref:`AnimatedSprite`, :ref:`AudioStreamPlayer2D`, :ref:`BackBufferCopy`, :ref:`Bone2D`, :ref:`CPUParticles2D`, :ref:`Camera2D`, :ref:`CanvasModulate`, :ref:`CollisionObject2D`, :ref:`CollisionPolygon2D`, :ref:`CollisionShape2D`, :ref:`Joint2D`, :ref:`Light2D`, :ref:`LightOccluder2D`, :ref:`Line2D`, :ref:`MeshInstance2D`, :ref:`Navigation2D`, :ref:`NavigationPolygonInstance`, :ref:`ParallaxLayer`, :ref:`Particles2D`, :ref:`Path2D`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`RayCast2D`, :ref:`RemoteTransform2D`, :ref:`Skeleton2D`, :ref:`Sprite`, :ref:`TileMap`, :ref:`TouchScreenButton`, :ref:`VisibilityNotifier2D`, :ref:`YSort` **Category:** Core diff --git a/classes/class_object.rst b/classes/class_object.rst index 229313602..baea9ebf9 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -7,7 +7,7 @@ Object ====== -**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`MainLoop`, :ref:`PhysicsDirectBodyState`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`JavaScript`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`ProjectSettings`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`JSON`, :ref:`AudioServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`VisualServer`, :ref:`OS`, :ref:`GodotSharp`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`VisualScriptEditor`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` +**Inherited By:** :ref:`ARVRPositionalTracker`, :ref:`ARVRServer`, :ref:`AudioServer`, :ref:`ClassDB`, :ref:`EditorFileSystemDirectory`, :ref:`EditorSelection`, :ref:`Engine`, :ref:`Geometry`, :ref:`GodotSharp`, :ref:`IP`, :ref:`Input`, :ref:`InputMap`, :ref:`JSON`, :ref:`JavaScript`, :ref:`MainLoop`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`Physics2DDirectBodyState`, :ref:`Physics2DDirectSpaceState`, :ref:`Physics2DServer`, :ref:`PhysicsDirectBodyState`, :ref:`PhysicsDirectSpaceState`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`Reference`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`VisualScriptEditor`, :ref:`VisualServer` **Category:** Core diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 2100f3074..427d29261 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -32,14 +32,6 @@ Properties Enumerations ------------ -.. _enum_OmniLight_ShadowDetail: - -enum **ShadowDetail**: - -- **SHADOW_DETAIL_VERTICAL** = **0** - -- **SHADOW_DETAIL_HORIZONTAL** = **1** - .. _enum_OmniLight_ShadowMode: enum **ShadowMode**: @@ -48,6 +40,14 @@ enum **ShadowMode**: - **SHADOW_CUBE** = **1** +.. _enum_OmniLight_ShadowDetail: + +enum **ShadowDetail**: + +- **SHADOW_DETAIL_VERTICAL** = **0** + +- **SHADOW_DETAIL_HORIZONTAL** = **1** + Description ----------- diff --git a/classes/class_os.rst b/classes/class_os.rst index 03cee008b..915ac2e96 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -237,58 +237,6 @@ Methods Enumerations ------------ -.. _enum_OS_SystemDir: - -enum **SystemDir**: - -- **SYSTEM_DIR_DESKTOP** = **0** --- Desktop directory path. - -- **SYSTEM_DIR_DCIM** = **1** --- DCIM (Digital Camera Images) directory path. - -- **SYSTEM_DIR_DOCUMENTS** = **2** --- Documents directory path. - -- **SYSTEM_DIR_DOWNLOADS** = **3** --- Downloads directory path. - -- **SYSTEM_DIR_MOVIES** = **4** --- Movies directory path. - -- **SYSTEM_DIR_MUSIC** = **5** --- Music directory path. - -- **SYSTEM_DIR_PICTURES** = **6** --- Pictures directory path. - -- **SYSTEM_DIR_RINGTONES** = **7** --- Ringtones directory path. - -.. _enum_OS_ScreenOrientation: - -enum **ScreenOrientation**: - -- **SCREEN_ORIENTATION_LANDSCAPE** = **0** --- Landscape screen orientation. - -- **SCREEN_ORIENTATION_PORTRAIT** = **1** --- Portrait screen orientation. - -- **SCREEN_ORIENTATION_REVERSE_LANDSCAPE** = **2** --- Reverse landscape screen orientation. - -- **SCREEN_ORIENTATION_REVERSE_PORTRAIT** = **3** --- Reverse portrait screen orientation. - -- **SCREEN_ORIENTATION_SENSOR_LANDSCAPE** = **4** --- Uses landscape or reverse landscape based on the hardware sensor. - -- **SCREEN_ORIENTATION_SENSOR_PORTRAIT** = **5** --- Uses portrait or reverse portrait based on the hardware sensor. - -- **SCREEN_ORIENTATION_SENSOR** = **6** --- Uses most suitable orientation based on the hardware sensor. - -.. _enum_OS_PowerState: - -enum **PowerState**: - -- **POWERSTATE_UNKNOWN** = **0** --- Unknown powerstate. - -- **POWERSTATE_ON_BATTERY** = **1** --- Unplugged, running on battery. - -- **POWERSTATE_NO_BATTERY** = **2** --- Plugged in, no battery available. - -- **POWERSTATE_CHARGING** = **3** --- Plugged in, battery charging. - -- **POWERSTATE_CHARGED** = **4** --- Plugged in, battery fully charged. - .. _enum_OS_Weekday: enum **Weekday**: @@ -335,6 +283,58 @@ enum **Month**: - **MONTH_DECEMBER** = **12** --- December. +.. _enum_OS_ScreenOrientation: + +enum **ScreenOrientation**: + +- **SCREEN_ORIENTATION_LANDSCAPE** = **0** --- Landscape screen orientation. + +- **SCREEN_ORIENTATION_PORTRAIT** = **1** --- Portrait screen orientation. + +- **SCREEN_ORIENTATION_REVERSE_LANDSCAPE** = **2** --- Reverse landscape screen orientation. + +- **SCREEN_ORIENTATION_REVERSE_PORTRAIT** = **3** --- Reverse portrait screen orientation. + +- **SCREEN_ORIENTATION_SENSOR_LANDSCAPE** = **4** --- Uses landscape or reverse landscape based on the hardware sensor. + +- **SCREEN_ORIENTATION_SENSOR_PORTRAIT** = **5** --- Uses portrait or reverse portrait based on the hardware sensor. + +- **SCREEN_ORIENTATION_SENSOR** = **6** --- Uses most suitable orientation based on the hardware sensor. + +.. _enum_OS_SystemDir: + +enum **SystemDir**: + +- **SYSTEM_DIR_DESKTOP** = **0** --- Desktop directory path. + +- **SYSTEM_DIR_DCIM** = **1** --- DCIM (Digital Camera Images) directory path. + +- **SYSTEM_DIR_DOCUMENTS** = **2** --- Documents directory path. + +- **SYSTEM_DIR_DOWNLOADS** = **3** --- Downloads directory path. + +- **SYSTEM_DIR_MOVIES** = **4** --- Movies directory path. + +- **SYSTEM_DIR_MUSIC** = **5** --- Music directory path. + +- **SYSTEM_DIR_PICTURES** = **6** --- Pictures directory path. + +- **SYSTEM_DIR_RINGTONES** = **7** --- Ringtones directory path. + +.. _enum_OS_PowerState: + +enum **PowerState**: + +- **POWERSTATE_UNKNOWN** = **0** --- Unknown powerstate. + +- **POWERSTATE_ON_BATTERY** = **1** --- Unplugged, running on battery. + +- **POWERSTATE_NO_BATTERY** = **2** --- Plugged in, no battery available. + +- **POWERSTATE_CHARGING** = **3** --- Plugged in, battery charging. + +- **POWERSTATE_CHARGED** = **4** --- Plugged in, battery fully charged. + Description ----------- diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 277bf8aa1..d3768534d 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -9,7 +9,7 @@ PacketPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebSocketPeer`, :ref:`PacketPeerGDNative`, :ref:`NetworkedMultiplayerPeer` +**Inherited By:** :ref:`NetworkedMultiplayerPeer`, :ref:`PacketPeerGDNative`, :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebSocketPeer` **Category:** Core diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 08286909c..9e44991b4 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -130,16 +130,6 @@ Properties Enumerations ------------ -.. _enum_ParticlesMaterial_Flags: - -enum **Flags**: - -- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag` to set :ref:`flag_align_y`. - -- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag` to set :ref:`flag_rotate_y` - -- **FLAG_MAX** = **3** - .. _enum_ParticlesMaterial_Parameter: enum **Parameter**: @@ -170,6 +160,16 @@ enum **Parameter**: - **PARAM_MAX** = **12** +.. _enum_ParticlesMaterial_Flags: + +enum **Flags**: + +- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag` to set :ref:`flag_align_y`. + +- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag` to set :ref:`flag_rotate_y` + +- **FLAG_MAX** = **3** + .. _enum_ParticlesMaterial_EmissionShape: enum **EmissionShape**: diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 3dbf15671..9f8456950 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -230,49 +230,23 @@ Methods Enumerations ------------ -.. _enum_Physics2DServer_CCDMode: +.. _enum_Physics2DServer_SpaceParameter: -enum **CCDMode**: +enum **SpaceParameter**: -- **CCD_MODE_DISABLED** = **0** --- Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. +- **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** --- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. -- **CCD_MODE_CAST_RAY** = **1** --- Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. +- **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated. -- **CCD_MODE_CAST_SHAPE** = **2** --- Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. +- **SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION** = **2** --- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. -.. _enum_Physics2DServer_BodyState: +- **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = **3** --- 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. -enum **BodyState**: +- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = **4** --- 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. -- **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body. +- **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** --- 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. -- **BODY_STATE_LINEAR_VELOCITY** = **1** --- Constant to set/get the current linear velocity of the body. - -- **BODY_STATE_ANGULAR_VELOCITY** = **2** --- Constant to set/get the current angular velocity of the body. - -- **BODY_STATE_SLEEPING** = **3** --- Constant to sleep/wake up a body, or to get whether it is sleeping. - -- **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep. - -.. _enum_Physics2DServer_ProcessInfo: - -enum **ProcessInfo**: - -- **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping. - -- **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions. - -- **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur. - -.. _enum_Physics2DServer_JointParam: - -enum **JointParam**: - -- **JOINT_PARAM_BIAS** = **0** - -- **JOINT_PARAM_MAX_BIAS** = **1** - -- **JOINT_PARAM_MAX_FORCE** = **2** +- **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **6** --- 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. .. _enum_Physics2DServer_ShapeType: @@ -316,13 +290,31 @@ enum **AreaParameter**: - **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area. -.. _enum_Physics2DServer_AreaBodyStatus: +.. _enum_Physics2DServer_AreaSpaceOverrideMode: -enum **AreaBodyStatus**: +enum **AreaSpaceOverrideMode**: -- **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes. +- **AREA_SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. -- **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. +- **AREA_SPACE_OVERRIDE_COMBINE** = **1** --- 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** = **2** --- 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** = **3** --- 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** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. + +.. _enum_Physics2DServer_BodyMode: + +enum **BodyMode**: + +- **BODY_MODE_STATIC** = **0** --- Constant for static bodies. + +- **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies. + +- **BODY_MODE_RIGID** = **2** --- Constant for rigid bodies. + +- **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. .. _enum_Physics2DServer_BodyParameter: @@ -344,17 +336,39 @@ enum **BodyParameter**: - **BODY_PARAM_MAX** = **7** --- This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. -.. _enum_Physics2DServer_BodyMode: +.. _enum_Physics2DServer_BodyState: -enum **BodyMode**: +enum **BodyState**: -- **BODY_MODE_STATIC** = **0** --- Constant for static bodies. +- **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body. -- **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies. +- **BODY_STATE_LINEAR_VELOCITY** = **1** --- Constant to set/get the current linear velocity of the body. -- **BODY_MODE_RIGID** = **2** --- Constant for rigid bodies. +- **BODY_STATE_ANGULAR_VELOCITY** = **2** --- Constant to set/get the current angular velocity of the body. -- **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. +- **BODY_STATE_SLEEPING** = **3** --- Constant to sleep/wake up a body, or to get whether it is sleeping. + +- **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep. + +.. _enum_Physics2DServer_JointType: + +enum **JointType**: + +- **JOINT_PIN** = **0** --- Constant to create pin joints. + +- **JOINT_GROOVE** = **1** --- Constant to create groove joints. + +- **JOINT_DAMPED_SPRING** = **2** --- Constant to create damped spring joints. + +.. _enum_Physics2DServer_JointParam: + +enum **JointParam**: + +- **JOINT_PARAM_BIAS** = **0** + +- **JOINT_PARAM_MAX_BIAS** = **1** + +- **JOINT_PARAM_MAX_FORCE** = **2** .. _enum_Physics2DServer_DampedStringParam: @@ -366,47 +380,33 @@ enum **DampedStringParam**: - **DAMPED_STRING_DAMPING** = **2** --- 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). -.. _enum_Physics2DServer_SpaceParameter: +.. _enum_Physics2DServer_CCDMode: -enum **SpaceParameter**: +enum **CCDMode**: -- **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** --- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. +- **CCD_MODE_DISABLED** = **0** --- Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. -- **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated. +- **CCD_MODE_CAST_RAY** = **1** --- Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. -- **SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION** = **2** --- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. +- **CCD_MODE_CAST_SHAPE** = **2** --- Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. -- **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = **3** --- 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. +.. _enum_Physics2DServer_AreaBodyStatus: -- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = **4** --- 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. +enum **AreaBodyStatus**: -- **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** --- 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. +- **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes. -- **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **6** --- 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. +- **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. -.. _enum_Physics2DServer_AreaSpaceOverrideMode: +.. _enum_Physics2DServer_ProcessInfo: -enum **AreaSpaceOverrideMode**: +enum **ProcessInfo**: -- **AREA_SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. +- **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping. -- **AREA_SPACE_OVERRIDE_COMBINE** = **1** --- 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. +- **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions. -- **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- 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** = **3** --- 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** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. - -.. _enum_Physics2DServer_JointType: - -enum **JointType**: - -- **JOINT_PIN** = **0** --- Constant to create pin joints. - -- **JOINT_GROOVE** = **1** --- Constant to create groove joints. - -- **JOINT_DAMPED_SPRING** = **2** --- Constant to create damped spring joints. +- **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur. Description ----------- diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index dad4dffd4..7e74a0123 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -9,7 +9,7 @@ PhysicsBody **Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PhysicalBone`, :ref:`StaticBody`, :ref:`KinematicBody`, :ref:`RigidBody` +**Inherited By:** :ref:`KinematicBody`, :ref:`PhysicalBone`, :ref:`RigidBody`, :ref:`StaticBody` **Category:** Core diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 4bb5027ff..772c98b7e 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -9,7 +9,7 @@ PhysicsBody2D **Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`RigidBody2D`, :ref:`StaticBody2D`, :ref:`KinematicBody2D` +**Inherited By:** :ref:`KinematicBody2D`, :ref:`RigidBody2D`, :ref:`StaticBody2D` **Category:** Core diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 1ba2879e9..cb98368af 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -248,117 +248,19 @@ Methods Enumerations ------------ -.. _enum_PhysicsServer_BodyState: +.. _enum_PhysicsServer_JointType: -enum **BodyState**: +enum **JointType**: -- **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body. +- **JOINT_PIN** = **0** --- The :ref:`Joint` is a :ref:`PinJoint`. -- **BODY_STATE_LINEAR_VELOCITY** = **1** --- Constant to set/get the current linear velocity of the body. +- **JOINT_HINGE** = **1** --- The :ref:`Joint` is a :ref:`HingeJoint`. -- **BODY_STATE_ANGULAR_VELOCITY** = **2** --- Constant to set/get the current angular velocity of the body. +- **JOINT_SLIDER** = **2** --- The :ref:`Joint` is a :ref:`SliderJoint`. -- **BODY_STATE_SLEEPING** = **3** --- Constant to sleep/wake up a body, or to get whether it is sleeping. +- **JOINT_CONE_TWIST** = **3** --- The :ref:`Joint` is a :ref:`ConeTwistJoint`. -- **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep. - -.. _enum_PhysicsServer_G6DOFJointAxisParam: - -enum **G6DOFJointAxisParam**: - -- **G6DOF_JOINT_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes. - -- **G6DOF_JOINT_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes. - -- **G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor that gets applied to the movement across the axes. The lower, the slower the movement. - -- **G6DOF_JOINT_LINEAR_RESTITUTION** = **3** --- The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost. - -- **G6DOF_JOINT_LINEAR_DAMPING** = **4** --- The amount of damping that happens at the linear motion across the axes. - -- **G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY** = **5** --- The velocity that the joint's linear motor will attempt to reach. - -- **G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT** = **6** --- The maximum force that the linear motor can apply while trying to reach the target velocity. - -- **G6DOF_JOINT_ANGULAR_LOWER_LIMIT** = **10** --- The minimum rotation in negative direction to break loose and rotate around the axes. - -- **G6DOF_JOINT_ANGULAR_UPPER_LIMIT** = **11** --- The minimum rotation in positive direction to break loose and rotate around the axes. - -- **G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS** = **12** --- A factor that gets multiplied onto all rotations across the axes. - -- **G6DOF_JOINT_ANGULAR_DAMPING** = **13** --- The amount of rotational damping across the axes. The lower, the more dampening occurs. - -- **G6DOF_JOINT_ANGULAR_RESTITUTION** = **14** --- The amount of rotational restitution across the axes. The lower, the more restitution occurs. - -- **G6DOF_JOINT_ANGULAR_FORCE_LIMIT** = **15** --- The maximum amount of force that can occur, when rotating around the axes. - -- **G6DOF_JOINT_ANGULAR_ERP** = **16** --- When correcting the crossing of limits in rotation across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - -- **G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY** = **17** --- Target speed for the motor at the axes. - -- **G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT** = **18** --- Maximum acceleration for the motor at the axes. - -.. _enum_PhysicsServer_ProcessInfo: - -enum **ProcessInfo**: - -- **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping. - -- **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions. - -- **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur. - -.. _enum_PhysicsServer_ShapeType: - -enum **ShapeType**: - -- **SHAPE_PLANE** = **0** --- The :ref:`Shape` is a :ref:`PlaneShape`. - -- **SHAPE_RAY** = **1** --- The :ref:`Shape` is a :ref:`RayShape`. - -- **SHAPE_SPHERE** = **2** --- The :ref:`Shape` is a :ref:`SphereShape`. - -- **SHAPE_BOX** = **3** --- The :ref:`Shape` is a :ref:`BoxShape`. - -- **SHAPE_CAPSULE** = **4** --- The :ref:`Shape` is a :ref:`CapsuleShape`. - -- **SHAPE_CYLINDER** = **5** --- The :ref:`Shape` is a :ref:`CylinderShape`. - -- **SHAPE_CONVEX_POLYGON** = **6** --- The :ref:`Shape` is a :ref:`ConvexPolygonShape`. - -- **SHAPE_CONCAVE_POLYGON** = **7** --- The :ref:`Shape` is a :ref:`ConcavePolygonShape`. - -- **SHAPE_HEIGHTMAP** = **8** --- The :ref:`Shape` is a HeightMapShape. - -- **SHAPE_CUSTOM** = **9** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. - -.. _enum_PhysicsServer_HingeJointFlag: - -enum **HingeJointFlag**: - -- **HINGE_JOINT_FLAG_USE_LIMIT** = **0** --- If ``true``, the Hinge has a maximum and a minimum rotation. - -- **HINGE_JOINT_FLAG_ENABLE_MOTOR** = **1** --- If ``true``, a motor turns the Hinge - -.. _enum_PhysicsServer_AreaParameter: - -enum **AreaParameter**: - -- **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area. - -- **AREA_PARAM_GRAVITY_VECTOR** = **1** --- Constant to set/get gravity vector/center in an area. - -- **AREA_PARAM_GRAVITY_IS_POINT** = **2** --- Constant to set/get whether the gravity vector of an area is a direction, or a center point. - -- **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = **3** --- 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. - -- **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = **4** --- This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE. - -- **AREA_PARAM_LINEAR_DAMP** = **5** --- Constant to set/get the linear dampening factor of an area. - -- **AREA_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get the angular dampening factor of an area. - -- **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area. +- **JOINT_6DOF** = **4** --- The :ref:`Joint` is a :ref:`Generic6DOFJoint`. .. _enum_PhysicsServer_PinJointParam: @@ -374,119 +276,33 @@ The higher, the stronger. - **PIN_JOINT_IMPULSE_CLAMP** = **2** --- If above 0, this value is the maximum value for an impulse that this Joint puts on its ends. -.. _enum_PhysicsServer_BodyParameter: +.. _enum_PhysicsServer_HingeJointParam: -enum **BodyParameter**: +enum **HingeJointParam**: -- **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor. +- **HINGE_JOINT_BIAS** = **0** --- The speed with which the two bodies get pulled together when they move in different directions. -- **BODY_PARAM_FRICTION** = **1** --- Constant to set/get a body's friction. +- **HINGE_JOINT_LIMIT_UPPER** = **1** --- The maximum rotation across the Hinge. -- **BODY_PARAM_MASS** = **2** --- Constant to set/get a body's mass. +- **HINGE_JOINT_LIMIT_LOWER** = **2** --- The minimum rotation across the Hinge. -- **BODY_PARAM_GRAVITY_SCALE** = **3** --- Constant to set/get a body's gravity multiplier. +- **HINGE_JOINT_LIMIT_BIAS** = **3** --- The speed with which the rotation across the axis perpendicular to the hinge gets corrected. -- **BODY_PARAM_LINEAR_DAMP** = **4** --- Constant to set/get a body's linear dampening factor. +- **HINGE_JOINT_LIMIT_SOFTNESS** = **4** -- **BODY_PARAM_ANGULAR_DAMP** = **5** --- Constant to set/get a body's angular dampening factor. +- **HINGE_JOINT_LIMIT_RELAXATION** = **5** --- The lower this value, the more the rotation gets slowed down. -- **BODY_PARAM_MAX** = **6** --- This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. +- **HINGE_JOINT_MOTOR_TARGET_VELOCITY** = **6** --- Target speed for the motor. -.. _enum_PhysicsServer_BodyMode: +- **HINGE_JOINT_MOTOR_MAX_IMPULSE** = **7** --- Maximum acceleration for the motor. -enum **BodyMode**: +.. _enum_PhysicsServer_HingeJointFlag: -- **BODY_MODE_STATIC** = **0** --- Constant for static bodies. +enum **HingeJointFlag**: -- **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies. +- **HINGE_JOINT_FLAG_USE_LIMIT** = **0** --- If ``true``, the Hinge has a maximum and a minimum rotation. -- **BODY_MODE_RIGID** = **2** --- Constant for rigid bodies. - -- **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. - -.. _enum_PhysicsServer_SpaceParameter: - -enum **SpaceParameter**: - -- **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** --- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. - -- **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated. - -- **SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION** = **2** --- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. - -- **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = **3** --- 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. - -- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = **4** --- 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. - -- **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** --- 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. - -- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO** = **6** - -- **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **7** --- 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. - -.. _enum_PhysicsServer_AreaBodyStatus: - -enum **AreaBodyStatus**: - -- **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes. - -- **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. - -.. _enum_PhysicsServer_BodyAxis: - -enum **BodyAxis**: - -- **BODY_AXIS_LINEAR_X** = **1** - -- **BODY_AXIS_LINEAR_Y** = **2** - -- **BODY_AXIS_LINEAR_Z** = **4** - -- **BODY_AXIS_ANGULAR_X** = **8** - -- **BODY_AXIS_ANGULAR_Y** = **16** - -- **BODY_AXIS_ANGULAR_Z** = **32** - -.. _enum_PhysicsServer_JointType: - -enum **JointType**: - -- **JOINT_PIN** = **0** --- The :ref:`Joint` is a :ref:`PinJoint`. - -- **JOINT_HINGE** = **1** --- The :ref:`Joint` is a :ref:`HingeJoint`. - -- **JOINT_SLIDER** = **2** --- The :ref:`Joint` is a :ref:`SliderJoint`. - -- **JOINT_CONE_TWIST** = **3** --- The :ref:`Joint` is a :ref:`ConeTwistJoint`. - -- **JOINT_6DOF** = **4** --- The :ref:`Joint` is a :ref:`Generic6DOFJoint`. - -.. _enum_PhysicsServer_AreaSpaceOverrideMode: - -enum **AreaSpaceOverrideMode**: - -- **AREA_SPACE_OVERRIDE_DISABLED** = **0** --- 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** = **1** --- 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** = **2** --- 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** = **3** --- 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** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. - -.. _enum_PhysicsServer_G6DOFJointAxisFlag: - -enum **G6DOFJointAxisFlag**: - -- **G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. - -- **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible. - -- **G6DOF_JOINT_FLAG_ENABLE_MOTOR** = **4** --- If ``set`` there is a rotational motor across these axes. - -- **G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR** = **5** --- If ``set`` there is a linear motor on this axis that targets a specific velocity. +- **HINGE_JOINT_FLAG_ENABLE_MOTOR** = **1** --- If ``true``, a motor turns the Hinge .. _enum_PhysicsServer_SliderJointParam: @@ -562,25 +378,209 @@ The higher, the faster. - **CONE_TWIST_JOINT_RELAXATION** = **4** --- Defines, how fast the swing- and twist-speed-difference on both sides gets synced. -.. _enum_PhysicsServer_HingeJointParam: +.. _enum_PhysicsServer_G6DOFJointAxisParam: -enum **HingeJointParam**: +enum **G6DOFJointAxisParam**: -- **HINGE_JOINT_BIAS** = **0** --- The speed with which the two bodies get pulled together when they move in different directions. +- **G6DOF_JOINT_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes. -- **HINGE_JOINT_LIMIT_UPPER** = **1** --- The maximum rotation across the Hinge. +- **G6DOF_JOINT_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes. -- **HINGE_JOINT_LIMIT_LOWER** = **2** --- The minimum rotation across the Hinge. +- **G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor that gets applied to the movement across the axes. The lower, the slower the movement. -- **HINGE_JOINT_LIMIT_BIAS** = **3** --- The speed with which the rotation across the axis perpendicular to the hinge gets corrected. +- **G6DOF_JOINT_LINEAR_RESTITUTION** = **3** --- The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost. -- **HINGE_JOINT_LIMIT_SOFTNESS** = **4** +- **G6DOF_JOINT_LINEAR_DAMPING** = **4** --- The amount of damping that happens at the linear motion across the axes. -- **HINGE_JOINT_LIMIT_RELAXATION** = **5** --- The lower this value, the more the rotation gets slowed down. +- **G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY** = **5** --- The velocity that the joint's linear motor will attempt to reach. -- **HINGE_JOINT_MOTOR_TARGET_VELOCITY** = **6** --- Target speed for the motor. +- **G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT** = **6** --- The maximum force that the linear motor can apply while trying to reach the target velocity. -- **HINGE_JOINT_MOTOR_MAX_IMPULSE** = **7** --- Maximum acceleration for the motor. +- **G6DOF_JOINT_ANGULAR_LOWER_LIMIT** = **10** --- The minimum rotation in negative direction to break loose and rotate around the axes. + +- **G6DOF_JOINT_ANGULAR_UPPER_LIMIT** = **11** --- The minimum rotation in positive direction to break loose and rotate around the axes. + +- **G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS** = **12** --- A factor that gets multiplied onto all rotations across the axes. + +- **G6DOF_JOINT_ANGULAR_DAMPING** = **13** --- The amount of rotational damping across the axes. The lower, the more dampening occurs. + +- **G6DOF_JOINT_ANGULAR_RESTITUTION** = **14** --- The amount of rotational restitution across the axes. The lower, the more restitution occurs. + +- **G6DOF_JOINT_ANGULAR_FORCE_LIMIT** = **15** --- The maximum amount of force that can occur, when rotating around the axes. + +- **G6DOF_JOINT_ANGULAR_ERP** = **16** --- When correcting the crossing of limits in rotation across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. + +- **G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY** = **17** --- Target speed for the motor at the axes. + +- **G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT** = **18** --- Maximum acceleration for the motor at the axes. + +.. _enum_PhysicsServer_G6DOFJointAxisFlag: + +enum **G6DOFJointAxisFlag**: + +- **G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. + +- **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible. + +- **G6DOF_JOINT_FLAG_ENABLE_MOTOR** = **4** --- If ``set`` there is a rotational motor across these axes. + +- **G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR** = **5** --- If ``set`` there is a linear motor on this axis that targets a specific velocity. + +.. _enum_PhysicsServer_ShapeType: + +enum **ShapeType**: + +- **SHAPE_PLANE** = **0** --- The :ref:`Shape` is a :ref:`PlaneShape`. + +- **SHAPE_RAY** = **1** --- The :ref:`Shape` is a :ref:`RayShape`. + +- **SHAPE_SPHERE** = **2** --- The :ref:`Shape` is a :ref:`SphereShape`. + +- **SHAPE_BOX** = **3** --- The :ref:`Shape` is a :ref:`BoxShape`. + +- **SHAPE_CAPSULE** = **4** --- The :ref:`Shape` is a :ref:`CapsuleShape`. + +- **SHAPE_CYLINDER** = **5** --- The :ref:`Shape` is a :ref:`CylinderShape`. + +- **SHAPE_CONVEX_POLYGON** = **6** --- The :ref:`Shape` is a :ref:`ConvexPolygonShape`. + +- **SHAPE_CONCAVE_POLYGON** = **7** --- The :ref:`Shape` is a :ref:`ConcavePolygonShape`. + +- **SHAPE_HEIGHTMAP** = **8** --- The :ref:`Shape` is a HeightMapShape. + +- **SHAPE_CUSTOM** = **9** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. + +.. _enum_PhysicsServer_AreaParameter: + +enum **AreaParameter**: + +- **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area. + +- **AREA_PARAM_GRAVITY_VECTOR** = **1** --- Constant to set/get gravity vector/center in an area. + +- **AREA_PARAM_GRAVITY_IS_POINT** = **2** --- Constant to set/get whether the gravity vector of an area is a direction, or a center point. + +- **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = **3** --- 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. + +- **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = **4** --- This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE. + +- **AREA_PARAM_LINEAR_DAMP** = **5** --- Constant to set/get the linear dampening factor of an area. + +- **AREA_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get the angular dampening factor of an area. + +- **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area. + +.. _enum_PhysicsServer_AreaSpaceOverrideMode: + +enum **AreaSpaceOverrideMode**: + +- **AREA_SPACE_OVERRIDE_DISABLED** = **0** --- 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** = **1** --- 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** = **2** --- 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** = **3** --- 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** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. + +.. _enum_PhysicsServer_BodyMode: + +enum **BodyMode**: + +- **BODY_MODE_STATIC** = **0** --- Constant for static bodies. + +- **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies. + +- **BODY_MODE_RIGID** = **2** --- Constant for rigid bodies. + +- **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. + +.. _enum_PhysicsServer_BodyParameter: + +enum **BodyParameter**: + +- **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor. + +- **BODY_PARAM_FRICTION** = **1** --- Constant to set/get a body's friction. + +- **BODY_PARAM_MASS** = **2** --- Constant to set/get a body's mass. + +- **BODY_PARAM_GRAVITY_SCALE** = **3** --- Constant to set/get a body's gravity multiplier. + +- **BODY_PARAM_LINEAR_DAMP** = **4** --- Constant to set/get a body's linear dampening factor. + +- **BODY_PARAM_ANGULAR_DAMP** = **5** --- Constant to set/get a body's angular dampening factor. + +- **BODY_PARAM_MAX** = **6** --- This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. + +.. _enum_PhysicsServer_BodyState: + +enum **BodyState**: + +- **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body. + +- **BODY_STATE_LINEAR_VELOCITY** = **1** --- Constant to set/get the current linear velocity of the body. + +- **BODY_STATE_ANGULAR_VELOCITY** = **2** --- Constant to set/get the current angular velocity of the body. + +- **BODY_STATE_SLEEPING** = **3** --- Constant to sleep/wake up a body, or to get whether it is sleeping. + +- **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep. + +.. _enum_PhysicsServer_AreaBodyStatus: + +enum **AreaBodyStatus**: + +- **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes. + +- **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. + +.. _enum_PhysicsServer_ProcessInfo: + +enum **ProcessInfo**: + +- **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping. + +- **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions. + +- **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur. + +.. _enum_PhysicsServer_SpaceParameter: + +enum **SpaceParameter**: + +- **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** --- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. + +- **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated. + +- **SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION** = **2** --- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. + +- **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = **3** --- 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. + +- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = **4** --- 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. + +- **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** --- 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. + +- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO** = **6** + +- **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **7** --- 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. + +.. _enum_PhysicsServer_BodyAxis: + +enum **BodyAxis**: + +- **BODY_AXIS_LINEAR_X** = **1** + +- **BODY_AXIS_LINEAR_Y** = **2** + +- **BODY_AXIS_LINEAR_Z** = **4** + +- **BODY_AXIS_ANGULAR_X** = **8** + +- **BODY_AXIS_ANGULAR_Y** = **16** + +- **BODY_AXIS_ANGULAR_Z** = **32** Description ----------- diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 0b25ba989..3532a0e38 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -9,7 +9,7 @@ Popup **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PopupPanel`, :ref:`PopupDialog`, :ref:`PopupMenu`, :ref:`WindowDialog` +**Inherited By:** :ref:`PopupDialog`, :ref:`PopupMenu`, :ref:`PopupPanel`, :ref:`WindowDialog` **Category:** Core diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index d7e50ec27..df45bd2bf 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -9,7 +9,7 @@ PrimitiveMesh **Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`PlaneMesh`, :ref:`CubeMesh`, :ref:`SphereMesh`, :ref:`CylinderMesh`, :ref:`CapsuleMesh`, :ref:`QuadMesh`, :ref:`PrismMesh` +**Inherited By:** :ref:`CapsuleMesh`, :ref:`CubeMesh`, :ref:`CylinderMesh`, :ref:`PlaneMesh`, :ref:`PrismMesh`, :ref:`QuadMesh`, :ref:`SphereMesh` **Category:** Core diff --git a/classes/class_range.rst b/classes/class_range.rst index 8bdde6503..07ce5aefb 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -9,7 +9,7 @@ Range **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`SpinBox`, :ref:`ScrollBar`, :ref:`ProgressBar`, :ref:`TextureProgress`, :ref:`Slider` +**Inherited By:** :ref:`ProgressBar`, :ref:`ScrollBar`, :ref:`Slider`, :ref:`SpinBox`, :ref:`TextureProgress` **Category:** Core diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 0916ef63f..945499e39 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -9,7 +9,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`AnimationTrackEditPlugin`, :ref:`EditorScenePostImport`, :ref:`Expression`, :ref:`PhysicsShapeQueryResult`, :ref:`EditorSceneImporter`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`EditorInspectorPlugin`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`UPNP`, :ref:`EditorScript`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`XMLParser`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`ResourceFormatSaver`, :ref:`SceneState`, :ref:`ResourceFormatLoader`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`RandomNumberGenerator`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`UPNPDevice`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioStreamPlayback`, :ref:`ConfigFile`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorImportPlugin`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`JSONParseResult`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`XMLParser` **Category:** Core diff --git a/classes/class_resource.rst b/classes/class_resource.rst index b7467a575..77f724fc7 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -9,7 +9,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AnimationNodeStateMachinePlayback`, :ref:`AudioStream`, :ref:`Sky`, :ref:`Theme`, :ref:`TextureLayered`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`VisualShaderNode`, :ref:`Curve2D`, :ref:`Image`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`Mesh`, :ref:`StyleBox`, :ref:`Environment`, :ref:`CubeMap`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`PhysicsMaterial`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`TextFile`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`OpenSimplexNoise`, :ref:`BitMap`, :ref:`Animation`, :ref:`BakedLightmapData`, :ref:`PolygonPathFinder`, :ref:`Translation`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`AnimationNode`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`AnimationNodeStateMachineTransition`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`Animation`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BakedLightmapData`, :ref:`BitMap`, :ref:`ButtonGroup`, :ref:`CubeMap`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`DynamicFontData`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GDNativeLibrary`, :ref:`GIProbeData`, :ref:`Gradient`, :ref:`Image`, :ref:`InputEvent`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`OccluderPolygon2D`, :ref:`OpenSimplexNoise`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`Script`, :ref:`Shader`, :ref:`Shape`, :ref:`Shape2D`, :ref:`ShortCut`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`TextFile`, :ref:`Texture`, :ref:`TextureLayered`, :ref:`Theme`, :ref:`TileSet`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VisualScriptNode`, :ref:`VisualShaderNode`, :ref:`World`, :ref:`World2D` **Category:** Core diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index 5ee61899d..647087ca3 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -9,7 +9,7 @@ ResourceFormatLoader **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`ResourceFormatLoaderNativeScript`, :ref:`ResourceFormatLoaderText`, :ref:`ResourceFormatLoaderGDScript`, :ref:`ResourceFormatPVR`, :ref:`GDNativeLibraryResourceLoader`, :ref:`ResourceFormatLoaderWebm`, :ref:`ResourceFormatLoaderDynamicFont`, :ref:`ResourceFormatLoaderStreamTexture`, :ref:`ResourceFormatLoaderTheora`, :ref:`ResourceFormatLoaderTextureLayered`, :ref:`ResourceFormatImporter`, :ref:`TranslationLoaderPO`, :ref:`ResourceFormatLoaderImage`, :ref:`ResourceFormatLoaderBinary`, :ref:`ResourceFormatDDS`, :ref:`ResourceFormatLoaderBMFont`, :ref:`ResourceFormatLoaderShader`, :ref:`ResourceFormatPKM` +**Inherited By:** :ref:`GDNativeLibraryResourceLoader`, :ref:`ResourceFormatDDS`, :ref:`ResourceFormatImporter`, :ref:`ResourceFormatLoaderBMFont`, :ref:`ResourceFormatLoaderBinary`, :ref:`ResourceFormatLoaderDynamicFont`, :ref:`ResourceFormatLoaderGDScript`, :ref:`ResourceFormatLoaderImage`, :ref:`ResourceFormatLoaderNativeScript`, :ref:`ResourceFormatLoaderShader`, :ref:`ResourceFormatLoaderStreamTexture`, :ref:`ResourceFormatLoaderText`, :ref:`ResourceFormatLoaderTextureLayered`, :ref:`ResourceFormatLoaderTheora`, :ref:`ResourceFormatLoaderWebm`, :ref:`ResourceFormatPKM`, :ref:`ResourceFormatPVR`, :ref:`TranslationLoaderPO` **Category:** Core diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index d10d7402f..c552f89cd 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -9,7 +9,7 @@ ResourceFormatSaver **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`ResourceFormatSaverBinary`, :ref:`ResourceSaverPNG`, :ref:`ResourceFormatSaverGDScript`, :ref:`ResourceFormatSaverShader`, :ref:`ResourceFormatSaverText`, :ref:`GDNativeLibraryResourceSaver`, :ref:`ResourceFormatSaverNativeScript` +**Inherited By:** :ref:`GDNativeLibraryResourceSaver`, :ref:`ResourceFormatSaverBinary`, :ref:`ResourceFormatSaverGDScript`, :ref:`ResourceFormatSaverNativeScript`, :ref:`ResourceFormatSaverShader`, :ref:`ResourceFormatSaverText`, :ref:`ResourceSaverPNG` **Category:** Core diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 767ce9e73..71f9f425f 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -161,16 +161,6 @@ Triggers when the mouse enters a meta tag. Enumerations ------------ -.. _enum_RichTextLabel_ListType: - -enum **ListType**: - -- **LIST_NUMBERS** = **0** - -- **LIST_LETTERS** = **1** - -- **LIST_DOTS** = **2** - .. _enum_RichTextLabel_Align: enum **Align**: @@ -183,6 +173,16 @@ enum **Align**: - **ALIGN_FILL** = **3** +.. _enum_RichTextLabel_ListType: + +enum **ListType**: + +- **LIST_NUMBERS** = **0** + +- **LIST_LETTERS** = **1** + +- **LIST_DOTS** = **2** + .. _enum_RichTextLabel_ItemType: enum **ItemType**: diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index f16663caa..6e0f3f6fa 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -122,16 +122,6 @@ Emitted when :ref:`sleeping` changes. Enumerations ------------ -.. _enum_RigidBody2D_CCDMode: - -enum **CCDMode**: - -- **CCD_MODE_DISABLED** = **0** --- Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. - -- **CCD_MODE_CAST_RAY** = **1** --- Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise. - -- **CCD_MODE_CAST_SHAPE** = **2** --- Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise. - .. _enum_RigidBody2D_Mode: enum **Mode**: @@ -144,6 +134,16 @@ enum **Mode**: - **MODE_KINEMATIC** = **3** --- Kinematic mode. The body behaves like a :ref:`KinematicBody2D`, and must be moved by code. +.. _enum_RigidBody2D_CCDMode: + +enum **CCDMode**: + +- **CCD_MODE_DISABLED** = **0** --- Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. + +- **CCD_MODE_CAST_RAY** = **1** --- Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise. + +- **CCD_MODE_CAST_SHAPE** = **2** --- Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise. + Description ----------- diff --git a/classes/class_script.rst b/classes/class_script.rst index d144724a6..89707b336 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -9,7 +9,7 @@ Script **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScript`, :ref:`GDScript`, :ref:`CSharpScript`, :ref:`NativeScript`, :ref:`PluginScript` +**Inherited By:** :ref:`CSharpScript`, :ref:`GDScript`, :ref:`NativeScript`, :ref:`PluginScript`, :ref:`VisualScript` **Category:** Core diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 6a6ee5ea3..9e0512df3 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -9,7 +9,7 @@ Shape **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`CylinderShape`, :ref:`RayShape`, :ref:`SphereShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`PlaneShape`, :ref:`ConcavePolygonShape` +**Inherited By:** :ref:`BoxShape`, :ref:`CapsuleShape`, :ref:`ConcavePolygonShape`, :ref:`ConvexPolygonShape`, :ref:`CylinderShape`, :ref:`PlaneShape`, :ref:`RayShape`, :ref:`SphereShape` **Category:** Core diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 0fbabe878..79d1df36a 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -9,7 +9,7 @@ Shape2D **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`RayShape2D`, :ref:`LineShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`CapsuleShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` +**Inherited By:** :ref:`CapsuleShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`LineShape2D`, :ref:`RayShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` **Category:** Core diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 41d74274e..53d21ef00 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -9,7 +9,7 @@ Spatial **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`ARVRController`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`SpringArm`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`OrientedPathFollow`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` +**Inherited By:** :ref:`ARVRAnchor`, :ref:`ARVRController`, :ref:`ARVROrigin`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment`, :ref:`Camera`, :ref:`CollisionObject`, :ref:`CollisionPolygon`, :ref:`CollisionShape`, :ref:`GridMap`, :ref:`Joint`, :ref:`Listener`, :ref:`Navigation`, :ref:`NavigationMeshInstance`, :ref:`OrientedPathFollow`, :ref:`Path`, :ref:`PathFollow`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RayCast`, :ref:`RemoteTransform`, :ref:`Skeleton`, :ref:`SpringArm`, :ref:`VehicleWheel`, :ref:`VisibilityNotifier`, :ref:`VisualInstance` **Category:** Core diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 6191b062a..64bfc1928 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -224,14 +224,6 @@ Properties Enumerations ------------ -.. _enum_SpatialMaterial_DetailUV: - -enum **DetailUV**: - -- **DETAIL_UV_1** = **0** - -- **DETAIL_UV_2** = **1** - .. _enum_SpatialMaterial_TextureParam: enum **TextureParam**: @@ -270,53 +262,13 @@ enum **TextureParam**: - **TEXTURE_MAX** = **16** -.. _enum_SpatialMaterial_DistanceFadeMode: +.. _enum_SpatialMaterial_DetailUV: -enum **DistanceFadeMode**: +enum **DetailUV**: -- **DISTANCE_FADE_DISABLED** = **0** +- **DETAIL_UV_1** = **0** -- **DISTANCE_FADE_PIXEL_ALPHA** = **1** - -- **DISTANCE_FADE_PIXEL_DITHER** = **2** - -- **DISTANCE_FADE_OBJECT_DITHER** = **3** - -.. _enum_SpatialMaterial_DepthDrawMode: - -enum **DepthDrawMode**: - -- **DEPTH_DRAW_OPAQUE_ONLY** = **0** --- Default depth draw mode. Depth is drawn only for opaque objects. - -- **DEPTH_DRAW_ALWAYS** = **1** --- Depth draw is calculated for both opaque and transparent objects. - -- **DEPTH_DRAW_DISABLED** = **2** --- No depth draw. - -- **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = **3** --- For transparent objects, an opaque pass is made first with the opaque parts, then transparency is drawn. - -.. _enum_SpatialMaterial_DiffuseMode: - -enum **DiffuseMode**: - -- **DIFFUSE_BURLEY** = **0** --- Default diffuse scattering algorithm. - -- **DIFFUSE_LAMBERT** = **1** --- Diffuse scattering ignores roughness. - -- **DIFFUSE_LAMBERT_WRAP** = **2** --- Extends Lambert to cover more than 90 degrees when roughness increases. - -- **DIFFUSE_OREN_NAYAR** = **3** --- Attempts to use roughness to emulate microsurfacing. - -- **DIFFUSE_TOON** = **4** --- Uses a hard cut for lighting, with smoothing affected by roughness. - -.. _enum_SpatialMaterial_CullMode: - -enum **CullMode**: - -- **CULL_BACK** = **0** --- Default cull mode. The back of the object is culled when not visible. - -- **CULL_FRONT** = **1** --- The front of the object is culled when not visible. - -- **CULL_DISABLED** = **2** --- No culling is performed. +- **DETAIL_UV_2** = **1** .. _enum_SpatialMaterial_Feature: @@ -348,6 +300,40 @@ enum **Feature**: - **FEATURE_MAX** = **12** +.. _enum_SpatialMaterial_BlendMode: + +enum **BlendMode**: + +- **BLEND_MODE_MIX** = **0** --- Default blend mode. + +- **BLEND_MODE_ADD** = **1** + +- **BLEND_MODE_SUB** = **2** + +- **BLEND_MODE_MUL** = **3** + +.. _enum_SpatialMaterial_DepthDrawMode: + +enum **DepthDrawMode**: + +- **DEPTH_DRAW_OPAQUE_ONLY** = **0** --- Default depth draw mode. Depth is drawn only for opaque objects. + +- **DEPTH_DRAW_ALWAYS** = **1** --- Depth draw is calculated for both opaque and transparent objects. + +- **DEPTH_DRAW_DISABLED** = **2** --- No depth draw. + +- **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = **3** --- For transparent objects, an opaque pass is made first with the opaque parts, then transparency is drawn. + +.. _enum_SpatialMaterial_CullMode: + +enum **CullMode**: + +- **CULL_BACK** = **0** --- Default cull mode. The back of the object is culled when not visible. + +- **CULL_FRONT** = **1** --- The front of the object is culled when not visible. + +- **CULL_DISABLED** = **2** --- No culling is performed. + .. _enum_SpatialMaterial_Flags: enum **Flags**: @@ -390,17 +376,19 @@ enum **Flags**: - **FLAG_MAX** = **18** -.. _enum_SpatialMaterial_BlendMode: +.. _enum_SpatialMaterial_DiffuseMode: -enum **BlendMode**: +enum **DiffuseMode**: -- **BLEND_MODE_MIX** = **0** --- Default blend mode. +- **DIFFUSE_BURLEY** = **0** --- Default diffuse scattering algorithm. -- **BLEND_MODE_ADD** = **1** +- **DIFFUSE_LAMBERT** = **1** --- Diffuse scattering ignores roughness. -- **BLEND_MODE_SUB** = **2** +- **DIFFUSE_LAMBERT_WRAP** = **2** --- Extends Lambert to cover more than 90 degrees when roughness increases. -- **BLEND_MODE_MUL** = **3** +- **DIFFUSE_OREN_NAYAR** = **3** --- Attempts to use roughness to emulate microsurfacing. + +- **DIFFUSE_TOON** = **4** --- Uses a hard cut for lighting, with smoothing affected by roughness. .. _enum_SpatialMaterial_SpecularMode: @@ -416,6 +404,18 @@ enum **SpecularMode**: - **SPECULAR_DISABLED** = **4** --- No specular blob. +.. _enum_SpatialMaterial_BillboardMode: + +enum **BillboardMode**: + +- **BILLBOARD_DISABLED** = **0** --- Default value. + +- **BILLBOARD_ENABLED** = **1** --- The object's z-axis will always face the camera. + +- **BILLBOARD_FIXED_Y** = **2** --- The object's x-axis will always face the camera. + +- **BILLBOARD_PARTICLES** = **3** --- Used for particle systems. Enables particle animation options. + .. _enum_SpatialMaterial_TextureChannel: enum **TextureChannel**: @@ -430,18 +430,6 @@ enum **TextureChannel**: - **TEXTURE_CHANNEL_GRAYSCALE** = **4** -.. _enum_SpatialMaterial_BillboardMode: - -enum **BillboardMode**: - -- **BILLBOARD_DISABLED** = **0** --- Default value. - -- **BILLBOARD_ENABLED** = **1** --- The object's z-axis will always face the camera. - -- **BILLBOARD_FIXED_Y** = **2** --- The object's x-axis will always face the camera. - -- **BILLBOARD_PARTICLES** = **3** --- Used for particle systems. Enables particle animation options. - .. _enum_SpatialMaterial_EmissionOperator: enum **EmissionOperator**: @@ -450,6 +438,18 @@ enum **EmissionOperator**: - **EMISSION_OP_MULTIPLY** = **1** +.. _enum_SpatialMaterial_DistanceFadeMode: + +enum **DistanceFadeMode**: + +- **DISTANCE_FADE_DISABLED** = **0** + +- **DISTANCE_FADE_PIXEL_ALPHA** = **1** + +- **DISTANCE_FADE_PIXEL_DITHER** = **2** + +- **DISTANCE_FADE_OBJECT_DITHER** = **3** + Description ----------- diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 9a9c5a56e..96ada5cc8 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -59,16 +59,6 @@ Methods Enumerations ------------ -.. _enum_SpriteBase3D_AlphaCutMode: - -enum **AlphaCutMode**: - -- **ALPHA_CUT_DISABLED** = **0** - -- **ALPHA_CUT_DISCARD** = **1** - -- **ALPHA_CUT_OPAQUE_PREPASS** = **2** - .. _enum_SpriteBase3D_DrawFlags: enum **DrawFlags**: @@ -81,6 +71,16 @@ enum **DrawFlags**: - **FLAG_MAX** = **3** --- Used internally to mark the end of the Flags section. +.. _enum_SpriteBase3D_AlphaCutMode: + +enum **AlphaCutMode**: + +- **ALPHA_CUT_DISABLED** = **0** + +- **ALPHA_CUT_DISCARD** = **1** + +- **ALPHA_CUT_OPAQUE_PREPASS** = **2** + Description ----------- diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 0f10bd327..b8c82c98e 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -9,7 +9,7 @@ StreamPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP`, :ref:`StreamPeerGDNative` +**Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerGDNative`, :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP` **Category:** Core diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 5ca8577f2..37d7bff2c 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -9,7 +9,7 @@ StyleBox **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`StyleBoxLine`, :ref:`StyleBoxFlat`, :ref:`StyleBoxTexture`, :ref:`StyleBoxEmpty` +**Inherited By:** :ref:`StyleBoxEmpty`, :ref:`StyleBoxFlat`, :ref:`StyleBoxLine`, :ref:`StyleBoxTexture` **Category:** Core diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 852256ac9..0d0bea432 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -143,18 +143,6 @@ Signals Enumerations ------------ -.. _enum_Tabs_CloseButtonDisplayPolicy: - -enum **CloseButtonDisplayPolicy**: - -- **CLOSE_BUTTON_SHOW_NEVER** = **0** - -- **CLOSE_BUTTON_SHOW_ACTIVE_ONLY** = **1** - -- **CLOSE_BUTTON_SHOW_ALWAYS** = **2** - -- **CLOSE_BUTTON_MAX** = **3** - .. _enum_Tabs_TabAlign: enum **TabAlign**: @@ -167,6 +155,18 @@ enum **TabAlign**: - **ALIGN_MAX** = **3** +.. _enum_Tabs_CloseButtonDisplayPolicy: + +enum **CloseButtonDisplayPolicy**: + +- **CLOSE_BUTTON_SHOW_NEVER** = **0** + +- **CLOSE_BUTTON_SHOW_ACTIVE_ONLY** = **1** + +- **CLOSE_BUTTON_SHOW_ALWAYS** = **2** + +- **CLOSE_BUTTON_MAX** = **3** + Description ----------- diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index e85179b90..5c9993311 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -247,6 +247,16 @@ Emitted when the text changes. Enumerations ------------ +.. _enum_TextEdit_SearchFlags: + +enum **SearchFlags**: + +- **SEARCH_MATCH_CASE** = **1** --- Match case when searching. + +- **SEARCH_WHOLE_WORDS** = **2** --- Match whole words when searching. + +- **SEARCH_BACKWARDS** = **4** --- Search from end to beginning. + .. _enum_TextEdit_MenuItems: enum **MenuItems**: @@ -267,16 +277,6 @@ enum **MenuItems**: - **MENU_MAX** = **7** -.. _enum_TextEdit_SearchFlags: - -enum **SearchFlags**: - -- **SEARCH_MATCH_CASE** = **1** --- Match case when searching. - -- **SEARCH_WHOLE_WORDS** = **2** --- Match whole words when searching. - -- **SEARCH_BACKWARDS** = **4** --- Search from end to beginning. - Description ----------- diff --git a/classes/class_texture.rst b/classes/class_texture.rst index fa2af7140..0acad975d 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -9,7 +9,7 @@ Texture **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`CurveTexture`, :ref:`NoiseTexture`, :ref:`AtlasTexture`, :ref:`ProxyTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`AnimatedTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` +**Inherited By:** :ref:`AnimatedTexture`, :ref:`AtlasTexture`, :ref:`CurveTexture`, :ref:`GradientTexture`, :ref:`ImageTexture`, :ref:`LargeTexture`, :ref:`NoiseTexture`, :ref:`ProxyTexture`, :ref:`StreamTexture`, :ref:`ViewportTexture` **Category:** Core diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index f95cd4070..0cc87b707 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -9,7 +9,7 @@ TextureLayered **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`TextureArray`, :ref:`Texture3D` +**Inherited By:** :ref:`Texture3D`, :ref:`TextureArray` **Category:** Core diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index ea1fd59e5..dfab2aa5f 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -112,6 +112,16 @@ Emitted when a tilemap setting has changed. Enumerations ------------ +.. _enum_TileMap_Mode: + +enum **Mode**: + +- **MODE_SQUARE** = **0** --- Orthogonal orientation mode. + +- **MODE_ISOMETRIC** = **1** --- Isometric orientation mode. + +- **MODE_CUSTOM** = **2** --- Custom orientation mode. + .. _enum_TileMap_HalfOffset: enum **HalfOffset**: @@ -132,16 +142,6 @@ enum **TileOrigin**: - **TILE_ORIGIN_BOTTOM_LEFT** = **2** --- Tile origin at its bottom-left corner. -.. _enum_TileMap_Mode: - -enum **Mode**: - -- **MODE_SQUARE** = **0** --- Orthogonal orientation mode. - -- **MODE_ISOMETRIC** = **1** --- Isometric orientation mode. - -- **MODE_CUSTOM** = **2** --- Custom orientation mode. - Constants --------- diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index b4608e5a7..4f3e81b6e 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -134,16 +134,6 @@ enum **BitmaskMode**: - **BITMASK_3X3** = **2** -.. _enum_TileSet_TileMode: - -enum **TileMode**: - -- **SINGLE_TILE** = **0** - -- **AUTO_TILE** = **1** - -- **ATLAS_TILE** = **2** - .. _enum_TileSet_AutotileBindings: enum **AutotileBindings**: @@ -164,6 +154,16 @@ enum **AutotileBindings**: - **BIND_BOTTOMRIGHT** = **256** +.. _enum_TileSet_TileMode: + +enum **TileMode**: + +- **SINGLE_TILE** = **0** + +- **AUTO_TILE** = **1** + +- **ATLAS_TILE** = **2** + Description ----------- diff --git a/classes/class_tree.rst b/classes/class_tree.rst index a3787f1db..9a762a1ae 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -261,16 +261,6 @@ Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``. Enumerations ------------ -.. _enum_Tree_DropModeFlags: - -enum **DropModeFlags**: - -- **DROP_MODE_DISABLED** = **0** - -- **DROP_MODE_ON_ITEM** = **1** - -- **DROP_MODE_INBETWEEN** = **2** - .. _enum_Tree_SelectMode: enum **SelectMode**: @@ -281,6 +271,16 @@ enum **SelectMode**: - **SELECT_MULTI** = **2** --- Allow selection of multiple items at the same time. +.. _enum_Tree_DropModeFlags: + +enum **DropModeFlags**: + +- **DROP_MODE_DISABLED** = **0** + +- **DROP_MODE_ON_ITEM** = **1** + +- **DROP_MODE_INBETWEEN** = **2** + Description ----------- diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 23abebbe7..7d47474f9 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -108,18 +108,6 @@ enum **TweenProcessMode**: - **TWEEN_PROCESS_IDLE** = **1** --- The tween updates with the ``_process`` callback. -.. _enum_Tween_EaseType: - -enum **EaseType**: - -- **EASE_IN** = **0** --- The interpolation starts slowly and speeds up towards the end. - -- **EASE_OUT** = **1** --- The interpolation starts quickly and slows down towards the end. - -- **EASE_IN_OUT** = **2** --- A combination of EASE_IN and EASE_OUT. The interpolation is slowest at both ends. - -- **EASE_OUT_IN** = **3** --- A combination of EASE_IN and EASE_OUT. The interpolation is fastest at both ends. - .. _enum_Tween_TransitionType: enum **TransitionType**: @@ -146,6 +134,18 @@ enum **TransitionType**: - **TRANS_BACK** = **10** --- The animation is interpolated backing out at ends. +.. _enum_Tween_EaseType: + +enum **EaseType**: + +- **EASE_IN** = **0** --- The interpolation starts slowly and speeds up towards the end. + +- **EASE_OUT** = **1** --- The interpolation starts quickly and slows down towards the end. + +- **EASE_IN_OUT** = **2** --- A combination of EASE_IN and EASE_OUT. The interpolation is slowest at both ends. + +- **EASE_OUT_IN** = **3** --- A combination of EASE_IN and EASE_OUT. The interpolation is fastest at both ends. + Description ----------- diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index e3f423a90..624d67f9a 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -9,7 +9,7 @@ VideoStream **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VideoStreamWebm`, :ref:`VideoStreamTheora` +**Inherited By:** :ref:`VideoStreamTheora`, :ref:`VideoStreamWebm` **Category:** Core diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 8fd9c2c2d..ab1e3cd77 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -156,72 +156,6 @@ enum **UpdateMode**: - **UPDATE_ALWAYS** = **3** --- Always update the render target. -.. _enum_Viewport_RenderInfo: - -enum **RenderInfo**: - -- **RENDER_INFO_OBJECTS_IN_FRAME** = **0** --- Amount of objects in frame. - -- **RENDER_INFO_VERTICES_IN_FRAME** = **1** --- Amount of vertices in frame. - -- **RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2** --- Amount of material changes in frame. - -- **RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3** --- Amount of shader changes in frame. - -- **RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4** --- Amount of surface changes in frame. - -- **RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** --- Amount of draw calls in frame. - -- **RENDER_INFO_MAX** = **6** --- Enum limiter. Do not use it directly. - -.. _enum_Viewport_MSAA: - -enum **MSAA**: - -- **MSAA_DISABLED** = **0** --- Multisample anti-aliasing mode disabled. This is the default value. - -- **MSAA_2X** = **1** - -- **MSAA_4X** = **2** - -- **MSAA_8X** = **3** - -- **MSAA_16X** = **4** - -.. _enum_Viewport_ClearMode: - -enum **ClearMode**: - -- **CLEAR_MODE_ALWAYS** = **0** --- Always clear the render target before drawing. - -- **CLEAR_MODE_NEVER** = **1** --- Never clear the render target. - -- **CLEAR_MODE_ONLY_NEXT_FRAME** = **2** --- Clear the render target next frame, then switch to ``CLEAR_MODE_NEVER``. - -.. _enum_Viewport_Usage: - -enum **Usage**: - -- **USAGE_2D** = **0** - -- **USAGE_2D_NO_SAMPLING** = **1** - -- **USAGE_3D** = **2** - -- **USAGE_3D_NO_EFFECTS** = **3** - -.. _enum_Viewport_DebugDraw: - -enum **DebugDraw**: - -- **DEBUG_DRAW_DISABLED** = **0** --- Objects are displayed normally. - -- **DEBUG_DRAW_UNSHADED** = **1** --- Objects are displayed without light information. - -- **DEBUG_DRAW_OVERDRAW** = **2** --- Objected are displayed semi-transparent with additive blending so you can see where they intersect. - -- **DEBUG_DRAW_WIREFRAME** = **3** --- Objects are displayed in wireframe style. - .. _enum_Viewport_ShadowAtlasQuadrantSubdiv: enum **ShadowAtlasQuadrantSubdiv**: @@ -242,6 +176,72 @@ enum **ShadowAtlasQuadrantSubdiv**: - **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7** --- Enum limiter. Do not use it directly. +.. _enum_Viewport_RenderInfo: + +enum **RenderInfo**: + +- **RENDER_INFO_OBJECTS_IN_FRAME** = **0** --- Amount of objects in frame. + +- **RENDER_INFO_VERTICES_IN_FRAME** = **1** --- Amount of vertices in frame. + +- **RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2** --- Amount of material changes in frame. + +- **RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3** --- Amount of shader changes in frame. + +- **RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4** --- Amount of surface changes in frame. + +- **RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** --- Amount of draw calls in frame. + +- **RENDER_INFO_MAX** = **6** --- Enum limiter. Do not use it directly. + +.. _enum_Viewport_DebugDraw: + +enum **DebugDraw**: + +- **DEBUG_DRAW_DISABLED** = **0** --- Objects are displayed normally. + +- **DEBUG_DRAW_UNSHADED** = **1** --- Objects are displayed without light information. + +- **DEBUG_DRAW_OVERDRAW** = **2** --- Objected are displayed semi-transparent with additive blending so you can see where they intersect. + +- **DEBUG_DRAW_WIREFRAME** = **3** --- Objects are displayed in wireframe style. + +.. _enum_Viewport_MSAA: + +enum **MSAA**: + +- **MSAA_DISABLED** = **0** --- Multisample anti-aliasing mode disabled. This is the default value. + +- **MSAA_2X** = **1** + +- **MSAA_4X** = **2** + +- **MSAA_8X** = **3** + +- **MSAA_16X** = **4** + +.. _enum_Viewport_Usage: + +enum **Usage**: + +- **USAGE_2D** = **0** + +- **USAGE_2D_NO_SAMPLING** = **1** + +- **USAGE_3D** = **2** + +- **USAGE_3D_NO_EFFECTS** = **3** + +.. _enum_Viewport_ClearMode: + +enum **ClearMode**: + +- **CLEAR_MODE_ALWAYS** = **0** --- Always clear the render target before drawing. + +- **CLEAR_MODE_NEVER** = **1** --- Never clear the render target. + +- **CLEAR_MODE_ONLY_NEXT_FRAME** = **2** --- Clear the render target next frame, then switch to ``CLEAR_MODE_NEVER``. + Description ----------- diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index a8aaea236..544c3a2e6 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -9,7 +9,7 @@ VisualInstance **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BakedLightmap`, :ref:`Light`, :ref:`RootMotionView`, :ref:`ReflectionProbe`, :ref:`CSGShape`, :ref:`GIProbe`, :ref:`GeometryInstance` +**Inherited By:** :ref:`BakedLightmap`, :ref:`CSGShape`, :ref:`GIProbe`, :ref:`GeometryInstance`, :ref:`Light`, :ref:`ReflectionProbe`, :ref:`RootMotionView` **Category:** Core diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index b1f6aa385..2ba3c18f5 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -9,7 +9,7 @@ VisualScriptNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptYield`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` +**Inherited By:** :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptCondition`, :ref:`VisualScriptConstant`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptExpression`, :ref:`VisualScriptFunction`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptIterator`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptOperator`, :ref:`VisualScriptPreload`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptSelect`, :ref:`VisualScriptSelf`, :ref:`VisualScriptSequence`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptYield`, :ref:`VisualScriptYieldSignal` **Category:** Core diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 58e0fc3db..d89a8d985 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -747,24 +747,6 @@ Signals Enumerations ------------ -.. _enum_VisualServer_ViewportRenderInfo: - -enum **ViewportRenderInfo**: - -- **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0** - -- **VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME** = **1** - -- **VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2** - -- **VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3** - -- **VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4** - -- **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** - -- **VIEWPORT_RENDER_INFO_MAX** = **6** --- Marks end of VIEWPORT_RENDER_INFO\* constants. Used internally. - .. _enum_VisualServer_CubeMapSide: enum **CubeMapSide**: @@ -793,15 +775,39 @@ enum **TextureType**: - **TEXTURE_TYPE_3D** = **3** -.. _enum_VisualServer_LightType: +.. _enum_VisualServer_TextureFlags: -enum **LightType**: +enum **TextureFlags**: -- **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light. +- **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. -- **LIGHT_OMNI** = **1** --- is an omni light. +- **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge). -- **LIGHT_SPOT** = **2** --- is an spot light. +- **TEXTURE_FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture. + +- **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** --- 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. + +- **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space. + +- **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeat texture with alternate sections mirrored. + +- **TEXTURE_FLAG_USED_FOR_STREAMING** = **2048** --- Texture is a video surface. + +- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. + +.. _enum_VisualServer_ShaderMode: + +enum **ShaderMode**: + +- **SHADER_SPATIAL** = **0** --- Shader is a 3D shader. + +- **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader. + +- **SHADER_PARTICLES** = **2** --- Shader is a particle shader. + +- **SHADER_MAX** = **3** --- Marks maximum of the shader types array. used internally. .. _enum_VisualServer_ArrayType: @@ -827,326 +833,6 @@ enum **ArrayType**: - **ARRAY_MAX** = **9** --- Marks the maximum of the array types. Used internally. -.. _enum_VisualServer_BlendShapeMode: - -enum **BlendShapeMode**: - -- **BLEND_SHAPE_MODE_NORMALIZED** = **0** - -- **BLEND_SHAPE_MODE_RELATIVE** = **1** - -.. _enum_VisualServer_ShadowCastingSetting: - -enum **ShadowCastingSetting**: - -- **SHADOW_CASTING_SETTING_OFF** = **0** - -- **SHADOW_CASTING_SETTING_ON** = **1** - -- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2** - -- **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3** - -.. _enum_VisualServer_CanvasOccluderPolygonCullMode: - -enum **CanvasOccluderPolygonCullMode**: - -- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled. - -- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise. - -- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise. - -.. _enum_VisualServer_ParticlesDrawOrder: - -enum **ParticlesDrawOrder**: - -- **PARTICLES_DRAW_ORDER_INDEX** = **0** - -- **PARTICLES_DRAW_ORDER_LIFETIME** = **1** - -- **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2** - -.. _enum_VisualServer_ViewportMSAA: - -enum **ViewportMSAA**: - -- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled. - -- **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X. - -- **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4X. - -- **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X. - -- **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X. - -.. _enum_VisualServer_ViewportUpdateMode: - -enum **ViewportUpdateMode**: - -- **VIEWPORT_UPDATE_DISABLED** = **0** - -- **VIEWPORT_UPDATE_ONCE** = **1** - -- **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2** - -- **VIEWPORT_UPDATE_ALWAYS** = **3** - -.. _enum_VisualServer_MultimeshColorFormat: - -enum **MultimeshColorFormat**: - -- **MULTIMESH_COLOR_NONE** = **0** - -- **MULTIMESH_COLOR_8BIT** = **1** - -- **MULTIMESH_COLOR_FLOAT** = **2** - -.. _enum_VisualServer_LightDirectionalShadowMode: - -enum **LightDirectionalShadowMode**: - -- **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = **0** - -- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = **1** - -- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = **2** - -.. _enum_VisualServer_LightOmniShadowMode: - -enum **LightOmniShadowMode**: - -- **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0** - -- **LIGHT_OMNI_SHADOW_CUBE** = **1** - -.. _enum_VisualServer_EnvironmentSSAOQuality: - -enum **EnvironmentSSAOQuality**: - -- **ENV_SSAO_QUALITY_LOW** = **0** - -- **ENV_SSAO_QUALITY_MEDIUM** = **1** - -- **ENV_SSAO_QUALITY_HIGH** = **2** - -.. _enum_VisualServer_LightParam: - -enum **LightParam**: - -- **LIGHT_PARAM_ENERGY** = **0** --- The light's energy. - -- **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity. - -- **LIGHT_PARAM_RANGE** = **3** --- The light's range. - -- **LIGHT_PARAM_ATTENUATION** = **4** --- The light's attenuation. - -- **LIGHT_PARAM_SPOT_ANGLE** = **5** --- The spotlight's angle. - -- **LIGHT_PARAM_SPOT_ATTENUATION** = **6** --- The spotlight's attenuation. - -- **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **7** --- Scales the shadow color. - -- **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **8** - -- **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **9** - -- **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **10** - -- **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **11** - -- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **12** - -- **LIGHT_PARAM_SHADOW_BIAS** = **13** - -- **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14** - -- **LIGHT_PARAM_MAX** = **15** --- The light parameters endpoint. Used internally. - -.. _enum_VisualServer_ScenarioDebugMode: - -enum **ScenarioDebugMode**: - -- **SCENARIO_DEBUG_DISABLED** = **0** - -- **SCENARIO_DEBUG_WIREFRAME** = **1** - -- **SCENARIO_DEBUG_OVERDRAW** = **2** - -- **SCENARIO_DEBUG_SHADELESS** = **3** - -.. _enum_VisualServer_LightDirectionalShadowDepthRangeMode: - -enum **LightDirectionalShadowDepthRangeMode**: - -- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE** = **0** - -- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** - -.. _enum_VisualServer_EnvironmentGlowBlendMode: - -enum **EnvironmentGlowBlendMode**: - -- **GLOW_BLEND_MODE_ADDITIVE** = **0** - -- **GLOW_BLEND_MODE_SCREEN** = **1** - -- **GLOW_BLEND_MODE_SOFTLIGHT** = **2** - -- **GLOW_BLEND_MODE_REPLACE** = **3** - -.. _enum_VisualServer_InstanceType: - -enum **InstanceType**: - -- **INSTANCE_NONE** = **0** --- The instance does not have a type. - -- **INSTANCE_MESH** = **1** --- The instance is a mesh. - -- **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh. - -- **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry. - -- **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter. - -- **INSTANCE_LIGHT** = **5** --- The instance is a light. - -- **INSTANCE_REFLECTION_PROBE** = **6** - -- **INSTANCE_GI_PROBE** = **7** - -- **INSTANCE_LIGHTMAP_CAPTURE** = **8** - -- **INSTANCE_MAX** = **9** --- The max value for INSTANCE\_\* constants, used internally. - -- **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). - -.. _enum_VisualServer_ShaderMode: - -enum **ShaderMode**: - -- **SHADER_SPATIAL** = **0** --- Shader is a 3D shader. - -- **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader. - -- **SHADER_PARTICLES** = **2** --- Shader is a particle shader. - -- **SHADER_MAX** = **3** --- Marks maximum of the shader types array. used internally. - -.. _enum_VisualServer_ViewportUsage: - -enum **ViewportUsage**: - -- **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples. - -- **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample. - -- **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects. - -- **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects. - -.. _enum_VisualServer_EnvironmentDOFBlurQuality: - -enum **EnvironmentDOFBlurQuality**: - -- **ENV_DOF_BLUR_QUALITY_LOW** = **0** - -- **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1** - -- **ENV_DOF_BLUR_QUALITY_HIGH** = **2** - -.. _enum_VisualServer_PrimitiveType: - -enum **PrimitiveType**: - -- **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points. - -- **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines. - -- **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end. - -- **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex). - -- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles. - -- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle). - -- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle). - -- **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally. - -.. _enum_VisualServer_InstanceFlags: - -enum **InstanceFlags**: - -- **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0** - -- **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1** - -- **INSTANCE_FLAG_MAX** = **2** - -.. _enum_VisualServer_ViewportClearMode: - -enum **ViewportClearMode**: - -- **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing. - -- **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing. - -- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER. - -.. _enum_VisualServer_LightOmniShadowDetail: - -enum **LightOmniShadowDetail**: - -- **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0** - -- **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1** - -.. _enum_VisualServer_CanvasLightMode: - -enum **CanvasLightMode**: - -- **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas. - -- **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas. - -- **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency. - -- **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask. - -.. _enum_VisualServer_NinePatchAxisMode: - -enum **NinePatchAxisMode**: - -- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed. - -- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed. - -- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed. - -.. _enum_VisualServer_ViewportDebugDraw: - -enum **ViewportDebugDraw**: - -- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting. - -- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded. - -- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``. - -- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe. - -.. _enum_VisualServer_MultimeshTransformFormat: - -enum **MultimeshTransformFormat**: - -- **MULTIMESH_TRANSFORM_2D** = **0** - -- **MULTIMESH_TRANSFORM_3D** = **1** - .. _enum_VisualServer_ArrayFormat: enum **ArrayFormat**: @@ -1193,17 +879,297 @@ enum **ArrayFormat**: - **ARRAY_COMPRESS_DEFAULT** = **97280** --- 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. -.. _enum_VisualServer_EnvironmentSSAOBlur: +.. _enum_VisualServer_PrimitiveType: -enum **EnvironmentSSAOBlur**: +enum **PrimitiveType**: -- **ENV_SSAO_BLUR_DISABLED** = **0** +- **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points. -- **ENV_SSAO_BLUR_1x1** = **1** +- **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines. -- **ENV_SSAO_BLUR_2x2** = **2** +- **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end. -- **ENV_SSAO_BLUR_3x3** = **3** +- **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex). + +- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles. + +- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle). + +- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle). + +- **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally. + +.. _enum_VisualServer_BlendShapeMode: + +enum **BlendShapeMode**: + +- **BLEND_SHAPE_MODE_NORMALIZED** = **0** + +- **BLEND_SHAPE_MODE_RELATIVE** = **1** + +.. _enum_VisualServer_LightType: + +enum **LightType**: + +- **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light. + +- **LIGHT_OMNI** = **1** --- is an omni light. + +- **LIGHT_SPOT** = **2** --- is an spot light. + +.. _enum_VisualServer_LightParam: + +enum **LightParam**: + +- **LIGHT_PARAM_ENERGY** = **0** --- The light's energy. + +- **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity. + +- **LIGHT_PARAM_RANGE** = **3** --- The light's range. + +- **LIGHT_PARAM_ATTENUATION** = **4** --- The light's attenuation. + +- **LIGHT_PARAM_SPOT_ANGLE** = **5** --- The spotlight's angle. + +- **LIGHT_PARAM_SPOT_ATTENUATION** = **6** --- The spotlight's attenuation. + +- **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **7** --- Scales the shadow color. + +- **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **8** + +- **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **9** + +- **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **10** + +- **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **11** + +- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **12** + +- **LIGHT_PARAM_SHADOW_BIAS** = **13** + +- **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14** + +- **LIGHT_PARAM_MAX** = **15** --- The light parameters endpoint. Used internally. + +.. _enum_VisualServer_LightOmniShadowMode: + +enum **LightOmniShadowMode**: + +- **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0** + +- **LIGHT_OMNI_SHADOW_CUBE** = **1** + +.. _enum_VisualServer_LightOmniShadowDetail: + +enum **LightOmniShadowDetail**: + +- **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0** + +- **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1** + +.. _enum_VisualServer_LightDirectionalShadowMode: + +enum **LightDirectionalShadowMode**: + +- **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = **0** + +- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = **1** + +- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = **2** + +.. _enum_VisualServer_LightDirectionalShadowDepthRangeMode: + +enum **LightDirectionalShadowDepthRangeMode**: + +- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE** = **0** + +- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** + +.. _enum_VisualServer_ViewportUpdateMode: + +enum **ViewportUpdateMode**: + +- **VIEWPORT_UPDATE_DISABLED** = **0** + +- **VIEWPORT_UPDATE_ONCE** = **1** + +- **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2** + +- **VIEWPORT_UPDATE_ALWAYS** = **3** + +.. _enum_VisualServer_ViewportClearMode: + +enum **ViewportClearMode**: + +- **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing. + +- **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing. + +- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER. + +.. _enum_VisualServer_ViewportMSAA: + +enum **ViewportMSAA**: + +- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled. + +- **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X. + +- **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4X. + +- **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X. + +- **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X. + +.. _enum_VisualServer_ViewportUsage: + +enum **ViewportUsage**: + +- **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples. + +- **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample. + +- **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects. + +- **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects. + +.. _enum_VisualServer_ViewportRenderInfo: + +enum **ViewportRenderInfo**: + +- **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0** + +- **VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME** = **1** + +- **VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2** + +- **VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3** + +- **VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4** + +- **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** + +- **VIEWPORT_RENDER_INFO_MAX** = **6** --- Marks end of VIEWPORT_RENDER_INFO\* constants. Used internally. + +.. _enum_VisualServer_ViewportDebugDraw: + +enum **ViewportDebugDraw**: + +- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting. + +- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded. + +- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``. + +- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe. + +.. _enum_VisualServer_ScenarioDebugMode: + +enum **ScenarioDebugMode**: + +- **SCENARIO_DEBUG_DISABLED** = **0** + +- **SCENARIO_DEBUG_WIREFRAME** = **1** + +- **SCENARIO_DEBUG_OVERDRAW** = **2** + +- **SCENARIO_DEBUG_SHADELESS** = **3** + +.. _enum_VisualServer_InstanceType: + +enum **InstanceType**: + +- **INSTANCE_NONE** = **0** --- The instance does not have a type. + +- **INSTANCE_MESH** = **1** --- The instance is a mesh. + +- **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh. + +- **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry. + +- **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter. + +- **INSTANCE_LIGHT** = **5** --- The instance is a light. + +- **INSTANCE_REFLECTION_PROBE** = **6** + +- **INSTANCE_GI_PROBE** = **7** + +- **INSTANCE_LIGHTMAP_CAPTURE** = **8** + +- **INSTANCE_MAX** = **9** --- The max value for INSTANCE\_\* constants, used internally. + +- **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). + +.. _enum_VisualServer_InstanceFlags: + +enum **InstanceFlags**: + +- **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0** + +- **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1** + +- **INSTANCE_FLAG_MAX** = **2** + +.. _enum_VisualServer_ShadowCastingSetting: + +enum **ShadowCastingSetting**: + +- **SHADOW_CASTING_SETTING_OFF** = **0** + +- **SHADOW_CASTING_SETTING_ON** = **1** + +- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2** + +- **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3** + +.. _enum_VisualServer_NinePatchAxisMode: + +enum **NinePatchAxisMode**: + +- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed. + +- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed. + +- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed. + +.. _enum_VisualServer_CanvasLightMode: + +enum **CanvasLightMode**: + +- **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas. + +- **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas. + +- **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency. + +- **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask. + +.. _enum_VisualServer_CanvasLightShadowFilter: + +enum **CanvasLightShadowFilter**: + +- **CANVAS_LIGHT_FILTER_NONE** = **0** + +- **CANVAS_LIGHT_FILTER_PCF3** = **1** + +- **CANVAS_LIGHT_FILTER_PCF5** = **2** + +- **CANVAS_LIGHT_FILTER_PCF7** = **3** + +- **CANVAS_LIGHT_FILTER_PCF9** = **4** + +- **CANVAS_LIGHT_FILTER_PCF13** = **5** + +.. _enum_VisualServer_CanvasOccluderPolygonCullMode: + +enum **CanvasOccluderPolygonCullMode**: + +- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled. + +- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise. + +- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise. .. _enum_VisualServer_RenderInfo: @@ -1229,6 +1195,32 @@ enum **RenderInfo**: - **INFO_VERTEX_MEM_USED** = **9** --- The amount of vertex memory used. +.. _enum_VisualServer_Features: + +enum **Features**: + +- **FEATURE_SHADERS** = **0** + +- **FEATURE_MULTITHREADED** = **1** + +.. _enum_VisualServer_MultimeshTransformFormat: + +enum **MultimeshTransformFormat**: + +- **MULTIMESH_TRANSFORM_2D** = **0** + +- **MULTIMESH_TRANSFORM_3D** = **1** + +.. _enum_VisualServer_MultimeshColorFormat: + +enum **MultimeshColorFormat**: + +- **MULTIMESH_COLOR_NONE** = **0** + +- **MULTIMESH_COLOR_8BIT** = **1** + +- **MULTIMESH_COLOR_FLOAT** = **2** + .. _enum_VisualServer_ReflectionProbeUpdateMode: enum **ReflectionProbeUpdateMode**: @@ -1237,6 +1229,16 @@ enum **ReflectionProbeUpdateMode**: - **REFLECTION_PROBE_UPDATE_ALWAYS** = **1** +.. _enum_VisualServer_ParticlesDrawOrder: + +enum **ParticlesDrawOrder**: + +- **PARTICLES_DRAW_ORDER_INDEX** = **0** + +- **PARTICLES_DRAW_ORDER_LIFETIME** = **1** + +- **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2** + .. _enum_VisualServer_EnvironmentBG: enum **EnvironmentBG**: @@ -1255,51 +1257,27 @@ enum **EnvironmentBG**: - **ENV_BG_MAX** = **6** -.. _enum_VisualServer_CanvasLightShadowFilter: +.. _enum_VisualServer_EnvironmentDOFBlurQuality: -enum **CanvasLightShadowFilter**: +enum **EnvironmentDOFBlurQuality**: -- **CANVAS_LIGHT_FILTER_NONE** = **0** +- **ENV_DOF_BLUR_QUALITY_LOW** = **0** -- **CANVAS_LIGHT_FILTER_PCF3** = **1** +- **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1** -- **CANVAS_LIGHT_FILTER_PCF5** = **2** +- **ENV_DOF_BLUR_QUALITY_HIGH** = **2** -- **CANVAS_LIGHT_FILTER_PCF7** = **3** +.. _enum_VisualServer_EnvironmentGlowBlendMode: -- **CANVAS_LIGHT_FILTER_PCF9** = **4** +enum **EnvironmentGlowBlendMode**: -- **CANVAS_LIGHT_FILTER_PCF13** = **5** +- **GLOW_BLEND_MODE_ADDITIVE** = **0** -.. _enum_VisualServer_Features: +- **GLOW_BLEND_MODE_SCREEN** = **1** -enum **Features**: +- **GLOW_BLEND_MODE_SOFTLIGHT** = **2** -- **FEATURE_SHADERS** = **0** - -- **FEATURE_MULTITHREADED** = **1** - -.. _enum_VisualServer_TextureFlags: - -enum **TextureFlags**: - -- **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. - -- **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge). - -- **TEXTURE_FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture. - -- **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** --- 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. - -- **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space. - -- **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeat texture with alternate sections mirrored. - -- **TEXTURE_FLAG_USED_FOR_STREAMING** = **2048** --- Texture is a video surface. - -- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. +- **GLOW_BLEND_MODE_REPLACE** = **3** .. _enum_VisualServer_EnvironmentToneMapper: @@ -1313,6 +1291,28 @@ enum **EnvironmentToneMapper**: - **ENV_TONE_MAPPER_ACES** = **3** +.. _enum_VisualServer_EnvironmentSSAOQuality: + +enum **EnvironmentSSAOQuality**: + +- **ENV_SSAO_QUALITY_LOW** = **0** + +- **ENV_SSAO_QUALITY_MEDIUM** = **1** + +- **ENV_SSAO_QUALITY_HIGH** = **2** + +.. _enum_VisualServer_EnvironmentSSAOBlur: + +enum **EnvironmentSSAOBlur**: + +- **ENV_SSAO_BLUR_DISABLED** = **0** + +- **ENV_SSAO_BLUR_1x1** = **1** + +- **ENV_SSAO_BLUR_2x2** = **2** + +- **ENV_SSAO_BLUR_3x3** = **3** + Constants --------- diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 6b6c93ae4..cf6499056 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -9,7 +9,7 @@ VisualShaderNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeColorConstant` +**Inherited By:** :ref:`VisualShaderNodeColorConstant`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeVectorOp` **Category:** Core diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index 50200da9b..baf79b323 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -9,7 +9,7 @@ VisualShaderNodeUniform **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeVec3Uniform`, :ref:`VisualShaderNodeScalarUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeColorUniform` +**Inherited By:** :ref:`VisualShaderNodeColorUniform`, :ref:`VisualShaderNodeScalarUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeVec3Uniform` **Category:** Core