From 2f06d055e303dd36e03a5dc12664879d0301c5ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sun, 7 Feb 2016 16:03:42 +0100 Subject: [PATCH] De-headline the Inherits and Category fields Also escape _ and * characters in e.g. "TYPE_*" description content. --- classes/class_@gdscript.rst | 10 +++----- classes/class_@global scope.rst | 8 ++---- classes/class_aabb.rst | 10 +++----- classes/class_acceptdialog.rst | 9 ++----- classes/class_animatedsprite.rst | 9 ++----- classes/class_animatedsprite3d.rst | 9 ++----- classes/class_animation.rst | 15 ++++------- classes/class_animationplayer.rst | 11 +++----- classes/class_animationtreeplayer.rst | 11 +++----- classes/class_area.rst | 9 ++----- classes/class_area2d.rst | 9 ++----- classes/class_array.rst | 6 +---- classes/class_atlastexture.rst | 9 ++----- classes/class_audioserver.rst | 25 ++++++++----------- classes/class_audioserversw.rst | 9 ++----- classes/class_audiostream.rst | 9 ++----- classes/class_audiostreammpc.rst | 9 ++----- classes/class_audiostreamoggvorbis.rst | 9 ++----- classes/class_audiostreamopus.rst | 9 ++----- classes/class_audiostreamplayback.rst | 9 ++----- classes/class_audiostreamspeex.rst | 9 ++----- classes/class_backbuffercopy.rst | 9 ++----- classes/class_bakedlight.rst | 9 ++----- classes/class_bakedlightinstance.rst | 9 ++----- classes/class_bakedlightsampler.rst | 9 ++----- classes/class_basebutton.rst | 11 +++----- classes/class_bitmap.rst | 9 ++----- classes/class_boneattachment.rst | 9 ++----- classes/class_bool.rst | 6 +---- classes/class_boxcontainer.rst | 9 ++----- classes/class_boxshape.rst | 9 ++----- classes/class_button.rst | 9 ++----- classes/class_buttonarray.rst | 9 ++----- classes/class_buttongroup.rst | 9 ++----- classes/class_camera.rst | 9 ++----- classes/class_camera2d.rst | 11 +++----- classes/class_canvasitem.rst | 15 ++++------- classes/class_canvasitemmaterial.rst | 9 ++----- classes/class_canvasitemshader.rst | 9 ++----- classes/class_canvasitemshadergraph.rst | 9 ++----- classes/class_canvaslayer.rst | 9 ++----- classes/class_canvasmodulate.rst | 9 ++----- classes/class_capsuleshape.rst | 9 ++----- classes/class_capsuleshape2d.rst | 9 ++----- classes/class_centercontainer.rst | 9 ++----- classes/class_checkbox.rst | 9 ++----- classes/class_checkbutton.rst | 9 ++----- classes/class_circleshape2d.rst | 9 ++----- classes/class_collisionobject.rst | 9 ++----- classes/class_collisionobject2d.rst | 9 ++----- classes/class_collisionpolygon.rst | 9 ++----- classes/class_collisionpolygon2d.rst | 9 ++----- classes/class_collisionshape.rst | 9 ++----- classes/class_collisionshape2d.rst | 9 ++----- classes/class_color.rst | 6 +---- classes/class_colorarray.rst | 6 +---- classes/class_colorpicker.rst | 9 ++----- classes/class_colorpickerbutton.rst | 9 ++----- classes/class_colorramp.rst | 9 ++----- classes/class_concavepolygonshape.rst | 9 ++----- classes/class_concavepolygonshape2d.rst | 9 ++----- classes/class_conetwistjoint.rst | 9 ++----- classes/class_configfile.rst | 9 ++----- classes/class_confirmationdialog.rst | 9 ++----- classes/class_container.rst | 9 ++----- classes/class_control.rst | 15 ++++------- classes/class_convexpolygonshape.rst | 9 ++----- classes/class_convexpolygonshape2d.rst | 9 ++----- classes/class_cubemap.rst | 9 ++----- classes/class_curve2d.rst | 9 ++----- classes/class_curve3d.rst | 9 ++----- classes/class_dampedspringjoint2d.rst | 9 ++----- classes/class_dictionary.rst | 6 +---- classes/class_directionallight.rst | 9 ++----- classes/class_directory.rst | 9 ++----- classes/class_editorfiledialog.rst | 9 ++----- classes/class_editorimportplugin.rst | 9 ++----- classes/class_editorplugin.rst | 9 ++----- classes/class_editorscenepostimport.rst | 9 ++----- classes/class_editorscript.rst | 9 ++----- classes/class_environment.rst | 9 ++----- classes/class_eventplayer.rst | 9 ++----- classes/class_eventstream.rst | 9 ++----- classes/class_eventstreamchibi.rst | 9 ++----- classes/class_file.rst | 9 ++----- classes/class_filedialog.rst | 15 ++++------- classes/class_fixedmaterial.rst | 17 +++++-------- classes/class_float.rst | 6 +---- classes/class_font.rst | 9 ++----- classes/class_funcref.rst | 9 ++----- classes/class_gdfunctionstate.rst | 9 ++----- classes/class_gdnativeclass.rst | 9 ++----- classes/class_gdscript.rst | 9 ++----- classes/class_generic6dofjoint.rst | 9 ++----- classes/class_geometry.rst | 9 ++----- classes/class_geometryinstance.rst | 9 ++----- classes/class_globals.rst | 9 ++----- classes/class_graphedit.rst | 9 ++----- classes/class_graphnode.rst | 9 ++----- classes/class_gridcontainer.rst | 9 ++----- classes/class_gridmap.rst | 9 ++----- classes/class_groovejoint2d.rst | 9 ++----- classes/class_hboxcontainer.rst | 9 ++----- classes/class_hbuttonarray.rst | 9 ++----- classes/class_hingejoint.rst | 9 ++----- classes/class_hscrollbar.rst | 9 ++----- classes/class_hseparator.rst | 9 ++----- classes/class_hslider.rst | 9 ++----- classes/class_hsplitcontainer.rst | 9 ++----- classes/class_httpclient.rst | 9 ++----- classes/class_image.rst | 6 +---- classes/class_imagetexture.rst | 9 ++----- classes/class_immediategeometry.rst | 9 ++----- classes/class_input.rst | 15 ++++------- classes/class_inputdefault.rst | 9 ++----- classes/class_inputevent.rst | 6 +---- classes/class_inputeventaction.rst | 6 +---- classes/class_inputeventjoybutton.rst | 6 +---- classes/class_inputeventjoymotion.rst | 6 +---- classes/class_inputeventkey.rst | 6 +---- classes/class_inputeventmousebutton.rst | 6 +---- classes/class_inputeventmousemotion.rst | 6 +---- classes/class_inputeventscreendrag.rst | 6 +---- classes/class_inputeventscreentouch.rst | 6 +---- classes/class_inputmap.rst | 9 ++----- classes/class_instanceplaceholder.rst | 9 ++----- classes/class_int.rst | 6 +---- classes/class_intarray.rst | 6 +---- classes/class_interpolatedcamera.rst | 9 ++----- classes/class_ip.rst | 11 +++----- classes/class_ip_unix.rst | 9 ++----- classes/class_itemlist.rst | 9 ++----- classes/class_joint.rst | 9 ++----- classes/class_joint2d.rst | 9 ++----- classes/class_kinematicbody.rst | 9 ++----- classes/class_kinematicbody2d.rst | 9 ++----- classes/class_label.rst | 17 +++++-------- classes/class_largetexture.rst | 9 ++----- classes/class_light.rst | 9 ++----- classes/class_light2d.rst | 9 ++----- classes/class_lightoccluder2d.rst | 9 ++----- classes/class_lineedit.rst | 11 +++----- classes/class_lineshape2d.rst | 9 ++----- classes/class_mainloop.rst | 9 ++----- classes/class_margincontainer.rst | 9 ++----- classes/class_marshalls.rst | 9 ++----- classes/class_material.rst | 13 +++------- classes/class_materialshader.rst | 9 ++----- classes/class_materialshadergraph.rst | 9 ++----- classes/class_matrix3.rst | 6 +---- classes/class_matrix32.rst | 6 +---- classes/class_menubutton.rst | 9 ++----- classes/class_mesh.rst | 11 +++----- classes/class_meshdatatool.rst | 9 ++----- classes/class_meshinstance.rst | 9 ++----- classes/class_meshlibrary.rst | 9 ++----- classes/class_multimesh.rst | 9 ++----- classes/class_multimeshinstance.rst | 9 ++----- classes/class_mutex.rst | 9 ++----- classes/class_navigation.rst | 9 ++----- classes/class_navigation2d.rst | 9 ++----- classes/class_navigationmesh.rst | 9 ++----- classes/class_navigationmeshinstance.rst | 9 ++----- classes/class_navigationpolygon.rst | 9 ++----- classes/class_navigationpolygoninstance.rst | 9 ++----- classes/class_nil.rst | 6 +---- classes/class_node.rst | 9 ++----- classes/class_node2d.rst | 9 ++----- classes/class_nodepath.rst | 6 +---- classes/class_object.rst | 14 ++++------- classes/class_occluderpolygon2d.rst | 9 ++----- classes/class_omnilight.rst | 9 ++----- classes/class_optionbutton.rst | 9 ++----- classes/class_os.rst | 9 ++----- classes/class_packeddatacontainer.rst | 9 ++----- classes/class_packeddatacontainerref.rst | 9 ++----- classes/class_packedscene.rst | 9 ++----- classes/class_packetpeer.rst | 9 ++----- classes/class_packetpeerstream.rst | 9 ++----- classes/class_packetpeerudp.rst | 9 ++----- classes/class_panel.rst | 9 ++----- classes/class_panelcontainer.rst | 9 ++----- classes/class_parallaxbackground.rst | 9 ++----- classes/class_parallaxlayer.rst | 9 ++----- classes/class_particleattractor2d.rst | 9 ++----- classes/class_particles.rst | 13 +++------- classes/class_particles2d.rst | 9 ++----- classes/class_patch9frame.rst | 9 ++----- classes/class_path.rst | 9 ++----- classes/class_path2d.rst | 9 ++----- classes/class_pathfollow.rst | 9 ++----- classes/class_pathfollow2d.rst | 9 ++----- classes/class_pathremap.rst | 9 ++----- classes/class_pckpacker.rst | 9 ++----- classes/class_performance.rst | 9 ++----- classes/class_phashtranslation.rst | 9 ++----- classes/class_physics2ddirectbodystate.rst | 9 ++----- classes/class_physics2ddirectbodystatesw.rst | 9 ++----- classes/class_physics2ddirectspacestate.rst | 9 ++----- classes/class_physics2dserver.rst | 9 ++----- classes/class_physics2dserversw.rst | 9 ++----- .../class_physics2dshapequeryparameters.rst | 9 ++----- classes/class_physics2dshapequeryresult.rst | 9 ++----- classes/class_physics2dtestmotionresult.rst | 9 ++----- classes/class_physicsbody.rst | 9 ++----- classes/class_physicsbody2d.rst | 9 ++----- classes/class_physicsdirectbodystate.rst | 9 ++----- classes/class_physicsdirectbodystatesw.rst | 9 ++----- classes/class_physicsdirectspacestate.rst | 9 ++----- classes/class_physicsserver.rst | 9 ++----- classes/class_physicsserversw.rst | 9 ++----- classes/class_physicsshapequeryparameters.rst | 9 ++----- classes/class_physicsshapequeryresult.rst | 9 ++----- classes/class_pinjoint.rst | 9 ++----- classes/class_pinjoint2d.rst | 9 ++----- classes/class_plane.rst | 6 +---- classes/class_planeshape.rst | 9 ++----- classes/class_polygon2d.rst | 9 ++----- classes/class_polygonpathfinder.rst | 9 ++----- classes/class_popup.rst | 9 ++----- classes/class_popupdialog.rst | 9 ++----- classes/class_popupmenu.rst | 9 ++----- classes/class_popuppanel.rst | 9 ++----- classes/class_portal.rst | 9 ++----- classes/class_position2d.rst | 9 ++----- classes/class_position3d.rst | 9 ++----- classes/class_progressbar.rst | 9 ++----- classes/class_proximitygroup.rst | 9 ++----- classes/class_quad.rst | 9 ++----- classes/class_quat.rst | 6 +---- classes/class_range.rst | 9 ++----- classes/class_rawarray.rst | 6 +---- classes/class_raycast.rst | 9 ++----- classes/class_raycast2d.rst | 9 ++----- classes/class_rayshape.rst | 9 ++----- classes/class_rayshape2d.rst | 9 ++----- classes/class_realarray.rst | 6 +---- classes/class_rect2.rst | 6 +---- classes/class_rectangleshape2d.rst | 9 ++----- classes/class_reference.rst | 9 ++----- classes/class_referenceframe.rst | 9 ++----- classes/class_regex.rst | 13 +++------- classes/class_remotetransform2d.rst | 9 ++----- classes/class_rendertargettexture.rst | 9 ++----- classes/class_resource.rst | 9 ++----- classes/class_resourceimportmetadata.rst | 9 ++----- classes/class_resourceinteractiveloader.rst | 9 ++----- classes/class_resourceloader.rst | 9 ++----- classes/class_resourcepreloader.rst | 9 ++----- classes/class_resourcesaver.rst | 9 ++----- classes/class_richtextlabel.rst | 9 ++----- classes/class_rid.rst | 6 +---- classes/class_rigidbody.rst | 9 ++----- classes/class_rigidbody2d.rst | 13 +++------- classes/class_room.rst | 9 ++----- classes/class_roombounds.rst | 9 ++----- classes/class_sample.rst | 13 +++------- classes/class_samplelibrary.rst | 9 ++----- classes/class_sampleplayer.rst | 25 ++++++++----------- classes/class_sampleplayer2d.rst | 13 +++------- classes/class_scenestate.rst | 9 ++----- classes/class_scenetree.rst | 9 ++----- classes/class_script.rst | 9 ++----- classes/class_scrollbar.rst | 9 ++----- classes/class_scrollcontainer.rst | 9 ++----- classes/class_segmentshape2d.rst | 9 ++----- classes/class_semaphore.rst | 9 ++----- classes/class_separator.rst | 9 ++----- classes/class_shader.rst | 9 ++----- classes/class_shadergraph.rst | 9 ++----- classes/class_shadermaterial.rst | 9 ++----- classes/class_shape.rst | 9 ++----- classes/class_shape2d.rst | 9 ++----- classes/class_skeleton.rst | 9 ++----- classes/class_slider.rst | 9 ++----- classes/class_sliderjoint.rst | 9 ++----- classes/class_soundplayer2d.rst | 9 ++----- classes/class_soundroomparams.rst | 9 ++----- classes/class_spatial.rst | 9 ++----- classes/class_spatialplayer.rst | 9 ++----- classes/class_spatialsampleplayer.rst | 9 ++----- classes/class_spatialsound2dserver.rst | 9 ++----- classes/class_spatialsound2dserversw.rst | 9 ++----- classes/class_spatialsoundserver.rst | 9 ++----- classes/class_spatialsoundserversw.rst | 9 ++----- classes/class_spatialstreamplayer.rst | 9 ++----- classes/class_sphereshape.rst | 9 ++----- classes/class_spinbox.rst | 9 ++----- classes/class_splitcontainer.rst | 9 ++----- classes/class_spotlight.rst | 9 ++----- classes/class_sprite.rst | 9 ++----- classes/class_sprite3d.rst | 9 ++----- classes/class_spritebase3d.rst | 9 ++----- classes/class_spriteframes.rst | 9 ++----- classes/class_staticbody.rst | 9 ++----- classes/class_staticbody2d.rst | 9 ++----- classes/class_streampeer.rst | 9 ++----- classes/class_streampeerssl.rst | 9 ++----- classes/class_streampeertcp.rst | 9 ++----- classes/class_streamplayer.rst | 9 ++----- classes/class_string.rst | 10 +++----- classes/class_stringarray.rst | 6 +---- classes/class_stylebox.rst | 15 ++++------- classes/class_styleboxempty.rst | 9 ++----- classes/class_styleboxflat.rst | 9 ++----- classes/class_styleboximagemask.rst | 13 +++------- classes/class_styleboxtexture.rst | 9 ++----- classes/class_surfacetool.rst | 9 ++----- classes/class_tabcontainer.rst | 13 +++------- classes/class_tabs.rst | 9 ++----- classes/class_tcp_server.rst | 9 ++----- classes/class_testcube.rst | 9 ++----- classes/class_textedit.rst | 11 +++----- classes/class_texture.rst | 9 ++----- classes/class_texturebutton.rst | 9 ++----- classes/class_textureframe.rst | 9 ++----- classes/class_textureprogress.rst | 9 ++----- classes/class_theme.rst | 9 ++----- classes/class_thread.rst | 9 ++----- classes/class_tilemap.rst | 15 ++++------- classes/class_tileset.rst | 9 ++----- classes/class_timer.rst | 11 +++----- classes/class_toolbutton.rst | 9 ++----- classes/class_touchscreenbutton.rst | 9 ++----- classes/class_transform.rst | 6 +---- classes/class_translation.rst | 9 ++----- classes/class_translationserver.rst | 9 ++----- classes/class_tree.rst | 9 ++----- classes/class_treeitem.rst | 9 ++----- classes/class_tween.rst | 9 ++----- classes/class_undoredo.rst | 9 ++----- classes/class_vboxcontainer.rst | 9 ++----- classes/class_vbuttonarray.rst | 9 ++----- classes/class_vector2.rst | 6 +---- classes/class_vector2array.rst | 6 +---- classes/class_vector3.rst | 6 +---- classes/class_vector3array.rst | 6 +---- classes/class_vehiclebody.rst | 9 ++----- classes/class_vehiclewheel.rst | 9 ++----- classes/class_videoplayer.rst | 9 ++----- classes/class_videostream.rst | 9 ++----- classes/class_videostreamtheora.rst | 9 ++----- classes/class_viewport.rst | 9 ++----- classes/class_viewportsprite.rst | 9 ++----- classes/class_visibilityenabler.rst | 9 ++----- classes/class_visibilityenabler2d.rst | 9 ++----- classes/class_visibilitynotifier.rst | 9 ++----- classes/class_visibilitynotifier2d.rst | 9 ++----- classes/class_visualinstance.rst | 9 ++----- classes/class_visualserver.rst | 9 ++----- classes/class_vscrollbar.rst | 9 ++----- classes/class_vseparator.rst | 9 ++----- classes/class_vslider.rst | 9 ++----- classes/class_vsplitcontainer.rst | 9 ++----- classes/class_weakref.rst | 9 ++----- classes/class_windowdialog.rst | 9 ++----- classes/class_world.rst | 9 ++----- classes/class_world2d.rst | 9 ++----- classes/class_worldenvironment.rst | 9 ++----- classes/class_xmlparser.rst | 9 ++----- classes/class_ysort.rst | 9 ++----- 361 files changed, 764 insertions(+), 2530 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index af6f435c5..1d6246ef7 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -3,11 +3,7 @@ @GDScript ========= -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Built-in GDScript functions. @@ -423,13 +419,13 @@ Returns a reference to the specified function - :ref:`Object` **convert** **(** Variant what, :ref:`int` type **)** -Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in :ref:`@Global Scope`. +Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE\_\* in :ref:`@Global Scope`. .. _class_@GDScript_typeof: - :ref:`int` **typeof** **(** Variant what **)** -Returns the internal type of the given Variant object, using the TYPE_* enum in :ref:`@Global Scope`. +Returns the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope`. .. _class_@GDScript_str: diff --git a/classes/class_@global scope.rst b/classes/class_@global scope.rst index e4c00743b..368a6be8d 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@global scope.rst @@ -3,11 +3,7 @@ @Global Scope ============= -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Global scope constants and variables. @@ -434,7 +430,7 @@ Numeric Constants - **PROPERTY_HINT_KEY_ACCEL** = **7** - **PROPERTY_HINT_FLAGS** = **8** --- Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. - **PROPERTY_HINT_ALL_FLAGS** = **9** --- Property hint for a bitmask description that covers all 32 bits. Valid only for integers. -- **PROPERTY_HINT_FILE** = **10** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". +- **PROPERTY_HINT_FILE** = **10** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "\*.doc". - **PROPERTY_HINT_DIR** = **11** --- String property is a directory (so pop up a file dialog when edited). - **PROPERTY_HINT_GLOBAL_FILE** = **12** - **PROPERTY_HINT_GLOBAL_DIR** = **13** diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 76cc43d34..0ad7b92b4 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -3,11 +3,7 @@ AABB ==== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Axis-Aligned Bounding Box. @@ -107,7 +103,7 @@ Return the normalized longest axis of the :ref:`AABB`. - :ref:`int` **get_longest_axis_index** **(** **)** -Return the index of the longest axis of the :ref:`AABB` (according to :ref:`Vector3`::AXIS* enum). +Return the index of the longest axis of the :ref:`AABB` (according to :ref:`Vector3`::AXIS\* enum). .. _class_AABB_get_longest_axis_size: @@ -125,7 +121,7 @@ Return the normalized shortest axis of the :ref:`AABB`. - :ref:`int` **get_shortest_axis_index** **(** **)** -Return the index of the shortest axis of the :ref:`AABB` (according to :ref:`Vector3`::AXIS* enum). +Return the index of the shortest axis of the :ref:`AABB` (according to :ref:`Vector3`::AXIS\* enum). .. _class_AABB_get_shortest_axis_size: diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index b12b79724..46b6a4ca9 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -3,14 +3,9 @@ AcceptDialog ============ -Inherits: :ref:`WindowDialog` -------------------------------------------------- +**Inherits:** :ref:`WindowDialog` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base dialog for user notification. diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 1b2cc052a..2feb44173 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -3,14 +3,9 @@ AnimatedSprite ============== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Sprite node that can use multiple textures for animation. diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 00ba0687f..2fd670a70 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -3,14 +3,9 @@ AnimatedSprite3D ================ -Inherits: :ref:`SpriteBase3D` -------------------------------------------------- +**Inherits:** :ref:`SpriteBase3D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_animation.rst b/classes/class_animation.rst index c5f90a1f6..b2fe0cf38 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -3,14 +3,9 @@ Animation ========= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Contains data used to animate everything in the engine. @@ -115,7 +110,7 @@ Member Function Description - :ref:`int` **add_track** **(** :ref:`int` type, :ref:`int` at_pos=-1 **)** -Add a track to the Animation. The track type must be specified as any of the values in te TYPE_* enumeration. +Add a track to the Animation. The track type must be specified as any of the values in te TYPE\_\* enumeration. .. _class_Animation_remove_track: @@ -233,13 +228,13 @@ Find the key index by time in a given track. Optionally, only find it if the exa - void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`int` interpolation **)** -Set the interpolation type of a given track, from the INTERPOLATION_* enum. +Set the interpolation type of a given track, from the INTERPOLATION\_\* enum. .. _class_Animation_track_get_interpolation_type: - :ref:`int` **track_get_interpolation_type** **(** :ref:`int` idx **)** const -Return the interpolation type of a given track, from the INTERPOLATION_* enum. +Return the interpolation type of a given track, from the INTERPOLATION\_\* enum. .. _class_Animation_transform_track_interpolate: diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 536b2805b..ffb959e4a 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -3,14 +3,9 @@ AnimationPlayer =============== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Container and player of :ref:`Animation` resources. @@ -299,7 +294,7 @@ The animation player creates caches for faster access to the nodes it will anima - void **set_animation_process_mode** **(** :ref:`int` mode **)** -Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*. +Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS\_\*. .. _class_AnimationPlayer_get_animation_process_mode: diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index 1d7e17d0f..080d1a5ee 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -3,14 +3,9 @@ AnimationTreePlayer =================== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Animation Player that uses a node graph for the blending. @@ -189,7 +184,7 @@ Rename a node in the graph. - :ref:`int` **node_get_type** **(** :ref:`String` id **)** const -Get the node type, will return from NODE_* enum. +Get the node type, will return from NODE\_\* enum. .. _class_AnimationTreePlayer_node_get_input_count: diff --git a/classes/class_area.rst b/classes/class_area.rst index 4d7f41290..dcbf42b6f 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -3,14 +3,9 @@ Area ==== -Inherits: :ref:`CollisionObject` -------------------------------------------------------- +**Inherits:** :ref:`CollisionObject` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index de6512ba1..0bd932eaa 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -3,14 +3,9 @@ Area2D ====== -Inherits: :ref:`CollisionObject2D` ------------------------------------------------------------ +**Inherits:** :ref:`CollisionObject2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core General purpose area detection and influence for 2D physics. diff --git a/classes/class_array.rst b/classes/class_array.rst index 9310cbdb6..1bc987926 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -3,11 +3,7 @@ Array ===== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Generic array datatype. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index af173568e..26e8ca04e 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -3,14 +3,9 @@ AtlasTexture ============ -Inherits: :ref:`Texture` ---------------------------------------- +**Inherits:** :ref:`Texture` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 93aad2d3f..581a449c8 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -3,14 +3,9 @@ AudioServer =========== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Server interface for low level audio access. @@ -143,7 +138,7 @@ Member Function Description - :ref:`RID` **sample_create** **(** :ref:`int` format, :ref:`bool` stereo, :ref:`int` length **)** -Create an audio sample, return a :ref:`RID` referencing it. The sample will be created with a given format (from the SAMPLE_FORMAT_* enum), a total length (in samples, not bytes), in either stereo or mono. +Create an audio sample, return a :ref:`RID` referencing it. The sample will be created with a given format (from the SAMPLE_FORMAT\_\* enum), a total length (in samples, not bytes), in either stereo or mono. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes. @@ -163,7 +158,7 @@ Return the description of an audio sample. Mainly used for organization. - :ref:`int` **sample_get_format** **(** :ref:`RID` sample **)** const -Return the format of the audio sample, in the form of the SAMPLE_FORMAT_* enum. +Return the format of the audio sample, in the form of the SAMPLE_FORMAT\_\* enum. .. _class_AudioServer_sample_is_stereo: @@ -223,13 +218,13 @@ Return the mix rate of the given sample. - void **sample_set_loop_format** **(** :ref:`RID` sample, :ref:`int` loop_format **)** -Set the loop format for a sample from the SAMPLE_LOOP_* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms. +Set the loop format for a sample from the SAMPLE_LOOP\_\* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms. .. _class_AudioServer_sample_get_loop_format: - :ref:`int` **sample_get_loop_format** **(** :ref:`RID` sample **)** const -Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum. +Return the loop format for a sample, as a value from the SAMPLE_LOOP\_\* enum. .. _class_AudioServer_sample_set_loop_begin: @@ -283,7 +278,7 @@ Change the pan of a currently playing voice and, optionally, the depth and heigh - void **voice_set_filter** **(** :ref:`RID` voice, :ref:`int` type, :ref:`float` cutoff, :ref:`float` resonance, :ref:`float` gain=0 **)** -Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum. +Set a resonant filter post processing for the voice. Filter type is a value from the FILTER\_\* enum. .. _class_AudioServer_voice_set_chorus: @@ -295,7 +290,7 @@ Set chorus send post processing for the voice (from 0 to 1). - void **voice_set_reverb** **(** :ref:`RID` voice, :ref:`int` room, :ref:`float` reverb **)** -Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum. +Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB\_\* enum. .. _class_AudioServer_voice_set_mix_rate: @@ -337,7 +332,7 @@ Return the current pan depth for a given voice (-1 to +1 range). - :ref:`int` **voice_get_filter_type** **(** :ref:`RID` voice **)** const -Return the current selected filter type for a given voice, from the FILTER_* enum. +Return the current selected filter type for a given voice, from the FILTER\_\* enum. .. _class_AudioServer_voice_get_filter_cutoff: @@ -361,7 +356,7 @@ Return the current chorus send for a given voice (0 to 1). - :ref:`int` **voice_get_reverb_type** **(** :ref:`RID` voice **)** const -Return the current reverb type for a given voice from the REVERB_* enum. +Return the current reverb type for a given voice from the REVERB\_\* enum. .. _class_AudioServer_voice_get_reverb: diff --git a/classes/class_audioserversw.rst b/classes/class_audioserversw.rst index 5646e3c2f..08df527da 100644 --- a/classes/class_audioserversw.rst +++ b/classes/class_audioserversw.rst @@ -3,14 +3,9 @@ AudioServerSW ============= -Inherits: :ref:`AudioServer` ------------------------------------------------ +**Inherits:** :ref:`AudioServer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Software implementation of :ref:`AudioServer`. diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index b4be1b855..c82f50f47 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -3,14 +3,9 @@ AudioStream =========== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for audio streams. diff --git a/classes/class_audiostreammpc.rst b/classes/class_audiostreammpc.rst index 48e892208..3aa4efe78 100644 --- a/classes/class_audiostreammpc.rst +++ b/classes/class_audiostreammpc.rst @@ -3,14 +3,9 @@ AudioStreamMPC ============== -Inherits: :ref:`AudioStream` ------------------------------------------------ +**Inherits:** :ref:`AudioStream` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core MusePack audio stream driver. diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 3bd600e1c..6b6275ec0 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -3,14 +3,9 @@ AudioStreamOGGVorbis ==================== -Inherits: :ref:`AudioStream` ------------------------------------------------ +**Inherits:** :ref:`AudioStream` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core OGG Vorbis audio stream driver. diff --git a/classes/class_audiostreamopus.rst b/classes/class_audiostreamopus.rst index 6ebc34e5f..8fad04fa0 100644 --- a/classes/class_audiostreamopus.rst +++ b/classes/class_audiostreamopus.rst @@ -3,14 +3,9 @@ AudioStreamOpus =============== -Inherits: :ref:`AudioStream` ------------------------------------------------ +**Inherits:** :ref:`AudioStream` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Opus Codec audio stream driver. diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index 3db3cf50b..bac2dad28 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -3,14 +3,9 @@ AudioStreamPlayback =================== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_audiostreamspeex.rst b/classes/class_audiostreamspeex.rst index 47c07a2d1..53b18552d 100644 --- a/classes/class_audiostreamspeex.rst +++ b/classes/class_audiostreamspeex.rst @@ -3,14 +3,9 @@ AudioStreamSpeex ================ -Inherits: :ref:`AudioStream` ------------------------------------------------ +**Inherits:** :ref:`AudioStream` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Speex audio stream driver. diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 2465a84b1..fb4a84fc0 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -3,14 +3,9 @@ BackBufferCopy ============== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_bakedlight.rst b/classes/class_bakedlight.rst index 2fb0ceae8..433f61cf3 100644 --- a/classes/class_bakedlight.rst +++ b/classes/class_bakedlight.rst @@ -3,14 +3,9 @@ BakedLight ========== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_bakedlightinstance.rst b/classes/class_bakedlightinstance.rst index 34bf1f8ba..cb35cd302 100644 --- a/classes/class_bakedlightinstance.rst +++ b/classes/class_bakedlightinstance.rst @@ -3,14 +3,9 @@ BakedLightInstance ================== -Inherits: :ref:`VisualInstance` ------------------------------------------------------ +**Inherits:** :ref:`VisualInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_bakedlightsampler.rst b/classes/class_bakedlightsampler.rst index 875307d5b..137d9b79e 100644 --- a/classes/class_bakedlightsampler.rst +++ b/classes/class_bakedlightsampler.rst @@ -3,14 +3,9 @@ BakedLightSampler ================= -Inherits: :ref:`VisualInstance` ------------------------------------------------------ +**Inherits:** :ref:`VisualInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 64334be8c..fbd9f6839 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -3,14 +3,9 @@ BaseButton ========== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Provides a base class for different kinds of buttons. @@ -130,6 +125,6 @@ Return the state of the click_on_press property (see :ref:`set_click_on_press` **get_draw_mode** **(** **)** const -Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overiding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. +Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overiding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum. diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 6fc7c1edf..4cfee9296 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -3,14 +3,9 @@ BitMap ====== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index f4cd5c3fd..bfa373714 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -3,14 +3,9 @@ BoneAttachment ============== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_bool.rst b/classes/class_bool.rst index e0ab5b0ba..2c6aca968 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -3,11 +3,7 @@ bool ==== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Boolean built-in type diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index f26fbdf21..8123c62a9 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -3,14 +3,9 @@ BoxContainer ============ -Inherits: :ref:`Container` -------------------------------------------- +**Inherits:** :ref:`Container` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for Box containers. diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index 626ec4d8a..dea967ca4 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -3,14 +3,9 @@ BoxShape ======== -Inherits: :ref:`Shape` ------------------------------------ +**Inherits:** :ref:`Shape` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Box shape resource. diff --git a/classes/class_button.rst b/classes/class_button.rst index c28386631..7a65101ed 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -3,14 +3,9 @@ Button ====== -Inherits: :ref:`BaseButton` ---------------------------------------------- +**Inherits:** :ref:`BaseButton` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Standard themed Button. diff --git a/classes/class_buttonarray.rst b/classes/class_buttonarray.rst index ea4f37a63..dbe74ff28 100644 --- a/classes/class_buttonarray.rst +++ b/classes/class_buttonarray.rst @@ -3,14 +3,9 @@ ButtonArray =========== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Array of Buttons. diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index 77883c71d..adcce491e 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -3,14 +3,9 @@ ButtonGroup =========== -Inherits: :ref:`BoxContainer` -------------------------------------------------- +**Inherits:** :ref:`BoxContainer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Group of Buttons. diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 67dc35aa5..539f7e4ab 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -3,14 +3,9 @@ Camera ====== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Camera node, displays from a point of view. diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index fb31b6d04..fca6ed19c 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -3,14 +3,9 @@ Camera2D ======== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Camera node for 2D scenes. @@ -187,7 +182,7 @@ Return the scrolling limit in pixels. - void **set_drag_margin** **(** :ref:`int` margin, :ref:`float` drag_margin **)** -Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges. +Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN\_\* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges. .. _class_Camera2D_get_drag_margin: diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index b302873c0..1d0e1d4f5 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -3,14 +3,9 @@ CanvasItem ========== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class of anything 2D. @@ -152,7 +147,7 @@ Description Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by :ref:`Control`, for anything GUI related, and by :ref:`Node2D` for anything 2D engine related. -Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significan'tly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrided function, though. +Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significan'tly. Several functions for drawing on the CanvasItem are provided (see draw\_\* functions). They can only be used inside the notification, signal or _draw() overrided function, though. Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). @@ -251,13 +246,13 @@ Return if set as toplevel. See :ref:`set_as_toplevel - void **set_blend_mode** **(** :ref:`int` blend_mode **)** -Set the blending mode from enum BLEND_MODE_*. +Set the blending mode from enum BLEND_MODE\_\*. .. _class_CanvasItem_get_blend_mode: - :ref:`int` **get_blend_mode** **(** **)** const -Return the current blending mode from enum BLEND_MODE_*. +Return the current blending mode from enum BLEND_MODE\_\*. .. _class_CanvasItem_set_light_mask: diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index b27ed663f..694739839 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -3,14 +3,9 @@ CanvasItemMaterial ================== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_canvasitemshader.rst b/classes/class_canvasitemshader.rst index a914d5354..d97a06af2 100644 --- a/classes/class_canvasitemshader.rst +++ b/classes/class_canvasitemshader.rst @@ -3,14 +3,9 @@ CanvasItemShader ================ -Inherits: :ref:`Shader` -------------------------------------- +**Inherits:** :ref:`Shader` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_canvasitemshadergraph.rst b/classes/class_canvasitemshadergraph.rst index ce0501bb4..6ac90d6b6 100644 --- a/classes/class_canvasitemshadergraph.rst +++ b/classes/class_canvasitemshadergraph.rst @@ -3,14 +3,9 @@ CanvasItemShaderGraph ===================== -Inherits: :ref:`ShaderGraph` ------------------------------------------------ +**Inherits:** :ref:`ShaderGraph` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 75a89f774..f4415def8 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -3,14 +3,9 @@ CanvasLayer =========== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Canvas Item layer. diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index 6cd4e62b1..7803a178b 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -3,14 +3,9 @@ CanvasModulate ============== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index e5bf87480..645bd1890 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -3,14 +3,9 @@ CapsuleShape ============ -Inherits: :ref:`Shape` ------------------------------------ +**Inherits:** :ref:`Shape` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Capsule shape resource. diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 1db5f3b66..725f99fb3 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -3,14 +3,9 @@ CapsuleShape2D ============== -Inherits: :ref:`Shape2D` ---------------------------------------- +**Inherits:** :ref:`Shape2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Capsule 2D shape resource for physics. diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index ff1dac626..8860f1de7 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -3,14 +3,9 @@ CenterContainer =============== -Inherits: :ref:`Container` -------------------------------------------- +**Inherits:** :ref:`Container` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Keeps children controls centered. diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 811c72d34..6077e3ef0 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -3,14 +3,9 @@ CheckBox ======== -Inherits: :ref:`Button` -------------------------------------- +**Inherits:** :ref:`Button` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index fbd2b9579..63b17a463 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -3,14 +3,9 @@ CheckButton =========== -Inherits: :ref:`Button` -------------------------------------- +**Inherits:** :ref:`Button` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Checkable button. diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 8c69b8b2e..ead5a56c6 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -3,14 +3,9 @@ CircleShape2D ============= -Inherits: :ref:`Shape2D` ---------------------------------------- +**Inherits:** :ref:`Shape2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Circular Shape for 2D Physics. diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 36230d82d..84b7d23f7 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -3,14 +3,9 @@ CollisionObject =============== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 8a3ec91e3..84846099e 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -3,14 +3,9 @@ CollisionObject2D ================= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base node for 2D collisionables. diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 3f6d08786..b556e769d 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -3,14 +3,9 @@ CollisionPolygon ================ -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 7e77a212c..1a2a07e92 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -3,14 +3,9 @@ CollisionPolygon2D ================== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Editor-only class for easy editing of collision polygons. diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 463cf5c76..a0dc72bbc 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -3,14 +3,9 @@ CollisionShape ============== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 979104d36..9946b1c8a 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -3,14 +3,9 @@ CollisionShape2D ================ -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Editor-only class for easy editing of shapes. diff --git a/classes/class_color.rst b/classes/class_color.rst index 3c85b427f..9dd66576b 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -3,11 +3,7 @@ Color ===== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Color in RGBA format. diff --git a/classes/class_colorarray.rst b/classes/class_colorarray.rst index 098e0a63c..62c975871 100644 --- a/classes/class_colorarray.rst +++ b/classes/class_colorarray.rst @@ -3,11 +3,7 @@ ColorArray ========== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Array of Colors diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 3d5e61828..c73b9cdb1 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -3,14 +3,9 @@ ColorPicker =========== -Inherits: :ref:`BoxContainer` -------------------------------------------------- +**Inherits:** :ref:`BoxContainer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Color picker control. diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index e01acfa61..686e81cf2 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -3,14 +3,9 @@ ColorPickerButton ================= -Inherits: :ref:`Button` -------------------------------------- +**Inherits:** :ref:`Button` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_colorramp.rst b/classes/class_colorramp.rst index 68edf2556..0728e0105 100644 --- a/classes/class_colorramp.rst +++ b/classes/class_colorramp.rst @@ -3,14 +3,9 @@ ColorRamp ========= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index 885db8bf8..da455e3e3 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -3,14 +3,9 @@ ConcavePolygonShape =================== -Inherits: :ref:`Shape` ------------------------------------ +**Inherits:** :ref:`Shape` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Concave polygon shape. diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 7f15f1d2d..535b93918 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -3,14 +3,9 @@ ConcavePolygonShape2D ===================== -Inherits: :ref:`Shape2D` ---------------------------------------- +**Inherits:** :ref:`Shape2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Concave polygon 2D shape resource for physics. diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index 141cfab1d..f5adf5009 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -3,14 +3,9 @@ ConeTwistJoint ============== -Inherits: :ref:`Joint` ------------------------------------ +**Inherits:** :ref:`Joint` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 001b68dff..eca00214b 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -3,14 +3,9 @@ ConfigFile ========== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 231d36504..38974a35b 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -3,14 +3,9 @@ ConfirmationDialog ================== -Inherits: :ref:`AcceptDialog` -------------------------------------------------- +**Inherits:** :ref:`AcceptDialog` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Dialog for confirmation of actions. diff --git a/classes/class_container.rst b/classes/class_container.rst index 32ee01404..99478782a 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -3,14 +3,9 @@ Container ========= -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base node for containers. diff --git a/classes/class_control.rst b/classes/class_control.rst index 2fc0ce08b..b58d1cddc 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -3,14 +3,9 @@ Control ======= -Inherits: :ref:`CanvasItem` ---------------------------------------------- +**Inherits:** :ref:`CanvasItem` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Control is the base node for all the GUI components. @@ -233,7 +228,7 @@ Only one control can hold the keyboard focus (receiving keyboard events), for th 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. +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. Member Function Description --------------------------- @@ -568,13 +563,13 @@ Return the tooltip, which will appear when the cursor is resting over this contr - void **set_default_cursor_shape** **(** :ref:`int` shape **)** -Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes. +Set the default cursor shape for this control. See enum CURSOR\_\* for the list of shapes. .. _class_Control_get_default_cursor_shape: - :ref:`int` **get_default_cursor_shape** **(** **)** const -Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes. +Return the default cursor shape for this control. See enum CURSOR\_\* for the list of shapes. .. _class_Control_get_cursor_shape: diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 69cfe6863..f43e36795 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -3,14 +3,9 @@ ConvexPolygonShape ================== -Inherits: :ref:`Shape` ------------------------------------ +**Inherits:** :ref:`Shape` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Convex Polygon Shape. diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index b082cd04d..83adaa854 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -3,14 +3,9 @@ ConvexPolygonShape2D ==================== -Inherits: :ref:`Shape2D` ---------------------------------------- +**Inherits:** :ref:`Shape2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Convex Polygon Shape for 2D physics. diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 435faeab1..4e91bb9ff 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -3,14 +3,9 @@ CubeMap ======= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 93a33d23b..02f8bc59c 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -3,14 +3,9 @@ Curve2D ======= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Describes a Bezier curve in 2D space. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 987d22d12..fd7dd8456 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -3,14 +3,9 @@ Curve3D ======= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Describes a Bezier curve in 3D space. diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 048c45658..1a0ad05eb 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -3,14 +3,9 @@ DampedSpringJoint2D =================== -Inherits: :ref:`Joint2D` ---------------------------------------- +**Inherits:** :ref:`Joint2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Damped spring constraint for 2D physics. diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index be38b389e..401e8fae5 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -3,11 +3,7 @@ Dictionary ========== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Dictionary type. diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 6041e9356..64ab718da 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -3,14 +3,9 @@ DirectionalLight ================ -Inherits: :ref:`Light` ------------------------------------ +**Inherits:** :ref:`Light` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Directional Light, such as the Sun or the Moon. diff --git a/classes/class_directory.rst b/classes/class_directory.rst index ecc9e6d14..15c91081f 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -3,14 +3,9 @@ Directory ========= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 0d3aef3c4..d17fd0da0 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -3,14 +3,9 @@ EditorFileDialog ================ -Inherits: :ref:`ConfirmationDialog` -------------------------------------------------------------- +**Inherits:** :ref:`ConfirmationDialog` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index be6e2c0a7..eaa216162 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -3,14 +3,9 @@ EditorImportPlugin ================== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 79819001a..5100fce2c 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -3,14 +3,9 @@ EditorPlugin ============ -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index 03caa7172..89c7326ba 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -3,14 +3,9 @@ EditorScenePostImport ===================== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 702205764..1debae164 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -3,14 +3,9 @@ EditorScript ============ -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_environment.rst b/classes/class_environment.rst index b3f2d9f9b..5c2489c77 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -3,14 +3,9 @@ Environment =========== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_eventplayer.rst b/classes/class_eventplayer.rst index 11cb77684..34f645c58 100644 --- a/classes/class_eventplayer.rst +++ b/classes/class_eventplayer.rst @@ -3,14 +3,9 @@ EventPlayer =========== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Class for event stream playback. diff --git a/classes/class_eventstream.rst b/classes/class_eventstream.rst index 6701c35b6..32d8b7e62 100644 --- a/classes/class_eventstream.rst +++ b/classes/class_eventstream.rst @@ -3,14 +3,9 @@ EventStream =========== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for all event-based stream drivers. diff --git a/classes/class_eventstreamchibi.rst b/classes/class_eventstreamchibi.rst index 2a95c2762..ead22c276 100644 --- a/classes/class_eventstreamchibi.rst +++ b/classes/class_eventstreamchibi.rst @@ -3,14 +3,9 @@ EventStreamChibi ================ -Inherits: :ref:`EventStream` ------------------------------------------------ +**Inherits:** :ref:`EventStream` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Driver for MOD playback. diff --git a/classes/class_file.rst b/classes/class_file.rst index 15c7c22bb..970b0d15d 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -3,14 +3,9 @@ File ==== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 7918ec9b9..e765e9215 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -3,14 +3,9 @@ FileDialog ========== -Inherits: :ref:`ConfirmationDialog` -------------------------------------------------------------- +**Inherits:** :ref:`ConfirmationDialog` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Dialog for selecting files or directories in the filesystem. @@ -87,7 +82,7 @@ Clear all the added filters in the dialog. - void **add_filter** **(** :ref:`String` filter **)** -Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images"); +Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("\*.png ; PNG Images"); .. _class_FileDialog_get_current_dir: @@ -123,13 +118,13 @@ Get the current selected path (directory and file) of the file dialog (empty if - void **set_mode** **(** :ref:`int` mode **)** -Set the file dialog mode from the MODE_* enum. +Set the file dialog mode from the MODE\_\* enum. .. _class_FileDialog_get_mode: - :ref:`int` **get_mode** **(** **)** const -Get the file dialog mode from the MODE_* enum. +Get the file dialog mode from the MODE\_\* enum. .. _class_FileDialog_get_vbox: diff --git a/classes/class_fixedmaterial.rst b/classes/class_fixedmaterial.rst index 647db3a88..8bd857e3a 100644 --- a/classes/class_fixedmaterial.rst +++ b/classes/class_fixedmaterial.rst @@ -3,14 +3,9 @@ FixedMaterial ============= -Inherits: :ref:`Material` ------------------------------------------ +**Inherits:** :ref:`Material` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Simple Material with a fixed parameter set. @@ -84,13 +79,13 @@ Member Function Description - void **set_parameter** **(** :ref:`int` param, var value **)** -Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum. +Set a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum. .. _class_FixedMaterial_get_parameter: - void **get_parameter** **(** :ref:`int` param **)** const -Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum. +Return a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum. .. _class_FixedMaterial_set_texture: @@ -108,13 +103,13 @@ Return a texture. Textures change parameters per texel and are mapped to the mod - void **set_texcoord_mode** **(** :ref:`int` param, :ref:`int` mode **)** -Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. +Set the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object. .. _class_FixedMaterial_get_texcoord_mode: - :ref:`int` **get_texcoord_mode** **(** :ref:`int` param **)** const -Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. +Return the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object. .. _class_FixedMaterial_set_fixed_flag: diff --git a/classes/class_float.rst b/classes/class_float.rst index d0d70371a..d11d2030d 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -3,11 +3,7 @@ float ===== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_font.rst b/classes/class_font.rst index 7a07e4061..da907da6b 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -3,14 +3,9 @@ Font ==== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Internationalized font and text drawing support. diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index c91ac03d4..1556368d1 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -3,14 +3,9 @@ FuncRef ======= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdfunctionstate.rst index 17ca36691..ffd2cab4e 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdfunctionstate.rst @@ -3,14 +3,9 @@ GDFunctionState =============== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_gdnativeclass.rst b/classes/class_gdnativeclass.rst index 329f19548..2b5ccf5ba 100644 --- a/classes/class_gdnativeclass.rst +++ b/classes/class_gdnativeclass.rst @@ -3,14 +3,9 @@ GDNativeClass ============= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index b9f53ec68..294590fc9 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -3,14 +3,9 @@ GDScript ======== -Inherits: :ref:`Script` -------------------------------------- +**Inherits:** :ref:`Script` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 885153550..a0d2e50a7 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -3,14 +3,9 @@ Generic6DOFJoint ================ -Inherits: :ref:`Joint` ------------------------------------ +**Inherits:** :ref:`Joint` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index b57018b29..9beb17948 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -3,14 +3,9 @@ Geometry ======== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index f60f1abe0..9776151bb 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -3,14 +3,9 @@ GeometryInstance ================ -Inherits: :ref:`VisualInstance` ------------------------------------------------------ +**Inherits:** :ref:`VisualInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base node for geometry based visual instances. diff --git a/classes/class_globals.rst b/classes/class_globals.rst index 50808d5f8..9fa41742d 100644 --- a/classes/class_globals.rst +++ b/classes/class_globals.rst @@ -3,14 +3,9 @@ Globals ======= -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Contains global variables accessible from everywhere. diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 03c49671b..6f44e4a6f 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -3,14 +3,9 @@ GraphEdit ========= -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 8e4fe0375..3b1779ec1 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -3,14 +3,9 @@ GraphNode ========= -Inherits: :ref:`Container` -------------------------------------------- +**Inherits:** :ref:`Container` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 9090c7827..2a2407e6f 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -3,14 +3,9 @@ GridContainer ============= -Inherits: :ref:`Container` -------------------------------------------- +**Inherits:** :ref:`Container` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 790e57b3b..723d39e13 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -3,14 +3,9 @@ GridMap ======= -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 432df2c62..4eef4d953 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -3,14 +3,9 @@ GrooveJoint2D ============= -Inherits: :ref:`Joint2D` ---------------------------------------- +**Inherits:** :ref:`Joint2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Groove constraint for 2D physics. diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index 3a769c641..4e0f8a253 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -3,14 +3,9 @@ HBoxContainer ============= -Inherits: :ref:`BoxContainer` -------------------------------------------------- +**Inherits:** :ref:`BoxContainer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Horizontal box container. diff --git a/classes/class_hbuttonarray.rst b/classes/class_hbuttonarray.rst index 78830897c..5d0625764 100644 --- a/classes/class_hbuttonarray.rst +++ b/classes/class_hbuttonarray.rst @@ -3,14 +3,9 @@ HButtonArray ============ -Inherits: :ref:`ButtonArray` ------------------------------------------------ +**Inherits:** :ref:`ButtonArray` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Horizontal button array. diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 9d737ce0a..b8542ce24 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -3,14 +3,9 @@ HingeJoint ========== -Inherits: :ref:`Joint` ------------------------------------ +**Inherits:** :ref:`Joint` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index 32257ec6f..48691e01c 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -3,14 +3,9 @@ HScrollBar ========== -Inherits: :ref:`ScrollBar` -------------------------------------------- +**Inherits:** :ref:`ScrollBar` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Horizontal scroll bar. diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index a3d756962..e4747267d 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -3,14 +3,9 @@ HSeparator ========== -Inherits: :ref:`Separator` -------------------------------------------- +**Inherits:** :ref:`Separator` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Horizontal separator. diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index a54f5f0a8..c12d349bc 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -3,14 +3,9 @@ HSlider ======= -Inherits: :ref:`Slider` -------------------------------------- +**Inherits:** :ref:`Slider` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Horizontal slider. diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index 17f6a3268..af95a27c2 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -3,14 +3,9 @@ HSplitContainer =============== -Inherits: :ref:`SplitContainer` ------------------------------------------------------ +**Inherits:** :ref:`SplitContainer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Horizontal split container. diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index da59c3479..0ba838f85 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -3,14 +3,9 @@ HTTPClient ========== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_image.rst b/classes/class_image.rst index 3a5c18666..78b79243a 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -3,11 +3,7 @@ Image ===== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Image datatype. diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 01ae93f18..3d34bc16a 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -3,14 +3,9 @@ ImageTexture ============ -Inherits: :ref:`Texture` ---------------------------------------- +**Inherits:** :ref:`Texture` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index 93ad3d425..da97b4a3a 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -3,14 +3,9 @@ ImmediateGeometry ================= -Inherits: :ref:`GeometryInstance` ---------------------------------------------------------- +**Inherits:** :ref:`GeometryInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_input.rst b/classes/class_input.rst index d2e502f56..4361f4195 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -3,14 +3,9 @@ Input ===== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core @@ -84,7 +79,7 @@ Member Function Description - :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** -Returns if the joystick button at the given index is currently pressed. (see JOY_* constans in :ref:`@Global Scope`) +Returns if the joystick button at the given index is currently pressed. (see JOY\_\* constans in :ref:`@Global Scope`) .. _class_Input_is_action_pressed: @@ -106,13 +101,13 @@ Removes all mappings from the internal db that match the given uid. - :ref:`bool` **is_joy_known** **(** :ref:`int` device **)** -Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see :ref:`@Global Scope`). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them. +Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY\_\* constants (see :ref:`@Global Scope`). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them. .. _class_Input_get_joy_axis: - :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** -Returns the current value of the joystick axis at given index (see JOY_* constants in :ref:`@Global Scope`) +Returns the current value of the joystick axis at given index (see JOY\_\* constants in :ref:`@Global Scope`) .. _class_Input_get_joy_name: diff --git a/classes/class_inputdefault.rst b/classes/class_inputdefault.rst index fa7a9bbf7..0464965c6 100644 --- a/classes/class_inputdefault.rst +++ b/classes/class_inputdefault.rst @@ -3,14 +3,9 @@ InputDefault ============ -Inherits: :ref:`Input` ------------------------------------ +**Inherits:** :ref:`Input` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index e29682dcd..ba332a939 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -3,11 +3,7 @@ InputEvent ========== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Built-in input event data. diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 3f2a1e05c..e78e3d26f 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -3,11 +3,7 @@ InputEventAction ================ -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_inputeventjoybutton.rst b/classes/class_inputeventjoybutton.rst index be6f62cb4..8cd1e62d0 100644 --- a/classes/class_inputeventjoybutton.rst +++ b/classes/class_inputeventjoybutton.rst @@ -3,11 +3,7 @@ InputEventJoyButton =================== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_inputeventjoymotion.rst b/classes/class_inputeventjoymotion.rst index 8308fb194..9c7424740 100644 --- a/classes/class_inputeventjoymotion.rst +++ b/classes/class_inputeventjoymotion.rst @@ -3,11 +3,7 @@ InputEventJoyMotion =================== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 8c5946c45..2c3d14d15 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -3,11 +3,7 @@ InputEventKey ============= -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index e72e169f6..0c1e87d19 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -3,11 +3,7 @@ InputEventMouseButton ===================== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index d95d5ccd1..52f3510fc 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -3,11 +3,7 @@ InputEventMouseMotion ===================== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index c6b67d200..55a5a4a84 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -3,11 +3,7 @@ InputEventScreenDrag ==================== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index bc9d05dd5..55bd67994 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -3,11 +3,7 @@ InputEventScreenTouch ===================== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 5690bca5c..bb51fe315 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -3,14 +3,9 @@ InputMap ======== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Singleton that manages actions. diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index e8a732fc3..f24a97d1c 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -3,14 +3,9 @@ InstancePlaceholder =================== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_int.rst b/classes/class_int.rst index 0ce147770..2290bb2d2 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -3,11 +3,7 @@ int === -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Integer built-in type. diff --git a/classes/class_intarray.rst b/classes/class_intarray.rst index a2a84293b..afca6308a 100644 --- a/classes/class_intarray.rst +++ b/classes/class_intarray.rst @@ -3,11 +3,7 @@ IntArray ======== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Integer Array. diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index 90b392a62..b94de0955 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -3,14 +3,9 @@ InterpolatedCamera ================== -Inherits: :ref:`Camera` -------------------------------------- +**Inherits:** :ref:`Camera` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 339269209..4ed17a802 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -3,14 +3,9 @@ IP == -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core IP Protocol support functions. @@ -65,7 +60,7 @@ Create a queue item for resolving a given hostname. The queue ID is returned, or - :ref:`int` **get_resolve_item_status** **(** :ref:`int` id **)** const -Return the status of hostname queued for resolving, given it's queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration. +Return the status of hostname queued for resolving, given it's queue ID. Returned status can be any of the RESOLVER_STATUS\_\* enumeration. .. _class_IP_get_resolve_item_address: diff --git a/classes/class_ip_unix.rst b/classes/class_ip_unix.rst index 0d0c107aa..497d422c1 100644 --- a/classes/class_ip_unix.rst +++ b/classes/class_ip_unix.rst @@ -3,14 +3,9 @@ IP_Unix ======= -Inherits: :ref:`IP` ------------------------------ +**Inherits:** :ref:`IP` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 4084ad8e5..0803d7c33 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -3,14 +3,9 @@ ItemList ======== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_joint.rst b/classes/class_joint.rst index b59d4016f..8028debea 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -3,14 +3,9 @@ Joint ===== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 5285d3916..0044669fa 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -3,14 +3,9 @@ Joint2D ======= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base node for all joint constraints in 2D phyisics. diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index fb42eae6c..47bcaeb2c 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -3,14 +3,9 @@ KinematicBody ============= -Inherits: :ref:`PhysicsBody` ------------------------------------------------ +**Inherits:** :ref:`PhysicsBody` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 443acb801..8f62828bd 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -3,14 +3,9 @@ KinematicBody2D =============== -Inherits: :ref:`PhysicsBody2D` ---------------------------------------------------- +**Inherits:** :ref:`PhysicsBody2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Kinematic body 2D node. diff --git a/classes/class_label.rst b/classes/class_label.rst index 539cb24f7..5d798fca0 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -3,14 +3,9 @@ Label ===== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Control that displays formatted text. @@ -89,25 +84,25 @@ Member Function Description - void **set_align** **(** :ref:`int` align **)** -Sets the alignment mode to any of the ALIGN_* enumeration values. +Sets the alignment mode to any of the ALIGN\_\* enumeration values. .. _class_Label_get_align: - :ref:`int` **get_align** **(** **)** const -Return the alignment mode (any of the ALIGN_* enumeration values). +Return the alignment mode (any of the ALIGN\_\* enumeration values). .. _class_Label_set_valign: - void **set_valign** **(** :ref:`int` valign **)** -Sets the vertical alignment mode to any of the VALIGN_* enumeration values. +Sets the vertical alignment mode to any of the VALIGN\_\* enumeration values. .. _class_Label_get_valign: - :ref:`int` **get_valign** **(** **)** const -Return the vertical alignment mode (any of the VALIGN_* enumeration values). +Return the vertical alignment mode (any of the VALIGN\_\* enumeration values). .. _class_Label_set_text: diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index 3388bd554..de84d357e 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -3,14 +3,9 @@ LargeTexture ============ -Inherits: :ref:`Texture` ---------------------------------------- +**Inherits:** :ref:`Texture` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_light.rst b/classes/class_light.rst index f200c5b67..4d8832b0f 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -3,14 +3,9 @@ Light ===== -Inherits: :ref:`VisualInstance` ------------------------------------------------------ +**Inherits:** :ref:`VisualInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Provides a base class for different kinds of light nodes. diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 78f818f3b..9cd6f4a84 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -3,14 +3,9 @@ Light2D ======= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index e261e1758..d99972082 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -3,14 +3,9 @@ LightOccluder2D =============== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 291757fe7..1175ded6d 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -3,14 +3,9 @@ LineEdit ======== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Control that provides single line string editing. @@ -151,7 +146,7 @@ Return the *editable* status of the :ref:`LineEdit` (see :ref:`s - void **set_secret** **(** :ref:`bool` enabled **)** -Set the *secret* status of the :ref:`LineEdit`. When enabled, every character is displayed as "*". +Set the *secret* status of the :ref:`LineEdit`. When enabled, every character is displayed as "\*". .. _class_LineEdit_is_secret: diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index b34126f36..846f12206 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -3,14 +3,9 @@ LineShape2D =========== -Inherits: :ref:`Shape2D` ---------------------------------------- +**Inherits:** :ref:`Shape2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Line shape for 2D collision objects. diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 3455c5c04..ec7de5b12 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -3,14 +3,9 @@ MainLoop ======== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Main loop is the abstract main loop base class. diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 233a17252..a737fd8c7 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -3,14 +3,9 @@ MarginContainer =============== -Inherits: :ref:`Container` -------------------------------------------- +**Inherits:** :ref:`Container` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Simple margin container. diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index b0fab3cb4..447e91e01 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -3,14 +3,9 @@ Marshalls ========= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_material.rst b/classes/class_material.rst index 05af04eba..9ecbbadf6 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -3,14 +3,9 @@ Material ======== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Abstract base :ref:`Resource` for coloring and shading geometry. @@ -68,13 +63,13 @@ Member Function Description - void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** -Set a :ref:`Material` flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. +Set a :ref:`Material` flag, which toggles on or off a behavior when rendering. See enumeration FLAG\_\* for a list. .. _class_Material_get_flag: - :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const -Return a :ref:`Material` flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. +Return a :ref:`Material` flag, which toggles on or off a behavior when rendering. See enumeration FLAG\_\* for a list. .. _class_Material_set_blend_mode: diff --git a/classes/class_materialshader.rst b/classes/class_materialshader.rst index 89972bed1..d4a447b60 100644 --- a/classes/class_materialshader.rst +++ b/classes/class_materialshader.rst @@ -3,14 +3,9 @@ MaterialShader ============== -Inherits: :ref:`Shader` -------------------------------------- +**Inherits:** :ref:`Shader` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_materialshadergraph.rst b/classes/class_materialshadergraph.rst index 0e73ec84a..954fdd772 100644 --- a/classes/class_materialshadergraph.rst +++ b/classes/class_materialshadergraph.rst @@ -3,14 +3,9 @@ MaterialShaderGraph =================== -Inherits: :ref:`ShaderGraph` ------------------------------------------------ +**Inherits:** :ref:`ShaderGraph` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_matrix3.rst b/classes/class_matrix3.rst index cfce192c1..ee5dc2a16 100644 --- a/classes/class_matrix3.rst +++ b/classes/class_matrix3.rst @@ -3,11 +3,7 @@ Matrix3 ======= -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types 3x3 matrix datatype. diff --git a/classes/class_matrix32.rst b/classes/class_matrix32.rst index b62ac48a4..4b719993f 100644 --- a/classes/class_matrix32.rst +++ b/classes/class_matrix32.rst @@ -3,11 +3,7 @@ Matrix32 ======== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types 3x2 Matrix for 2D transforms. diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 08d363e1c..894b75493 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -3,14 +3,9 @@ MenuButton ========== -Inherits: :ref:`Button` -------------------------------------- +**Inherits:** :ref:`Button` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Special button that brings up a :ref:`PopupMenu` when clicked. diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 524c2403c..d9bf6e129 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -3,14 +3,9 @@ Mesh ==== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core A :ref:`Resource` that contains vertex-array based geometry. @@ -132,7 +127,7 @@ Create a new surface (:ref:`get_surface_count` that will 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). -The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed. +The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT\_\* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed. .. _class_Mesh_get_surface_count: diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index c55628cd7..c40d3ad48 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -3,14 +3,9 @@ MeshDataTool ============ -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 2520397db..6fab14d7e 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -3,14 +3,9 @@ MeshInstance ============ -Inherits: :ref:`GeometryInstance` ---------------------------------------------------------- +**Inherits:** :ref:`GeometryInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Node that instances meshes into a :ref:`Scenario`. diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index c8cc16d03..83f423094 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -3,14 +3,9 @@ MeshLibrary =========== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Library of meshes. diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index fdffa8954..e539dd0ba 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -3,14 +3,9 @@ MultiMesh ========= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Provides high perfomance mesh instancing. diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index 53e202dae..4374bd48c 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -3,14 +3,9 @@ MultiMeshInstance ================= -Inherits: :ref:`GeometryInstance` ---------------------------------------------------------- +**Inherits:** :ref:`GeometryInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Node that instances a :ref:`MultiMesh`. diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 097f45506..d05d81662 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -3,14 +3,9 @@ Mutex ===== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index d12ef3819..a6fbc8ade 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -3,14 +3,9 @@ Navigation ========== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index e3dc9acaf..960d6eef6 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -3,14 +3,9 @@ Navigation2D ============ -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index fa4b89314..cd0a42da8 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -3,14 +3,9 @@ NavigationMesh ============== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index 39b3a66bf..9f75b4212 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -3,14 +3,9 @@ NavigationMeshInstance ====================== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 22311462e..cc48cdaf1 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -3,14 +3,9 @@ NavigationPolygon ================= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index 20943ef2e..a9debc8d8 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -3,14 +3,9 @@ NavigationPolygonInstance ========================= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_nil.rst b/classes/class_nil.rst index fcbe58fad..6e9e3e711 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -3,11 +3,7 @@ Nil === -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_node.rst b/classes/class_node.rst index ed3054110..797d5e684 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -3,14 +3,9 @@ Node ==== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for all the "Scene" elements. diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 98a2084f1..38ca9c2f6 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -3,14 +3,9 @@ Node2D ====== -Inherits: :ref:`CanvasItem` ---------------------------------------------- +**Inherits:** :ref:`CanvasItem` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base node for 2D system. diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 5935e998e..a45f009a9 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -3,11 +3,7 @@ NodePath ======== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Built-in type optimized for path traversing. diff --git a/classes/class_object.rst b/classes/class_object.rst index 8d13eb3fa..5ef2053f6 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -3,11 +3,7 @@ Object ====== -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for all non built-in types. @@ -136,7 +132,7 @@ Return a property, return null if the property does not exist. - :ref:`Array` **_get_property_list** **(** **)** virtual -Return the property list, array of dictionaries, dictionaries must countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). +Return the property list, array of dictionaries, dictionaries must countain: name:String, type:int (see TYPE\_\* enum in globals) and optionally: hint:int (see PROPERTY_HINT\_\* in globals), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in globals). .. _class_Object__init: @@ -186,7 +182,7 @@ Get a property from the object. - :ref:`Array` **get_property_list** **(** **)** const -Return the list of properties as an array of dictionaries, dictionaries countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). +Return the list of properties as an array of dictionaries, dictionaries countain: name:String, type:int (see TYPE\_\* enum in globals) and optionally: hint:int (see PROPERTY_HINT\_\* in globals), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in globals). .. _class_Object_get_method_list: @@ -244,7 +240,7 @@ Return the list of metadatas in the object. - void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=Array() **)** -Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from :ref:`@Global Scope` TYPE_*). +Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from :ref:`@Global Scope` TYPE\_\*). .. _class_Object_has_user_signal: @@ -290,7 +286,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: diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index e9d5b7f5c..0af37c51b 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -3,14 +3,9 @@ OccluderPolygon2D ================= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 155877208..274f9991d 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -3,14 +3,9 @@ OmniLight ========= -Inherits: :ref:`Light` ------------------------------------ +**Inherits:** :ref:`Light` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core OmniDirectional Light, such as a lightbulb or a candle. diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 33b38d412..f642c7da8 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -3,14 +3,9 @@ OptionButton ============ -Inherits: :ref:`Button` -------------------------------------- +**Inherits:** :ref:`Button` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Button control that provides selectable options when pressed. diff --git a/classes/class_os.rst b/classes/class_os.rst index b75b643a9..f03e62b1a 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -3,14 +3,9 @@ OS == -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Operating System functions. diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index cf7b3d1db..9f4d7f3ea 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -3,14 +3,9 @@ PackedDataContainer =================== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index dbbd9e5cf..a4cfe50cb 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -3,14 +3,9 @@ PackedDataContainerRef ====================== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 8a1dcf083..e52ed18bb 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -3,14 +3,9 @@ PackedScene =========== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index dd50f1470..8bd0de657 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -3,14 +3,9 @@ PacketPeer ========== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Abstraction and base class for packet-based protocols. diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 5041e4645..85b8f8ef0 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -3,14 +3,9 @@ PacketPeerStream ================ -Inherits: :ref:`PacketPeer` ---------------------------------------------- +**Inherits:** :ref:`PacketPeer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Wrapper to use a PacketPeer over a StreamPeer. diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 57e4647b5..a708834c3 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -3,14 +3,9 @@ PacketPeerUDP ============= -Inherits: :ref:`PacketPeer` ---------------------------------------------- +**Inherits:** :ref:`PacketPeer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_panel.rst b/classes/class_panel.rst index 13d87d1e3..b12c98c5e 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -3,14 +3,9 @@ Panel ===== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Provides an opaque background for :ref:`Control` children. diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index 3ba38edd4..dba59e864 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -3,14 +3,9 @@ PanelContainer ============== -Inherits: :ref:`Container` -------------------------------------------- +**Inherits:** :ref:`Container` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Panel container type. diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 59c876c8b..3a4a0ea6e 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -3,14 +3,9 @@ ParallaxBackground ================== -Inherits: :ref:`CanvasLayer` ------------------------------------------------ +**Inherits:** :ref:`CanvasLayer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 87b435c06..8ad484136 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -3,14 +3,9 @@ ParallaxLayer ============= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_particleattractor2d.rst b/classes/class_particleattractor2d.rst index 5c904103e..a44107e6e 100644 --- a/classes/class_particleattractor2d.rst +++ b/classes/class_particleattractor2d.rst @@ -3,14 +3,9 @@ ParticleAttractor2D =================== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_particles.rst b/classes/class_particles.rst index e85981f1f..80882c993 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -3,14 +3,9 @@ Particles ========= -Inherits: :ref:`GeometryInstance` ---------------------------------------------------------- +**Inherits:** :ref:`GeometryInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Particle system 3D Node @@ -189,13 +184,13 @@ Return the normal vector towards where gravity is pulling (by default, negative - void **set_variable** **(** :ref:`int` variable, :ref:`float` value **)** -Set a specific variable for the particle system (see VAR_* enum). +Set a specific variable for the particle system (see VAR\_\* enum). .. _class_Particles_get_variable: - :ref:`float` **get_variable** **(** :ref:`int` variable **)** const -Return a specific variable for the particle system (see VAR_* enum). +Return a specific variable for the particle system (see VAR\_\* enum). .. _class_Particles_set_randomness: diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 07def08a9..b37425a8e 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -3,14 +3,9 @@ Particles2D =========== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_patch9frame.rst b/classes/class_patch9frame.rst index cd9550e56..93c943fd8 100644 --- a/classes/class_patch9frame.rst +++ b/classes/class_patch9frame.rst @@ -3,14 +3,9 @@ Patch9Frame =========== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_path.rst b/classes/class_path.rst index 10ae0cee7..0ac09250f 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -3,14 +3,9 @@ Path ==== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Container for a :ref:`Curve3D`. diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 472dd69d8..3b5f05675 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -3,14 +3,9 @@ Path2D ====== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Container for a :ref:`Curve2D`. diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index 934e0e152..4ab3b7438 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -3,14 +3,9 @@ PathFollow ========== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Point sampler for a :ref:`Path`. diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index 448db39ad..e1551407f 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -3,14 +3,9 @@ PathFollow2D ============ -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Point sampler for a :ref:`Path2D`. diff --git a/classes/class_pathremap.rst b/classes/class_pathremap.rst index 9a271d026..ef96f181f 100644 --- a/classes/class_pathremap.rst +++ b/classes/class_pathremap.rst @@ -3,14 +3,9 @@ PathRemap ========= -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Singleton containing the list of remapped resources. diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index db5597c34..2062f5f04 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -3,14 +3,9 @@ PCKPacker ========= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_performance.rst b/classes/class_performance.rst index e4b92cc8d..a9c1df9a8 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -3,14 +3,9 @@ Performance =========== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index 36665dac6..056e375fa 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -3,14 +3,9 @@ PHashTranslation ================ -Inherits: :ref:`Translation` ------------------------------------------------ +**Inherits:** :ref:`Translation` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Optimized translation. diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 6999197eb..ff2643eeb 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -3,14 +3,9 @@ Physics2DDirectBodyState ======================== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Direct access object to a physics body in the :ref:`Physics2DServer`. diff --git a/classes/class_physics2ddirectbodystatesw.rst b/classes/class_physics2ddirectbodystatesw.rst index 52f18536b..9a1f28454 100644 --- a/classes/class_physics2ddirectbodystatesw.rst +++ b/classes/class_physics2ddirectbodystatesw.rst @@ -3,14 +3,9 @@ Physics2DDirectBodyStateSW ========================== -Inherits: :ref:`Physics2DDirectBodyState` -------------------------------------------------------------------------- +**Inherits:** :ref:`Physics2DDirectBodyState` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index d9fa3d019..845de7ea9 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -3,14 +3,9 @@ Physics2DDirectSpaceState ========================= -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Direct access object to a space in the :ref:`Physics2DServer`. diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 19b078bd1..d1eaf12c0 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -3,14 +3,9 @@ Physics2DServer =============== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Physics 2D Server. diff --git a/classes/class_physics2dserversw.rst b/classes/class_physics2dserversw.rst index 82d21ca93..6e4dd994a 100644 --- a/classes/class_physics2dserversw.rst +++ b/classes/class_physics2dserversw.rst @@ -3,14 +3,9 @@ Physics2DServerSW ================= -Inherits: :ref:`Physics2DServer` -------------------------------------------------------- +**Inherits:** :ref:`Physics2DServer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 9b99ef2c4..ea781c1a9 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -3,14 +3,9 @@ Physics2DShapeQueryParameters ============================= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index 5c4afcfaa..35cefffd0 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -3,14 +3,9 @@ Physics2DShapeQueryResult ========================= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index 476ce4f6f..ee5fc6dd9 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -3,14 +3,9 @@ Physics2DTestMotionResult ========================= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index e93ce7221..c77b78bbb 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -3,14 +3,9 @@ PhysicsBody =========== -Inherits: :ref:`CollisionObject` -------------------------------------------------------- +**Inherits:** :ref:`CollisionObject` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for different types of Physics bodies. diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index f229db76b..384482abe 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -3,14 +3,9 @@ PhysicsBody2D ============= -Inherits: :ref:`CollisionObject2D` ------------------------------------------------------------ +**Inherits:** :ref:`CollisionObject2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for all objects affected by physics. diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index 555045af3..5574c0c72 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -3,14 +3,9 @@ PhysicsDirectBodyState ====================== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physicsdirectbodystatesw.rst b/classes/class_physicsdirectbodystatesw.rst index 61eec79b1..6ef1439d8 100644 --- a/classes/class_physicsdirectbodystatesw.rst +++ b/classes/class_physicsdirectbodystatesw.rst @@ -3,14 +3,9 @@ PhysicsDirectBodyStateSW ======================== -Inherits: :ref:`PhysicsDirectBodyState` ---------------------------------------------------------------------- +**Inherits:** :ref:`PhysicsDirectBodyState` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index ea9f2504f..346519433 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -3,14 +3,9 @@ PhysicsDirectSpaceState ======================= -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index ee0b76236..0ccae1146 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -3,14 +3,9 @@ PhysicsServer ============= -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physicsserversw.rst b/classes/class_physicsserversw.rst index 74a1bab88..672dc1549 100644 --- a/classes/class_physicsserversw.rst +++ b/classes/class_physicsserversw.rst @@ -3,14 +3,9 @@ PhysicsServerSW =============== -Inherits: :ref:`PhysicsServer` ---------------------------------------------------- +**Inherits:** :ref:`PhysicsServer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 6911ba651..2261a5fa3 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -3,14 +3,9 @@ PhysicsShapeQueryParameters =========================== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index cf4d2ada9..85152e1c1 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -3,14 +3,9 @@ PhysicsShapeQueryResult ======================= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Result of a shape query in Physics2DServer. diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 797001c8f..174003f4a 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -3,14 +3,9 @@ PinJoint ======== -Inherits: :ref:`Joint` ------------------------------------ +**Inherits:** :ref:`Joint` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index ea1b3140f..79d8fbc53 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -3,14 +3,9 @@ PinJoint2D ========== -Inherits: :ref:`Joint2D` ---------------------------------------- +**Inherits:** :ref:`Joint2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Pin Joint for 2D Shapes. diff --git a/classes/class_plane.rst b/classes/class_plane.rst index a8ee4b650..5c843afa5 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -3,11 +3,7 @@ Plane ===== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Plane in hessian form. diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 1b6b98474..3ff32e1ca 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -3,14 +3,9 @@ PlaneShape ========== -Inherits: :ref:`Shape` ------------------------------------ +**Inherits:** :ref:`Shape` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 976d0e7c8..34b506dad 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -3,14 +3,9 @@ Polygon2D ========= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index b4dd7daa0..65a4122be 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -3,14 +3,9 @@ PolygonPathFinder ================= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 69d160dd7..b2cd2c47d 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -3,14 +3,9 @@ Popup ===== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base container control for popups and dialogs. diff --git a/classes/class_popupdialog.rst b/classes/class_popupdialog.rst index 44ceaf9ab..36205b004 100644 --- a/classes/class_popupdialog.rst +++ b/classes/class_popupdialog.rst @@ -3,14 +3,9 @@ PopupDialog =========== -Inherits: :ref:`Popup` ------------------------------------ +**Inherits:** :ref:`Popup` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for Popup Dialogs. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 0185d6574..f24cfcc3d 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -3,14 +3,9 @@ PopupMenu ========= -Inherits: :ref:`Popup` ------------------------------------ +**Inherits:** :ref:`Popup` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core PopupMenu displays a list of options. diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 056508113..4a679d0ff 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -3,14 +3,9 @@ PopupPanel ========== -Inherits: :ref:`Popup` ------------------------------------ +**Inherits:** :ref:`Popup` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for Popup Panels diff --git a/classes/class_portal.rst b/classes/class_portal.rst index 3fedd1325..30165e186 100644 --- a/classes/class_portal.rst +++ b/classes/class_portal.rst @@ -3,14 +3,9 @@ Portal ====== -Inherits: :ref:`VisualInstance` ------------------------------------------------------ +**Inherits:** :ref:`VisualInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Portals provide virtual openings to rooms. diff --git a/classes/class_position2d.rst b/classes/class_position2d.rst index 272f31326..ca0a4011b 100644 --- a/classes/class_position2d.rst +++ b/classes/class_position2d.rst @@ -3,14 +3,9 @@ Position2D ========== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Generic 2D Position hint for editing. diff --git a/classes/class_position3d.rst b/classes/class_position3d.rst index 8693184e2..6851b05ae 100644 --- a/classes/class_position3d.rst +++ b/classes/class_position3d.rst @@ -3,14 +3,9 @@ Position3D ========== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Generic 3D Position hint for editing diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 99cbf0c62..aa369a228 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -3,14 +3,9 @@ ProgressBar =========== -Inherits: :ref:`Range` ------------------------------------ +**Inherits:** :ref:`Range` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core General purpose progress bar. diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 0e86b9650..95553a36d 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -3,14 +3,9 @@ ProximityGroup ============== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core General purpose proximity-detection node. diff --git a/classes/class_quad.rst b/classes/class_quad.rst index d27bab2a4..fb3ef2a92 100644 --- a/classes/class_quad.rst +++ b/classes/class_quad.rst @@ -3,14 +3,9 @@ Quad ==== -Inherits: :ref:`GeometryInstance` ---------------------------------------------------------- +**Inherits:** :ref:`GeometryInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 7c9b85614..2d8a0f4cd 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -3,11 +3,7 @@ Quat ==== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Quaternion. diff --git a/classes/class_range.rst b/classes/class_range.rst index 5e39a9e4d..11bdcb8df 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -3,14 +3,9 @@ Range ===== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Abstract base class for range-based controls. diff --git a/classes/class_rawarray.rst b/classes/class_rawarray.rst index 3786c2263..4744e7968 100644 --- a/classes/class_rawarray.rst +++ b/classes/class_rawarray.rst @@ -3,11 +3,7 @@ RawArray ======== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Raw byte array. diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 51fb511ce..2a56c76d0 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -3,14 +3,9 @@ RayCast ======= -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 42afe89e1..e751964a1 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -3,14 +3,9 @@ RayCast2D ========= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 9a2fa35da..fc27cc2cb 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -3,14 +3,9 @@ RayShape ======== -Inherits: :ref:`Shape` ------------------------------------ +**Inherits:** :ref:`Shape` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 6e16a0e2e..37a4a93c7 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -3,14 +3,9 @@ RayShape2D ========== -Inherits: :ref:`Shape2D` ---------------------------------------- +**Inherits:** :ref:`Shape2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Ray 2D shape resource for physics. diff --git a/classes/class_realarray.rst b/classes/class_realarray.rst index fccab8c39..afd3a9d73 100644 --- a/classes/class_realarray.rst +++ b/classes/class_realarray.rst @@ -3,11 +3,7 @@ RealArray ========= -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Real Array . diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 045946ccf..ff9214c8d 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -3,11 +3,7 @@ Rect2 ===== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types 2D Axis-aligned bounding box. diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 83c9969c0..e10e1f786 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -3,14 +3,9 @@ RectangleShape2D ================ -Inherits: :ref:`Shape2D` ---------------------------------------- +**Inherits:** :ref:`Shape2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Rectangle Shape for 2D Physics. diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 2b65b23b6..6ebf6eb81 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -3,14 +3,9 @@ Reference ========= -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for anything that keeps a reference count. diff --git a/classes/class_referenceframe.rst b/classes/class_referenceframe.rst index 3845a69d8..bfa48403f 100644 --- a/classes/class_referenceframe.rst +++ b/classes/class_referenceframe.rst @@ -3,14 +3,9 @@ ReferenceFrame ============== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Reference frame for GUI. diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 68eba74fd..ccf53e5f6 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -3,14 +3,9 @@ RegEx ===== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Simple regular expression matcher. @@ -52,11 +47,11 @@ Shorthand caracter classes :ref:`code`\w \W \s \S \d \D:ref:`/code`:ref:`A-Za-z`:ref:`/code` -Simple quantifiers :ref:`code`?:ref:`/code`, :ref:`code`*:ref:`/code` and :ref:`code`+:ref:`/code` +Simple quantifiers :ref:`code`?:ref:`/code`, :ref:`code`\*:ref:`/code` and :ref:`code`+:ref:`/code` Range quantifiers :ref:`code`{x,y}:ref:`/code` -Lazy (non-greedy) quantifiers :ref:`code`*?:ref:`/code` +Lazy (non-greedy) quantifiers :ref:`code`\*?:ref:`/code` Begining :ref:`code`^:ref:`/code` and end :ref:`code`$:ref:`/code` anchors diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 750be0fdd..8f1faf846 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -3,14 +3,9 @@ RemoteTransform2D ================= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_rendertargettexture.rst b/classes/class_rendertargettexture.rst index 6d184d377..5bd795129 100644 --- a/classes/class_rendertargettexture.rst +++ b/classes/class_rendertargettexture.rst @@ -3,14 +3,9 @@ RenderTargetTexture =================== -Inherits: :ref:`Texture` ---------------------------------------- +**Inherits:** :ref:`Texture` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_resource.rst b/classes/class_resource.rst index d1abf9560..8bcf65019 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -3,14 +3,9 @@ Resource ======== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for all resources. diff --git a/classes/class_resourceimportmetadata.rst b/classes/class_resourceimportmetadata.rst index 3c0b0151a..fca2fb0e7 100644 --- a/classes/class_resourceimportmetadata.rst +++ b/classes/class_resourceimportmetadata.rst @@ -3,14 +3,9 @@ ResourceImportMetadata ====================== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index cd9ed0a9a..ee4693165 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -3,14 +3,9 @@ ResourceInteractiveLoader ========================= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Interactive Resource Loader. diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index b01477307..5cd267f58 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -3,14 +3,9 @@ ResourceLoader ============== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Resource Loader. diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 127f772a0..5ff304600 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -3,14 +3,9 @@ ResourcePreloader ================= -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Resource Preloader Node. diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 3023cba96..3ed8e9e7d 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -3,14 +3,9 @@ ResourceSaver ============= -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Resource Saving Interface. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 94624cf2b..1838bf5ae 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -3,14 +3,9 @@ RichTextLabel ============= -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Label that displays rich text. diff --git a/classes/class_rid.rst b/classes/class_rid.rst index 33a70dc6c..ced0f431e 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -3,11 +3,7 @@ RID === -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index a5f54c6a4..602c5bdc8 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -3,14 +3,9 @@ RigidBody ========= -Inherits: :ref:`PhysicsBody` ------------------------------------------------ +**Inherits:** :ref:`PhysicsBody` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index bcbee426e..ebe318ea2 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -3,14 +3,9 @@ RigidBody2D =========== -Inherits: :ref:`PhysicsBody2D` ---------------------------------------------------- +**Inherits:** :ref:`PhysicsBody2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Rigid body 2D node. @@ -138,7 +133,7 @@ Override this function to use a custom force integrator. This allows to hook up - void **set_mode** **(** :ref:`int` mode **)** -Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. +Set the body mode, from the MODE\_\* enum. This allows to change to a static body or a character body. .. _class_RigidBody2D_get_mode: @@ -294,7 +289,7 @@ Return whether contact monitoring is enabled. - void **set_continuous_collision_detection_mode** **(** :ref:`int` mode **)** -Set the continuous collision detection mode from the enum CCD_MODE_*. +Set the continuous collision detection mode from the enum CCD_MODE\_\*. Coninuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fat-moving objects. diff --git a/classes/class_room.rst b/classes/class_room.rst index 1111813b2..f87edfa4f 100644 --- a/classes/class_room.rst +++ b/classes/class_room.rst @@ -3,14 +3,9 @@ Room ==== -Inherits: :ref:`VisualInstance` ------------------------------------------------------ +**Inherits:** :ref:`VisualInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Room data resource. diff --git a/classes/class_roombounds.rst b/classes/class_roombounds.rst index 410ece7da..f589698fb 100644 --- a/classes/class_roombounds.rst +++ b/classes/class_roombounds.rst @@ -3,14 +3,9 @@ RoomBounds ========== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_sample.rst b/classes/class_sample.rst index a65259633..60f3645ad 100644 --- a/classes/class_sample.rst +++ b/classes/class_sample.rst @@ -3,14 +3,9 @@ Sample ====== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Audio sample (sound) class. @@ -69,7 +64,7 @@ Member Function Description - void **create** **(** :ref:`int` format, :ref:`bool` stereo, :ref:`int` length **)** -Create new data for the sample, with format (see FORMAT_* constants), stereo hint, and length in samples (not bytes). +Create new data for the sample, with format (see FORMAT\_\* constants), stereo hint, and length in samples (not bytes). Calling this method overrides previously existing data. Stereo samples are interleaved pairs of left and right points (in that order), but count as one sample for length purposes. @@ -127,7 +122,7 @@ Return the mix rate for the sample. - void **set_loop_format** **(** :ref:`int` format **)** -Set the loop format (use LOOP_* constants as argument). +Set the loop format (use LOOP\_\* constants as argument). .. _class_Sample_get_loop_format: diff --git a/classes/class_samplelibrary.rst b/classes/class_samplelibrary.rst index c05ec87ce..ea8c11d47 100644 --- a/classes/class_samplelibrary.rst +++ b/classes/class_samplelibrary.rst @@ -3,14 +3,9 @@ SampleLibrary ============= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Library that contains a collection of samples. diff --git a/classes/class_sampleplayer.rst b/classes/class_sampleplayer.rst index 4ceff2d54..ddb48cac2 100644 --- a/classes/class_sampleplayer.rst +++ b/classes/class_sampleplayer.rst @@ -3,14 +3,9 @@ SamplePlayer ============ -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Sample Player node. @@ -233,7 +228,7 @@ Optionally, for hardware than support 3D sound, one can also set depth and heigh - void **set_filter** **(** :ref:`int` voice, :ref:`int` type, :ref:`float` cutoff_hz, :ref:`float` resonance, :ref:`float` gain=0 **)** -Set the filter for a given voice, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). +Set the filter for a given voice, using the given type (see FILTER\_\* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). Optionally, a gain can also be given (from 0 to 2.0). @@ -247,7 +242,7 @@ Set the chorus send level of a voice (from 0 to 1.0). For setting chorus paramet - void **set_reverb** **(** :ref:`int` voice, :ref:`int` room_type, :ref:`float` send **)** -Set the reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of a voice. +Set the reverberation type (see REVERB\_\* constants) and send level (from 0 to 1.0) of a voice. .. _class_SamplePlayer_get_mix_rate: @@ -295,7 +290,7 @@ Return the current pan height for a given voice. - :ref:`int` **get_filter_type** **(** :ref:`int` voice **)** const -Return the current filter type in use (see FILTER_* constants) for a given voice. +Return the current filter type in use (see FILTER\_\* constants) for a given voice. .. _class_SamplePlayer_get_filter_cutoff: @@ -325,7 +320,7 @@ Return the current chorus send level for a given voice. - :ref:`int` **get_reverb_room** **(** :ref:`int` voice **)** const -Return the current reverberation room type for a given voice (see REVERB_* enum). +Return the current reverberation room type for a given voice (see REVERB\_\* enum). .. _class_SamplePlayer_get_reverb: @@ -369,7 +364,7 @@ Optionally, for hardware than support 3D sound, one can also set depth and heigh - void **set_default_filter** **(** :ref:`int` type, :ref:`float` cutoff_hz, :ref:`float` resonance, :ref:`float` gain=0 **)** -Set the default filter for the player, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). +Set the default filter for the player, using the given type (see FILTER\_\* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). Optionally, a gain can also be given (from 0 to 2.0). @@ -383,7 +378,7 @@ Set the default chorus send level of the player (from 0 to 1.0). For setting cho - void **set_default_reverb** **(** :ref:`int` room_type, :ref:`float` send **)** -Set the default reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of the player. +Set the default reverberation type (see REVERB\_\* constants) and send level (from 0 to 1.0) of the player. .. _class_SamplePlayer_get_default_pitch_scale: @@ -425,7 +420,7 @@ Return the default pan height of the player. - :ref:`int` **get_default_filter_type** **(** **)** const -Return the default filter type in use (see FILTER_* constants) for the player. +Return the default filter type in use (see FILTER\_\* constants) for the player. .. _class_SamplePlayer_get_default_filter_cutoff: @@ -455,7 +450,7 @@ Return the default chorus send level of the player. - :ref:`int` **get_default_reverb_room** **(** **)** const -Return the default reverberation room type of the player (see REVERB_* enum). +Return the default reverberation room type of the player (see REVERB\_\* enum). .. _class_SamplePlayer_get_default_reverb: diff --git a/classes/class_sampleplayer2d.rst b/classes/class_sampleplayer2d.rst index 697ff705a..5c286e280 100644 --- a/classes/class_sampleplayer2d.rst +++ b/classes/class_sampleplayer2d.rst @@ -3,14 +3,9 @@ SamplePlayer2D ============== -Inherits: :ref:`SoundPlayer2D` ---------------------------------------------------- +**Inherits:** :ref:`SoundPlayer2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Sample player for positional 2D Sound. @@ -127,9 +122,9 @@ Set the amplitude for random pitch scale variations. If different from zero, the The actual pitch scale will be, with "variation" ranging from -val to val: -* variation > 0: 1.0 + variation +\* variation > 0: 1.0 + variation -* variation < 0: 1.0/(1.0 - variation) +\* variation < 0: 1.0/(1.0 - variation) .. _class_SamplePlayer2D_get_random_pitch_scale: diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index bdd4f97e2..bbc6c1765 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -3,14 +3,9 @@ SceneState ========== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index bf4e4fc33..2f0e991e9 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -3,14 +3,9 @@ SceneTree ========= -Inherits: :ref:`MainLoop` ------------------------------------------ +**Inherits:** :ref:`MainLoop` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_script.rst b/classes/class_script.rst index 47f1a66e7..fb8261ec9 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -3,14 +3,9 @@ Script ====== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for scripts. diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index ef375cfb9..4d69845ea 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -3,14 +3,9 @@ ScrollBar ========= -Inherits: :ref:`Range` ------------------------------------ +**Inherits:** :ref:`Range` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for scroll bars. diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 2e09ec720..e62cfae76 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -3,14 +3,9 @@ ScrollContainer =============== -Inherits: :ref:`Container` -------------------------------------------- +**Inherits:** :ref:`Container` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core A helper node for displaying scollable elements (e.g. lists). diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 9c35553d9..de2e12518 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -3,14 +3,9 @@ SegmentShape2D ============== -Inherits: :ref:`Shape2D` ---------------------------------------- +**Inherits:** :ref:`Shape2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Segment Shape for 2D Collision Detection. diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 4f28d0461..1fbd9b7e1 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -3,14 +3,9 @@ Semaphore ========= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_separator.rst b/classes/class_separator.rst index 8a9550adb..c450b64c6 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -3,14 +3,9 @@ Separator ========= -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for separators. diff --git a/classes/class_shader.rst b/classes/class_shader.rst index bd16402b3..645e5ec39 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -3,14 +3,9 @@ Shader ====== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core To be changed, ignore. diff --git a/classes/class_shadergraph.rst b/classes/class_shadergraph.rst index c804e1a0e..25bde308f 100644 --- a/classes/class_shadergraph.rst +++ b/classes/class_shadergraph.rst @@ -3,14 +3,9 @@ ShaderGraph =========== -Inherits: :ref:`Shader` -------------------------------------- +**Inherits:** :ref:`Shader` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 3326c84a9..e525df788 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -3,14 +3,9 @@ ShaderMaterial ============== -Inherits: :ref:`Material` ------------------------------------------ +**Inherits:** :ref:`Material` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_shape.rst b/classes/class_shape.rst index e413d669a..4a2de711a 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -3,14 +3,9 @@ Shape ===== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 9de8182e9..f7ee43d41 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -3,14 +3,9 @@ Shape2D ======= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for all 2D Shapes. diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index e495188c1..7e863d991 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -3,14 +3,9 @@ Skeleton ======== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Skeleton for characters and animated objects. diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 71818e7e7..19362e41d 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -3,14 +3,9 @@ Slider ====== -Inherits: :ref:`Range` ------------------------------------ +**Inherits:** :ref:`Range` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for GUI Sliders. diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 493a02be6..7f7786429 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -3,14 +3,9 @@ SliderJoint =========== -Inherits: :ref:`Joint` ------------------------------------ +**Inherits:** :ref:`Joint` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_soundplayer2d.rst b/classes/class_soundplayer2d.rst index 412978335..e8ba70cc6 100644 --- a/classes/class_soundplayer2d.rst +++ b/classes/class_soundplayer2d.rst @@ -3,14 +3,9 @@ SoundPlayer2D ============= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for playing spatial 2D sound. diff --git a/classes/class_soundroomparams.rst b/classes/class_soundroomparams.rst index 2d83d1d3a..fbf421924 100644 --- a/classes/class_soundroomparams.rst +++ b/classes/class_soundroomparams.rst @@ -3,14 +3,9 @@ SoundRoomParams =============== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 29046473c..596de0a89 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -3,14 +3,9 @@ Spatial ======= -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for all 3D nodes. diff --git a/classes/class_spatialplayer.rst b/classes/class_spatialplayer.rst index fa0c26dea..d0ef977b5 100644 --- a/classes/class_spatialplayer.rst +++ b/classes/class_spatialplayer.rst @@ -3,14 +3,9 @@ SpatialPlayer ============= -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_spatialsampleplayer.rst b/classes/class_spatialsampleplayer.rst index 8d1ebd4ec..3396e8b2b 100644 --- a/classes/class_spatialsampleplayer.rst +++ b/classes/class_spatialsampleplayer.rst @@ -3,14 +3,9 @@ SpatialSamplePlayer =================== -Inherits: :ref:`SpatialPlayer` ---------------------------------------------------- +**Inherits:** :ref:`SpatialPlayer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_spatialsound2dserver.rst b/classes/class_spatialsound2dserver.rst index 6d4900e3c..9a68f606f 100644 --- a/classes/class_spatialsound2dserver.rst +++ b/classes/class_spatialsound2dserver.rst @@ -3,14 +3,9 @@ SpatialSound2DServer ==================== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Server for Spatial 2D Sound. diff --git a/classes/class_spatialsound2dserversw.rst b/classes/class_spatialsound2dserversw.rst index 062b3e468..ba8a5d327 100644 --- a/classes/class_spatialsound2dserversw.rst +++ b/classes/class_spatialsound2dserversw.rst @@ -3,14 +3,9 @@ SpatialSound2DServerSW ====================== -Inherits: :ref:`SpatialSound2DServer` ------------------------------------------------------------------ +**Inherits:** :ref:`SpatialSound2DServer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_spatialsoundserver.rst b/classes/class_spatialsoundserver.rst index 6626ab229..039251bdd 100644 --- a/classes/class_spatialsoundserver.rst +++ b/classes/class_spatialsoundserver.rst @@ -3,14 +3,9 @@ SpatialSoundServer ================== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_spatialsoundserversw.rst b/classes/class_spatialsoundserversw.rst index eac102bee..a0e05a435 100644 --- a/classes/class_spatialsoundserversw.rst +++ b/classes/class_spatialsoundserversw.rst @@ -3,14 +3,9 @@ SpatialSoundServerSW ==================== -Inherits: :ref:`SpatialSoundServer` -------------------------------------------------------------- +**Inherits:** :ref:`SpatialSoundServer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_spatialstreamplayer.rst b/classes/class_spatialstreamplayer.rst index d031abb23..b5879e0c7 100644 --- a/classes/class_spatialstreamplayer.rst +++ b/classes/class_spatialstreamplayer.rst @@ -3,14 +3,9 @@ SpatialStreamPlayer =================== -Inherits: :ref:`SpatialPlayer` ---------------------------------------------------- +**Inherits:** :ref:`SpatialPlayer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 4950852cd..290a71217 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -3,14 +3,9 @@ SphereShape =========== -Inherits: :ref:`Shape` ------------------------------------ +**Inherits:** :ref:`Shape` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 18c1fb729..b58e7ed46 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -3,14 +3,9 @@ SpinBox ======= -Inherits: :ref:`Range` ------------------------------------ +**Inherits:** :ref:`Range` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Numerical input text field. diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index fe78cc88e..133b180f0 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -3,14 +3,9 @@ SplitContainer ============== -Inherits: :ref:`Container` -------------------------------------------- +**Inherits:** :ref:`Container` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Container for splitting and adjusting. diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index ec1ae4ebd..2e639530a 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -3,14 +3,9 @@ SpotLight ========= -Inherits: :ref:`Light` ------------------------------------ +**Inherits:** :ref:`Light` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Spotlight :ref:`Light`, such as a reflector spotlight or a latern. diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 3530cee69..94f889e80 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -3,14 +3,9 @@ Sprite ====== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core General purpose Sprite node. diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 0f96343d4..fb5cab9ba 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -3,14 +3,9 @@ Sprite3D ======== -Inherits: :ref:`SpriteBase3D` -------------------------------------------------- +**Inherits:** :ref:`SpriteBase3D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 11955209d..6362d37b5 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -3,14 +3,9 @@ SpriteBase3D ============ -Inherits: :ref:`GeometryInstance` ---------------------------------------------------------- +**Inherits:** :ref:`GeometryInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 2b907f557..19853d597 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -3,14 +3,9 @@ SpriteFrames ============ -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Sprite frame library for AnimatedSprite. diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index cb363dd59..16628d0ad 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -3,14 +3,9 @@ StaticBody ========== -Inherits: :ref:`PhysicsBody` ------------------------------------------------ +**Inherits:** :ref:`PhysicsBody` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core PhysicsBody for static collision objects. diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index ae8c5fe2c..dd703a4d3 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -3,14 +3,9 @@ StaticBody2D ============ -Inherits: :ref:`PhysicsBody2D` ---------------------------------------------------- +**Inherits:** :ref:`PhysicsBody2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Static body for 2D Physics. diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 371d7de5c..079a2e7f4 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -3,14 +3,9 @@ StreamPeer ========== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Abstraction and base class for stream-based protocols. diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index e78f07702..0314f1ec3 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -3,14 +3,9 @@ StreamPeerSSL ============= -Inherits: :ref:`StreamPeer` ---------------------------------------------- +**Inherits:** :ref:`StreamPeer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index c73326f26..66831c876 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -3,14 +3,9 @@ StreamPeerTCP ============= -Inherits: :ref:`StreamPeer` ---------------------------------------------- +**Inherits:** :ref:`StreamPeer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core TCP Stream peer. diff --git a/classes/class_streamplayer.rst b/classes/class_streamplayer.rst index 72e7a1cdb..ee87a7458 100644 --- a/classes/class_streamplayer.rst +++ b/classes/class_streamplayer.rst @@ -3,14 +3,9 @@ StreamPlayer ============ -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for audio stream playback. diff --git a/classes/class_string.rst b/classes/class_string.rst index 4577bcc39..c243bfc65 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -3,11 +3,7 @@ String ====== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Built-in string class. @@ -284,13 +280,13 @@ Return the length of the string in characters. - :ref:`bool` **match** **(** :ref:`String` expr **)** -Do a simple expression matching, using ? and * wildcards. +Do a simple expression matching, using ? and \* wildcards. .. _class_String_matchn: - :ref:`bool` **matchn** **(** :ref:`String` expr **)** -Do a simple, case insensitive, expression matching, using ? and * wildcards. +Do a simple, case insensitive, expression matching, using ? and \* wildcards. .. _class_String_md5_buffer: diff --git a/classes/class_stringarray.rst b/classes/class_stringarray.rst index 8c5e2814a..fe8023663 100644 --- a/classes/class_stringarray.rst +++ b/classes/class_stringarray.rst @@ -3,11 +3,7 @@ StringArray =========== -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types String Array. diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 4812c29c2..59da312c7 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -3,14 +3,9 @@ StyleBox ======== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for drawing stylized boxes for the UI. @@ -53,19 +48,19 @@ Test a position in a rectangle, return wether it pases the mask test. - void **set_default_margin** **(** :ref:`int` margin, :ref:`float` offset **)** -Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. +Set the default offset "offset" of the margin "margin" (see MARGIN\_\* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. .. _class_StyleBox_get_default_margin: - :ref:`float` **get_default_margin** **(** :ref:`int` margin **)** const -Return the default offset of the margin "margin" (see MARGIN_* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. +Return the default offset of the margin "margin" (see MARGIN\_\* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. .. _class_StyleBox_get_margin: - :ref:`float` **get_margin** **(** :ref:`int` margin **)** const -Return the offset of margin "margin" (see MARGIN_* enum). +Return the offset of margin "margin" (see MARGIN\_\* enum). .. _class_StyleBox_get_minimum_size: diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index d3c772705..62d00cd36 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -3,14 +3,9 @@ StyleBoxEmpty ============= -Inherits: :ref:`StyleBox` ------------------------------------------ +**Inherits:** :ref:`StyleBox` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Empty stylebox (does not display anything). diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index e12243d75..9b532df7e 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -3,14 +3,9 @@ StyleBoxFlat ============ -Inherits: :ref:`StyleBox` ------------------------------------------ +**Inherits:** :ref:`StyleBox` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Stylebox of a single color. diff --git a/classes/class_styleboximagemask.rst b/classes/class_styleboximagemask.rst index 753a19043..969786d1f 100644 --- a/classes/class_styleboximagemask.rst +++ b/classes/class_styleboximagemask.rst @@ -3,14 +3,9 @@ StyleBoxImageMask ================= -Inherits: :ref:`StyleBox` ------------------------------------------ +**Inherits:** :ref:`StyleBox` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Image mask based StyleBox, for mask test. @@ -67,12 +62,12 @@ Return wether the expand property is set(default). When expanding, the image wil - void **set_expand_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** -Set an expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. +Set an expand margin size (from enum MARGIN\_\*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. .. _class_StyleBoxImageMask_get_expand_margin_size: - :ref:`float` **get_expand_margin_size** **(** :ref:`int` margin **)** const -Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. +Return the expand margin size (from enum MARGIN\_\*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index b3059561c..3e5d6e59f 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -3,14 +3,9 @@ StyleBoxTexture =============== -Inherits: :ref:`StyleBox` ------------------------------------------ +**Inherits:** :ref:`StyleBox` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Texture Based 3x3 scale style. diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index f9c2d0cd2..7a3636a11 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -3,14 +3,9 @@ SurfaceTool =========== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Helper tool to create geometry. diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 04beee4c5..8196b0be8 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -3,14 +3,9 @@ TabContainer ============ -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Tabbed Container. @@ -95,13 +90,13 @@ Return the current tab that is being showed. - void **set_tab_align** **(** :ref:`int` align **)** -Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. +Set tab alignment, from the ALIGN\_\* enum. Moves tabs to the left, right or center. .. _class_TabContainer_get_tab_align: - :ref:`int` **get_tab_align** **(** **)** const -Return tab alignment, from the ALIGN_* enum. +Return tab alignment, from the ALIGN\_\* enum. .. _class_TabContainer_set_tabs_visible: diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index d314a243e..5bf85994e 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -3,14 +3,9 @@ Tabs ==== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Tabs Control. diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index df7b983e9..6483e87fa 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -3,14 +3,9 @@ TCP_Server ========== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core TCP Server. diff --git a/classes/class_testcube.rst b/classes/class_testcube.rst index 4b07765da..7eec1b41e 100644 --- a/classes/class_testcube.rst +++ b/classes/class_testcube.rst @@ -3,14 +3,9 @@ TestCube ======== -Inherits: :ref:`GeometryInstance` ---------------------------------------------------------- +**Inherits:** :ref:`GeometryInstance` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 7f7c58e02..b529f050c 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -3,14 +3,9 @@ TextEdit ======== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Multiline text editing control. @@ -253,7 +248,7 @@ Return the text inside the selection. - :ref:`IntArray` **search** **(** :ref:`String` flags, :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line **)** const -Perform a search inside the text. Search flags can be specified in the SEARCH_* enum. +Perform a search inside the text. Search flags can be specified in the SEARCH\_\* enum. .. _class_TextEdit_undo: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 7b84685fe..227b743dd 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -3,14 +3,9 @@ Texture ======= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Texture for 2D and 3D. diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index a6ca57833..e6db65ee3 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -3,14 +3,9 @@ TextureButton ============= -Inherits: :ref:`BaseButton` ---------------------------------------------- +**Inherits:** :ref:`BaseButton` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Button that can be themed with textures. diff --git a/classes/class_textureframe.rst b/classes/class_textureframe.rst index 5fe940d2d..e31ad72cc 100644 --- a/classes/class_textureframe.rst +++ b/classes/class_textureframe.rst @@ -3,14 +3,9 @@ TextureFrame ============ -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Control Frame that draws a texture. diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index ad427f098..69f764a2f 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -3,14 +3,9 @@ TextureProgress =============== -Inherits: :ref:`Range` ------------------------------------ +**Inherits:** :ref:`Range` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Textured progress bar implementation. diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 3326aff0e..15a337da6 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -3,14 +3,9 @@ Theme ===== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Theme for controls. diff --git a/classes/class_thread.rst b/classes/class_thread.rst index e45ef1da4..43319436f 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -3,14 +3,9 @@ Thread ====== -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index e902ccec3..fcd591b82 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -3,14 +3,9 @@ TileMap ======= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Node for 2D tile-based games. @@ -147,7 +142,7 @@ Return the current tileset. - void **set_mode** **(** :ref:`int` mode **)** -Set the orientation mode as square, isometric or custom (use MODE_* constants as argument). +Set the orientation mode as square, isometric or custom (use MODE\_\* constants as argument). .. _class_TileMap_get_mode: @@ -159,7 +154,7 @@ Return the orientation mode. - void **set_half_offset** **(** :ref:`int` half_offset **)** -Set an half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument). +Set an half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET\_\* constants as argument). Half offset sets every other tile off by a half tile size in the specified direction. @@ -211,7 +206,7 @@ Return the quadrant size. - void **set_tile_origin** **(** :ref:`int` origin **)** -Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument). +Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN\_\* constants as argument). .. _class_TileMap_get_tile_origin: diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index a38c80a2e..ffb862383 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -3,14 +3,9 @@ TileSet ======= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Tile library for tilemaps. diff --git a/classes/class_timer.rst b/classes/class_timer.rst index d3e2070ca..8a92133ad 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -3,14 +3,9 @@ Timer ===== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core @@ -118,7 +113,7 @@ Return the time left for timeout in seconds if the timer is active, 0 otherwise. - void **set_timer_process_mode** **(** :ref:`int` mode **)** -Set the timer's processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument). +Set the timer's processing mode (fixed or idle, use TIMER_PROCESS\_\* constants as argument). .. _class_Timer_get_timer_process_mode: diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index 234da4945..88878b090 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -3,14 +3,9 @@ ToolButton ========== -Inherits: :ref:`Button` -------------------------------------- +**Inherits:** :ref:`Button` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 9bfb68bac..f99dfe2f6 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -3,14 +3,9 @@ TouchScreenButton ================= -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_transform.rst b/classes/class_transform.rst index c2767da20..904aedf5a 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -3,11 +3,7 @@ Transform ========= -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types 3D Transformation. diff --git a/classes/class_translation.rst b/classes/class_translation.rst index a8581d646..30bd413f5 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -3,14 +3,9 @@ Translation =========== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Language Translation. diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index ead98f90c..4ca3631e6 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -3,14 +3,9 @@ TranslationServer ================= -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Server that manages all translations. Translations can be set to it and removed from it. diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 7e0df2ae9..555267f01 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -3,14 +3,9 @@ Tree ==== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 88c590275..de3f11692 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -3,14 +3,9 @@ TreeItem ======== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_tween.rst b/classes/class_tween.rst index d563f74c5..a3aebd36b 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -3,14 +3,9 @@ Tween ===== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index a62bd9839..366faebcf 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -3,14 +3,9 @@ UndoRedo ======== -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index e13f66b8b..24955eeef 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -3,14 +3,9 @@ VBoxContainer ============= -Inherits: :ref:`BoxContainer` -------------------------------------------------- +**Inherits:** :ref:`BoxContainer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Vertical box container. diff --git a/classes/class_vbuttonarray.rst b/classes/class_vbuttonarray.rst index 1a6c35825..63a295094 100644 --- a/classes/class_vbuttonarray.rst +++ b/classes/class_vbuttonarray.rst @@ -3,14 +3,9 @@ VButtonArray ============ -Inherits: :ref:`ButtonArray` ------------------------------------------------ +**Inherits:** :ref:`ButtonArray` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Vertical button array. diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index b66257d85..1d2176c43 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -3,11 +3,7 @@ Vector2 ======= -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Vector used for 2D Math. diff --git a/classes/class_vector2array.rst b/classes/class_vector2array.rst index bc83a8075..e1019f54c 100644 --- a/classes/class_vector2array.rst +++ b/classes/class_vector2array.rst @@ -3,11 +3,7 @@ Vector2Array ============ -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types An Array of Vector2. diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index fea298376..474135f2a 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -3,11 +3,7 @@ Vector3 ======= -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types Vector class, which performs basic 3D vector math operations. diff --git a/classes/class_vector3array.rst b/classes/class_vector3array.rst index 319cbadc9..12be4b7b5 100644 --- a/classes/class_vector3array.rst +++ b/classes/class_vector3array.rst @@ -3,11 +3,7 @@ Vector3Array ============ -Category: Built-In Types ------------------------- - -Brief Description ------------------ +**Category:** Built-In Types An Array of Vector3. diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index c3bc8a715..24958cb7d 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -3,14 +3,9 @@ VehicleBody =========== -Inherits: :ref:`PhysicsBody` ------------------------------------------------ +**Inherits:** :ref:`PhysicsBody` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 428ef808c..322dfc312 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -3,14 +3,9 @@ VehicleWheel ============ -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index fa14b8052..8b3cdd507 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -3,14 +3,9 @@ VideoPlayer =========== -Inherits: :ref:`Control` ---------------------------------------- +**Inherits:** :ref:`Control` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index 9bb802c12..41417c6dc 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -3,14 +3,9 @@ VideoStream =========== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index f87cd1179..dceb1caea 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -3,14 +3,9 @@ VideoStreamTheora ================= -Inherits: :ref:`VideoStream` ------------------------------------------------ +**Inherits:** :ref:`VideoStream` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 96d5f3cc6..4d5048dfd 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -3,14 +3,9 @@ Viewport ======== -Inherits: :ref:`Node` ---------------------------------- +**Inherits:** :ref:`Node` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Creates a sub-view into the screen. diff --git a/classes/class_viewportsprite.rst b/classes/class_viewportsprite.rst index c59f14742..192bd9c84 100644 --- a/classes/class_viewportsprite.rst +++ b/classes/class_viewportsprite.rst @@ -3,14 +3,9 @@ ViewportSprite ============== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index 0ec6e5b0d..2342c92b9 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -3,14 +3,9 @@ VisibilityEnabler ================= -Inherits: :ref:`VisibilityNotifier` -------------------------------------------------------------- +**Inherits:** :ref:`VisibilityNotifier` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index fe55756b7..bf36950ef 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -3,14 +3,9 @@ VisibilityEnabler2D =================== -Inherits: :ref:`VisibilityNotifier2D` ------------------------------------------------------------------ +**Inherits:** :ref:`VisibilityNotifier2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 75c171823..68f13e4fa 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -3,14 +3,9 @@ VisibilityNotifier ================== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 0fbc3bd30..ba66ca1c4 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -3,14 +3,9 @@ VisibilityNotifier2D ==================== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 1deb0a4d5..73e83306b 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -3,14 +3,9 @@ VisualInstance ============== -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index a189cd841..4aa6bf102 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -3,14 +3,9 @@ VisualServer ============ -Inherits: :ref:`Object` -------------------------------------- +**Inherits:** :ref:`Object` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Server for anything visible. diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index a939b6cf6..cbe8a90bd 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -3,14 +3,9 @@ VScrollBar ========== -Inherits: :ref:`ScrollBar` -------------------------------------------- +**Inherits:** :ref:`ScrollBar` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core 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 af54ef4e4..9312bceef 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -3,14 +3,9 @@ VSeparator ========== -Inherits: :ref:`Separator` -------------------------------------------- +**Inherits:** :ref:`Separator` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Vertical version of :ref:`Separator`. diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 69d62e7a4..a4f1f145b 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -3,14 +3,9 @@ VSlider ======= -Inherits: :ref:`Slider` -------------------------------------- +**Inherits:** :ref:`Slider` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Vertical slider. diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index 0f2753be6..a1f5ec4b1 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -3,14 +3,9 @@ VSplitContainer =============== -Inherits: :ref:`SplitContainer` ------------------------------------------------------ +**Inherits:** :ref:`SplitContainer` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Vertical split container. diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index bbdffbf47..8bd04a881 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -3,14 +3,9 @@ WeakRef ======= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index b0c7c5491..5b7d7897d 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -3,14 +3,9 @@ WindowDialog ============ -Inherits: :ref:`Popup` ------------------------------------ +**Inherits:** :ref:`Popup` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Base class for window dialogs. diff --git a/classes/class_world.rst b/classes/class_world.rst index c00888fc6..13101c556 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -3,14 +3,9 @@ World ===== -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Class that has everything pertaining to a world. diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index ccb130d4d..521b7c367 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -3,14 +3,9 @@ World2D ======= -Inherits: :ref:`Resource` ------------------------------------------ +**Inherits:** :ref:`Resource` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core Class that has everything pertaining to a 2D world. diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 7f6346ab3..ca36f8664 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -3,14 +3,9 @@ WorldEnvironment ================ -Inherits: :ref:`Spatial` ---------------------------------------- +**Inherits:** :ref:`Spatial` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 515db48c5..1ca022152 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -3,14 +3,9 @@ XMLParser ========= -Inherits: :ref:`Reference` -------------------------------------------- +**Inherits:** :ref:`Reference` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index 49474e1e1..a146790dd 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -3,14 +3,9 @@ YSort ===== -Inherits: :ref:`Node2D` -------------------------------------- +**Inherits:** :ref:`Node2D` -Category: Core --------------- - -Brief Description ------------------ +**Category:** Core