From fa00c829f02c31f07aa983c81a2811f4e577b834 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sun, 7 Feb 2016 18:28:45 +0100 Subject: [PATCH] Add inheritance path Also fix parsing of [method (Class.)name] --- classes/class_@gdscript.rst | 3 + classes/class_@global scope.rst | 5 +- classes/class_aabb.rst | 5 +- classes/class_acceptdialog.rst | 7 ++- classes/class_animatedsprite.rst | 7 ++- classes/class_animatedsprite3d.rst | 5 +- classes/class_animation.rst | 9 ++- classes/class_animationplayer.rst | 9 ++- classes/class_animationtreeplayer.rst | 5 +- classes/class_area.rst | 5 +- classes/class_area2d.rst | 15 +++-- classes/class_array.rst | 5 +- classes/class_atlastexture.rst | 5 +- classes/class_audioserver.rst | 23 +++++--- classes/class_audioserversw.rst | 5 +- classes/class_audiostream.rst | 7 ++- classes/class_audiostreammpc.rst | 5 +- classes/class_audiostreamoggvorbis.rst | 5 +- classes/class_audiostreamopus.rst | 5 +- classes/class_audiostreamplayback.rst | 5 +- classes/class_audiostreamspeex.rst | 5 +- classes/class_backbuffercopy.rst | 5 +- classes/class_bakedlight.rst | 5 +- classes/class_bakedlightinstance.rst | 5 +- classes/class_bakedlightsampler.rst | 5 +- classes/class_basebutton.rst | 13 +++-- classes/class_bitmap.rst | 5 +- classes/class_boneattachment.rst | 5 +- classes/class_bool.rst | 3 + classes/class_boxcontainer.rst | 7 ++- classes/class_boxshape.rst | 5 +- classes/class_button.rst | 11 +++- classes/class_buttonarray.rst | 7 ++- classes/class_buttongroup.rst | 7 ++- classes/class_camera.rst | 7 ++- classes/class_camera2d.rst | 9 ++- classes/class_canvasitem.rst | 11 +++- classes/class_canvasitemmaterial.rst | 5 +- classes/class_canvasitemshader.rst | 5 +- classes/class_canvasitemshadergraph.rst | 5 +- classes/class_canvaslayer.rst | 7 ++- classes/class_canvasmodulate.rst | 5 +- classes/class_capsuleshape.rst | 5 +- classes/class_capsuleshape2d.rst | 5 +- classes/class_centercontainer.rst | 5 +- classes/class_checkbox.rst | 5 +- classes/class_checkbutton.rst | 5 +- classes/class_circleshape2d.rst | 5 +- classes/class_collisionobject.rst | 7 ++- classes/class_collisionobject2d.rst | 7 ++- classes/class_collisionpolygon.rst | 5 +- classes/class_collisionpolygon2d.rst | 13 +++-- classes/class_collisionshape.rst | 5 +- classes/class_collisionshape2d.rst | 5 +- classes/class_color.rst | 3 + classes/class_colorarray.rst | 3 + classes/class_colorpicker.rst | 5 +- classes/class_colorpickerbutton.rst | 5 +- classes/class_colorramp.rst | 5 +- classes/class_concavepolygonshape.rst | 5 +- classes/class_concavepolygonshape2d.rst | 5 +- classes/class_conetwistjoint.rst | 5 +- classes/class_configfile.rst | 5 +- classes/class_confirmationdialog.rst | 7 ++- classes/class_container.rst | 7 ++- classes/class_control.rst | 47 +++++++++------- classes/class_convexpolygonshape.rst | 5 +- classes/class_convexpolygonshape2d.rst | 5 +- classes/class_cubemap.rst | 5 +- classes/class_curve2d.rst | 11 ++-- classes/class_curve3d.rst | 11 ++-- classes/class_dampedspringjoint2d.rst | 5 +- classes/class_dictionary.rst | 3 + classes/class_directionallight.rst | 5 +- classes/class_directory.rst | 5 +- classes/class_editorfiledialog.rst | 5 +- classes/class_editorimportplugin.rst | 5 +- classes/class_editorplugin.rst | 5 +- classes/class_editorscenepostimport.rst | 5 +- classes/class_editorscript.rst | 5 +- classes/class_environment.rst | 5 +- classes/class_eventplayer.rst | 9 ++- classes/class_eventstream.rst | 7 ++- classes/class_eventstreamchibi.rst | 5 +- classes/class_file.rst | 5 +- classes/class_filedialog.rst | 5 +- classes/class_fixedmaterial.rst | 9 ++- classes/class_float.rst | 3 + classes/class_font.rst | 5 +- classes/class_funcref.rst | 5 +- classes/class_gdfunctionstate.rst | 5 +- classes/class_gdnativeclass.rst | 5 +- classes/class_gdscript.rst | 5 +- classes/class_generic6dofjoint.rst | 5 +- classes/class_geometry.rst | 3 + classes/class_geometryinstance.rst | 7 ++- classes/class_globals.rst | 3 + classes/class_graphedit.rst | 7 ++- classes/class_graphnode.rst | 5 +- classes/class_gridcontainer.rst | 5 +- classes/class_gridmap.rst | 5 +- classes/class_groovejoint2d.rst | 5 +- classes/class_hboxcontainer.rst | 5 +- classes/class_hbuttonarray.rst | 5 +- classes/class_hingejoint.rst | 5 +- classes/class_hscrollbar.rst | 5 +- classes/class_hseparator.rst | 5 +- classes/class_hslider.rst | 5 +- classes/class_hsplitcontainer.rst | 5 +- classes/class_httpclient.rst | 55 +++++++------------ classes/class_image.rst | 3 + classes/class_imagetexture.rst | 5 +- classes/class_immediategeometry.rst | 5 +- classes/class_input.rst | 5 ++ classes/class_inputdefault.rst | 5 +- classes/class_inputevent.rst | 3 + classes/class_inputeventaction.rst | 3 + classes/class_inputeventjoybutton.rst | 3 + classes/class_inputeventjoymotion.rst | 3 + classes/class_inputeventkey.rst | 3 + classes/class_inputeventmousebutton.rst | 3 + classes/class_inputeventmousemotion.rst | 3 + classes/class_inputeventscreendrag.rst | 3 + classes/class_inputeventscreentouch.rst | 3 + classes/class_inputmap.rst | 3 + classes/class_instanceplaceholder.rst | 5 +- classes/class_int.rst | 3 + classes/class_intarray.rst | 3 + classes/class_interpolatedcamera.rst | 5 +- classes/class_ip.rst | 7 ++- classes/class_ip_unix.rst | 5 +- classes/class_itemlist.rst | 5 +- classes/class_joint.rst | 7 ++- classes/class_joint2d.rst | 7 ++- classes/class_kinematicbody.rst | 5 +- classes/class_kinematicbody2d.rst | 13 +++-- classes/class_label.rst | 7 ++- classes/class_largetexture.rst | 5 +- classes/class_light.rst | 7 ++- classes/class_light2d.rst | 5 +- classes/class_lightoccluder2d.rst | 5 +- classes/class_lineedit.rst | 9 ++- classes/class_lineshape2d.rst | 5 +- classes/class_mainloop.rst | 5 ++ classes/class_margincontainer.rst | 5 +- classes/class_marshalls.rst | 5 +- classes/class_material.rst | 7 ++- classes/class_materialshader.rst | 5 +- classes/class_materialshadergraph.rst | 5 +- classes/class_matrix3.rst | 3 + classes/class_matrix32.rst | 3 + classes/class_menubutton.rst | 5 +- classes/class_mesh.rst | 25 +++++---- classes/class_meshdatatool.rst | 5 +- classes/class_meshinstance.rst | 5 +- classes/class_meshlibrary.rst | 5 +- classes/class_multimesh.rst | 9 ++- classes/class_multimeshinstance.rst | 5 +- classes/class_mutex.rst | 5 +- classes/class_navigation.rst | 5 +- classes/class_navigation2d.rst | 5 +- classes/class_navigationmesh.rst | 5 +- classes/class_navigationmeshinstance.rst | 5 +- classes/class_navigationpolygon.rst | 5 +- classes/class_navigationpolygoninstance.rst | 5 +- classes/class_nil.rst | 3 + classes/class_node.rst | 43 ++++++++------- classes/class_node2d.rst | 7 ++- classes/class_nodepath.rst | 3 + classes/class_object.rst | 15 +++-- classes/class_occluderpolygon2d.rst | 5 +- classes/class_omnilight.rst | 5 +- classes/class_optionbutton.rst | 5 +- classes/class_os.rst | 3 + classes/class_packeddatacontainer.rst | 5 +- classes/class_packeddatacontainerref.rst | 5 +- classes/class_packedscene.rst | 7 ++- classes/class_packetpeer.rst | 7 ++- classes/class_packetpeerstream.rst | 5 +- classes/class_packetpeerudp.rst | 5 +- classes/class_panel.rst | 5 +- classes/class_panelcontainer.rst | 5 +- classes/class_parallaxbackground.rst | 5 +- classes/class_parallaxlayer.rst | 5 +- classes/class_particleattractor2d.rst | 5 +- classes/class_particles.rst | 7 ++- classes/class_particles2d.rst | 5 +- classes/class_patch9frame.rst | 5 +- classes/class_path.rst | 5 +- classes/class_path2d.rst | 5 +- classes/class_pathfollow.rst | 11 ++-- classes/class_pathfollow2d.rst | 11 ++-- classes/class_pathremap.rst | 3 + classes/class_pckpacker.rst | 5 +- classes/class_performance.rst | 3 + classes/class_phashtranslation.rst | 5 +- classes/class_physics2ddirectbodystate.rst | 5 ++ classes/class_physics2ddirectbodystatesw.rst | 5 +- classes/class_physics2ddirectspacestate.rst | 5 +- classes/class_physics2dserver.rst | 5 ++ classes/class_physics2dserversw.rst | 5 +- .../class_physics2dshapequeryparameters.rst | 5 +- classes/class_physics2dshapequeryresult.rst | 5 +- classes/class_physics2dtestmotionresult.rst | 5 +- classes/class_physicsbody.rst | 7 ++- classes/class_physicsbody2d.rst | 11 +++- classes/class_physicsdirectbodystate.rst | 5 ++ classes/class_physicsdirectbodystatesw.rst | 5 +- classes/class_physicsdirectspacestate.rst | 3 + classes/class_physicsserver.rst | 5 ++ classes/class_physicsserversw.rst | 5 +- classes/class_physicsshapequeryparameters.rst | 5 +- classes/class_physicsshapequeryresult.rst | 5 +- classes/class_pinjoint.rst | 5 +- classes/class_pinjoint2d.rst | 5 +- classes/class_plane.rst | 3 + classes/class_planeshape.rst | 5 +- classes/class_polygon2d.rst | 5 +- classes/class_polygonpathfinder.rst | 5 +- classes/class_popup.rst | 7 ++- classes/class_popupdialog.rst | 5 +- classes/class_popupmenu.rst | 5 +- classes/class_popuppanel.rst | 5 +- classes/class_portal.rst | 13 +++-- classes/class_position2d.rst | 5 +- classes/class_position3d.rst | 5 +- classes/class_progressbar.rst | 5 +- classes/class_proximitygroup.rst | 5 +- classes/class_quad.rst | 5 +- classes/class_quat.rst | 3 + classes/class_range.rst | 7 ++- classes/class_rawarray.rst | 3 + classes/class_raycast.rst | 5 +- classes/class_raycast2d.rst | 7 ++- classes/class_rayshape.rst | 5 +- classes/class_rayshape2d.rst | 5 +- classes/class_realarray.rst | 3 + classes/class_rect2.rst | 3 + classes/class_rectangleshape2d.rst | 5 +- classes/class_reference.rst | 5 ++ classes/class_referenceframe.rst | 5 +- classes/class_regex.rst | 9 ++- classes/class_remotetransform2d.rst | 5 +- classes/class_rendertargettexture.rst | 5 +- classes/class_resource.rst | 7 ++- classes/class_resourceimportmetadata.rst | 5 +- classes/class_resourceinteractiveloader.rst | 11 ++-- classes/class_resourceloader.rst | 3 + classes/class_resourcepreloader.rst | 5 +- classes/class_resourcesaver.rst | 3 + classes/class_richtextlabel.rst | 5 +- classes/class_rid.rst | 3 + classes/class_rigidbody.rst | 5 +- classes/class_rigidbody2d.rst | 25 +++++---- classes/class_room.rst | 5 +- classes/class_roombounds.rst | 5 +- classes/class_sample.rst | 9 ++- classes/class_samplelibrary.rst | 7 ++- classes/class_sampleplayer.rst | 5 +- classes/class_sampleplayer2d.rst | 5 +- classes/class_scenestate.rst | 5 +- classes/class_scenetree.rst | 5 +- classes/class_script.rst | 7 ++- classes/class_scrollbar.rst | 7 ++- classes/class_scrollcontainer.rst | 5 +- classes/class_segmentshape2d.rst | 5 +- classes/class_semaphore.rst | 5 +- classes/class_separator.rst | 7 ++- classes/class_shader.rst | 7 ++- classes/class_shadergraph.rst | 7 ++- classes/class_shadermaterial.rst | 5 +- classes/class_shape.rst | 7 ++- classes/class_shape2d.rst | 7 ++- classes/class_skeleton.rst | 7 ++- classes/class_slider.rst | 7 ++- classes/class_sliderjoint.rst | 5 +- classes/class_soundplayer2d.rst | 7 ++- classes/class_soundroomparams.rst | 5 +- classes/class_spatial.rst | 7 ++- classes/class_spatialplayer.rst | 7 ++- classes/class_spatialsampleplayer.rst | 5 +- classes/class_spatialsound2dserver.rst | 5 ++ classes/class_spatialsound2dserversw.rst | 5 +- classes/class_spatialsoundserver.rst | 5 ++ classes/class_spatialsoundserversw.rst | 5 +- classes/class_spatialstreamplayer.rst | 5 +- classes/class_sphereshape.rst | 5 +- classes/class_spinbox.rst | 5 +- classes/class_splitcontainer.rst | 7 ++- classes/class_spotlight.rst | 5 +- classes/class_sprite.rst | 9 ++- classes/class_sprite3d.rst | 5 +- classes/class_spritebase3d.rst | 7 ++- classes/class_spriteframes.rst | 5 +- classes/class_staticbody.rst | 5 +- classes/class_staticbody2d.rst | 5 +- classes/class_streampeer.rst | 15 +++-- classes/class_streampeerssl.rst | 5 +- classes/class_streampeertcp.rst | 5 +- classes/class_streamplayer.rst | 7 ++- classes/class_string.rst | 7 ++- classes/class_stringarray.rst | 3 + classes/class_stylebox.rst | 7 ++- classes/class_styleboxempty.rst | 5 +- classes/class_styleboxflat.rst | 5 +- classes/class_styleboximagemask.rst | 7 ++- classes/class_styleboxtexture.rst | 5 +- classes/class_surfacetool.rst | 5 +- classes/class_tabcontainer.rst | 5 +- classes/class_tabs.rst | 5 +- classes/class_tcp_server.rst | 5 +- classes/class_testcube.rst | 5 +- classes/class_textedit.rst | 5 +- classes/class_texture.rst | 9 ++- classes/class_texturebutton.rst | 5 +- classes/class_textureframe.rst | 5 +- classes/class_textureprogress.rst | 5 +- classes/class_theme.rst | 5 +- classes/class_thread.rst | 5 +- classes/class_tilemap.rst | 5 +- classes/class_tileset.rst | 5 +- classes/class_timer.rst | 5 +- classes/class_toolbutton.rst | 5 +- classes/class_touchscreenbutton.rst | 5 +- classes/class_transform.rst | 3 + classes/class_translation.rst | 7 ++- classes/class_translationserver.rst | 3 + classes/class_tree.rst | 5 +- classes/class_treeitem.rst | 3 + classes/class_tween.rst | 5 +- classes/class_undoredo.rst | 3 + classes/class_vboxcontainer.rst | 5 +- classes/class_vbuttonarray.rst | 5 +- classes/class_vector2.rst | 3 + classes/class_vector2array.rst | 3 + classes/class_vector3.rst | 3 + classes/class_vector3array.rst | 3 + classes/class_vehiclebody.rst | 5 +- classes/class_vehiclewheel.rst | 5 +- classes/class_videoplayer.rst | 5 +- classes/class_videostream.rst | 7 ++- classes/class_videostreamtheora.rst | 5 +- classes/class_viewport.rst | 5 +- classes/class_viewportsprite.rst | 5 +- classes/class_visibilityenabler.rst | 5 +- classes/class_visibilityenabler2d.rst | 5 +- classes/class_visibilitynotifier.rst | 7 ++- classes/class_visibilitynotifier2d.rst | 7 ++- classes/class_visualinstance.rst | 7 ++- classes/class_visualserver.rst | 3 + classes/class_vscrollbar.rst | 5 +- classes/class_vseparator.rst | 5 +- classes/class_vslider.rst | 5 +- classes/class_vsplitcontainer.rst | 5 +- classes/class_weakref.rst | 5 +- classes/class_windowdialog.rst | 7 ++- classes/class_world.rst | 5 +- classes/class_world2d.rst | 5 +- classes/class_worldenvironment.rst | 5 +- classes/class_xmlparser.rst | 5 +- classes/class_ysort.rst | 5 +- 361 files changed, 1676 insertions(+), 487 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 1d6246ef7..f45d8ebf8 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -5,6 +5,9 @@ **Category:** Core +Brief Description +----------------- + Built-in GDScript functions. Member Functions diff --git a/classes/class_@global scope.rst b/classes/class_@global scope.rst index 368a6be8d..cb080b902 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@global scope.rst @@ -5,6 +5,9 @@ **Category:** Core +Brief Description +----------------- + Global scope constants and variables. Member Variables @@ -380,7 +383,7 @@ Numeric Constants - **JOY_ANALOG_2_Y** = **5** - **JOY_ANALOG_L2** = **6** - **JOY_ANALOG_R2** = **7** -- **OK** = **0** --- Functions that return :ref:`Error` return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout. +- **OK** = **0** --- Functions that return Error return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout. - **FAILED** = **1** --- Generic fail return error. - **ERR_UNAVAILABLE** = **2** - **ERR_UNCONFIGURED** = **3** diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 0ad7b92b4..f6a7f1e53 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -5,6 +5,9 @@ AABB **Category:** Built-In Types +Brief Description +----------------- + Axis-Aligned Bounding Box. Member Functions @@ -163,7 +166,7 @@ Return true if the :ref:`AABB` contains a point. - :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** -Return the intersection between two :ref:`AABB`s. An empty AABB (size 0,0,0) is returned on failure. +Return the intersection between two :ref:`AABB`. An empty AABB (size 0,0,0) is returned on failure. .. _class_AABB_intersects: diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 46b6a4ca9..567865244 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -3,10 +3,15 @@ AcceptDialog ============ -**Inherits:** :ref:`WindowDialog` +**Inherits:** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`ConfirmationDialog` **Category:** Core +Brief Description +----------------- + Base dialog for user notification. Member Functions diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 2feb44173..1772988f5 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -3,10 +3,13 @@ AnimatedSprite ============== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Sprite node that can use multiple textures for animation. Member Functions @@ -77,7 +80,7 @@ When turned on, offset at (0,0) is the center of the sprite, when off, the top-l - :ref:`bool` **is_centered** **(** **)** const -Return true when centered. See :ref:`set_centered`. +Return true when centered. See :ref:`set_centered`. .. _class_AnimatedSprite_set_offset: diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 2fd670a70..70d272e6c 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -3,10 +3,13 @@ AnimatedSprite3D ================ -**Inherits:** :ref:`SpriteBase3D` +**Inherits:** :ref:`SpriteBase3D` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_animation.rst b/classes/class_animation.rst index b2fe0cf38..e13cd85da 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -3,10 +3,13 @@ Animation ========= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Contains data used to animate everything in the engine. Member Functions @@ -99,7 +102,7 @@ Numeric Constants Description ----------- -An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. +An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. Animations are just data containers, and must be added to odes such as an :ref:`AnimationPlayer` or :ref:`AnimationTreePlayer` to be played back. @@ -134,7 +137,7 @@ Get the type of a track. - :ref:`NodePath` **track_get_path** **(** :ref:`int` idx **)** const -Get the path of a track. for more information on the path format, see :ref:`track_set_path` +Get the path of a track. for more information on the path format, see :ref:`track_set_path` .. _class_Animation_track_set_path: diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index ffb959e4a..151c2ef04 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -3,10 +3,13 @@ AnimationPlayer =============== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Container and player of :ref:`Animation` resources. Member Functions @@ -264,7 +267,7 @@ AnimationPlayer resolves animation track paths from this node (which is relative - :ref:`NodePath` **get_root** **(** **)** const -Return path to root node (see :ref:`set_root`). +Return path to root node (see :ref:`set_root`). .. _class_AnimationPlayer_seek: @@ -300,7 +303,7 @@ Set the mode in which the animation player processes. By default, it processes o - :ref:`int` **get_animation_process_mode** **(** **)** const -Return the mode in which the animation player processes. See :ref:`set_animation_process_mode`. +Return the mode in which the animation player processes. See :ref:`set_animation_process_mode`. .. _class_AnimationPlayer_get_current_animation_pos: diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index 080d1a5ee..0a3a8404b 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -3,10 +3,13 @@ AnimationTreePlayer =================== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Animation Player that uses a node graph for the blending. Member Functions diff --git a/classes/class_area.rst b/classes/class_area.rst index dcbf42b6f..4aa95578a 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -3,10 +3,13 @@ Area ==== -**Inherits:** :ref:`CollisionObject` +**Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 0bd932eaa..caef94248 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -3,10 +3,13 @@ Area2D ====== -**Inherits:** :ref:`CollisionObject2D` +**Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + General purpose area detection and influence for 2D physics. Member Functions @@ -124,7 +127,7 @@ Return the space override mode. - void **set_gravity_is_point** **(** :ref:`bool` enable **)** -When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector`/:ref:`get_gravity_vector`. +When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector`/:ref:`get_gravity_vector`. .. _class_Area2D_is_gravity_a_point: @@ -150,13 +153,13 @@ Return the falloff factor for point gravity. Set the gravity vector. This vector does not have to be normalized. -If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. +If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. .. _class_Area2D_get_gravity_vector: - :ref:`Vector2` **get_gravity_vector** **(** **)** const -Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. +Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. .. _class_Area2D_set_gravity: @@ -164,7 +167,7 @@ Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point`), or a calculated one (when using a center of gravity). +This value multiplies the gravity vector, whether it is the given vector (:ref:`set_gravity_vector`), or a calculated one (when using a center of gravity). .. _class_Area2D_get_gravity: @@ -232,7 +235,7 @@ Return the physics layers this area can scan for collisions. Set the physics layers this area is in. -Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask`. +Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask`. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. diff --git a/classes/class_array.rst b/classes/class_array.rst index 1bc987926..19d3f5c89 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -5,6 +5,9 @@ Array **Category:** Built-In Types +Brief Description +----------------- + Generic array datatype. Member Functions @@ -74,7 +77,7 @@ Member Function Description - void **append** **(** var value **)** -Append an element at the end of the array (alias of :ref:`push_back`). +Append an element at the end of the array (alias of :ref:`push_back`). .. _class_Array_clear: diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 26e8ca04e..09c8c7f46 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -3,10 +3,13 @@ AtlasTexture ============ -**Inherits:** :ref:`Texture` +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 581a449c8..d556df878 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -5,8 +5,13 @@ AudioServer **Inherits:** :ref:`Object` +**Inherited By:** :ref:`AudioServerSW` + **Category:** Core +Brief Description +----------------- + Server interface for low level audio access. Member Functions @@ -178,7 +183,7 @@ Return the length in samples (not bytes) of the audio sample. Even if a stereo s Set the sample data for a given sample as an array of floats. The length must be equal to the sample lenght or an error will be produced. -For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by :ref:`sample_get_length`. +For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by :ref:`sample_get_length`. Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data. @@ -188,13 +193,13 @@ Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw Set the sample data for a given sample as an array of bytes. The length must be equal to the sample lenght expected in bytes or an error will be produced. The byte length can be calculated as follows: -Get the sample length (:ref:`get_sample_length`). +Get the sample length (:ref:`get_sample_length`). If the sample format is SAMPLE_FORMAT_PCM16, multiply it by 2. If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. -If the sample is stereo (:ref:`sample_is_stereo`), multiply it by 2. +If the sample is stereo (:ref:`sample_is_stereo`), multiply it by 2. .. _class_AudioServer_sample_get_data: @@ -230,31 +235,31 @@ Return the loop format for a sample, as a value from the SAMPLE_LOOP\_\* enum. - void **sample_set_loop_begin** **(** :ref:`RID` sample, :ref:`int` pos **)** -Set the initial loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format`. +Set the initial loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format`. .. _class_AudioServer_sample_get_loop_begin: - :ref:`int` **sample_get_loop_begin** **(** :ref:`RID` sample **)** const -Return the initial loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format`. +Return the initial loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format`. .. _class_AudioServer_sample_set_loop_end: - void **sample_set_loop_end** **(** :ref:`RID` sample, :ref:`int` pos **)** -Set the final loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format`. +Set the final loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format`. .. _class_AudioServer_sample_get_loop_end: - :ref:`int` **sample_get_loop_end** **(** :ref:`RID` sample **)** const -Return the final loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format`. +Return the final loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format`. .. _class_AudioServer_voice_create: - :ref:`RID` **voice_create** **(** **)** -Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See :ref:`sample_create`. +Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See :ref:`sample_create`. .. _class_AudioServer_voice_play: @@ -374,7 +379,7 @@ Return the current mix rate for a given voice. - :ref:`bool` **voice_is_positional** **(** :ref:`RID` voice **)** const -Return wether the current voice is positional. See :ref:`voice_set_positional`. +Return wether the current voice is positional. See :ref:`voice_set_positional`. .. _class_AudioServer_voice_stop: diff --git a/classes/class_audioserversw.rst b/classes/class_audioserversw.rst index 08df527da..fbf34223b 100644 --- a/classes/class_audioserversw.rst +++ b/classes/class_audioserversw.rst @@ -3,10 +3,13 @@ AudioServerSW ============= -**Inherits:** :ref:`AudioServer` +**Inherits:** :ref:`AudioServer` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Software implementation of :ref:`AudioServer`. Description diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index c82f50f47..6abcfbfb4 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -3,10 +3,15 @@ AudioStream =========== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`AudioStreamSpeex`, :ref:`AudioStreamMPC`, :ref:`AudioStreamOGGVorbis`, :ref:`AudioStreamOpus` **Category:** Core +Brief Description +----------------- + Base class for audio streams. Description diff --git a/classes/class_audiostreammpc.rst b/classes/class_audiostreammpc.rst index 3aa4efe78..1da091726 100644 --- a/classes/class_audiostreammpc.rst +++ b/classes/class_audiostreammpc.rst @@ -3,10 +3,13 @@ AudioStreamMPC ============== -**Inherits:** :ref:`AudioStream` +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + MusePack audio stream driver. Description diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 6b6275ec0..661282887 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -3,10 +3,13 @@ AudioStreamOGGVorbis ==================== -**Inherits:** :ref:`AudioStream` +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + OGG Vorbis audio stream driver. Description diff --git a/classes/class_audiostreamopus.rst b/classes/class_audiostreamopus.rst index 8fad04fa0..ad609b42b 100644 --- a/classes/class_audiostreamopus.rst +++ b/classes/class_audiostreamopus.rst @@ -3,10 +3,13 @@ AudioStreamOpus =============== -**Inherits:** :ref:`AudioStream` +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Opus Codec audio stream driver. Description diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index bac2dad28..e48a9dfe8 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -3,10 +3,13 @@ AudioStreamPlayback =================== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_audiostreamspeex.rst b/classes/class_audiostreamspeex.rst index 53b18552d..93f76682f 100644 --- a/classes/class_audiostreamspeex.rst +++ b/classes/class_audiostreamspeex.rst @@ -3,10 +3,13 @@ AudioStreamSpeex ================ -**Inherits:** :ref:`AudioStream` +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Speex audio stream driver. Description diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index fb4a84fc0..56d08413c 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -3,10 +3,13 @@ BackBufferCopy ============== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_bakedlight.rst b/classes/class_bakedlight.rst index 433f61cf3..9f4dc46d3 100644 --- a/classes/class_bakedlight.rst +++ b/classes/class_bakedlight.rst @@ -3,10 +3,13 @@ BakedLight ========== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_bakedlightinstance.rst b/classes/class_bakedlightinstance.rst index cb35cd302..0c9516bbb 100644 --- a/classes/class_bakedlightinstance.rst +++ b/classes/class_bakedlightinstance.rst @@ -3,10 +3,13 @@ BakedLightInstance ================== -**Inherits:** :ref:`VisualInstance` +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_bakedlightsampler.rst b/classes/class_bakedlightsampler.rst index 137d9b79e..6b0a82a44 100644 --- a/classes/class_bakedlightsampler.rst +++ b/classes/class_bakedlightsampler.rst @@ -3,10 +3,13 @@ BakedLightSampler ================= -**Inherits:** :ref:`VisualInstance` +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index fbd9f6839..eb2407c3f 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -3,10 +3,15 @@ BaseButton ========== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`TextureButton`, :ref:`Button` **Category:** Core +Brief Description +----------------- + Provides a base class for different kinds of buttons. Member Functions @@ -95,7 +100,7 @@ Set the button toggle_mode property. Toggle mode makes the button flip state bet - :ref:`bool` **is_toggle_mode** **(** **)** const -Return the toggle_mode property (see :ref:`set_toggle_mode`). +Return the toggle_mode property (see :ref:`set_toggle_mode`). .. _class_BaseButton_set_disabled: @@ -107,7 +112,7 @@ Set the button into disabled state. When a button is disabled, it can't be click - :ref:`bool` **is_disabled** **(** **)** const -Return wether the button is in disabled state (see :ref:`set_disabled`). +Return wether the button is in disabled state (see :ref:`set_disabled`). .. _class_BaseButton_set_click_on_press: @@ -119,7 +124,7 @@ Set the button click_on_press mode. This mode generates click events when a mous - :ref:`bool` **get_click_on_press** **(** **)** const -Return the state of the click_on_press property (see :ref:`set_click_on_press`). +Return the state of the click_on_press property (see :ref:`set_click_on_press`). .. _class_BaseButton_get_draw_mode: diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 4cfee9296..4185e41a0 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -3,10 +3,13 @@ BitMap ====== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index bfa373714..fb2a101a1 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -3,9 +3,12 @@ BoneAttachment ============== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 2c6aca968..80925a874 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -5,6 +5,9 @@ bool **Category:** Built-In Types +Brief Description +----------------- + Boolean built-in type Member Functions diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 8123c62a9..b53929e3c 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -3,10 +3,15 @@ BoxContainer ============ -**Inherits:** :ref:`Container` +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`VBoxContainer`, :ref:`ButtonGroup`, :ref:`HBoxContainer`, :ref:`ColorPicker` **Category:** Core +Brief Description +----------------- + Base class for Box containers. Member Functions diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index dea967ca4..ff549f083 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -3,10 +3,13 @@ BoxShape ======== -**Inherits:** :ref:`Shape` +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Box shape resource. Member Functions diff --git a/classes/class_button.rst b/classes/class_button.rst index 7a65101ed..284b2522f 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -3,10 +3,15 @@ Button ====== -**Inherits:** :ref:`BaseButton` +**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` **Category:** Core +Brief Description +----------------- + Standard themed Button. Member Functions @@ -78,7 +83,7 @@ Set the *clip_text* property of a Button. When this property is enabled, text th - :ref:`bool` **get_clip_text** **(** **)** const -Return the state of the *clip_text* property (see :ref:`set_clip_text`) +Return the state of the *clip_text* property (see :ref:`set_clip_text`) .. _class_Button_set_text_align: @@ -92,6 +97,6 @@ Return the state of the *clip_text* property (see :ref:`set_clip_text` **is_flat** **(** **)** const -Return the state of the *flat* property (see :ref:`set_flat`) +Return the state of the *flat* property (see :ref:`set_flat`) diff --git a/classes/class_buttonarray.rst b/classes/class_buttonarray.rst index dbe74ff28..e96e98bb4 100644 --- a/classes/class_buttonarray.rst +++ b/classes/class_buttonarray.rst @@ -3,10 +3,15 @@ ButtonArray =========== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`HButtonArray`, :ref:`VButtonArray` **Category:** Core +Brief Description +----------------- + Array of Buttons. Member Functions diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index adcce491e..0712da5fb 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -3,10 +3,13 @@ ButtonGroup =========== -**Inherits:** :ref:`BoxContainer` +**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Group of Buttons. Member Functions @@ -27,7 +30,7 @@ Member Functions Description ----------- -Group of :ref:`Button`s. All direct and indirect children buttons become radios. Only one allows being pressed. +Group of :ref:`Button`. All direct and indirect children buttons become radios. Only one allows being pressed. Member Function Description --------------------------- diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 539f7e4ab..a26a7d527 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -3,10 +3,15 @@ Camera ====== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`InterpolatedCamera` **Category:** Core +Brief Description +----------------- + Camera node, displays from a point of view. Member Functions diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index fca6ed19c..ea6877382 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -3,10 +3,13 @@ Camera2D ======== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Camera node for 2D scenes. Member Functions @@ -132,7 +135,7 @@ Make this the current 2D camera for the scene (viewport and layer), in case ther - :ref:`bool` **is_current** **(** **)** const -Return true of this is the current camera (see :ref:`Camera2D.make_current`). +Return true of this is the current camera (see :ref:`make_current`). .. _class_Camera2D_set_limit: @@ -188,7 +191,7 @@ Set the margins needed to drag the camera (relative to the screen size). Margin - :ref:`float` **get_drag_margin** **(** :ref:`int` margin **)** const -Return the margins needed to drag the camera (see :ref:`set_drag_margin`). +Return the margins needed to drag the camera (see :ref:`set_drag_margin`). .. _class_Camera2D_get_camera_pos: diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 1d0e1d4f5..3b427dfdf 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -3,10 +3,15 @@ CanvasItem ========== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`Node2D`, :ref:`Control` **Category:** Core +Brief Description +----------------- + Base class of anything 2D. Member Functions @@ -206,7 +211,7 @@ Return true if this CanvasItem is visible. It may be invisible because itself or - :ref:`bool` **is_hidden** **(** **)** const -Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden (:ref:`hide` called) the function will return false. +Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden (:ref:`hide` called) the function will return false. .. _class_CanvasItem_show: @@ -240,7 +245,7 @@ Set as toplevel. This means that it will not inherit transform from parent canva - :ref:`bool` **is_set_as_toplevel** **(** **)** const -Return if set as toplevel. See :ref:`set_as_toplevel`/ +Return if set as toplevel. See :ref:`set_as_toplevel`. .. _class_CanvasItem_set_blend_mode: diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 694739839..bf6b28780 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -3,10 +3,13 @@ CanvasItemMaterial ================== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_canvasitemshader.rst b/classes/class_canvasitemshader.rst index d97a06af2..d0462e975 100644 --- a/classes/class_canvasitemshader.rst +++ b/classes/class_canvasitemshader.rst @@ -3,9 +3,12 @@ CanvasItemShader ================ -**Inherits:** :ref:`Shader` +**Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_canvasitemshadergraph.rst b/classes/class_canvasitemshadergraph.rst index 6ac90d6b6..4295295b5 100644 --- a/classes/class_canvasitemshadergraph.rst +++ b/classes/class_canvasitemshadergraph.rst @@ -3,9 +3,12 @@ CanvasItemShaderGraph ===================== -**Inherits:** :ref:`ShaderGraph` +**Inherits:** :ref:`ShaderGraph` **<** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index f4415def8..a66f46058 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -3,10 +3,15 @@ CanvasLayer =========== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`ParallaxBackground` **Category:** Core +Brief Description +----------------- + Canvas Item layer. Member Functions diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index 7803a178b..a548cb6be 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -3,10 +3,13 @@ CanvasModulate ============== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 645bd1890..6e7246108 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -3,10 +3,13 @@ CapsuleShape ============ -**Inherits:** :ref:`Shape` +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Capsule shape resource. Member Functions diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 725f99fb3..c02704c93 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -3,10 +3,13 @@ CapsuleShape2D ============== -**Inherits:** :ref:`Shape2D` +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Capsule 2D shape resource for physics. Member Functions diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 8860f1de7..e0e74740f 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -3,10 +3,13 @@ CenterContainer =============== -**Inherits:** :ref:`Container` +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Keeps children controls centered. Member Functions diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 6077e3ef0..cd0b4db7a 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -3,9 +3,12 @@ CheckBox ======== -**Inherits:** :ref:`Button` +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index 63b17a463..c1e31aae0 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -3,10 +3,13 @@ CheckButton =========== -**Inherits:** :ref:`Button` +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Checkable button. Description diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index ead5a56c6..278d1ba45 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -3,10 +3,13 @@ CircleShape2D ============= -**Inherits:** :ref:`Shape2D` +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Circular Shape for 2D Physics. Member Functions diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 84b7d23f7..66ccd96c1 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -3,10 +3,15 @@ CollisionObject =============== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`PhysicsBody`, :ref:`Area` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 84846099e..13f4c20b2 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -3,10 +3,15 @@ CollisionObject2D ================= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`Area2D`, :ref:`PhysicsBody2D` **Category:** Core +Brief Description +----------------- + Base node for 2D collisionables. Member Functions diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index b556e769d..4a9a521ef 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -3,10 +3,13 @@ CollisionPolygon ================ -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 8dac431b1..d7f38efde 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -3,10 +3,13 @@ CollisionPolygon2D ================== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Editor-only class for easy editing of collision polygons. Member Functions @@ -44,7 +47,7 @@ Member Function Description Set the array of points forming the polygon. -When editing the point list via the editor, depending on :ref:`get_build_mode`, it has to be a list of points (for ``build_mode``=0), or a list of lines (for ``build_mode``=1). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point. +When editing the point list via the editor, depending on :ref:`get_build_mode`, it has to be a list of points (for ``build_mode==0``), or a list of lines (for ``build_mode==1``). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point. .. _class_CollisionPolygon2D_get_polygon: @@ -56,13 +59,13 @@ Return the list of points that define the polygon. - void **set_build_mode** **(** :ref:`int` build_mode **)** -Set whether the polygon is to be a :ref:`ConvexPolygon2D` (``build_mode``=0), or a :ref:`ConcavePolygon2D` (``build_mode``=1). +Set whether the polygon is to be a :ref:`ConvexPolygon2D` (``build_mode==0``), or a :ref:`ConcavePolygon2D` (``build_mode==1``). .. _class_CollisionPolygon2D_get_build_mode: - :ref:`int` **get_build_mode** **(** **)** const -Return whether the polygon is a :ref:`ConvexPolygon2D` (``build_mode``=0), or a :ref:`ConcavePolygon2D` (``build_mode``=1). +Return whether the polygon is a :ref:`ConvexPolygon2D` (``build_mode==0``), or a :ref:`ConcavePolygon2D` (``build_mode==1``). .. _class_CollisionPolygon2D_set_trigger: @@ -82,7 +85,7 @@ Return whether this polygon is a trigger. Return the index of the first shape generated by the editor. -When ``build_mode`` is set to generate convex polygons, the shape shown in the editor may be decomopsed into many convex polygons. In that case, a range of indexes is needed to directly access the :ref:`Shape2D`s. +When ``build_mode`` is set to generate convex polygons, the shape shown in the editor may be decomopsed into many convex polygons. In that case, a range of indexes is needed to directly access the :ref:`Shape2D`. When ``build_mode`` is set to generate concave polygons, there is only one :ref:`Shape2D` generated, so the start index and the end index are the same. diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index a0dc72bbc..0c2fc3aca 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -3,10 +3,13 @@ CollisionShape ============== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 9946b1c8a..6ebb3b47c 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -3,10 +3,13 @@ CollisionShape2D ================ -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Editor-only class for easy editing of shapes. Member Functions diff --git a/classes/class_color.rst b/classes/class_color.rst index 9dd66576b..6f629b2d4 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -5,6 +5,9 @@ Color **Category:** Built-In Types +Brief Description +----------------- + Color in RGBA format. Member Functions diff --git a/classes/class_colorarray.rst b/classes/class_colorarray.rst index 62c975871..ab6d036ec 100644 --- a/classes/class_colorarray.rst +++ b/classes/class_colorarray.rst @@ -5,6 +5,9 @@ ColorArray **Category:** Built-In Types +Brief Description +----------------- + Array of Colors Member Functions diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index c73b9cdb1..356e9035b 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -3,10 +3,13 @@ ColorPicker =========== -**Inherits:** :ref:`BoxContainer` +**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Color picker control. Member Functions diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 686e81cf2..6b5e1106a 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -3,10 +3,13 @@ ColorPickerButton ================= -**Inherits:** :ref:`Button` +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_colorramp.rst b/classes/class_colorramp.rst index 0728e0105..461d1f805 100644 --- a/classes/class_colorramp.rst +++ b/classes/class_colorramp.rst @@ -3,10 +3,13 @@ ColorRamp ========= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index da455e3e3..29bd13d1b 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -3,10 +3,13 @@ ConcavePolygonShape =================== -**Inherits:** :ref:`Shape` +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Concave polygon shape. Member Functions diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 535b93918..15bc1097a 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -3,10 +3,13 @@ ConcavePolygonShape2D ===================== -**Inherits:** :ref:`Shape2D` +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Concave polygon 2D shape resource for physics. Member Functions diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index f5adf5009..e296e9e3d 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -3,10 +3,13 @@ ConeTwistJoint ============== -**Inherits:** :ref:`Joint` +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index eca00214b..16a891cfc 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -3,10 +3,13 @@ ConfigFile ========== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 38974a35b..0960ecbe9 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -3,10 +3,15 @@ ConfirmationDialog ================== -**Inherits:** :ref:`AcceptDialog` +**Inherits:** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`EditorFileDialog`, :ref:`FileDialog` **Category:** Core +Brief Description +----------------- + Dialog for confirmation of actions. Member Functions diff --git a/classes/class_container.rst b/classes/class_container.rst index 99478782a..0432f0455 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -3,10 +3,15 @@ Container ========= -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer` **Category:** Core +Brief Description +----------------- + Base node for containers. Member Functions diff --git a/classes/class_control.rst b/classes/class_control.rst index b58d1cddc..628c31de2 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -3,10 +3,15 @@ Control ======= -**Inherits:** :ref:`CanvasItem` +**Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`Label`, :ref:`Tabs`, :ref:`TextureFrame`, :ref:`ButtonArray`, :ref:`VideoPlayer`, :ref:`LineEdit`, :ref:`Container`, :ref:`ReferenceFrame`, :ref:`Patch9Frame`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`GraphEdit`, :ref:`ItemList` **Category:** Core +Brief Description +----------------- + Control is the base node for all the GUI components. Member Functions @@ -222,11 +227,11 @@ Controls are relative to the parent position and size by using anchors and margi Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range. -Input device events (:ref:`InputEvent`) are first sent to the root controls via the :ref:`Node._input`, which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling :ref:`Node._input_event`. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even :ref:`Node._unhandled_input`), the control can accept it by calling :ref:`accept_event`. +Input device events (:ref:`InputEvent`) are first sent to the root controls via the :ref:`Node._input`, which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling :ref:`Node._input_event`. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even :ref:`Node._unhandled_input`), the control can accept it by calling :ref:`accept_event`. -Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with :ref:`set_focus_mode`. Focus is lost when another control gains it, or the current focus owner is hidden. +Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with :ref:`set_focus_mode`. Focus is lost when another control gains it, or the current focus owner is hidden. -It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling :ref:`set_ignore_mouse` enables this function. +It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling :ref:`set_ignore_mouse` enables this function. Finally, controls are skinned according to a :ref:`Theme`. Setting a :ref:`Theme` on a control will propagate all the skinning down the tree. Optionally, skinning can be overrided per each control by calling the add\_\*_override functions, or from the editor. @@ -261,7 +266,7 @@ Return the minimum size this Control can shrink to. A control will never be disp - void **accept_event** **(** **)** -Handles the event, no other control will receive it and it will not be sent to nodes waiting on :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. +Handles the event, no other control will receive it and it will not be sent to nodes waiting on :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. .. _class_Control_get_minimum_size: @@ -277,7 +282,7 @@ Return the minimum size this Control can shrink to. A control will never be disp - void **set_anchor** **(** :ref:`int` margin, :ref:`int` anchor_mode **)** -Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previos anchor mode to the new one, so margin offsets (:ref:`set_margin`) must be done after setting anchors, or at the same time (:ref:`set_anchor_and_margin`). +Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previos anchor mode to the new one, so margin offsets (:ref:`set_margin`) must be done after setting anchors, or at the same time (:ref:`set_anchor_and_margin`). .. _class_Control_get_anchor: @@ -295,31 +300,31 @@ Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT - void **set_anchor_and_margin** **(** :ref:`int` margin, :ref:`int` anchor_mode, :ref:`float` offset **)** -Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see :ref:`set_anchor` and :ref:`set_margin`). +Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see :ref:`set_anchor` and :ref:`set_margin`). .. _class_Control_set_begin: - void **set_begin** **(** :ref:`Vector2` pos **)** -Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). +Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). .. _class_Control_set_end: - void **set_end** **(** :ref:`Vector2` pos **)** -Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref:`set_margin`). +Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref:`set_margin`). .. _class_Control_set_pos: - void **set_pos** **(** :ref:`Vector2` pos **)** -Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see :ref:`set_margin`). +Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see :ref:`set_margin`). .. _class_Control_set_size: - void **set_size** **(** :ref:`Vector2` size **)** -Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see :ref:`set_margin`). +Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see :ref:`set_margin`). .. _class_Control_set_custom_minimum_size: @@ -329,7 +334,7 @@ Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (se - void **set_global_pos** **(** :ref:`Vector2` pos **)** -Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin`). +Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin`). .. _class_Control_set_rotation: @@ -353,7 +358,7 @@ Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RI - :ref:`Vector2` **get_end** **(** **)** const -Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). +Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). .. _class_Control_get_pos: @@ -365,7 +370,7 @@ Returns the Control position, relative to the top-left corner of the parent Cont - :ref:`Vector2` **get_size** **(** **)** const -Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by :ref:`get_minimum_size`**. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, :ref:`get_minimum_size`, :ref:`set_margin`, :ref:`set_anchor`). +Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by :ref:`get_minimum_size`**. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, :ref:`get_minimum_size`, :ref:`set_margin`, :ref:`set_anchor`). .. _class_Control_get_rotation: @@ -393,25 +398,25 @@ Returns the Control position, relative to the top-left corner of the parent Cont - :ref:`Rect2` **get_rect** **(** **)** const -Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see :ref:`get_pos`,:ref:`get_size`). +Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see :ref:`get_pos`, :ref:`get_size`). .. _class_Control_get_global_rect: - :ref:`Rect2` **get_global_rect** **(** **)** const -Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_pos`,:ref:`get_size`). +Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_pos`, :ref:`get_size`). .. _class_Control_set_area_as_parent_rect: - void **set_area_as_parent_rect** **(** :ref:`int` margin=0 **)** -Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see :ref:`set_anchor`,:ref:`set_margin`). +Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see :ref:`set_anchor`, :ref:`set_margin`). .. _class_Control_show_modal: - void **show_modal** **(** :ref:`bool` exclusive=false **)** -Display a Control as modal. Control must be a subwindow (see :ref:`set_as_subwindow`). Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. +Display a Control as modal. Control must be a subwindow (see :ref:`set_as_subwindow`). Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. .. _class_Control_set_focus_mode: @@ -423,13 +428,13 @@ Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). - :ref:`bool` **has_focus** **(** **)** const -Return wether the Control is the current focused control (see :ref:`set_focus_mode`). +Return wether the Control is the current focused control (see :ref:`set_focus_mode`). .. _class_Control_grab_focus: - void **grab_focus** **(** **)** -Steal the focus from another control and become the focused control (see :ref:`set_focus_mode`). +Steal the focus from another control and become the focused control (see :ref:`set_focus_mode`). .. _class_Control_release_focus: @@ -489,7 +494,7 @@ Override whole the :ref:`Theme` for this Control and all its childr - :ref:`Theme` **get_theme** **(** **)** const -Return a :ref:`Theme` override, if one exists (see :ref:`set_theme`). +Return a :ref:`Theme` override, if one exists (see :ref:`set_theme`). .. _class_Control_add_icon_override: diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index f43e36795..fbb0fe9a3 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -3,10 +3,13 @@ ConvexPolygonShape ================== -**Inherits:** :ref:`Shape` +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Convex Polygon Shape. Member Functions diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 83adaa854..f1ce34362 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -3,10 +3,13 @@ ConvexPolygonShape2D ==================== -**Inherits:** :ref:`Shape2D` +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Convex Polygon Shape for 2D physics. Member Functions diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 4e91bb9ff..dff734b4c 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -3,10 +3,13 @@ CubeMap ======= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 02f8bc59c..5a5b8c7fa 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -3,10 +3,13 @@ Curve2D ======= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Describes a Bezier curve in 2D space. Member Functions @@ -70,7 +73,7 @@ Returns the number of points describing the curve. Adds a point to a curve, at position "pos", with control points "in" and "out". -If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count`), the point will be appended at the end of the point list. +If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count`), the point will be appended at the end of the point list. .. _class_Curve2D_set_point_pos: @@ -126,7 +129,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i - :ref:`Vector2` **interpolatef** **(** :ref:`float` fofs **)** const -Returns the position at the vertex "fofs". It calls :ref:`interpolate` using the integer part of fofs as "idx", and its fractional part as "t". +Returns the position at the vertex "fofs". It calls :ref:`interpolate` using the integer part of fofs as "idx", and its fractional part as "t". .. _class_Curve2D_set_bake_interval: @@ -144,7 +147,7 @@ Returns the distance between two adjacent cached points. - :ref:`float` **get_baked_length** **(** **)** const -Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval`), it should be approximate enough. +Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval`), it should be approximate enough. .. _class_Curve2D_interpolate_baked: diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index fd7dd8456..89438f6dc 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -3,10 +3,13 @@ Curve3D ======= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Describes a Bezier curve in 3D space. Member Functions @@ -76,7 +79,7 @@ Returns the number of points describing the curve. Adds a point to a curve, at position "pos", with control points "in" and "out". -If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count`), the point will be appended at the end of the point list. +If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count`), the point will be appended at the end of the point list. .. _class_Curve3D_set_point_pos: @@ -146,7 +149,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i - :ref:`Vector3` **interpolatef** **(** :ref:`float` fofs **)** const -Returns the position at the vertex "fofs". It calls :ref:`interpolate` using the integer part of fofs as "idx", and its fractional part as "t". +Returns the position at the vertex "fofs". It calls :ref:`interpolate` using the integer part of fofs as "idx", and its fractional part as "t". .. _class_Curve3D_set_bake_interval: @@ -164,7 +167,7 @@ Returns the distance between two adjacent cached points. - :ref:`float` **get_baked_length** **(** **)** const -Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval`), it should be approximate enough. +Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval`), it should be approximate enough. .. _class_Curve3D_interpolate_baked: diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 1a0ad05eb..6d92aaf13 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -3,10 +3,13 @@ DampedSpringJoint2D =================== -**Inherits:** :ref:`Joint2D` +**Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Damped spring constraint for 2D physics. Member Functions diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 401e8fae5..c236fbc08 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -5,6 +5,9 @@ Dictionary **Category:** Built-In Types +Brief Description +----------------- + Dictionary type. Member Functions diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 64ab718da..0a5f79920 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -3,10 +3,13 @@ DirectionalLight ================ -**Inherits:** :ref:`Light` +**Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Directional Light, such as the Sun or the Moon. Member Functions diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 15c91081f..4303ae9ea 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -3,10 +3,13 @@ Directory ========= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index d17fd0da0..c6c035bf6 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -3,10 +3,13 @@ EditorFileDialog ================ -**Inherits:** :ref:`ConfirmationDialog` +**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index eaa216162..09859163b 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -3,10 +3,13 @@ EditorImportPlugin ================== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 5100fce2c..5c256d042 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -3,10 +3,13 @@ EditorPlugin ============ -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index 89c7326ba..5d0e93301 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -3,10 +3,13 @@ EditorScenePostImport ===================== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 1debae164..3f0181054 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -3,10 +3,13 @@ EditorScript ============ -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 5c2489c77..386e83e4c 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -3,10 +3,13 @@ Environment =========== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_eventplayer.rst b/classes/class_eventplayer.rst index 34f645c58..88d2cc290 100644 --- a/classes/class_eventplayer.rst +++ b/classes/class_eventplayer.rst @@ -3,10 +3,13 @@ EventPlayer =========== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Class for event stream playback. Member Functions @@ -174,7 +177,7 @@ Return the tempo multiplier. - void **set_volume_db** **(** :ref:`float` db **)** -Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see :ref:`set_volume`) still apply. +Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see :ref:`set_volume`) still apply. .. _class_EventPlayer_get_volume_db: @@ -228,7 +231,7 @@ Return whether this player will start playing as soon as it enters the scene tre - void **set_channel_volume** **(** :ref:`int` channel, :ref:`float` channel_volume **)** -Set the volume scale for an individual channel of the stream, with the same value range as :ref:`methid set_volume`. The channel number depends on the stream format. For example, MIDIs range from 0 to 15, and MODs from 0 to 63. +Set the volume scale for an individual channel of the stream, with the same value range as :ref:`set_volume`. The channel number depends on the stream format. For example, MIDIs range from 0 to 15, and MODs from 0 to 63. Many stream formats are multichannel, so this allows to affect only a part of the music. diff --git a/classes/class_eventstream.rst b/classes/class_eventstream.rst index 32d8b7e62..32dac2ad7 100644 --- a/classes/class_eventstream.rst +++ b/classes/class_eventstream.rst @@ -3,10 +3,15 @@ EventStream =========== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`EventStreamChibi` **Category:** Core +Brief Description +----------------- + Base class for all event-based stream drivers. Description diff --git a/classes/class_eventstreamchibi.rst b/classes/class_eventstreamchibi.rst index ead22c276..b3c2b99d7 100644 --- a/classes/class_eventstreamchibi.rst +++ b/classes/class_eventstreamchibi.rst @@ -3,10 +3,13 @@ EventStreamChibi ================ -**Inherits:** :ref:`EventStream` +**Inherits:** :ref:`EventStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Driver for MOD playback. Description diff --git a/classes/class_file.rst b/classes/class_file.rst index 970b0d15d..ca7969d3f 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -3,10 +3,13 @@ File ==== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index e765e9215..238f5946a 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -3,10 +3,13 @@ FileDialog ========== -**Inherits:** :ref:`ConfirmationDialog` +**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Dialog for selecting files or directories in the filesystem. Member Functions diff --git a/classes/class_fixedmaterial.rst b/classes/class_fixedmaterial.rst index 8bd857e3a..a34b46584 100644 --- a/classes/class_fixedmaterial.rst +++ b/classes/class_fixedmaterial.rst @@ -3,10 +3,13 @@ FixedMaterial ============= -**Inherits:** :ref:`Material` +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Simple Material with a fixed parameter set. Member Functions @@ -91,13 +94,13 @@ Return a parameter, parameters are defined in the PARAM\_\* enum. The type of ea - void **set_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** -Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode`). +Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode`). .. _class_FixedMaterial_get_texture: - :ref:`Texture` **get_texture** **(** :ref:`int` param **)** const -Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode`). +Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode`). .. _class_FixedMaterial_set_texcoord_mode: diff --git a/classes/class_float.rst b/classes/class_float.rst index d11d2030d..01815c7d2 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -5,6 +5,9 @@ float **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_font.rst b/classes/class_font.rst index da907da6b..97aca0a8d 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -3,10 +3,13 @@ Font ==== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Internationalized font and text drawing support. Member Functions diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index 1556368d1..4c5571a52 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -3,10 +3,13 @@ FuncRef ======= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdfunctionstate.rst index ffd2cab4e..63f9c5b74 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdfunctionstate.rst @@ -3,10 +3,13 @@ GDFunctionState =============== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_gdnativeclass.rst b/classes/class_gdnativeclass.rst index 2b5ccf5ba..03719284c 100644 --- a/classes/class_gdnativeclass.rst +++ b/classes/class_gdnativeclass.rst @@ -3,10 +3,13 @@ GDNativeClass ============= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 294590fc9..e4698ada0 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -3,10 +3,13 @@ GDScript ======== -**Inherits:** :ref:`Script` +**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index a0d2e50a7..2c9a26813 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -3,10 +3,13 @@ Generic6DOFJoint ================ -**Inherits:** :ref:`Joint` +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 9beb17948..8ad1a78f0 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -7,6 +7,9 @@ Geometry **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 9776151bb..23421b93a 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -3,10 +3,15 @@ GeometryInstance ================ -**Inherits:** :ref:`VisualInstance` +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`MultiMeshInstance`, :ref:`SpriteBase3D`, :ref:`MeshInstance`, :ref:`Particles`, :ref:`Quad`, :ref:`TestCube`, :ref:`ImmediateGeometry` **Category:** Core +Brief Description +----------------- + Base node for geometry based visual instances. Member Functions diff --git a/classes/class_globals.rst b/classes/class_globals.rst index 9fa41742d..1a91ad4e0 100644 --- a/classes/class_globals.rst +++ b/classes/class_globals.rst @@ -7,6 +7,9 @@ Globals **Category:** Core +Brief Description +----------------- + Contains global variables accessible from everywhere. Member Functions diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 6f44e4a6f..85bc3afdb 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -3,10 +3,13 @@ GraphEdit ========= -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. Member Functions @@ -48,7 +51,7 @@ Description GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. -It is greatly advised to enable low processor usage mode :ref:`OS.set_low_processor_usage_mode()` when using GraphEdits. +It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_processor_usage_mode`) when using GraphEdits. Member Function Description --------------------------- diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 3b1779ec1..18910e634 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -3,10 +3,13 @@ GraphNode ========= -**Inherits:** :ref:`Container` +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. Member Functions diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 2a2407e6f..0e0a65aee 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -3,10 +3,13 @@ GridContainer ============= -**Inherits:** :ref:`Container` +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 723d39e13..693f20da7 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -3,10 +3,13 @@ GridMap ======= -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 4eef4d953..448f421a4 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -3,10 +3,13 @@ GrooveJoint2D ============= -**Inherits:** :ref:`Joint2D` +**Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Groove constraint for 2D physics. Member Functions diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index 4e0f8a253..c81fa2426 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -3,10 +3,13 @@ HBoxContainer ============= -**Inherits:** :ref:`BoxContainer` +**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Horizontal box container. Description diff --git a/classes/class_hbuttonarray.rst b/classes/class_hbuttonarray.rst index 5d0625764..5197e079f 100644 --- a/classes/class_hbuttonarray.rst +++ b/classes/class_hbuttonarray.rst @@ -3,10 +3,13 @@ HButtonArray ============ -**Inherits:** :ref:`ButtonArray` +**Inherits:** :ref:`ButtonArray` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Horizontal button array. Description diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index b8542ce24..26a124121 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -3,10 +3,13 @@ HingeJoint ========== -**Inherits:** :ref:`Joint` +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index 48691e01c..8561c92cc 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -3,10 +3,13 @@ HScrollBar ========== -**Inherits:** :ref:`ScrollBar` +**Inherits:** :ref:`ScrollBar` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Horizontal scroll bar. Description diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index e4747267d..c76ab09a1 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -3,10 +3,13 @@ HSeparator ========== -**Inherits:** :ref:`Separator` +**Inherits:** :ref:`Separator` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Horizontal separator. Description diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index c12d349bc..fbf23fed7 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -3,10 +3,13 @@ HSlider ======= -**Inherits:** :ref:`Slider` +**Inherits:** :ref:`Slider` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Horizontal slider. Description diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index af95a27c2..7ed152ebe 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -3,10 +3,13 @@ HSplitContainer =============== -**Inherits:** :ref:`SplitContainer` +**Inherits:** :ref:`SplitContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Horizontal split container. Description diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 0ba838f85..7003d3907 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -3,10 +3,13 @@ HTTPClient ========== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions @@ -147,33 +150,19 @@ verify_host will check the SSL identity of the host if set to true. - :ref:`int` **request** **(** :ref:`int` method, :ref:`String` url, :ref:`StringArray` headers, :ref:`String` body="" **)** -Sends a request to the connected host. The url is the what is normally behind the hostname, i.e: +Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in ``http://somehost.com/index.php``, url would be "index.php". -http://somehost.com/index.php +Headers are HTTP request headers. -url would be "index.php" +To create a POST request with query strings to push to the server, do:: + var fields = {"username" : "user", "password" : "pass"} + var queryString = httpClient.query_string_from_dict(fields) -Headers are HTTP request headers + var headers = :ref:`"Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())` - - -To create a POST request with query strings to push to the server, do: - -var fields = {"username" : "user", - - "password" : "pass"} - -var queryString = httpClient.query_string_from_dict(fields) - -var headers = :ref:`"Content-Type: application/x-www-form-urlencoded", - - "Content-Length: " + str(queryString.length())` - -var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) + var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) .. _class_HTTPClient_send_body_text: @@ -239,28 +228,24 @@ If set to true, execute will wait until all data is read from the response. - :ref:`int` **get_status** **(** **)** const -Returns a status string like STATUS_REQUESTING. Need to call :ref:`poll` in order to get status updates. +Returns a status string like STATUS_REQUESTING. Need to call :ref:`poll` in order to get status updates. .. _class_HTTPClient_poll: - Error **poll** **(** **)** -This needs to be called in order to have any request processed. Check results with :ref:`get_status` +This needs to be called in order to have any request processed. Check results with :ref:`get_status` .. _class_HTTPClient_query_string_from_dict: - :ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** -Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary. - - - -var fields = {"username": "user", "password": "pass"} - -String queryString = httpClient.query_string_from_dict(fields) - - - -returns:= "username=user&password=pass" +Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.:: + + var fields = {"username": "user", "password": "pass"} + + String queryString = httpClient.query_string_from_dict(fields) + + returns:= "username=user&password=pass" diff --git a/classes/class_image.rst b/classes/class_image.rst index 78b79243a..d350af0bc 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -5,6 +5,9 @@ Image **Category:** Built-In Types +Brief Description +----------------- + Image datatype. Member Functions diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 3d34bc16a..07e5b351c 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -3,10 +3,13 @@ ImageTexture ============ -**Inherits:** :ref:`Texture` +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index da97b4a3a..590111c77 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -3,10 +3,13 @@ ImmediateGeometry ================= -**Inherits:** :ref:`GeometryInstance` +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_input.rst b/classes/class_input.rst index 4361f4195..cbca28833 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -5,8 +5,13 @@ Input **Inherits:** :ref:`Object` +**Inherited By:** :ref:`InputDefault` + **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_inputdefault.rst b/classes/class_inputdefault.rst index 0464965c6..843a7dea1 100644 --- a/classes/class_inputdefault.rst +++ b/classes/class_inputdefault.rst @@ -3,9 +3,12 @@ InputDefault ============ -**Inherits:** :ref:`Input` +**Inherits:** :ref:`Input` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index ba332a939..f78ac92fe 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -5,6 +5,9 @@ InputEvent **Category:** Built-In Types +Brief Description +----------------- + Built-in input event data. Member Functions diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index e78e3d26f..52b58ea5d 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -5,6 +5,9 @@ InputEventAction **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_inputeventjoybutton.rst b/classes/class_inputeventjoybutton.rst index 8cd1e62d0..16a50c179 100644 --- a/classes/class_inputeventjoybutton.rst +++ b/classes/class_inputeventjoybutton.rst @@ -5,6 +5,9 @@ InputEventJoyButton **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_inputeventjoymotion.rst b/classes/class_inputeventjoymotion.rst index 9c7424740..09061029a 100644 --- a/classes/class_inputeventjoymotion.rst +++ b/classes/class_inputeventjoymotion.rst @@ -5,6 +5,9 @@ InputEventJoyMotion **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 2c3d14d15..000e32fb2 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -5,6 +5,9 @@ InputEventKey **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 0c1e87d19..2ae3b74cd 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -5,6 +5,9 @@ InputEventMouseButton **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 52f3510fc..0f16ec741 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -5,6 +5,9 @@ InputEventMouseMotion **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 55a5a4a84..d69af1f48 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -5,6 +5,9 @@ InputEventScreenDrag **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 55bd67994..e53ffae73 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -5,6 +5,9 @@ InputEventScreenTouch **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index bb51fe315..ce2cfd72c 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -7,6 +7,9 @@ InputMap **Category:** Core +Brief Description +----------------- + Singleton that manages actions. Member Functions diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index f24a97d1c..57c865189 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -3,10 +3,13 @@ InstancePlaceholder =================== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_int.rst b/classes/class_int.rst index 2290bb2d2..be11ffb83 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -5,6 +5,9 @@ int **Category:** Built-In Types +Brief Description +----------------- + Integer built-in type. Member Functions diff --git a/classes/class_intarray.rst b/classes/class_intarray.rst index afca6308a..4ba12443b 100644 --- a/classes/class_intarray.rst +++ b/classes/class_intarray.rst @@ -5,6 +5,9 @@ IntArray **Category:** Built-In Types +Brief Description +----------------- + Integer Array. Member Functions diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index b94de0955..f2e5aad45 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -3,10 +3,13 @@ InterpolatedCamera ================== -**Inherits:** :ref:`Camera` +**Inherits:** :ref:`Camera` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 4ed17a802..903164f6a 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -5,8 +5,13 @@ IP **Inherits:** :ref:`Object` +**Inherited By:** :ref:`IP_Unix` + **Category:** Core +Brief Description +----------------- + IP Protocol support functions. Member Functions @@ -66,7 +71,7 @@ Return the status of hostname queued for resolving, given it's queue ID. Returne - :ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** const -Return a resolved item address, or an empty string if an error happened or resolution didn't happen yet (see :ref:`get_resolve_item_status`). +Return a resolved item address, or an empty string if an error happened or resolution didn't happen yet (see :ref:`get_resolve_item_status`). .. _class_IP_erase_resolve_item: diff --git a/classes/class_ip_unix.rst b/classes/class_ip_unix.rst index 497d422c1..7c4a5fd2b 100644 --- a/classes/class_ip_unix.rst +++ b/classes/class_ip_unix.rst @@ -3,9 +3,12 @@ IP_Unix ======= -**Inherits:** :ref:`IP` +**Inherits:** :ref:`IP` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 0803d7c33..fd988f816 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -3,10 +3,13 @@ ItemList ======== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 8028debea..cb21956f6 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -3,10 +3,15 @@ Joint ===== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`ConeTwistJoint`, :ref:`SliderJoint`, :ref:`Generic6DOFJoint`, :ref:`HingeJoint`, :ref:`PinJoint` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 0044669fa..98c8e595d 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -3,10 +3,15 @@ Joint2D ======= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`PinJoint2D`, :ref:`DampedSpringJoint2D`, :ref:`GrooveJoint2D` **Category:** Core +Brief Description +----------------- + Base node for all joint constraints in 2D phyisics. Member Functions diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 47bcaeb2c..bac248a4b 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -3,10 +3,13 @@ KinematicBody ============= -**Inherits:** :ref:`PhysicsBody` +**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 8f62828bd..4ed7f463d 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -3,10 +3,13 @@ KinematicBody2D =============== -**Inherits:** :ref:`PhysicsBody2D` +**Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Kinematic body 2D node. Member Functions @@ -49,7 +52,7 @@ Kinematic bodies are special types of bodies that are meant to be user-controlle Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). -Kinematic Characters: KinematicBody2D also has an api for moving objects (the :ref:`move` method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. +Kinematic Characters: KinematicBody2D also has an api for moving objects (the :ref:`move` method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. Member Function Description --------------------------- @@ -94,7 +97,7 @@ Return whether the body is colliding with another. - :ref:`Vector2` **get_collision_pos** **(** **)** const -Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with :ref:`is_colliding`. +Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with :ref:`is_colliding`. .. _class_KinematicBody2D_get_collision_normal: @@ -118,13 +121,13 @@ Return the body that collided with this one. - :ref:`int` **get_collider_shape** **(** **)** const -Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with :ref:`is_colliding`. +Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with :ref:`is_colliding`. .. _class_KinematicBody2D_get_collider_metadata: - Variant **get_collider_metadata** **(** **)** const -Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with :ref:`is_colliding`. Aditionally, this metadata can not be set with :ref:`Object.set_meta`, it must be set with :ref:`Physics2DServer.body_set_shape_metadata`. +Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with :ref:`is_colliding`. Aditionally, this metadata can not be set with :ref:`Object.set_meta`, it must be set with :ref:`Physics2DServer.body_set_shape_metadata`. .. _class_KinematicBody2D_set_collision_margin: diff --git a/classes/class_label.rst b/classes/class_label.rst index 5d798fca0..f53b06df3 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -3,10 +3,13 @@ Label ===== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Control that displays formatted text. Member Functions @@ -126,7 +129,7 @@ Set *autowrap* mode. When enabled, autowrap will fit text to the control width, - :ref:`bool` **has_autowrap** **(** **)** const -Return the state of the *autowrap* mode (see :ref:`set_autowrap`). +Return the state of the *autowrap* mode (see :ref:`set_autowrap`). .. _class_Label_set_clip_text: diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index de84d357e..a095c2d2e 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -3,10 +3,13 @@ LargeTexture ============ -**Inherits:** :ref:`Texture` +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_light.rst b/classes/class_light.rst index 4d8832b0f..116f7fe97 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -3,10 +3,15 @@ Light ===== -**Inherits:** :ref:`VisualInstance` +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`SpotLight`, :ref:`OmniLight`, :ref:`DirectionalLight` **Category:** Core +Brief Description +----------------- + Provides a base class for different kinds of light nodes. Member Functions diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 9cd6f4a84..b87493066 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -3,10 +3,13 @@ Light2D ======= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index d99972082..d2e029e7d 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -3,10 +3,13 @@ LightOccluder2D =============== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 1175ded6d..019cd5844 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -3,10 +3,13 @@ LineEdit ======== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Control that provides single line string editing. Member Functions @@ -140,7 +143,7 @@ Set the *editable* status of the :ref:`LineEdit`. When disabled, - :ref:`bool` **is_editable** **(** **)** const -Return the *editable* status of the :ref:`LineEdit` (see :ref:`set_editable`). +Return the *editable* status of the :ref:`LineEdit` (see :ref:`set_editable`). .. _class_LineEdit_set_secret: @@ -152,7 +155,7 @@ Set the *secret* status of the :ref:`LineEdit`. When enabled, ev - :ref:`bool` **is_secret** **(** **)** const -Return the *secret* status of the :ref:`LineEdit` (see :ref:`set_secret`). +Return the *secret* status of the :ref:`LineEdit` (see :ref:`set_secret`). .. _class_LineEdit_select: diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 846f12206..879994cd7 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -3,10 +3,13 @@ LineShape2D =========== -**Inherits:** :ref:`Shape2D` +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Line shape for 2D collision objects. Member Functions diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index ec7de5b12..ac1805520 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -5,8 +5,13 @@ MainLoop **Inherits:** :ref:`Object` +**Inherited By:** :ref:`SceneTree` + **Category:** Core +Brief Description +----------------- + Main loop is the abstract main loop base class. Member Functions diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index a737fd8c7..667493023 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -3,10 +3,13 @@ MarginContainer =============== -**Inherits:** :ref:`Container` +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Simple margin container. Description diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 447e91e01..6847cd40c 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -3,10 +3,13 @@ Marshalls ========= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_material.rst b/classes/class_material.rst index 9ecbbadf6..2917daf13 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -3,10 +3,15 @@ Material ======== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`ShaderMaterial`, :ref:`FixedMaterial` **Category:** Core +Brief Description +----------------- + Abstract base :ref:`Resource` for coloring and shading geometry. Member Functions diff --git a/classes/class_materialshader.rst b/classes/class_materialshader.rst index d4a447b60..89284c4e3 100644 --- a/classes/class_materialshader.rst +++ b/classes/class_materialshader.rst @@ -3,9 +3,12 @@ MaterialShader ============== -**Inherits:** :ref:`Shader` +**Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_materialshadergraph.rst b/classes/class_materialshadergraph.rst index 954fdd772..729eec7bb 100644 --- a/classes/class_materialshadergraph.rst +++ b/classes/class_materialshadergraph.rst @@ -3,9 +3,12 @@ MaterialShaderGraph =================== -**Inherits:** :ref:`ShaderGraph` +**Inherits:** :ref:`ShaderGraph` **<** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_matrix3.rst b/classes/class_matrix3.rst index ee5dc2a16..8c6f1c3b8 100644 --- a/classes/class_matrix3.rst +++ b/classes/class_matrix3.rst @@ -5,6 +5,9 @@ Matrix3 **Category:** Built-In Types +Brief Description +----------------- + 3x3 matrix datatype. Member Functions diff --git a/classes/class_matrix32.rst b/classes/class_matrix32.rst index 4b719993f..7eac88b25 100644 --- a/classes/class_matrix32.rst +++ b/classes/class_matrix32.rst @@ -5,6 +5,9 @@ Matrix32 **Category:** Built-In Types +Brief Description +----------------- + 3x2 Matrix for 2D transforms. Member Functions diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 894b75493..71227297f 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -3,10 +3,13 @@ MenuButton ========== -**Inherits:** :ref:`Button` +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Special button that brings up a :ref:`PopupMenu` when clicked. Member Functions diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index d9bf6e129..e99a8b8ad 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -3,10 +3,13 @@ Mesh ==== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + A :ref:`Resource` that contains vertex-array based geometry. Member Functions @@ -61,12 +64,12 @@ Numeric Constants - **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present. - **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4). -- **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3`() vertices). -- **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3`() normals). +- **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3` vertices). +- **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3` normals). - **ARRAY_TANGENT** = **2** --- Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. -- **ARRAY_COLOR** = **3** --- Vertex array (array of :ref:`Color`() colors). -- **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3`() UVs or float array of groups of 2 floats (u,v)). -- **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`Vector3`() UVs or float array of groups of 2 floats (u,v)). +- **ARRAY_COLOR** = **3** --- Vertex array (array of :ref:`Color` colors). +- **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). +- **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). - **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats. - **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats. - **ARRAY_INDEX** = **8** --- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. @@ -123,7 +126,7 @@ Member Function Description - void **add_surface** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` morph_arrays=Array(), :ref:`bool` alphasort=false **)** -Create a new surface (:ref:`get_surface_count` that will become surf_idx for this. +Create a new surface (:ref:`get_surface_count` that will become surf_idx for this. Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). @@ -145,25 +148,25 @@ Remove a surface at position surf_idx, shifting greater surfaces one surf_idx sl - :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const -Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface`). +Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface`). .. _class_Mesh_surface_get_array_index_len: - :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const -Return the length in indices of the index array in the requested surface (see :ref:`add_surface`). +Return the length in indices of the index array in the requested surface (see :ref:`add_surface`). .. _class_Mesh_surface_get_format: - :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const -Return the format mask of the requested surface (see :ref:`add_surface`). +Return the format mask of the requested surface (see :ref:`add_surface`). .. _class_Mesh_surface_get_primitive_type: - :ref:`int` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const -Return the primitive type of the requested surface (see :ref:`add_surface`). +Return the primitive type of the requested surface (see :ref:`add_surface`). .. _class_Mesh_surface_set_material: diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index c40d3ad48..fd54cb756 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -3,10 +3,13 @@ MeshDataTool ============ -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 6fab14d7e..11cfdec60 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -3,10 +3,13 @@ MeshInstance ============ -**Inherits:** :ref:`GeometryInstance` +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Node that instances meshes into a :ref:`Scenario`. Member Functions diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 83f423094..69ad6151f 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -3,10 +3,13 @@ MeshLibrary =========== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Library of meshes. Member Functions diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index e539dd0ba..6cf484a11 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -3,10 +3,13 @@ MultiMesh ========= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Provides high perfomance mesh instancing. Member Functions @@ -43,9 +46,9 @@ MultiMesh provides low level mesh instancing. If the amount of :ref:`Mesh`. +Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with :ref:`generate_aabb`. Member Function Description --------------------------- diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index 4374bd48c..4648eb9e6 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -3,10 +3,13 @@ MultiMeshInstance ================= -**Inherits:** :ref:`GeometryInstance` +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Node that instances a :ref:`MultiMesh`. Member Functions diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index d05d81662..93880c446 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -3,10 +3,13 @@ Mutex ===== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index a6fbc8ade..b3f50704b 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -3,10 +3,13 @@ Navigation ========== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 960d6eef6..969d3562c 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -3,10 +3,13 @@ Navigation2D ============ -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index cd0a42da8..630492f91 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -3,10 +3,13 @@ NavigationMesh ============== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index 9f75b4212..1efe238f6 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -3,10 +3,13 @@ NavigationMeshInstance ====================== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index cc48cdaf1..83f9edaac 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -3,10 +3,13 @@ NavigationPolygon ================= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index a9debc8d8..0cfd5b336 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -3,10 +3,13 @@ NavigationPolygonInstance ========================= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_nil.rst b/classes/class_nil.rst index 6e9e3e711..d3eb6e6a8 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -5,6 +5,9 @@ Nil **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_node.rst b/classes/class_node.rst index 797d5e684..a56e3c4b5 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -5,8 +5,13 @@ Node **Inherits:** :ref:`Object` +**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`CanvasLayer`, :ref:`EventPlayer`, :ref:`SoundRoomParams`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`SamplePlayer`, :ref:`InstancePlaceholder`, :ref:`StreamPlayer`, :ref:`CanvasItem`, :ref:`Tween` + **Category:** Core +Brief Description +----------------- + Base class for all the "Scene" elements. Member Functions @@ -157,7 +162,7 @@ Numeric Constants - **NOTIFICATION_MOVED_IN_PARENT** = **12** - **NOTIFICATION_READY** = **13** - **NOTIFICATION_FIXED_PROCESS** = **16** -- **NOTIFICATION_PROCESS** = **17** --- Notification received every frame when the process flag is set (see :ref:`set_process`). +- **NOTIFICATION_PROCESS** = **17** --- Notification received every frame when the process flag is set (see :ref:`set_process`). - **NOTIFICATION_PARENTED** = **18** --- Notification received when a node is set as a child of another node. Note that this doesn't mean that a node entered the Scene Tree. - **NOTIFICATION_UNPARENTED** = **19** --- Notification received when a node is unparented (parent removed it from the list of children). - **NOTIFICATION_PAUSED** = **14** @@ -180,9 +185,9 @@ A node can contain any number of nodes as a children (but there is only one tree Nodes can, optionally, be added to groups. This makes it easy to reach a number of nodes from the code (for example an "enemies" group). -Nodes can be set to "process" state, so they constantly receive a callback requesting them to process (do anything). Normal processing (:ref:`_process`) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Fixed processing (:ref:`_fixed_process`) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. +Nodes can be set to "process" state, so they constantly receive a callback requesting them to process (do anything). Normal processing (:ref:`_process`) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Fixed processing (:ref:`_fixed_process`) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. -Nodes can also process input events. When set, the :ref:`_input` function will be called with every input that the program receives. Since this is usually too overkill (unless used for simple projects), an :ref:`_unhandled_input` function is called when the input was not handled by anyone else (usually, GUI :ref:`Control` nodes). +Nodes can also process input events. When set, the :ref:`_input` function will be called with every input that the program receives. Since this is usually too overkill (unless used for simple projects), an :ref:`_unhandled_input` function is called when the input was not handled by anyone else (usually, GUI :ref:`Control` nodes). To keep track of the scene hieararchy (specially when instancing scenes into scenes) an "owner" can be set to a node. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. @@ -209,7 +214,7 @@ Called for fixed processing (synced to the physics). - void **_input** **(** :ref:`InputEvent` event **)** virtual -Called when any input happens (also must enable with :ref:`set_process_input` or the property). +Called when any input happens (also must enable with :ref:`set_process_input` or the property). .. _class_Node__process: @@ -227,7 +232,7 @@ Called when ready (entered scene and children entered too). - void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual -Called when any input happens that was not handled by something else (also must enable with :ref:`set_process_unhandled_input` or the property). +Called when any input happens that was not handled by something else (also must enable with :ref:`set_process_unhandled_input` or the property). .. _class_Node__unhandled_key_input: @@ -275,7 +280,7 @@ Return the amount of children nodes. - :ref:`Node` **get_child** **(** :ref:`int` idx **)** const -Return a children node by it's index (see :ref:`get_child_count`). This method is often used for iterating all children of a node. +Return a children node by it's index (see :ref:`get_child_count`). This method is often used for iterating all children of a node. .. _class_Node_has_node: @@ -287,7 +292,7 @@ Return a children node by it's index (see :ref:`get_child_count`). Examples. Assume your current node is Character and following tree: +Note: fetching absolute paths only works when the node is inside the scene tree (see :ref:`is_inside_scene`). Examples. Assume your current node is Character and following tree: @@ -357,7 +362,7 @@ Return *true* if "node" occurs later in the scene hierarchy than the current nod - :ref:`NodePath` **get_path** **(** **)** const -Return the absolute path of the current node. This only works if the curent node is inside the scene tree (see :ref:`is_inside_scene`). +Return the absolute path of the current node. This only works if the curent node is inside the scene tree (see :ref:`is_inside_scene`). .. _class_Node_get_path_to: @@ -369,7 +374,7 @@ Return the relative path from the current node to the specified node in "node" a - void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** -Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies", "Collectables", etc. A :ref:`Node` can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see :ref:`is_inside_scene`). +Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies", "Collectables", etc. A :ref:`Node` can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see :ref:`is_inside_scene`). .. _class_Node_remove_from_group: @@ -407,7 +412,7 @@ Set the node owner. A node can have any other node as owner (as long as a valid - :ref:`Node` **get_owner** **(** **)** const -Get the node owner (see :ref:`set_node_owner`). +Get the node owner (see :ref:`set_node_owner`). .. _class_Node_remove_and_skip: @@ -437,7 +442,7 @@ A node can contain a filename. This filename should not be changed by the user, - :ref:`String` **get_filename** **(** **)** const -Return a filename that may be containedA node can contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see :ref:`set_filename`). +Return a filename that may be containedA node can contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see :ref:`set_filename`). .. _class_Node_propagate_notification: @@ -449,7 +454,7 @@ Notify the current node and all its chldren recursively by calling notification( - void **set_fixed_process** **(** :ref:`bool` enable **)** -Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60fps, check :ref:`OS` to change that) interval (and the :ref:`_fixed_process` callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling :ref:`get_fixed_process_time`. +Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60fps, check :ref:`OS` to change that) interval (and the :ref:`_fixed_process` callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling :ref:`get_fixed_process_time`. .. _class_Node_get_fixed_process_delta_time: @@ -461,13 +466,13 @@ Return the time elapsed since the last fixed frame. This is always the same in f - :ref:`bool` **is_fixed_processing** **(** **)** const -Return true if fixed processing is enabled (see :ref:`set_fixed_process`). +Return true if fixed processing is enabled (see :ref:`set_fixed_process`). .. _class_Node_set_process: - void **set_process** **(** :ref:`bool` enable **)** -Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the :ref:`_process` callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling :ref:`get_process_time`. +Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the :ref:`_process` callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling :ref:`get_process_time`. .. _class_Node_get_process_delta_time: @@ -479,31 +484,31 @@ Return the time elapsed (in seconds) since the last process callback. This is al - :ref:`bool` **is_processing** **(** **)** const -Return whether processing is enabled in the current node (see :ref:`set_process`). +Return whether processing is enabled in the current node (see :ref:`set_process`). .. _class_Node_set_process_input: - void **set_process_input** **(** :ref:`bool` enable **)** -Enable input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input (see :ref:`_input`). +Enable input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input (see :ref:`_input`). .. _class_Node_is_processing_input: - :ref:`bool` **is_processing_input** **(** **)** const -Return true if the node is processing input (see :ref:`set_process_input`). +Return true if the node is processing input (see :ref:`set_process_input`). .. _class_Node_set_process_unhandled_input: - void **set_process_unhandled_input** **(** :ref:`bool` enable **)** -Enable unhandled input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a :ref:`Control`). (see :ref:`_unhandled_input`). +Enable unhandled input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a :ref:`Control`). (see :ref:`_unhandled_input`). .. _class_Node_is_processing_unhandled_input: - :ref:`bool` **is_processing_unhandled_input** **(** **)** const -Return true if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). +Return true if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). .. _class_Node_set_process_unhandled_key_input: diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 38ca9c2f6..199561da4 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -3,10 +3,15 @@ Node2D ====== -**Inherits:** :ref:`CanvasItem` +**Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`ParticleAttractor2D`, :ref:`CollisionObject2D`, :ref:`VisibilityNotifier2D`, :ref:`TileMap`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`Light2D`, :ref:`SoundPlayer2D`, :ref:`ViewportSprite`, :ref:`Path2D`, :ref:`Sprite`, :ref:`RayCast2D`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`ParallaxLayer`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`BackBufferCopy`, :ref:`CanvasModulate`, :ref:`YSort`, :ref:`Camera2D` **Category:** Core +Brief Description +----------------- + Base node for 2D system. Member Functions diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index a45f009a9..6d30c2d6b 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -5,6 +5,9 @@ NodePath **Category:** Built-In Types +Brief Description +----------------- + Built-in type optimized for path traversing. Member Functions diff --git a/classes/class_object.rst b/classes/class_object.rst index 5ef2053f6..4bb83e3ab 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -3,8 +3,13 @@ Object ====== +**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`Input`, :ref:`SpatialSound2DServer`, :ref:`Node`, :ref:`Geometry`, :ref:`TreeItem`, :ref:`PhysicsDirectSpaceState`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`PathRemap`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`SpatialSoundServer`, :ref:`IP`, :ref:`VisualServer`, :ref:`OS`, :ref:`Physics2DDirectBodyState`, :ref:`Globals`, :ref:`PhysicsDirectBodyState`, :ref:`TranslationServer` + **Category:** Core +Brief Description +----------------- + Base class for all non built-in types. Member Functions @@ -111,13 +116,13 @@ Description Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. -Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the :ref:`free` function from the script or delete from C++). +Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the :ref:`free` function from the script or delete from C++). Some derivates add memory management, such as :ref:`Reference` (which keps a reference count and deletes itself automatically when no longer referenced) and :ref:`Node`, which deletes the children tree when deleted. -Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in :ref:`_get_property_list` and handled in :ref:`_get` and :ref:`_set`. However, scripting languages and C++ have simper means to export them. +Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in :ref:`_get_property_list` and handled in :ref:`_get` and :ref:`_set`. However, scripting languages and C++ have simper means to export them. -Objects also receive notifications (:ref:`_notification`). Notifications are a simple way to notify the object about simple events, so they can all be handled together. +Objects also receive notifications (:ref:`_notification`). Notifications are a simple way to notify the object about simple events, so they can all be handled together. Member Function Description --------------------------- @@ -286,7 +291,7 @@ Return the list of signals as an array of dictionaries. - :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=Array(), :ref:`int` flags=0 **)** -Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT\_\*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use :ref:`is_connected` to check. +Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT\_\*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use :ref:`is_connected` to check. .. _class_Object_disconnect: @@ -338,7 +343,7 @@ Deprecated, will go away. - :ref:`String` **tr** **(** :ref:`String` message **)** const -Translate a message. Only works in message translation is enabled (which is by default). See :ref:`set_message_translation`. +Translate a message. Only works in message translation is enabled (which is by default). See :ref:`set_message_translation`. .. _class_Object_is_queued_for_deletion: diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 0af37c51b..9448e8f43 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -3,10 +3,13 @@ OccluderPolygon2D ================= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 274f9991d..3f1175448 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -3,10 +3,13 @@ OmniLight ========= -**Inherits:** :ref:`Light` +**Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + OmniDirectional Light, such as a lightbulb or a candle. Description diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index f642c7da8..36c0bd34e 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -3,10 +3,13 @@ OptionButton ============ -**Inherits:** :ref:`Button` +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Button control that provides selectable options when pressed. Member Functions diff --git a/classes/class_os.rst b/classes/class_os.rst index f03e62b1a..133f009b4 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -7,6 +7,9 @@ OS **Category:** Core +Brief Description +----------------- + Operating System functions. Member Functions diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 9f4d7f3ea..807fcf17c 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -3,10 +3,13 @@ PackedDataContainer =================== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index a4cfe50cb..be62f7506 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -3,10 +3,13 @@ PackedDataContainerRef ====================== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index e52ed18bb..26fbd760a 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -3,10 +3,13 @@ PackedScene =========== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions @@ -34,7 +37,7 @@ Member Function Description - :ref:`int` **pack** **(** :ref:`Node` path **)** -Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner`. +Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner`. .. _class_PackedScene_instance: diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 8bd0de657..cecb554d5 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -3,10 +3,15 @@ PacketPeer ========== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP` **Category:** Core +Brief Description +----------------- + Abstraction and base class for packet-based protocols. Member Functions diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 85b8f8ef0..8acdbfb43 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -3,10 +3,13 @@ PacketPeerStream ================ -**Inherits:** :ref:`PacketPeer` +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Wrapper to use a PacketPeer over a StreamPeer. Member Functions diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index a708834c3..4875146ea 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -3,10 +3,13 @@ PacketPeerUDP ============= -**Inherits:** :ref:`PacketPeer` +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_panel.rst b/classes/class_panel.rst index b12c98c5e..0bed633dc 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -3,10 +3,13 @@ Panel ===== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Provides an opaque background for :ref:`Control` children. Description diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index dba59e864..cd68e5c36 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -3,10 +3,13 @@ PanelContainer ============== -**Inherits:** :ref:`Container` +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Panel container type. Description diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 3a4a0ea6e..50f00de84 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -3,10 +3,13 @@ ParallaxBackground ================== -**Inherits:** :ref:`CanvasLayer` +**Inherits:** :ref:`CanvasLayer` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 8ad484136..9161cba7d 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -3,10 +3,13 @@ ParallaxLayer ============= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_particleattractor2d.rst b/classes/class_particleattractor2d.rst index a44107e6e..f3d3b22f6 100644 --- a/classes/class_particleattractor2d.rst +++ b/classes/class_particleattractor2d.rst @@ -3,10 +3,13 @@ ParticleAttractor2D =================== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 80882c993..7e561e8b4 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -3,10 +3,13 @@ Particles ========= -**Inherits:** :ref:`GeometryInstance` +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Particle system 3D Node Member Functions @@ -126,7 +129,7 @@ Set the "emitting" property state. When emitting, the particle system generates - :ref:`bool` **is_emitting** **(** **)** const -Return the "emitting" property state (see :ref:`set_emitting`). +Return the "emitting" property state (see :ref:`set_emitting`). .. _class_Particles_set_visibility_aabb: diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index b37425a8e..e6a7df091 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -3,10 +3,13 @@ Particles2D =========== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_patch9frame.rst b/classes/class_patch9frame.rst index 93c943fd8..a470a1c9b 100644 --- a/classes/class_patch9frame.rst +++ b/classes/class_patch9frame.rst @@ -3,10 +3,13 @@ Patch9Frame =========== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_path.rst b/classes/class_path.rst index 0ac09250f..1fb598518 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -3,10 +3,13 @@ Path ==== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Container for a :ref:`Curve3D`. Member Functions diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 3b5f05675..1c6ec5b9c 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -3,10 +3,13 @@ Path2D ====== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Container for a :ref:`Curve2D`. Member Functions diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index 4ab3b7438..8bd986980 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -3,10 +3,13 @@ PathFollow ========== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Point sampler for a :ref:`Path`. Member Functions @@ -90,7 +93,7 @@ Returns the X displacement this node has from its parent :ref:`Path` - void **set_v_offset** **(** :ref:`float` v_offset **)** -Moves this node in the Y axis, for the same reasons of :ref:`set_h_offset`. +Moves this node in the Y axis, for the same reasons of :ref:`set_h_offset`. .. _class_PathFollow_get_v_offset: @@ -136,13 +139,13 @@ This method controls whether the position between two cached points is interpola - :ref:`bool` **get_cubic_interpolation** **(** **)** const -This method returns whether the position between two cached points (see :ref:`set_cubic_interpolation`) is interpolated linearly, or cubicly. +This method returns whether the position between two cached points (see :ref:`set_cubic_interpolation`) is interpolated linearly, or cubicly. .. _class_PathFollow_set_loop: - void **set_loop** **(** :ref:`bool` loop **)** -If set, any offset outside the path's length (whether set by :ref:`set_offset` or :ref:`set_unit_offset` will wrap around, instead of stopping at the ends. Set it for cyclic paths. +If set, any offset outside the path's length (whether set by :ref:`set_offset` or :ref:`set_unit_offset` will wrap around, instead of stopping at the ends. Set it for cyclic paths. .. _class_PathFollow_has_loop: diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index e1551407f..f5eda4cac 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -3,10 +3,13 @@ PathFollow2D ============ -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Point sampler for a :ref:`Path2D`. Member Functions @@ -82,7 +85,7 @@ Returns the horizontal displacement this node has from its parent :ref:`Path2D` v_offset **)** -Moves the PathFollow2D vertically, for the same reasons of :ref:`set_h_offset`. +Moves the PathFollow2D vertically, for the same reasons of :ref:`set_h_offset`. .. _class_PathFollow2D_get_v_offset: @@ -128,13 +131,13 @@ This method controls whether the position between two cached points is interpola - :ref:`bool` **get_cubic_interpolation** **(** **)** const -This method returns whether the position between two cached points (see :ref:`set_cubic_interpolation`) is interpolated linearly, or cubicly. +This method returns whether the position between two cached points (see :ref:`set_cubic_interpolation`) is interpolated linearly, or cubicly. .. _class_PathFollow2D_set_loop: - void **set_loop** **(** :ref:`bool` loop **)** -If set, any offset outside the path's length (whether set by :ref:`set_offset` or :ref:`set_unit_offset` will wrap around, instead of stopping at the ends. Set it for cyclic paths. +If set, any offset outside the path's length (whether set by :ref:`set_offset` or :ref:`set_unit_offset` will wrap around, instead of stopping at the ends. Set it for cyclic paths. .. _class_PathFollow2D_has_loop: diff --git a/classes/class_pathremap.rst b/classes/class_pathremap.rst index ef96f181f..f5d58deaa 100644 --- a/classes/class_pathremap.rst +++ b/classes/class_pathremap.rst @@ -7,6 +7,9 @@ PathRemap **Category:** Core +Brief Description +----------------- + Singleton containing the list of remapped resources. Member Functions diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 2062f5f04..ee96e8d0b 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -3,10 +3,13 @@ PCKPacker ========= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_performance.rst b/classes/class_performance.rst index a9c1df9a8..e503d958e 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -7,6 +7,9 @@ Performance **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index 056e375fa..f88c57bdf 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -3,10 +3,13 @@ PHashTranslation ================ -**Inherits:** :ref:`Translation` +**Inherits:** :ref:`Translation` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Optimized translation. Member Functions diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index ff2643eeb..f9d01cef0 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -5,8 +5,13 @@ Physics2DDirectBodyState **Inherits:** :ref:`Object` +**Inherited By:** :ref:`Physics2DDirectBodyStateSW` + **Category:** Core +Brief Description +----------------- + Direct access object to a physics body in the :ref:`Physics2DServer`. Member Functions diff --git a/classes/class_physics2ddirectbodystatesw.rst b/classes/class_physics2ddirectbodystatesw.rst index 9a1f28454..2216cd4fb 100644 --- a/classes/class_physics2ddirectbodystatesw.rst +++ b/classes/class_physics2ddirectbodystatesw.rst @@ -3,9 +3,12 @@ Physics2DDirectBodyStateSW ========================== -**Inherits:** :ref:`Physics2DDirectBodyState` +**Inherits:** :ref:`Physics2DDirectBodyState` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index 845de7ea9..79cbbc231 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -7,6 +7,9 @@ Physics2DDirectSpaceState **Category:** Core +Brief Description +----------------- + Direct access object to a space in the :ref:`Physics2DServer`. Member Functions @@ -60,7 +63,7 @@ normal: normal of the object at the point where the ray was stopped. shape: shape index of the object agaisnt which the ray was stopped. -collider_: collider agaisnt which the ray was stopped. +collider\_: collider agaisnt which the ray was stopped. collider_id: collider id of the object agaisnt which the ray was stopped. diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index d1eaf12c0..810742f1c 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -5,8 +5,13 @@ Physics2DServer **Inherits:** :ref:`Object` +**Inherited By:** :ref:`Physics2DServerSW` + **Category:** Core +Brief Description +----------------- + Physics 2D Server. Member Functions diff --git a/classes/class_physics2dserversw.rst b/classes/class_physics2dserversw.rst index 6e4dd994a..7fefaad0e 100644 --- a/classes/class_physics2dserversw.rst +++ b/classes/class_physics2dserversw.rst @@ -3,9 +3,12 @@ Physics2DServerSW ================= -**Inherits:** :ref:`Physics2DServer` +**Inherits:** :ref:`Physics2DServer` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index ea781c1a9..f2da91c8b 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -3,10 +3,13 @@ Physics2DShapeQueryParameters ============================= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index 35cefffd0..000d0dabd 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -3,10 +3,13 @@ Physics2DShapeQueryResult ========================= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index ee5fc6dd9..2e04c4252 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -3,10 +3,13 @@ Physics2DTestMotionResult ========================= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index c77b78bbb..a56d20e3c 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -3,10 +3,15 @@ PhysicsBody =========== -**Inherits:** :ref:`CollisionObject` +**Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`VehicleBody`, :ref:`KinematicBody`, :ref:`StaticBody`, :ref:`RigidBody` **Category:** Core +Brief Description +----------------- + Base class for different types of Physics bodies. Member Functions diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 384482abe..9cfb519e1 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -3,10 +3,15 @@ PhysicsBody2D ============= -**Inherits:** :ref:`CollisionObject2D` +**Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`RigidBody2D`, :ref:`StaticBody2D`, :ref:`KinematicBody2D` **Category:** Core +Brief Description +----------------- + Base class for all objects affected by physics. Member Functions @@ -56,7 +61,7 @@ Member Function Description Set the physics layers this area is in. -Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask`. +Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask`. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. @@ -118,7 +123,7 @@ Return the direction used for one-way collision detection. - void **set_one_way_collision_max_depth** **(** :ref:`float` depth **)** -Set how far a body can go through this one, when it allows one-way collisions (see :ref:`set_one_way_collision_detection`). +Set how far a body can go through this one, when it allows one-way collisions (see :ref:`set_one_way_collision_detection`). .. _class_PhysicsBody2D_get_one_way_collision_max_depth: diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index 5574c0c72..433cac4e2 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -5,8 +5,13 @@ PhysicsDirectBodyState **Inherits:** :ref:`Object` +**Inherited By:** :ref:`PhysicsDirectBodyStateSW` + **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_physicsdirectbodystatesw.rst b/classes/class_physicsdirectbodystatesw.rst index 6ef1439d8..2cbdfe162 100644 --- a/classes/class_physicsdirectbodystatesw.rst +++ b/classes/class_physicsdirectbodystatesw.rst @@ -3,9 +3,12 @@ PhysicsDirectBodyStateSW ======================== -**Inherits:** :ref:`PhysicsDirectBodyState` +**Inherits:** :ref:`PhysicsDirectBodyState` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 346519433..fa8456fb2 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -7,6 +7,9 @@ PhysicsDirectSpaceState **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 0ccae1146..dd5085413 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -5,8 +5,13 @@ PhysicsServer **Inherits:** :ref:`Object` +**Inherited By:** :ref:`PhysicsServerSW` + **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_physicsserversw.rst b/classes/class_physicsserversw.rst index 672dc1549..0d62c6ecd 100644 --- a/classes/class_physicsserversw.rst +++ b/classes/class_physicsserversw.rst @@ -3,9 +3,12 @@ PhysicsServerSW =============== -**Inherits:** :ref:`PhysicsServer` +**Inherits:** :ref:`PhysicsServer` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 2261a5fa3..b224a4aaf 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -3,10 +3,13 @@ PhysicsShapeQueryParameters =========================== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index 85152e1c1..a36351f2e 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -3,10 +3,13 @@ PhysicsShapeQueryResult ======================= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Result of a shape query in Physics2DServer. Member Functions diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 174003f4a..946c17b34 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -3,10 +3,13 @@ PinJoint ======== -**Inherits:** :ref:`Joint` +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index 79d8fbc53..c8809fea7 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -3,10 +3,13 @@ PinJoint2D ========== -**Inherits:** :ref:`Joint2D` +**Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Pin Joint for 2D Shapes. Member Functions diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 5c843afa5..36b5ac554 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -5,6 +5,9 @@ Plane **Category:** Built-In Types +Brief Description +----------------- + Plane in hessian form. Member Functions diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 3ff32e1ca..fcd44ce3c 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -3,10 +3,13 @@ PlaneShape ========== -**Inherits:** :ref:`Shape` +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 34b506dad..d53c51deb 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -3,10 +3,13 @@ Polygon2D ========= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 65a4122be..70f3c8279 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -3,10 +3,13 @@ PolygonPathFinder ================= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_popup.rst b/classes/class_popup.rst index b2cd2c47d..d1f23ca7f 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -3,10 +3,15 @@ Popup ===== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`PopupPanel`, :ref:`PopupDialog`, :ref:`PopupMenu`, :ref:`WindowDialog` **Category:** Core +Brief Description +----------------- + Base container control for popups and dialogs. Member Functions diff --git a/classes/class_popupdialog.rst b/classes/class_popupdialog.rst index 36205b004..c8895b13f 100644 --- a/classes/class_popupdialog.rst +++ b/classes/class_popupdialog.rst @@ -3,9 +3,12 @@ PopupDialog =========== -**Inherits:** :ref:`Popup` +**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Base class for Popup Dialogs. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index f24cfcc3d..94364ac50 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -3,10 +3,13 @@ PopupMenu ========= -**Inherits:** :ref:`Popup` +**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + PopupMenu displays a list of options. Member Functions diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 4a679d0ff..6d1b16316 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -3,9 +3,12 @@ PopupPanel ========== -**Inherits:** :ref:`Popup` +**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Base class for Popup Panels diff --git a/classes/class_portal.rst b/classes/class_portal.rst index 30165e186..5c698770e 100644 --- a/classes/class_portal.rst +++ b/classes/class_portal.rst @@ -3,10 +3,13 @@ Portal ====== -**Inherits:** :ref:`VisualInstance` +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Portals provide virtual openings to rooms. Member Functions @@ -70,25 +73,25 @@ Return wether the portal is active. When disabled it causes the parent :ref:`Roo - void **set_disable_distance** **(** :ref:`float` distance **)** -Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see :ref:`set_disabled_color`). +Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see :ref:`set_disabled_color`). .. _class_Portal_get_disable_distance: - :ref:`float` **get_disable_distance** **(** **)** const -Return the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see :ref:`set_disabled_color`). +Return the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see :ref:`set_disabled_color`). .. _class_Portal_set_disabled_color: - void **set_disabled_color** **(** :ref:`Color` color **)** -When the portal goes beyond the disable distance (see :ref:`set_disable_distance`), it becomes opaque and displayed with color "color". +When the portal goes beyond the disable distance (see :ref:`set_disable_distance`), it becomes opaque and displayed with color "color". .. _class_Portal_get_disabled_color: - :ref:`Color` **get_disabled_color** **(** **)** const -Return the color for when the portal goes beyond the disable distance (see :ref:`set_disable_distance`) and becomes disabled. +Return the color for when the portal goes beyond the disable distance (see :ref:`set_disable_distance`) and becomes disabled. .. _class_Portal_set_connect_range: diff --git a/classes/class_position2d.rst b/classes/class_position2d.rst index ca0a4011b..ba39d723c 100644 --- a/classes/class_position2d.rst +++ b/classes/class_position2d.rst @@ -3,10 +3,13 @@ Position2D ========== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Generic 2D Position hint for editing. Description diff --git a/classes/class_position3d.rst b/classes/class_position3d.rst index 6851b05ae..efb630439 100644 --- a/classes/class_position3d.rst +++ b/classes/class_position3d.rst @@ -3,10 +3,13 @@ Position3D ========== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Generic 3D Position hint for editing Description diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index aa369a228..a49c739b6 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -3,10 +3,13 @@ ProgressBar =========== -**Inherits:** :ref:`Range` +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + General purpose progress bar. Member Functions diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 95553a36d..4b8d3f007 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -3,10 +3,13 @@ ProximityGroup ============== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + General purpose proximity-detection node. Member Functions diff --git a/classes/class_quad.rst b/classes/class_quad.rst index fb3ef2a92..00b994b18 100644 --- a/classes/class_quad.rst +++ b/classes/class_quad.rst @@ -3,10 +3,13 @@ Quad ==== -**Inherits:** :ref:`GeometryInstance` +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 2d8a0f4cd..3794f1320 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -5,6 +5,9 @@ Quat **Category:** Built-In Types +Brief Description +----------------- + Quaternion. Member Functions diff --git a/classes/class_range.rst b/classes/class_range.rst index 11bdcb8df..ce3c101a7 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -3,10 +3,15 @@ Range ===== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`SpinBox`, :ref:`ScrollBar`, :ref:`ProgressBar`, :ref:`TextureProgress`, :ref:`Slider` **Category:** Core +Brief Description +----------------- + Abstract base class for range-based controls. Member Functions diff --git a/classes/class_rawarray.rst b/classes/class_rawarray.rst index 4744e7968..5002aacfe 100644 --- a/classes/class_rawarray.rst +++ b/classes/class_rawarray.rst @@ -5,6 +5,9 @@ RawArray **Category:** Built-In Types +Brief Description +----------------- + Raw byte array. Member Functions diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 2a56c76d0..ff7e0fcb0 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -3,10 +3,13 @@ RayCast ======= -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index e751964a1..37035d1b4 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -3,10 +3,13 @@ RayCast2D ========= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions @@ -79,7 +82,7 @@ Return whether the closest object the ray is pointing to is colliding with the v - :ref:`Object` **get_collider** **(** **)** const -Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. +Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. .. _class_RayCast2D_get_collider_shape: diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index fc27cc2cb..c0bdd6f11 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -3,10 +3,13 @@ RayShape ======== -**Inherits:** :ref:`Shape` +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 37a4a93c7..25f28fdf4 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -3,10 +3,13 @@ RayShape2D ========== -**Inherits:** :ref:`Shape2D` +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Ray 2D shape resource for physics. Member Functions diff --git a/classes/class_realarray.rst b/classes/class_realarray.rst index afd3a9d73..1680f06e7 100644 --- a/classes/class_realarray.rst +++ b/classes/class_realarray.rst @@ -5,6 +5,9 @@ RealArray **Category:** Built-In Types +Brief Description +----------------- + Real Array . Member Functions diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index ff9214c8d..7943423da 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -5,6 +5,9 @@ Rect2 **Category:** Built-In Types +Brief Description +----------------- + 2D Axis-aligned bounding box. Member Functions diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index e10e1f786..0d267a305 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -3,10 +3,13 @@ RectangleShape2D ================ -**Inherits:** :ref:`Shape2D` +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Rectangle Shape for 2D Physics. Member Functions diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 6ebf6eb81..c306010fa 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -5,8 +5,13 @@ Reference **Inherits:** :ref:`Object` +**Inherited By:** :ref:`RegEx`, :ref:`SurfaceTool`, :ref:`EditorScenePostImport`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`MeshDataTool`, :ref:`GDFunctionState`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`Marshalls`, :ref:`WeakRef`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`Resource`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`ResourceImportMetadata`, :ref:`PhysicsShapeQueryParameters` + **Category:** Core +Brief Description +----------------- + Base class for anything that keeps a reference count. Member Functions diff --git a/classes/class_referenceframe.rst b/classes/class_referenceframe.rst index bfa48403f..b41e061be 100644 --- a/classes/class_referenceframe.rst +++ b/classes/class_referenceframe.rst @@ -3,10 +3,13 @@ ReferenceFrame ============== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Reference frame for GUI. Description diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 2e8e4881c..12ca3c605 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -3,10 +3,13 @@ RegEx ===== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Simple regular expression matcher. Member Functions @@ -80,13 +83,13 @@ Compiles and assign the regular expression pattern to use. The limit on the numb - :ref:`int` **find** **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const -This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see :ref:`get_capture`) for further retrieval. +This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see :ref:`get_capture`) for further retrieval. .. _class_RegEx_clear: - void **clear** **(** **)** -This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object, and forgets all captures made by the last :ref:`find`. +This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object, and forgets all captures made by the last :ref:`find`. .. _class_RegEx_is_valid: diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 8f1faf846..893414f34 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -3,10 +3,13 @@ RemoteTransform2D ================= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_rendertargettexture.rst b/classes/class_rendertargettexture.rst index 5bd795129..6a7321688 100644 --- a/classes/class_rendertargettexture.rst +++ b/classes/class_rendertargettexture.rst @@ -3,9 +3,12 @@ RenderTargetTexture =================== -**Inherits:** :ref:`Texture` +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 8bcf65019..3a66851f0 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -3,10 +3,15 @@ Resource ======== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`EventStream`, :ref:`CubeMap`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`BakedLight`, :ref:`ColorRamp`, :ref:`StyleBox`, :ref:`Environment`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Script`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`TileSet`, :ref:`BitMap`, :ref:`Animation`, :ref:`Sample`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`World`, :ref:`SampleLibrary`, :ref:`World2D`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`MultiMesh`, :ref:`CanvasItemMaterial`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core +Brief Description +----------------- + Base class for all resources. Member Functions diff --git a/classes/class_resourceimportmetadata.rst b/classes/class_resourceimportmetadata.rst index fca2fb0e7..5f827b955 100644 --- a/classes/class_resourceimportmetadata.rst +++ b/classes/class_resourceimportmetadata.rst @@ -3,10 +3,13 @@ ResourceImportMetadata ====================== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index ee4693165..279d30271 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -3,10 +3,13 @@ ResourceInteractiveLoader ========================= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Interactive Resource Loader. Member Functions @@ -42,7 +45,7 @@ Return the loaded resource (only if loaded). Otherwise, returns null. - :ref:`int` **poll** **(** **)** -Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. +Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. .. _class_ResourceInteractiveLoader_wait: @@ -52,12 +55,12 @@ Poll the load. If OK is returned, this means poll will have to be called again. - :ref:`int` **get_stage** **(** **)** const -Return the load stage. The total amount of stages can be queried with :ref:`get_stage_count` +Return the load stage. The total amount of stages can be queried with :ref:`get_stage_count` .. _class_ResourceInteractiveLoader_get_stage_count: - :ref:`int` **get_stage_count** **(** **)** const -Return the total amount of stages (calls to :ref:`poll` ) needed to completely load this resource. +Return the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 5cd267f58..155ccec02 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -7,6 +7,9 @@ ResourceLoader **Category:** Core +Brief Description +----------------- + Resource Loader. Member Functions diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 5ff304600..ce2dd8eb8 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -3,10 +3,13 @@ ResourcePreloader ================= -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Resource Preloader Node. Member Functions diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 3ed8e9e7d..f7f3bb622 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -7,6 +7,9 @@ ResourceSaver **Category:** Core +Brief Description +----------------- + Resource Saving Interface. Member Functions diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 1838bf5ae..95184298f 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -3,10 +3,13 @@ RichTextLabel ============= -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Label that displays rich text. Member Functions diff --git a/classes/class_rid.rst b/classes/class_rid.rst index ced0f431e..61142eb72 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -5,6 +5,9 @@ RID **Category:** Built-In Types +Brief Description +----------------- + Member Functions diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 602c5bdc8..bc55c1da0 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -3,10 +3,13 @@ RigidBody ========= -**Inherits:** :ref:`PhysicsBody` +**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index ebe318ea2..e91fc71f9 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -3,10 +3,13 @@ RigidBody2D =========== -**Inherits:** :ref:`PhysicsBody2D` +**Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Rigid body 2D node. Member Functions @@ -139,7 +142,7 @@ Set the body mode, from the MODE\_\* enum. This allows to change to a static bod - :ref:`int` **get_mode** **(** **)** const -Return the current body mode, see :ref:`set_mode`. +Return the current body mode, see :ref:`set_mode`. .. _class_RigidBody2D_set_mass: @@ -229,25 +232,25 @@ Return the angular damp for this body. - void **set_linear_velocity** **(** :ref:`Vector2` linear_velocity **)** -Set the body linear velocity. Can be used sporadically, but** DONT SET THIS IN EVERY FRAME **, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. +Set the body linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. .. _class_RigidBody2D_get_linear_velocity: - :ref:`Vector2` **get_linear_velocity** **(** **)** const -Return the body linear velocity. This changes by physics granularity. See :ref:`set_linear_velocity`. +Return the body linear velocity. This changes by physics granularity. See :ref:`set_linear_velocity`. .. _class_RigidBody2D_set_angular_velocity: - void **set_angular_velocity** **(** :ref:`float` angular_velocity **)** -Set the body angular velocity. Can be used sporadically, but** DONT SET THIS IN EVERY FRAME **, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. +Set the body angular velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. .. _class_RigidBody2D_get_angular_velocity: - :ref:`float` **get_angular_velocity** **(** **)** const -Return the body angular velocity. This changes by physics granularity. See :ref:`set_angular_velocity`. +Return the body angular velocity. This changes by physics granularity. See :ref:`set_angular_velocity`. .. _class_RigidBody2D_set_max_contacts_reported: @@ -259,13 +262,13 @@ Set the maximum contacts to report. Bodies can keep a log of the contacts with o - :ref:`int` **get_max_contacts_reported** **(** **)** const -Return the maximum contacts that can be reported. See :ref:`set_max_contacts_reported`. +Return the maximum contacts that can be reported. See :ref:`set_max_contacts_reported`. .. _class_RigidBody2D_set_use_custom_integrator: - void **set_use_custom_integrator** **(** :ref:`bool` enable **)** -Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the :ref:`_integrate_forces` will be able to integrate them if overrided. +Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the :ref:`_integrate_forces` will be able to integrate them if overrided. .. _class_RigidBody2D_is_using_custom_integrator: @@ -327,7 +330,7 @@ Return the applied force vector. - void **set_sleeping** **(** :ref:`bool` sleeping **)** -Set whether a body is isleeping or not. Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse`/:ref:`set_applied_force` wakes them up. Until then, they behave like a static body. +Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse` / :ref:`set_applied_force` wakes them up. Until then, they behave like a static body. .. _class_RigidBody2D_is_sleeping: @@ -341,13 +344,13 @@ Return whether the body is sleeping. Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. -Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse`/:ref:`set_applied_force` wakes them up. Until then, they behave like a static body. +Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse` / :ref:`set_applied_force` wakes them up. Until then, they behave like a static body. .. _class_RigidBody2D_is_able_to_sleep: - :ref:`bool` **is_able_to_sleep** **(** **)** const -Return true if the body has the ability to fall asleep when not moving. See :ref:`set_can_sleep`. +Return true if the body has the ability to fall asleep when not moving. See :ref:`set_can_sleep`. .. _class_RigidBody2D_test_motion: diff --git a/classes/class_room.rst b/classes/class_room.rst index f87edfa4f..77fdd4370 100644 --- a/classes/class_room.rst +++ b/classes/class_room.rst @@ -3,10 +3,13 @@ Room ==== -**Inherits:** :ref:`VisualInstance` +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Room data resource. Member Functions diff --git a/classes/class_roombounds.rst b/classes/class_roombounds.rst index f589698fb..d1e55c2c9 100644 --- a/classes/class_roombounds.rst +++ b/classes/class_roombounds.rst @@ -3,10 +3,13 @@ RoomBounds ========== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_sample.rst b/classes/class_sample.rst index 60f3645ad..648350f63 100644 --- a/classes/class_sample.rst +++ b/classes/class_sample.rst @@ -3,10 +3,13 @@ Sample ====== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Audio sample (sound) class. Member Functions @@ -92,13 +95,13 @@ Return the sample length in samples. Stereo samples count as one, even if they a Set sample data. Data must be little endian, no matter the host platform, and exactly as long as to fit all samples. The length of this array can be calculated as follows: -Get the sample length (:ref:`get_length`). +Get the sample length (:ref:`get_length`). If the sample format is FORMAT_PCM16, multiply it by 2. If the sample format is FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. -If the sample is stereo (:ref:`is_stereo`), multiply it by 2. +If the sample is stereo (:ref:`is_stereo`), multiply it by 2. .. _class_Sample_get_data: diff --git a/classes/class_samplelibrary.rst b/classes/class_samplelibrary.rst index ea8c11d47..0f1504af8 100644 --- a/classes/class_samplelibrary.rst +++ b/classes/class_samplelibrary.rst @@ -3,10 +3,13 @@ SampleLibrary ============= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Library that contains a collection of samples. Member Functions @@ -33,7 +36,7 @@ Member Functions Description ----------- -Library that contains a collection of :ref:`Sample`s, each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives. +Library that contains a collection of :ref:`Sample`, each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives. Member Function Description --------------------------- diff --git a/classes/class_sampleplayer.rst b/classes/class_sampleplayer.rst index ddb48cac2..a55aa1f4b 100644 --- a/classes/class_sampleplayer.rst +++ b/classes/class_sampleplayer.rst @@ -3,10 +3,13 @@ SamplePlayer ============ -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Sample Player node. Member Functions diff --git a/classes/class_sampleplayer2d.rst b/classes/class_sampleplayer2d.rst index 5c286e280..2a2368f2c 100644 --- a/classes/class_sampleplayer2d.rst +++ b/classes/class_sampleplayer2d.rst @@ -3,10 +3,13 @@ SamplePlayer2D ============== -**Inherits:** :ref:`SoundPlayer2D` +**Inherits:** :ref:`SoundPlayer2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Sample player for positional 2D Sound. Member Functions diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index bbc6c1765..5c9e8685a 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -3,10 +3,13 @@ SceneState ========== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 2f0e991e9..3f23f2628 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -3,10 +3,13 @@ SceneTree ========= -**Inherits:** :ref:`MainLoop` +**Inherits:** :ref:`MainLoop` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_script.rst b/classes/class_script.rst index fb8261ec9..5d77616e6 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -3,10 +3,15 @@ Script ====== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`GDScript` **Category:** Core +Brief Description +----------------- + Base class for scripts. Member Functions diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 4d69845ea..2fdbf83e7 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -3,10 +3,15 @@ ScrollBar ========= -**Inherits:** :ref:`Range` +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`HScrollBar`, :ref:`VScrollBar` **Category:** Core +Brief Description +----------------- + Base class for scroll bars. Member Functions diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index e62cfae76..fa5709962 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -3,10 +3,13 @@ ScrollContainer =============== -**Inherits:** :ref:`Container` +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + A helper node for displaying scollable elements (e.g. lists). Member Functions diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index de2e12518..07132c872 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -3,10 +3,13 @@ SegmentShape2D ============== -**Inherits:** :ref:`Shape2D` +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Segment Shape for 2D Collision Detection. Member Functions diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 1fbd9b7e1..38a40ad5a 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -3,10 +3,13 @@ Semaphore ========= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_separator.rst b/classes/class_separator.rst index c450b64c6..a13a3212d 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -3,10 +3,15 @@ Separator ========= -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`VSeparator`, :ref:`HSeparator` **Category:** Core +Brief Description +----------------- + Base class for separators. Description diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 645e5ec39..618d59f0c 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -3,10 +3,15 @@ Shader ====== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`MaterialShader`, :ref:`CanvasItemShader`, :ref:`ShaderGraph` **Category:** Core +Brief Description +----------------- + To be changed, ignore. Member Functions diff --git a/classes/class_shadergraph.rst b/classes/class_shadergraph.rst index 25bde308f..abceba8cb 100644 --- a/classes/class_shadergraph.rst +++ b/classes/class_shadergraph.rst @@ -3,10 +3,15 @@ ShaderGraph =========== -**Inherits:** :ref:`Shader` +**Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`MaterialShaderGraph`, :ref:`CanvasItemShaderGraph` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index e525df788..c62e7b91e 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -3,10 +3,13 @@ ShaderMaterial ============== -**Inherits:** :ref:`Material` +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 4a2de711a..1859eadf4 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -3,9 +3,14 @@ Shape ===== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`SphereShape`, :ref:`PlaneShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`RayShape`, :ref:`ConcavePolygonShape` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 087dc2f54..307a72d2e 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -3,10 +3,15 @@ Shape2D ======= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`RayShape2D`, :ref:`CapsuleShape2D`, :ref:`LineShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` **Category:** Core +Brief Description +----------------- + Base class for all 2D Shapes. Member Functions diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index 7e863d991..4ee0f898b 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -3,10 +3,13 @@ Skeleton ======== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Skeleton for characters and animated objects. Member Functions @@ -75,7 +78,7 @@ Member Function Description - void **add_bone** **(** :ref:`String` name **)** -Add a bone, with name "name". :ref:`get_bone_count` will become the bone index. +Add a bone, with name "name". :ref:`get_bone_count` will become the bone index. .. _class_Skeleton_find_bone: diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 19362e41d..2f52bf9ba 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -3,10 +3,15 @@ Slider ====== -**Inherits:** :ref:`Range` +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`HSlider`, :ref:`VSlider` **Category:** Core +Brief Description +----------------- + Base class for GUI Sliders. Member Functions diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 7f7786429..f4c11be6d 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -3,10 +3,13 @@ SliderJoint =========== -**Inherits:** :ref:`Joint` +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_soundplayer2d.rst b/classes/class_soundplayer2d.rst index e8ba70cc6..22dd88fe9 100644 --- a/classes/class_soundplayer2d.rst +++ b/classes/class_soundplayer2d.rst @@ -3,10 +3,15 @@ SoundPlayer2D ============= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`SamplePlayer2D` **Category:** Core +Brief Description +----------------- + Base class for playing spatial 2D sound. Member Functions diff --git a/classes/class_soundroomparams.rst b/classes/class_soundroomparams.rst index fbf421924..ee8fcade9 100644 --- a/classes/class_soundroomparams.rst +++ b/classes/class_soundroomparams.rst @@ -3,10 +3,13 @@ SoundRoomParams =============== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 596de0a89..462f0aee1 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -3,10 +3,15 @@ Spatial ======= -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`Path`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`SpatialPlayer`, :ref:`WorldEnvironment`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`CollisionObject` **Category:** Core +Brief Description +----------------- + Base class for all 3D nodes. Member Functions diff --git a/classes/class_spatialplayer.rst b/classes/class_spatialplayer.rst index d0ef977b5..63bdd1052 100644 --- a/classes/class_spatialplayer.rst +++ b/classes/class_spatialplayer.rst @@ -3,10 +3,15 @@ SpatialPlayer ============= -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`SpatialStreamPlayer`, :ref:`SpatialSamplePlayer` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_spatialsampleplayer.rst b/classes/class_spatialsampleplayer.rst index 3396e8b2b..30d7ef2e3 100644 --- a/classes/class_spatialsampleplayer.rst +++ b/classes/class_spatialsampleplayer.rst @@ -3,10 +3,13 @@ SpatialSamplePlayer =================== -**Inherits:** :ref:`SpatialPlayer` +**Inherits:** :ref:`SpatialPlayer` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_spatialsound2dserver.rst b/classes/class_spatialsound2dserver.rst index 9a68f606f..4d402a383 100644 --- a/classes/class_spatialsound2dserver.rst +++ b/classes/class_spatialsound2dserver.rst @@ -5,8 +5,13 @@ SpatialSound2DServer **Inherits:** :ref:`Object` +**Inherited By:** :ref:`SpatialSound2DServerSW` + **Category:** Core +Brief Description +----------------- + Server for Spatial 2D Sound. Description diff --git a/classes/class_spatialsound2dserversw.rst b/classes/class_spatialsound2dserversw.rst index ba8a5d327..42c299b10 100644 --- a/classes/class_spatialsound2dserversw.rst +++ b/classes/class_spatialsound2dserversw.rst @@ -3,9 +3,12 @@ SpatialSound2DServerSW ====================== -**Inherits:** :ref:`SpatialSound2DServer` +**Inherits:** :ref:`SpatialSound2DServer` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_spatialsoundserver.rst b/classes/class_spatialsoundserver.rst index 039251bdd..bacbb5614 100644 --- a/classes/class_spatialsoundserver.rst +++ b/classes/class_spatialsoundserver.rst @@ -5,7 +5,12 @@ SpatialSoundServer **Inherits:** :ref:`Object` +**Inherited By:** :ref:`SpatialSoundServerSW` + **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_spatialsoundserversw.rst b/classes/class_spatialsoundserversw.rst index a0e05a435..3144403e6 100644 --- a/classes/class_spatialsoundserversw.rst +++ b/classes/class_spatialsoundserversw.rst @@ -3,9 +3,12 @@ SpatialSoundServerSW ==================== -**Inherits:** :ref:`SpatialSoundServer` +**Inherits:** :ref:`SpatialSoundServer` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_spatialstreamplayer.rst b/classes/class_spatialstreamplayer.rst index b5879e0c7..3d1e60013 100644 --- a/classes/class_spatialstreamplayer.rst +++ b/classes/class_spatialstreamplayer.rst @@ -3,10 +3,13 @@ SpatialStreamPlayer =================== -**Inherits:** :ref:`SpatialPlayer` +**Inherits:** :ref:`SpatialPlayer` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 290a71217..bb4c87ae5 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -3,10 +3,13 @@ SphereShape =========== -**Inherits:** :ref:`Shape` +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index b58e7ed46..6bbab346d 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -3,10 +3,13 @@ SpinBox ======= -**Inherits:** :ref:`Range` +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Numerical input text field. Member Functions diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 133b180f0..8518f7154 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -3,10 +3,15 @@ SplitContainer ============== -**Inherits:** :ref:`Container` +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`HSplitContainer`, :ref:`VSplitContainer` **Category:** Core +Brief Description +----------------- + Container for splitting and adjusting. Member Functions diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index 2e639530a..cf18e2459 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -3,10 +3,13 @@ SpotLight ========= -**Inherits:** :ref:`Light` +**Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Spotlight :ref:`Light`, such as a reflector spotlight or a latern. Description diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 94f889e80..aff51fc48 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -3,10 +3,13 @@ Sprite ====== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + General purpose Sprite node. Member Functions @@ -177,7 +180,7 @@ Set the amount of vertical frames and converts the sprite into a sprite-sheet. T - :ref:`int` **get_vframes** **(** **)** const -Return the amount of vertical frames. See :ref:`set_vframes`. +Return the amount of vertical frames. See :ref:`set_vframes`. .. _class_Sprite_set_hframes: @@ -189,7 +192,7 @@ Set the amount of horizontal frames and converts the sprite into a sprite-sheet. - :ref:`int` **get_hframes** **(** **)** const -Return the amount of horizontal frames. See :ref:`set_hframes`. +Return the amount of horizontal frames. See :ref:`set_hframes`. .. _class_Sprite_set_modulate: diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index fb5cab9ba..69cd3f91d 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -3,10 +3,13 @@ Sprite3D ======== -**Inherits:** :ref:`SpriteBase3D` +**Inherits:** :ref:`SpriteBase3D` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 6362d37b5..1b18db19e 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -3,10 +3,15 @@ SpriteBase3D ============ -**Inherits:** :ref:`GeometryInstance` +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`AnimatedSprite3D`, :ref:`Sprite3D` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 19853d597..cb135a0ac 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -3,10 +3,13 @@ SpriteFrames ============ -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Sprite frame library for AnimatedSprite. Member Functions diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 16628d0ad..c6dd624a6 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -3,10 +3,13 @@ StaticBody ========== -**Inherits:** :ref:`PhysicsBody` +**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + PhysicsBody for static collision objects. Member Functions diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index dd703a4d3..838f10982 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -3,10 +3,13 @@ StaticBody2D ============ -**Inherits:** :ref:`PhysicsBody2D` +**Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Static body for 2D Physics. Member Functions diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 079a2e7f4..f79cccbee 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -3,10 +3,15 @@ StreamPeer ========== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP` **Category:** Core +Brief Description +----------------- + Abstraction and base class for stream-based protocols. Member Functions @@ -90,25 +95,25 @@ Member Function Description - :ref:`int` **put_data** **(** :ref:`RawArray` data **)** -Send a chunk of data through the connection, blocking if necesary until the data is done sending. This function returns an :ref:`Error` code. +Send a chunk of data through the connection, blocking if necesary until the data is done sending. This function returns an Error code. .. _class_StreamPeer_put_partial_data: - :ref:`Array` **put_partial_data** **(** :ref:`RawArray` data **)** -Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an :ref:`Error` code and an integer, describing how much data was actually sent. +Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. .. _class_StreamPeer_get_data: - :ref:`Array` **get_data** **(** :ref:`int` bytes **)** -Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an :ref:`Error` code and a data array. +Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. .. _class_StreamPeer_get_partial_data: - :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** -Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an :ref:`Error` code, and a data array. +Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. .. _class_StreamPeer_get_available_bytes: diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 0314f1ec3..345fb6c65 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -3,10 +3,13 @@ StreamPeerSSL ============= -**Inherits:** :ref:`StreamPeer` +**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 66831c876..019f89162 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -3,10 +3,13 @@ StreamPeerTCP ============= -**Inherits:** :ref:`StreamPeer` +**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + TCP Stream peer. Member Functions diff --git a/classes/class_streamplayer.rst b/classes/class_streamplayer.rst index ee87a7458..681043fbc 100644 --- a/classes/class_streamplayer.rst +++ b/classes/class_streamplayer.rst @@ -3,10 +3,13 @@ StreamPlayer ============ -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Base class for audio stream playback. Member Functions @@ -145,7 +148,7 @@ Return the playback volume for this player. - void **set_volume_db** **(** :ref:`float` db **)** -Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see :ref:`set_volume`) still apply. +Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see :ref:`set_volume`) still apply. .. _class_StreamPlayer_get_volume_db: diff --git a/classes/class_string.rst b/classes/class_string.rst index c243bfc65..8d5789ffe 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -5,6 +5,9 @@ String **Category:** Built-In Types +Brief Description +----------------- + Built-in string class. Member Functions @@ -362,13 +365,13 @@ Return the right side of the string from a given position. - :ref:`StringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** -Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return :ref:`"One","Two","Three"` if split by ",". +Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return \:ref:`"One","Two","Three"\` if split by ",". .. _class_String_split_floats: - :ref:`RealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** -Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return :ref:`1,2.5,3` if split by ",". +Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return \:ref:`1,2.5,3\` if split by ",". .. _class_String_strip_edges: diff --git a/classes/class_stringarray.rst b/classes/class_stringarray.rst index fe8023663..b70dab60c 100644 --- a/classes/class_stringarray.rst +++ b/classes/class_stringarray.rst @@ -5,6 +5,9 @@ StringArray **Category:** Built-In Types +Brief Description +----------------- + String Array. Member Functions diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 59da312c7..fb22b165e 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -3,10 +3,15 @@ StyleBox ======== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`StyleBoxImageMask`, :ref:`StyleBoxFlat`, :ref:`StyleBoxTexture`, :ref:`StyleBoxEmpty` **Category:** Core +Brief Description +----------------- + Base class for drawing stylized boxes for the UI. Member Functions diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index 62d00cd36..d4c9b03a2 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -3,10 +3,13 @@ StyleBoxEmpty ============= -**Inherits:** :ref:`StyleBox` +**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Empty stylebox (does not display anything). Description diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 9b532df7e..53669e228 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -3,10 +3,13 @@ StyleBoxFlat ============ -**Inherits:** :ref:`StyleBox` +**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Stylebox of a single color. Member Functions diff --git a/classes/class_styleboximagemask.rst b/classes/class_styleboximagemask.rst index 969786d1f..28500e6b4 100644 --- a/classes/class_styleboximagemask.rst +++ b/classes/class_styleboximagemask.rst @@ -3,10 +3,13 @@ StyleBoxImageMask ================= -**Inherits:** :ref:`StyleBox` +**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Image mask based StyleBox, for mask test. Member Functions @@ -44,7 +47,7 @@ Set the image used for mask testing. Pixels (converted to grey) that have a valu - :ref:`Image` **get_image** **(** **)** const -Return the image used for mask testing. (see :ref:`set_imag`). +Return the image used for mask testing. (see :ref:`set_image`). .. _class_StyleBoxImageMask_set_expand: diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 3e5d6e59f..28d47fb43 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -3,10 +3,13 @@ StyleBoxTexture =============== -**Inherits:** :ref:`StyleBox` +**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Texture Based 3x3 scale style. Member Functions diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 7a3636a11..3f98c4116 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -3,10 +3,13 @@ SurfaceTool =========== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Helper tool to create geometry. Member Functions diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 8196b0be8..7d242d85c 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -3,10 +3,13 @@ TabContainer ============ -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Tabbed Container. Member Functions diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 5bf85994e..74d01539e 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -3,10 +3,13 @@ Tabs ==== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Tabs Control. Member Functions diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 6483e87fa..9314a9a9a 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -3,10 +3,13 @@ TCP_Server ========== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + TCP Server. Member Functions diff --git a/classes/class_testcube.rst b/classes/class_testcube.rst index 7eec1b41e..ef994b131 100644 --- a/classes/class_testcube.rst +++ b/classes/class_testcube.rst @@ -3,9 +3,12 @@ TestCube ======== -**Inherits:** :ref:`GeometryInstance` +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index b529f050c..8f394e03e 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -3,10 +3,13 @@ TextEdit ======== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Multiline text editing control. Member Functions diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 227b743dd..0cf82e1f7 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -3,10 +3,15 @@ Texture ======= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`RenderTargetTexture`, :ref:`AtlasTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` **Category:** Core +Brief Description +----------------- + Texture for 2D and 3D. Member Functions @@ -49,7 +54,7 @@ Numeric Constants Description ----------- -A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D :ref:`Sprite` or GUI :ref:`Control`s. +A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D :ref:`Sprite` or GUI :ref:`Control`. Member Function Description --------------------------- diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index e6db65ee3..2bb97d087 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -3,10 +3,13 @@ TextureButton ============= -**Inherits:** :ref:`BaseButton` +**Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Button that can be themed with textures. Member Functions diff --git a/classes/class_textureframe.rst b/classes/class_textureframe.rst index e31ad72cc..b0289493c 100644 --- a/classes/class_textureframe.rst +++ b/classes/class_textureframe.rst @@ -3,10 +3,13 @@ TextureFrame ============ -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Control Frame that draws a texture. Member Functions diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 69f764a2f..4d2aa3e5f 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -3,10 +3,13 @@ TextureProgress =============== -**Inherits:** :ref:`Range` +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Textured progress bar implementation. Member Functions diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 15a337da6..0529d9daf 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -3,10 +3,13 @@ Theme ===== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Theme for controls. Member Functions diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 43319436f..57eb9384a 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -3,10 +3,13 @@ Thread ====== -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index fcd591b82..870c12e46 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -3,10 +3,13 @@ TileMap ======= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Node for 2D tile-based games. Member Functions diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index ffb862383..33585d6b6 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -3,10 +3,13 @@ TileSet ======= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Tile library for tilemaps. Member Functions diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 8a92133ad..a1b3200f8 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -3,10 +3,13 @@ Timer ===== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index 88878b090..c4e7e1540 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -3,9 +3,12 @@ ToolButton ========== -**Inherits:** :ref:`Button` +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index f99dfe2f6..679fc6f36 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -3,10 +3,13 @@ TouchScreenButton ================= -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 904aedf5a..fd67dc1cc 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -5,6 +5,9 @@ Transform **Category:** Built-In Types +Brief Description +----------------- + 3D Transformation. Member Functions diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 30bd413f5..51de8eddb 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -3,10 +3,15 @@ Translation =========== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`PHashTranslation` **Category:** Core +Brief Description +----------------- + Language Translation. Member Functions diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index 4ca3631e6..692137b5c 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -7,6 +7,9 @@ TranslationServer **Category:** Core +Brief Description +----------------- + Server that manages all translations. Translations can be set to it and removed from it. Member Functions diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 555267f01..74823bf6c 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -3,10 +3,13 @@ Tree ==== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index de3f11692..146b92aaa 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -7,6 +7,9 @@ TreeItem **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_tween.rst b/classes/class_tween.rst index a3aebd36b..044330096 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -3,10 +3,13 @@ Tween ===== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 366faebcf..587fd7fec 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -7,6 +7,9 @@ UndoRedo **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index 24955eeef..9052d6176 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -3,10 +3,13 @@ VBoxContainer ============= -**Inherits:** :ref:`BoxContainer` +**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Vertical box container. Description diff --git a/classes/class_vbuttonarray.rst b/classes/class_vbuttonarray.rst index 63a295094..e8afb302d 100644 --- a/classes/class_vbuttonarray.rst +++ b/classes/class_vbuttonarray.rst @@ -3,10 +3,13 @@ VButtonArray ============ -**Inherits:** :ref:`ButtonArray` +**Inherits:** :ref:`ButtonArray` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Vertical button array. Description diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 1d2176c43..5f7d1bd56 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -5,6 +5,9 @@ Vector2 **Category:** Built-In Types +Brief Description +----------------- + Vector used for 2D Math. Member Functions diff --git a/classes/class_vector2array.rst b/classes/class_vector2array.rst index e1019f54c..65f6ef1d8 100644 --- a/classes/class_vector2array.rst +++ b/classes/class_vector2array.rst @@ -5,6 +5,9 @@ Vector2Array **Category:** Built-In Types +Brief Description +----------------- + An Array of Vector2. Member Functions diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 474135f2a..e14f7f093 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -5,6 +5,9 @@ Vector3 **Category:** Built-In Types +Brief Description +----------------- + Vector class, which performs basic 3D vector math operations. Member Functions diff --git a/classes/class_vector3array.rst b/classes/class_vector3array.rst index 12be4b7b5..69a515788 100644 --- a/classes/class_vector3array.rst +++ b/classes/class_vector3array.rst @@ -5,6 +5,9 @@ Vector3Array **Category:** Built-In Types +Brief Description +----------------- + An Array of Vector3. Member Functions diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 24958cb7d..356778573 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -3,10 +3,13 @@ VehicleBody =========== -**Inherits:** :ref:`PhysicsBody` +**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 322dfc312..1d3dd6c7d 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -3,10 +3,13 @@ VehicleWheel ============ -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 8b3cdd507..93f81aa95 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -3,10 +3,13 @@ VideoPlayer =========== -**Inherits:** :ref:`Control` +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index 41417c6dc..00f4a1aaf 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -3,9 +3,14 @@ VideoStream =========== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`VideoStreamTheora` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index dceb1caea..570d31a6b 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -3,9 +3,12 @@ VideoStreamTheora ================= -**Inherits:** :ref:`VideoStream` +**Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 4d5048dfd..38bee2a42 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -3,10 +3,13 @@ Viewport ======== -**Inherits:** :ref:`Node` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Creates a sub-view into the screen. Member Functions diff --git a/classes/class_viewportsprite.rst b/classes/class_viewportsprite.rst index 192bd9c84..d2f4dc319 100644 --- a/classes/class_viewportsprite.rst +++ b/classes/class_viewportsprite.rst @@ -3,10 +3,13 @@ ViewportSprite ============== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index 2342c92b9..fdddc763b 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -3,10 +3,13 @@ VisibilityEnabler ================= -**Inherits:** :ref:`VisibilityNotifier` +**Inherits:** :ref:`VisibilityNotifier` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index bf36950ef..762f8c180 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -3,10 +3,13 @@ VisibilityEnabler2D =================== -**Inherits:** :ref:`VisibilityNotifier2D` +**Inherits:** :ref:`VisibilityNotifier2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 68f13e4fa..db30db907 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -3,10 +3,15 @@ VisibilityNotifier ================== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`VisibilityEnabler` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index ba66ca1c4..e4283d57a 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -3,10 +3,15 @@ VisibilityNotifier2D ==================== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`VisibilityEnabler2D` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 73e83306b..8c0356cf5 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -3,10 +3,15 @@ VisualInstance ============== -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`BakedLightInstance`, :ref:`Light`, :ref:`Room`, :ref:`BakedLightSampler`, :ref:`Portal`, :ref:`GeometryInstance` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 4aa6bf102..4c439e4f2 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -7,6 +7,9 @@ VisualServer **Category:** Core +Brief Description +----------------- + Server for anything visible. Member Functions diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index cbe8a90bd..7c871983f 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -3,9 +3,12 @@ VScrollBar ========== -**Inherits:** :ref:`ScrollBar` +**Inherits:** :ref:`ScrollBar` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Vertical version of :ref:`ScrollBar`, which goes from left (min) to right (max). diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index 9312bceef..abe2f7b93 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -3,10 +3,13 @@ VSeparator ========== -**Inherits:** :ref:`Separator` +**Inherits:** :ref:`Separator` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Vertical version of :ref:`Separator`. Description diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index a4f1f145b..4d86a9f4e 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -3,10 +3,13 @@ VSlider ======= -**Inherits:** :ref:`Slider` +**Inherits:** :ref:`Slider` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Vertical slider. Description diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index a1f5ec4b1..9a2681462 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -3,10 +3,13 @@ VSplitContainer =============== -**Inherits:** :ref:`SplitContainer` +**Inherits:** :ref:`SplitContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Vertical split container. Description diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 8bd04a881..5a630fbf0 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -3,10 +3,13 @@ WeakRef ======= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index 5b7d7897d..277952878 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -3,10 +3,15 @@ WindowDialog ============ -**Inherits:** :ref:`Popup` +**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`AcceptDialog` **Category:** Core +Brief Description +----------------- + Base class for window dialogs. Member Functions diff --git a/classes/class_world.rst b/classes/class_world.rst index 13101c556..51ab3dec1 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -3,10 +3,13 @@ World ===== -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Class that has everything pertaining to a world. Member Functions diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 521b7c367..d66963d37 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -3,10 +3,13 @@ World2D ======= -**Inherits:** :ref:`Resource` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Class that has everything pertaining to a 2D world. Member Functions diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index ca36f8664..228d5cef8 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -3,10 +3,13 @@ WorldEnvironment ================ -**Inherits:** :ref:`Spatial` +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 1ca022152..3886094b5 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -3,10 +3,13 @@ XMLParser ========= -**Inherits:** :ref:`Reference` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index a146790dd..756acd75a 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -3,10 +3,13 @@ YSort ===== -**Inherits:** :ref:`Node2D` +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core +Brief Description +----------------- + Member Functions