From 5bf33731b6b4a892269fe69a78bb06920a5ab0d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 27 Nov 2017 08:32:15 +0100 Subject: [PATCH] Sync classref with current source --- classes/class_@gdscript.rst | 338 +++---- ...lobal scope.rst => class_@globalscope.rst} | 58 +- classes/class_aabb.rst | 214 +++++ classes/class_acceptdialog.rst | 32 - classes/class_animatedsprite.rst | 126 +-- classes/class_animatedsprite3d.rst | 62 +- classes/class_animationplayer.rst | 48 - classes/class_animationtreeplayer.rst | 16 - classes/class_area.rst | 324 +------ classes/class_area2d.rst | 276 +----- classes/class_array.rst | 142 +-- classes/class_arraymesh.rst | 14 +- classes/class_arvranchor.rst | 34 +- classes/class_arvrcontroller.rst | 54 +- classes/class_arvrinterface.rst | 84 +- classes/class_arvrorigin.rst | 29 - classes/class_arvrpositionaltracker.rst | 12 - classes/class_arvrserver.rst | 40 +- classes/class_atlastexture.rst | 57 -- classes/class_audioeffectamplify.rst | 21 - classes/class_audioeffectchorus.rst | 153 ---- classes/class_audioeffectcompressor.rst | 93 -- classes/class_audioeffectdelay.rst | 165 ---- classes/class_audioeffectdistortion.rst | 69 -- classes/class_audioeffectfilter.rst | 57 -- classes/class_audioeffectlimiter.rst | 57 -- classes/class_audioeffectpanner.rst | 21 - classes/class_audioeffectphaser.rst | 69 -- classes/class_audioeffectpitchshift.rst | 21 - classes/class_audioeffectreverb.rst | 84 -- classes/class_audioeffectstereoenhance.rst | 45 - classes/class_audioserver.rst | 2 +- classes/class_audiostreamoggvorbis.rst | 45 - classes/class_audiostreamplayer.rst | 84 +- classes/class_audiostreamplayer2d.rst | 108 +-- classes/class_audiostreamplayer3d.rst | 216 +---- classes/class_audiostreamrandompitch.rst | 33 - classes/class_audiostreamsample.rst | 93 -- classes/class_backbuffercopy.rst | 41 - classes/class_basebutton.rst | 122 +-- classes/class_basis.rst | 4 +- classes/class_bitmapfont.rst | 78 +- classes/class_boxcontainer.rst | 22 +- classes/class_boxshape.rst | 25 - classes/class_button.rst | 69 -- classes/class_camera2d.rst | 246 +---- classes/class_canvasitem.rst | 160 ---- classes/class_canvasitemmaterial.rst | 33 - classes/class_canvaslayer.rst | 64 -- classes/class_canvasmodulate.rst | 25 - classes/class_capsulemesh.rst | 57 -- classes/class_capsuleshape.rst | 41 - classes/class_capsuleshape2d.rst | 41 - classes/class_centercontainer.rst | 25 - classes/class_circleshape2d.rst | 25 - classes/class_collisionobject.rst | 24 - classes/class_collisionobject2d.rst | 16 - classes/class_collisionpolygon.rst | 45 - classes/class_collisionpolygon2d.rst | 67 -- classes/class_collisionshape.rst | 34 +- classes/class_collisionshape2d.rst | 45 - classes/class_color.rst | 26 + classes/class_colorpickerbutton.rst | 43 +- classes/class_colorrect.rst | 35 - classes/class_concavepolygonshape2d.rst | 25 - classes/class_conetwistjoint.rst | 21 - classes/class_configfile.rst | 4 +- classes/class_control.rst | 260 +----- classes/class_convexpolygonshape.rst | 21 - classes/class_convexpolygonshape2d.rst | 22 +- classes/class_cubemap.rst | 50 +- classes/class_cubemesh.rst | 57 -- classes/class_curve.rst | 36 - classes/class_curve2d.rst | 16 - classes/class_curve3d.rst | 16 - classes/class_curvetexture.rst | 27 - classes/class_cylindermesh.rst | 69 -- classes/class_dampedspringjoint2d.rst | 73 -- classes/class_directionallight.rst | 45 - classes/class_directory.rst | 14 +- classes/class_dynamicfont.rst | 78 -- classes/class_dynamicfontdata.rst | 25 - classes/class_editorexportplugin.rst | 56 +- classes/class_editorinterface.rst | 2 +- classes/class_editorscenepostimport.rst | 33 + classes/class_editorsettings.rst | 14 +- classes/class_editorspatialgizmo.rst | 4 +- classes/class_engine.rst | 16 +- classes/class_environment.rst | 861 ------------------ classes/class_file.rst | 2 +- classes/class_filedialog.rst | 102 +-- classes/class_gdnative.rst | 26 +- classes/class_gdnativelibrary.rst | 50 +- ...te.rst => class_gdscriptfunctionstate.rst} | 28 +- ...lass.rst => class_gdscriptnativeclass.rst} | 16 +- classes/class_generic6dofjoint.rst | 81 -- classes/class_geometryinstance.rst | 109 --- classes/class_giprobe.rst | 130 +-- classes/class_giprobedata.rst | 143 +-- classes/class_gradient.rst | 66 +- classes/class_gradienttexture.rst | 27 - classes/class_graphnode.rst | 44 - classes/class_gridcontainer.rst | 25 - classes/class_groovejoint2d.rst | 41 - classes/class_hingejoint.rst | 33 - classes/class_httprequest.rst | 48 - classes/class_image.rst | 20 +- classes/class_input.rst | 10 +- classes/class_inputevent.rst | 16 +- classes/class_inputeventaction.rst | 29 +- classes/class_inputeventgesture.rst | 28 + classes/class_inputeventjoypadbutton.rst | 39 - classes/class_inputeventjoypadmotion.rst | 33 - classes/class_inputeventkey.rst | 36 - classes/class_inputeventmagnifygesture.rst | 26 + classes/class_inputeventmouse.rst | 47 +- classes/class_inputeventmousebutton.rst | 53 +- classes/class_inputeventmousemotion.rst | 33 - classes/class_inputeventpangesture.rst | 26 + classes/class_inputeventscreendrag.rst | 57 -- classes/class_inputeventscreentouch.rst | 39 - classes/class_inputeventwithmodifiers.rst | 71 +- classes/class_inputmap.rst | 2 +- classes/class_interpolatedcamera.rst | 42 +- classes/class_itemlist.rst | 132 +-- classes/class_javascript.rst | 42 + classes/class_joint.rst | 57 -- classes/class_joint2d.rst | 65 -- classes/class_jsonparseresult.rst | 61 +- classes/class_kinematicbody.rst | 14 +- classes/class_kinematicbody2d.rst | 14 +- classes/class_kinematiccollision.rst | 77 +- classes/class_kinematiccollision2d.rst | 75 -- classes/class_label.rst | 170 +--- classes/class_light.rst | 138 +-- classes/class_light2d.rst | 325 ------- classes/class_lightoccluder2d.rst | 41 - classes/class_line2d.rst | 156 +--- classes/class_lineedit.rst | 210 +---- classes/class_lineshape2d.rst | 41 - classes/class_linkbutton.rst | 41 - classes/class_material.rst | 33 - classes/class_meshinstance.rst | 26 - classes/class_mobilevrinterface.rst | 105 --- classes/class_multimesh.rst | 64 +- classes/class_multimeshinstance.rst | 25 - classes/class_nativescript.rst | 30 +- classes/class_navigation.rst | 12 - classes/class_navigationmesh.rst | 238 +---- classes/class_navigationmeshinstance.rst | 33 - classes/class_navigationpolygon.rst | 12 - classes/class_navigationpolygoninstance.rst | 33 - classes/class_nil.rst | 4 +- classes/class_ninepatchrect.rst | 81 -- classes/class_node.rst | 28 - classes/class_node2d.rst | 186 +--- classes/class_nodepath.rst | 50 +- classes/class_object.rst | 20 +- classes/class_occluderpolygon2d.rst | 45 - classes/class_omnilight.rst | 33 - classes/class_optionbutton.rst | 8 - classes/class_os.rst | 16 +- classes/class_panoramasky.rst | 21 - classes/class_parallaxbackground.rst | 101 -- classes/class_parallaxlayer.rst | 53 -- classes/class_particles.rst | 206 +---- classes/class_particles2d.rst | 240 +---- classes/class_particlesmaterial.rst | 237 ----- classes/class_path.rst | 25 - classes/class_path2d.rst | 25 - classes/class_physics2ddirectspacestate.rst | 44 +- .../class_physics2dshapequeryparameters.rst | 70 +- classes/class_physicsbody.rst | 26 +- classes/class_physicsbody2d.rst | 36 - classes/class_physicsdirectspacestate.rst | 34 +- classes/class_physicsshapequeryparameters.rst | 66 +- classes/class_pinjoint.rst | 21 - classes/class_pinjoint2d.rst | 21 - classes/class_planemesh.rst | 45 - classes/class_planeshape.rst | 21 - classes/class_polygon2d.rst | 194 +--- classes/class_popup.rst | 34 +- classes/class_popupmenu.rst | 32 - classes/class_primitivemesh.rst | 18 +- classes/class_prismmesh.rst | 69 -- classes/class_proceduralsky.rst | 201 ---- classes/class_progressbar.rst | 21 - classes/class_projectsettings.rst | 14 +- classes/class_proximitygroup.rst | 26 +- classes/class_quadmesh.rst | 8 + classes/class_range.rst | 116 +-- classes/class_raycast.rst | 74 -- classes/class_raycast2d.rst | 90 -- classes/class_rayshape.rst | 21 - classes/class_rayshape2d.rst | 25 - classes/class_rect3.rst | 214 ----- classes/class_rectangleshape2d.rst | 25 - classes/class_reference.rst | 2 +- classes/class_reflectionprobe.rst | 153 ---- classes/class_regex.rst | 78 +- classes/class_regexmatch.rst | 20 +- classes/class_remotetransform.rst | 83 +- classes/class_remotetransform2d.rst | 83 +- classes/class_resource.rst | 46 +- classes/class_resourceimporter.rst | 2 +- classes/class_resourceimportertheora.rst | 18 + classes/class_resourceimporterwebm.rst | 18 + classes/class_richtextlabel.rst | 150 +-- classes/class_rigidbody.rst | 294 +----- classes/class_rigidbody2d.rst | 260 ------ classes/class_scripteditor.rst | 28 +- classes/class_scrollbar.rst | 21 - classes/class_scrollcontainer.rst | 50 +- classes/class_segmentshape2d.rst | 41 - classes/class_shader.rst | 12 - classes/class_shape2d.rst | 20 +- classes/class_shortcut.rst | 26 +- classes/class_sky.rst | 21 - classes/class_slider.rst | 53 -- classes/class_sliderjoint.rst | 21 - classes/class_spatial.rst | 106 +-- classes/class_spatialmaterial.rst | 663 +------------- classes/class_spheremesh.rst | 69 -- classes/class_sphereshape.rst | 21 - classes/class_spinbox.rst | 52 +- classes/class_splitcontainer.rst | 57 -- classes/class_sprite.rst | 193 ---- classes/class_sprite3d.rst | 81 -- classes/class_spritebase3d.rst | 126 +-- classes/class_staticbody.rst | 73 -- classes/class_staticbody2d.rst | 73 -- classes/class_streamtexture.rst | 21 - classes/class_string.rst | 6 +- classes/class_stylebox.rst | 42 +- classes/class_styleboxflat.rst | 170 +--- classes/class_styleboxline.rst | 46 +- classes/class_styleboxtexture.rst | 118 +-- classes/class_tabcontainer.rst | 48 - classes/class_tabs.rst | 34 +- classes/class_textedit.rst | 230 +---- classes/class_texturebutton.rst | 105 --- classes/class_textureprogress.rst | 125 --- classes/class_texturerect.rst | 45 - classes/class_theme.rst | 12 - classes/class_thread.rst | 2 +- classes/class_tilemap.rst | 336 +------ classes/class_tileset.rst | 186 ++-- classes/class_timer.rst | 90 +- classes/class_touchscreenbutton.rst | 144 +-- classes/class_translation.rst | 16 - classes/class_treeitem.rst | 2 +- classes/class_tween.rst | 128 ++- classes/class_vehiclebody.rst | 70 +- classes/class_vehiclewheel.rst | 142 +-- classes/class_videoplayer.rst | 146 +-- classes/class_videostream.rst | 2 + classes/class_videostreamtheora.rst | 26 + classes/class_videostreamwebm.rst | 26 + classes/class_viewport.rst | 292 ------ classes/class_viewportcontainer.rst | 33 - classes/class_viewporttexture.rst | 21 - classes/class_visibilityenabler.rst | 25 - classes/class_visibilityenabler2d.rst | 25 - classes/class_visibilitynotifier.rst | 24 +- classes/class_visibilitynotifier2d.rst | 22 +- classes/class_visualinstance.rst | 30 +- .../class_visualscriptbasictypeconstant.rst | 33 - classes/class_visualscriptbuiltinfunc.rst | 67 +- classes/class_visualscriptclassconstant.rst | 33 - classes/class_visualscriptcomment.rst | 45 - classes/class_visualscriptconstant.rst | 33 - classes/class_visualscriptconstructor.rst | 33 - classes/class_visualscriptcustomnode.rst | 4 +- classes/class_visualscriptdeconstruct.rst | 21 - classes/class_visualscripteditor.rst | 53 ++ classes/class_visualscriptemitsignal.rst | 21 - classes/class_visualscriptenginesingleton.rst | 25 +- classes/class_visualscriptfunctioncall.rst | 129 --- classes/class_visualscriptglobalconstant.rst | 21 - classes/class_visualscriptinputaction.rst | 33 - classes/class_visualscriptlocalvar.rst | 33 - classes/class_visualscriptlocalvarset.rst | 33 - classes/class_visualscriptmathconstant.rst | 21 - classes/class_visualscriptnode.rst | 2 +- classes/class_visualscriptoperator.rst | 33 - classes/class_visualscriptpreload.rst | 21 - classes/class_visualscriptpropertyget.rst | 93 -- classes/class_visualscriptpropertyset.rst | 105 --- classes/class_visualscriptresourcepath.rst | 21 - classes/class_visualscriptreturn.rst | 33 - classes/class_visualscriptscenenode.rst | 21 - classes/class_visualscriptselect.rst | 21 - classes/class_visualscriptsequence.rst | 21 - classes/class_visualscripttypecast.rst | 33 - classes/class_visualscriptvariableget.rst | 21 - classes/class_visualscriptvariableset.rst | 21 - classes/class_visualscriptyield.rst | 33 - classes/class_visualscriptyieldsignal.rst | 57 -- classes/class_visualserver.rst | 48 +- classes/class_windowdialog.rst | 34 +- classes/class_world.rst | 38 +- classes/class_worldenvironment.rst | 25 - classes/class_ysort.rst | 25 - 303 files changed, 2187 insertions(+), 18408 deletions(-) rename classes/{class_@global scope.rst => class_@globalscope.rst} (95%) create mode 100644 classes/class_aabb.rst create mode 100644 classes/class_editorscenepostimport.rst rename classes/{class_gdfunctionstate.rst => class_gdscriptfunctionstate.rst} (65%) rename classes/{class_gdnativeclass.rst => class_gdscriptnativeclass.rst} (63%) create mode 100644 classes/class_inputeventgesture.rst create mode 100644 classes/class_inputeventmagnifygesture.rst create mode 100644 classes/class_inputeventpangesture.rst create mode 100644 classes/class_javascript.rst delete mode 100644 classes/class_rect3.rst create mode 100644 classes/class_resourceimportertheora.rst create mode 100644 classes/class_resourceimporterwebm.rst create mode 100644 classes/class_videostreamtheora.rst create mode 100644 classes/class_videostreamwebm.rst create mode 100644 classes/class_visualscripteditor.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index e9510b5ba..cb496a140 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -17,163 +17,167 @@ Built-in GDScript functions. Member Functions ---------------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`asin` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`assert` **(** :ref:`bool` condition **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`atan` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`atan2` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`clamp` **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cosh` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`db2linear` **(** :ref:`float` db **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`decimals` **(** :ref:`float` step **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dectime` **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ease` **(** :ref:`float` s, :ref:`float` curve **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`exp` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`floor` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fmod` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inf` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_nan` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`load` **(** :ref:`String` path **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max` **(** :ref:`float` a, :ref:`float` b **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`min` **(** :ref:`float` a, :ref:`float` b **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` val **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print` **(** **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stack` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printerr` **(** **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printraw` **(** **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`prints` **(** **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printt` **(** **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rad2deg` **(** :ref:`float` rad **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randf` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`randi` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`randomize` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`range` **(** **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`range_lerp` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`round` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seed` **(** :ref:`int` seed **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sign` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sin` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sinh` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sqrt` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`str` **(** **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tan` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`weakref` **(** :ref:`Object` obj **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`wrapf` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`wrapi` **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDFunctionState` | :ref:`yield` **(** :ref:`Object` object, :ref:`String` signal **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`asin` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`assert` **(** :ref:`bool` condition **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`atan` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`atan2` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`cartesian2polar` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`clamp` **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cosh` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`db2linear` **(** :ref:`float` db **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`decimals` **(** :ref:`float` step **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dectime` **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ease` **(** :ref:`float` s, :ref:`float` curve **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`exp` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`floor` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fmod` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_inf` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_nan` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`load` **(** :ref:`String` path **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max` **(** :ref:`float` a, :ref:`float` b **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`min` **(** :ref:`float` a, :ref:`float` b **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` val **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`polar2cartesian` **(** :ref:`float` r, :ref:`float` th **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print` **(** **)** vararg | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stack` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printerr` **(** **)** vararg | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printraw` **(** **)** vararg | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`prints` **(** **)** vararg | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printt` **(** **)** vararg | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rad2deg` **(** :ref:`float` rad **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randf` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`randi` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`randomize` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`range` **(** **)** vararg | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`range_lerp` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`round` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seed` **(** :ref:`int` seed **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sign` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sin` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sinh` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sqrt` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`str` **(** **)** vararg | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tan` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`weakref` **(** :ref:`Object` obj **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`wrapf` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`wrapi` **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GDScriptFunctionState` | :ref:`yield` **(** :ref:`Object` object, :ref:`String` signal **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -296,6 +300,12 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ` Decodes a byte array back to a value. +.. _class_@GDScript_cartesian2polar: + +- :ref:`Vector2` **cartesian2polar** **(** :ref:`float` x, :ref:`float` y **)** + +Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). + .. _class_@GDScript_ceil: - :ref:`float` **ceil** **(** :ref:`float` s **)** @@ -340,7 +350,7 @@ Clamps ``val`` and returns a value not less than ``min`` and not more than ``max - :ref:`Object` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** -Converts from a type to another in the best way possible. The ``type`` parameter uses the enum TYPE\_\* in :ref:`@Global Scope`. +Converts from a type to another in the best way possible. The ``type`` parameter uses the enum TYPE\_\* in :ref:`@GlobalScope`. :: @@ -667,6 +677,12 @@ Be aware that the JSON specification does not define integer or float types, but else: print("unexpected results") +.. _class_@GDScript_polar2cartesian: + +- :ref:`Vector2` **polar2cartesian** **(** :ref:`float` r, :ref:`float` th **)** + +Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis). + .. _class_@GDScript_pow: - :ref:`float` **pow** **(** :ref:`float` x, :ref:`float` y **)** @@ -996,7 +1012,7 @@ Returns whether the given class exists in :ref:`ClassDB`. - :ref:`int` **typeof** **(** :ref:`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:`@GlobalScope`. :: @@ -1103,9 +1119,9 @@ Usable for creating loop-alike behavior or infinite surfaces. .. _class_@GDScript_yield: -- :ref:`GDFunctionState` **yield** **(** :ref:`Object` object, :ref:`String` signal **)** +- :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object, :ref:`String` signal **)** -Stops the function execution and returns the current state. Call :ref:`GDFunctionState.resume` on the state to resume execution. This invalidates the state. +Stops the function execution and returns the current state. Call :ref:`GDScriptFunctionState.resume` on the state to resume execution. This invalidates the state. Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emitted. diff --git a/classes/class_@global scope.rst b/classes/class_@globalscope.rst similarity index 95% rename from classes/class_@global scope.rst rename to classes/class_@globalscope.rst index a24ff81a3..db82cab49 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@globalscope.rst @@ -1,11 +1,11 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the @Global Scope.xml source instead. +.. DO NOT EDIT THIS FILE, but the @GlobalScope.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_@Global Scope: +.. _class_@GlobalScope: -@Global Scope -============= +@GlobalScope +============ **Category:** Core @@ -17,83 +17,91 @@ Global scope constants and variables. Member Variables ---------------- - .. _class_@Global Scope_ARVRServer: + .. _class_@GlobalScope_ARVRServer: - :ref:`ARVRServer` **ARVRServer** - :ref:`ARVRServer` singleton - .. _class_@Global Scope_AudioServer: + .. _class_@GlobalScope_AudioServer: - :ref:`AudioServer` **AudioServer** - :ref:`AudioServer` singleton - .. _class_@Global Scope_ClassDB: + .. _class_@GlobalScope_ClassDB: - :ref:`ClassDB` **ClassDB** - :ref:`ClassDB` singleton - .. _class_@Global Scope_Engine: + .. _class_@GlobalScope_Engine: - :ref:`Engine` **Engine** - :ref:`Engine` singleton - .. _class_@Global Scope_Geometry: + .. _class_@GlobalScope_Geometry: - :ref:`Geometry` **Geometry** - :ref:`Geometry` singleton - .. _class_@Global Scope_GodotSharp: + .. _class_@GlobalScope_GodotSharp: - :ref:`GodotSharp` **GodotSharp** - :ref:`GodotSharp` singleton - .. _class_@Global Scope_IP: + .. _class_@GlobalScope_IP: - :ref:`IP` **IP** - :ref:`IP` singleton - .. _class_@Global Scope_Input: + .. _class_@GlobalScope_Input: - :ref:`Input` **Input** - :ref:`Input` singleton - .. _class_@Global Scope_InputMap: + .. _class_@GlobalScope_InputMap: - :ref:`InputMap` **InputMap** - :ref:`InputMap` singleton - .. _class_@Global Scope_JSON: + .. _class_@GlobalScope_JSON: - :ref:`JSON` **JSON** - :ref:`JSON` singleton - .. _class_@Global Scope_Marshalls: + .. _class_@GlobalScope_JavaScript: + +- :ref:`JavaScript` **JavaScript** + + .. _class_@GlobalScope_Marshalls: - :ref:`Reference` **Marshalls** - :ref:`Marshalls` singleton - .. _class_@Global Scope_OS: + .. _class_@GlobalScope_OS: - :ref:`OS` **OS** - :ref:`OS` singleton - .. _class_@Global Scope_Performance: + .. _class_@GlobalScope_Performance: - :ref:`Performance` **Performance** - :ref:`Performance` singleton - .. _class_@Global Scope_Physics2DServer: + .. _class_@GlobalScope_Physics2DServer: - :ref:`Physics2DServer` **Physics2DServer** - :ref:`Physics2DServer` singleton - .. _class_@Global Scope_PhysicsServer: + .. _class_@GlobalScope_PhysicsServer: - :ref:`PhysicsServer` **PhysicsServer** - :ref:`PhysicsServer` singleton - .. _class_@Global Scope_ProjectSettings: + .. _class_@GlobalScope_ProjectSettings: - :ref:`ProjectSettings` **ProjectSettings** - :ref:`ProjectSettings` singleton - .. _class_@Global Scope_ResourceLoader: + .. _class_@GlobalScope_ResourceLoader: - :ref:`ResourceLoader` **ResourceLoader** - :ref:`ResourceLoader` singleton - .. _class_@Global Scope_ResourceSaver: + .. _class_@GlobalScope_ResourceSaver: - :ref:`ResourceSaver` **ResourceSaver** - :ref:`ResourceSaver` singleton - .. _class_@Global Scope_TranslationServer: + .. _class_@GlobalScope_TranslationServer: - :ref:`TranslationServer` **TranslationServer** - :ref:`TranslationServer` singleton - .. _class_@Global Scope_VisualServer: + .. _class_@GlobalScope_VisualScriptEditor: + +- :ref:`VisualScriptEditor` **VisualScriptEditor** - :ref:`VisualScriptEditor` singleton + + .. _class_@GlobalScope_VisualServer: - :ref:`VisualServer` **VisualServer** - :ref:`VisualServer` singleton @@ -532,7 +540,7 @@ Numeric Constants - **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D`. - **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane`. - **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat`. -- **TYPE_RECT3** = **11** --- Variable is of type :ref:`Rect3`. +- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB`. - **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis`. - **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform`. - **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color`. diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst new file mode 100644 index 000000000..68b590e8b --- /dev/null +++ b/classes/class_aabb.rst @@ -0,0 +1,214 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AABB.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AABB: + +AABB +==== + +**Category:** Built-In Types + +Brief Description +----------------- + +Axis-Aligned Bounding Box. + +Member Functions +---------------- + ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`encloses` **(** :ref:`AABB` with **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_area` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_area` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_surface` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_AABB_end: + +- :ref:`Vector3` **end** - Ending corner. + + .. _class_AABB_position: + +- :ref:`Vector3` **position** - Beginning corner. + + .. _class_AABB_size: + +- :ref:`Vector3` **size** - Size from position to end. + + +Description +----------- + +AABB consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + +Member Function Description +--------------------------- + +.. _class_AABB_AABB: + +- :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** + +Optional constructor, accepts position and size. + +.. _class_AABB_encloses: + +- :ref:`bool` **encloses** **(** :ref:`AABB` with **)** + +Returns ``true`` if this ``AABB`` completely encloses another one. + +.. _class_AABB_expand: + +- :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** + +Returns this ``AABB`` expanded to include a given point. + +.. _class_AABB_get_area: + +- :ref:`float` **get_area** **(** **)** + +Gets the area of the ``AABB``. + +.. _class_AABB_get_endpoint: + +- :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** + +Gets the position of the 8 endpoints of the ``AABB`` in space. + +.. _class_AABB_get_longest_axis: + +- :ref:`Vector3` **get_longest_axis** **(** **)** + +Returns the normalized longest axis of the ``AABB``. + +.. _class_AABB_get_longest_axis_index: + +- :ref:`int` **get_longest_axis_index** **(** **)** + +Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). + +.. _class_AABB_get_longest_axis_size: + +- :ref:`float` **get_longest_axis_size** **(** **)** + +Returns the scalar length of the longest axis of the ``AABB``. + +.. _class_AABB_get_shortest_axis: + +- :ref:`Vector3` **get_shortest_axis** **(** **)** + +Returns the normalized shortest axis of the ``AABB``. + +.. _class_AABB_get_shortest_axis_index: + +- :ref:`int` **get_shortest_axis_index** **(** **)** + +Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). + +.. _class_AABB_get_shortest_axis_size: + +- :ref:`float` **get_shortest_axis_size** **(** **)** + +Returns the scalar length of the shortest axis of the ``AABB``. + +.. _class_AABB_get_support: + +- :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** + +Returns the support point in a given direction. This is useful for collision detection algorithms. + +.. _class_AABB_grow: + +- :ref:`AABB` **grow** **(** :ref:`float` by **)** + +Returns a copy of the ``AABB`` grown a given amount of units towards all the sides. + +.. _class_AABB_has_no_area: + +- :ref:`bool` **has_no_area** **(** **)** + +Returns ``true`` if the ``AABB`` is flat or empty. + +.. _class_AABB_has_no_surface: + +- :ref:`bool` **has_no_surface** **(** **)** + +Returns ``true`` if the ``AABB`` is empty. + +.. _class_AABB_has_point: + +- :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** + +Returns ``true`` if the ``AABB`` contains a point. + +.. _class_AABB_intersection: + +- :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** + +Returns the intersection between two ``AABB``. An empty AABB (size 0,0,0) is returned on failure. + +.. _class_AABB_intersects: + +- :ref:`bool` **intersects** **(** :ref:`AABB` with **)** + +Returns ``true`` if the ``AABB`` overlaps with another. + +.. _class_AABB_intersects_plane: + +- :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** + +Returns ``true`` if the ``AABB`` is on both sides of a plane. + +.. _class_AABB_intersects_segment: + +- :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** + +Returns ``true`` if the ``AABB`` intersects the line segment between ``from`` and ``to``. + +.. _class_AABB_merge: + +- :ref:`AABB` **merge** **(** :ref:`AABB` with **)** + +Returns a larger AABB that contains this AABB and ``with``. + + diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 7ffc249ac..e82d0a87e 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -26,20 +26,12 @@ Member Functions +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_hide_on_ok` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Label` | :ref:`get_label` **(** **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Button` | :ref:`get_ok` **(** **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_ok` **(** :ref:`bool` enabled **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -91,12 +83,6 @@ If ``true``, *right* will place the button to the right of any sibling buttons. Adds a button with label *name* and a cancel action to the dialog and returns the created button. -.. _class_AcceptDialog_get_hide_on_ok: - -- :ref:`bool` **get_hide_on_ok** **(** **)** const - -Return true if the dialog will be hidden when accepted (default true). - .. _class_AcceptDialog_get_label: - :ref:`Label` **get_label** **(** **)** @@ -109,28 +95,10 @@ Return the label used for built-in text. Return the OK Button. -.. _class_AcceptDialog_get_text: - -- :ref:`String` **get_text** **(** **)** const - -Return the built-in label text. - .. _class_AcceptDialog_register_text_enter: - void **register_text_enter** **(** :ref:`Node` line_edit **)** Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. -.. _class_AcceptDialog_set_hide_on_ok: - -- void **set_hide_on_ok** **(** :ref:`bool` enabled **)** - -Set whether the dialog is hidden when accepted (default true). - -.. _class_AcceptDialog_set_text: - -- void **set_text** **(** :ref:`String` text **)** - -Set the built-in label text. - diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 19cde3522..65a941c4f 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -19,41 +19,13 @@ Sprite node that can use multiple textures for animation. Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_animation` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpriteFrames` | :ref:`get_sprite_frames` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_centered` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation` **(** :ref:`String` animation **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`int` frame **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sprite_frames` **(** :ref:`SpriteFrames` sprite_frames **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` anim="" **)** | ++--------------------------+----------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++--------------------------+----------------------------------------------------------------------------------------+ Signals ------- @@ -115,48 +87,6 @@ Animations are created using a :ref:`SpriteFrames` resource, Member Function Description --------------------------- -.. _class_AnimatedSprite_get_animation: - -- :ref:`String` **get_animation** **(** **)** const - -Return the name of the current animation set to the node. - -.. _class_AnimatedSprite_get_frame: - -- :ref:`int` **get_frame** **(** **)** const - -Return the visible frame index. - -.. _class_AnimatedSprite_get_offset: - -- :ref:`Vector2` **get_offset** **(** **)** const - -Return the offset of the sprite in the node origin. - -.. _class_AnimatedSprite_get_sprite_frames: - -- :ref:`SpriteFrames` **get_sprite_frames** **(** **)** const - -Get the :ref:`SpriteFrames` resource, which contains all frames. - -.. _class_AnimatedSprite_is_centered: - -- :ref:`bool` **is_centered** **(** **)** const - -Return true when centered. See :ref:`set_centered`. - -.. _class_AnimatedSprite_is_flipped_h: - -- :ref:`bool` **is_flipped_h** **(** **)** const - -Return true if sprite is flipped horizontally. - -.. _class_AnimatedSprite_is_flipped_v: - -- :ref:`bool` **is_flipped_v** **(** **)** const - -Return true if sprite is flipped vertically. - .. _class_AnimatedSprite_is_playing: - :ref:`bool` **is_playing** **(** **)** const @@ -169,48 +99,6 @@ Return true if an animation if currently being played. Play the animation set in parameter. If no parameter is provided, the current animation is played. -.. _class_AnimatedSprite_set_animation: - -- void **set_animation** **(** :ref:`String` animation **)** - -Set the current animation of the node and reinits the frame counter of the animation. - -.. _class_AnimatedSprite_set_centered: - -- void **set_centered** **(** :ref:`bool` centered **)** - -When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is. - -.. _class_AnimatedSprite_set_flip_h: - -- void **set_flip_h** **(** :ref:`bool` flip_h **)** - -If true, sprite is flipped horizontally. - -.. _class_AnimatedSprite_set_flip_v: - -- void **set_flip_v** **(** :ref:`bool` flip_v **)** - -If true, sprite is flipped vertically. - -.. _class_AnimatedSprite_set_frame: - -- void **set_frame** **(** :ref:`int` frame **)** - -Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames` resource). - -.. _class_AnimatedSprite_set_offset: - -- void **set_offset** **(** :ref:`Vector2` offset **)** - -Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not. - -.. _class_AnimatedSprite_set_sprite_frames: - -- void **set_sprite_frames** **(** :ref:`SpriteFrames` sprite_frames **)** - -Set the :ref:`SpriteFrames` resource, which contains all frames. - .. _class_AnimatedSprite_stop: - void **stop** **(** **)** diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 14aa021ee..b777bbc05 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -19,25 +19,13 @@ Brief Description Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_animation` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpriteFrames` | :ref:`get_sprite_frames` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation` **(** :ref:`String` animation **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`int` frame **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sprite_frames` **(** :ref:`SpriteFrames` sprite_frames **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` anim="" **)** | ++--------------------------+------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++--------------------------+------------------------------------------------------------------------------------------+ Signals ------- @@ -77,24 +65,6 @@ Animations are created using a :ref:`SpriteFrames` resource, Member Function Description --------------------------- -.. _class_AnimatedSprite3D_get_animation: - -- :ref:`String` **get_animation** **(** **)** const - -Return the name of the current animation set to the node. - -.. _class_AnimatedSprite3D_get_frame: - -- :ref:`int` **get_frame** **(** **)** const - -Return the visible frame index. - -.. _class_AnimatedSprite3D_get_sprite_frames: - -- :ref:`SpriteFrames` **get_sprite_frames** **(** **)** const - -Get the :ref:`SpriteFrames` resource, which contains all frames. - .. _class_AnimatedSprite3D_is_playing: - :ref:`bool` **is_playing** **(** **)** const @@ -107,24 +77,6 @@ Return true if an animation if currently being played. Play the animation set in parameter. If no parameter is provided, the current animation is played. -.. _class_AnimatedSprite3D_set_animation: - -- void **set_animation** **(** :ref:`String` animation **)** - -Set the current animation of the node and reinits the frame counter of the animation. - -.. _class_AnimatedSprite3D_set_frame: - -- void **set_frame** **(** :ref:`int` frame **)** - -Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames` resource). - -.. _class_AnimatedSprite3D_set_sprite_frames: - -- void **set_sprite_frames** **(** :ref:`SpriteFrames` sprite_frames **)** - -Set the :ref:`SpriteFrames` resource, which contains all frames. - .. _class_AnimatedSprite3D_stop: - void **stop** **(** **)** diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 5c7e7ad3b..a1e04108c 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -38,8 +38,6 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_autoplay` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | @@ -50,12 +48,8 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_current_animation_position` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_blend_time` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_position` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_root` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_speed_scale` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | @@ -78,18 +72,12 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` active **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_autoplay` **(** :ref:`String` name **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_current_animation` **(** :ref:`String` anim **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_blend_time` **(** :ref:`float` sec **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_root` **(** :ref:`NodePath` path **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** :ref:`bool` reset=true **)** | @@ -203,12 +191,6 @@ Get an :ref:`Animation` resource by requesting a name. Get the list of names of the animations stored in the player. -.. _class_AnimationPlayer_get_animation_process_mode: - -- :ref:`int` **get_animation_process_mode** **(** **)** const - -Return the mode in which the animation player processes. See :ref:`set_animation_process_mode`. - .. _class_AnimationPlayer_get_autoplay: - :ref:`String` **get_autoplay** **(** **)** const @@ -239,24 +221,12 @@ Get the length (in seconds) of the currently being played animation. Get the position (in seconds) of the currently being played animation. -.. _class_AnimationPlayer_get_default_blend_time: - -- :ref:`float` **get_default_blend_time** **(** **)** const - -Return the default blend time between animations. - .. _class_AnimationPlayer_get_position: - :ref:`float` **get_position** **(** **)** const Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). -.. _class_AnimationPlayer_get_root: - -- :ref:`NodePath` **get_root** **(** **)** const - -Return path to root node (see :ref:`set_root`). - .. _class_AnimationPlayer_get_speed_scale: - :ref:`float` **get_speed_scale** **(** **)** const @@ -323,12 +293,6 @@ Seek the animation to a given position in time (in seconds). If 'update' is true Set the player as active (playing). If false, it will do nothing. -.. _class_AnimationPlayer_set_animation_process_mode: - -- 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\_\*. - .. _class_AnimationPlayer_set_autoplay: - void **set_autoplay** **(** :ref:`String` name **)** @@ -347,18 +311,6 @@ Specify a blend time (in seconds) between two animations, referenced by their na Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). -.. _class_AnimationPlayer_set_default_blend_time: - -- void **set_default_blend_time** **(** :ref:`float` sec **)** - -Set the default blend time between animations. - -.. _class_AnimationPlayer_set_root: - -- void **set_root** **(** :ref:`NodePath` path **)** - -AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed. - .. _class_AnimationPlayer_set_speed_scale: - void **set_speed_scale** **(** :ref:`float` speed **)** diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index c957743fc..784c6b9ce 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -54,8 +54,6 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_master_player` **(** **)** const | @@ -118,8 +116,6 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` enabled **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_base_path` **(** :ref:`NodePath` path **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_master_player` **(** :ref:`NodePath` nodepath **)** | @@ -273,12 +269,6 @@ Connects node ``id`` to ``dst_id`` at the specified input slot. Disconnects nodes connected to ``id`` at the specified input slot. -.. _class_AnimationTreePlayer_get_animation_process_mode: - -- :ref:`int` **get_animation_process_mode** **(** **)** const - -Returns playback process mode of this AnimationTreePlayer. - .. _class_AnimationTreePlayer_get_base_path: - :ref:`NodePath` **get_base_path** **(** **)** const @@ -455,12 +445,6 @@ Resets this AnimationTreePlayer. Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active. -.. _class_AnimationTreePlayer_set_animation_process_mode: - -- void **set_animation_process_mode** **(** :ref:`int` mode **)** - -Sets process mode (ANIMATION_PROCESS\_\*) of this AnimationTreePlayer. - .. _class_AnimationTreePlayer_set_base_path: - void **set_base_path** **(** :ref:`NodePath` path **)** diff --git a/classes/class_area.rst b/classes/class_area.rst index d354fcaa9..3f06933f3 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -19,95 +19,23 @@ General purpose area node for detection and 3D physics influence. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_audio_bus` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity_vector` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_priority` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_reverb_amount` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_reverb_bus` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_reverb_uniformity` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overriding_audio_bus` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_reverb_bus` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_bus` **(** :ref:`String` name **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_bus_override` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_vector` **(** :ref:`Vector3` vector **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_priority` **(** :ref:`float` priority **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_reverb_amount` **(** :ref:`float` amount **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_reverb_bus` **(** :ref:`String` name **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_reverb_uniformity` **(** :ref:`float` amount **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_reverb_bus` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -254,69 +182,23 @@ Description Member Function Description --------------------------- -.. _class_Area_get_angular_damp: - -- :ref:`float` **get_angular_damp** **(** **)** const - -Return the angular damp rate. - -.. _class_Area_get_audio_bus: - -- :ref:`String` **get_audio_bus** **(** **)** const - -.. _class_Area_get_collision_layer: - -- :ref:`int` **get_collision_layer** **(** **)** const - -Return the physics layer this area is in. - .. _class_Area_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the layer mask. -.. _class_Area_get_collision_mask: - -- :ref:`int` **get_collision_mask** **(** **)** const - -Return the physics layers this area can scan for collisions. - .. _class_Area_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. -.. _class_Area_get_gravity: - -- :ref:`float` **get_gravity** **(** **)** const - -Return the gravity intensity. - -.. _class_Area_get_gravity_distance_scale: - -- :ref:`float` **get_gravity_distance_scale** **(** **)** const - -Return the falloff factor for point gravity. - -.. _class_Area_get_gravity_vector: - -- :ref:`Vector3` **get_gravity_vector** **(** **)** const - -Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. - -.. _class_Area_get_linear_damp: - -- :ref:`float` **get_linear_damp** **(** **)** const - -Return the linear damp rate. - .. _class_Area_get_overlapping_areas: - :ref:`Array` **get_overlapping_areas** **(** **)** const -Returns a list of intersecting ``Area``s. +Returns a list of intersecting ``Area``\ s. .. _class_Area_get_overlapping_bodies: @@ -324,56 +206,6 @@ Returns a list of intersecting ``Area``s. Returns a list of intersecting :ref:`PhysicsBody`\ s. -.. _class_Area_get_priority: - -- :ref:`float` **get_priority** **(** **)** const - -Return the processing order of this area. - -.. _class_Area_get_reverb_amount: - -- :ref:`float` **get_reverb_amount** **(** **)** const - -.. _class_Area_get_reverb_bus: - -- :ref:`String` **get_reverb_bus** **(** **)** const - -.. _class_Area_get_reverb_uniformity: - -- :ref:`float` **get_reverb_uniformity** **(** **)** const - -.. _class_Area_get_space_override_mode: - -- :ref:`int` **get_space_override_mode** **(** **)** const - -Return the space override mode. - -.. _class_Area_is_gravity_a_point: - -- :ref:`bool` **is_gravity_a_point** **(** **)** const - -Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. - -.. _class_Area_is_monitorable: - -- :ref:`bool` **is_monitorable** **(** **)** const - -Return whether this area can be detected by other, monitoring, areas. - -.. _class_Area_is_monitoring: - -- :ref:`bool` **is_monitoring** **(** **)** const - -Return whether this area detects bodies/areas entering/exiting it. - -.. _class_Area_is_overriding_audio_bus: - -- :ref:`bool` **is_overriding_audio_bus** **(** **)** const - -.. _class_Area_is_using_reverb_bus: - -- :ref:`bool` **is_using_reverb_bus** **(** **)** const - .. _class_Area_overlaps_area: - :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const @@ -386,136 +218,16 @@ If ``true`` the given area overlaps the Area. If ``true`` the given body overlaps the Area. -.. _class_Area_set_angular_damp: - -- void **set_angular_damp** **(** :ref:`float` angular_damp **)** - -Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. - -In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. - -.. _class_Area_set_audio_bus: - -- void **set_audio_bus** **(** :ref:`String` name **)** - -.. _class_Area_set_audio_bus_override: - -- void **set_audio_bus_override** **(** :ref:`bool` enable **)** - -.. _class_Area_set_collision_layer: - -- void **set_collision_layer** **(** :ref:`int` collision_layer **)** - -Set the physics layers this area is in. - -Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask`. - -A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - .. _class_Area_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. -.. _class_Area_set_collision_mask: - -- void **set_collision_mask** **(** :ref:`int` collision_mask **)** - -Set the physics layers this area can scan for collisions. - .. _class_Area_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. -.. _class_Area_set_gravity: - -- void **set_gravity** **(** :ref:`float` gravity **)** - -Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. - -This value multiplies the gravity vector, whether it is the given vector (:ref:`set_gravity_vector`), or a calculated one (when using a center of gravity). - -.. _class_Area_set_gravity_distance_scale: - -- void **set_gravity_distance_scale** **(** :ref:`float` distance_scale **)** - -Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. - -.. _class_Area_set_gravity_is_point: - -- void **set_gravity_is_point** **(** :ref:`bool` enable **)** - -When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector`/:ref:`get_gravity_vector`. - -.. _class_Area_set_gravity_vector: - -- void **set_gravity_vector** **(** :ref:`Vector3` vector **)** - -Set the gravity vector. This vector does not have to be normalized. - -If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. - -.. _class_Area_set_linear_damp: - -- void **set_linear_damp** **(** :ref:`float` linear_damp **)** - -Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. - -In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. - -.. _class_Area_set_monitorable: - -- void **set_monitorable** **(** :ref:`bool` enable **)** - -Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. - -.. _class_Area_set_monitoring: - -- void **set_monitoring** **(** :ref:`bool` enable **)** - -Set whether this area can detect bodies/areas entering/exiting it. - -.. _class_Area_set_priority: - -- void **set_priority** **(** :ref:`float` priority **)** - -Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. - -Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. - -.. _class_Area_set_reverb_amount: - -- void **set_reverb_amount** **(** :ref:`float` amount **)** - -.. _class_Area_set_reverb_bus: - -- void **set_reverb_bus** **(** :ref:`String` name **)** - -.. _class_Area_set_reverb_uniformity: - -- void **set_reverb_uniformity** **(** :ref:`float` amount **)** - -.. _class_Area_set_space_override_mode: - -- void **set_space_override_mode** **(** :ref:`int` enable **)** - -Set the space override mode. This mode controls how an area affects gravity and damp. - -AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. - -AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. - -AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. - -AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. - -AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. - -.. _class_Area_set_use_reverb_bus: - -- void **set_use_reverb_bus** **(** :ref:`bool` enable **)** - diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 7d89b5d00..433f963eb 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -19,79 +19,23 @@ Brief Description Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_audio_bus_name` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_gravity_vector` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_priority` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overriding_audio_bus` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_bus_name` **(** :ref:`String` name **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_bus_override` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_vector` **(** :ref:`Vector2` vector **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_priority` **(** :ref:`float` priority **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_space_override_mode` **(** :ref:`int` space_override_mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -222,69 +166,23 @@ Description Member Function Description --------------------------- -.. _class_Area2D_get_angular_damp: - -- :ref:`float` **get_angular_damp** **(** **)** const - -Return the angular damp rate. - -.. _class_Area2D_get_audio_bus_name: - -- :ref:`String` **get_audio_bus_name** **(** **)** const - -.. _class_Area2D_get_collision_layer: - -- :ref:`int` **get_collision_layer** **(** **)** const - -Return the physics layer this area is in. - .. _class_Area2D_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. -.. _class_Area2D_get_collision_mask: - -- :ref:`int` **get_collision_mask** **(** **)** const - -Return the physics layers this area will scan to determine collisions. - .. _class_Area2D_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. -.. _class_Area2D_get_gravity: - -- :ref:`float` **get_gravity** **(** **)** const - -Return the gravity intensity. - -.. _class_Area2D_get_gravity_distance_scale: - -- :ref:`float` **get_gravity_distance_scale** **(** **)** const - -Return the falloff factor for point gravity. - -.. _class_Area2D_get_gravity_vector: - -- :ref:`Vector2` **get_gravity_vector** **(** **)** const - -Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. - -.. _class_Area2D_get_linear_damp: - -- :ref:`float` **get_linear_damp** **(** **)** const - -Return the linear damp rate. - .. _class_Area2D_get_overlapping_areas: - :ref:`Array` **get_overlapping_areas** **(** **)** const -Returns a list of intersecting ``Area2D``s. +Returns a list of intersecting ``Area2D``\ s. .. _class_Area2D_get_overlapping_bodies: @@ -292,40 +190,6 @@ Returns a list of intersecting ``Area2D``s. Returns a list of intersecting :ref:`PhysicsBody2D`\ s. -.. _class_Area2D_get_priority: - -- :ref:`float` **get_priority** **(** **)** const - -Return the processing order of this area. - -.. _class_Area2D_get_space_override_mode: - -- :ref:`int` **get_space_override_mode** **(** **)** const - -Return the space override mode. - -.. _class_Area2D_is_gravity_a_point: - -- :ref:`bool` **is_gravity_a_point** **(** **)** const - -Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. - -.. _class_Area2D_is_monitorable: - -- :ref:`bool` **is_monitorable** **(** **)** const - -Return whether this area can be detected by other, monitoring, areas. - -.. _class_Area2D_is_monitoring: - -- :ref:`bool` **is_monitoring** **(** **)** const - -Return whether this area detects bodies/areas entering/exiting it. - -.. _class_Area2D_is_overriding_audio_bus: - -- :ref:`bool` **is_overriding_audio_bus** **(** **)** const - .. _class_Area2D_overlaps_area: - :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const @@ -338,120 +202,16 @@ If ``true`` the given area overlaps the Area2D. If ``true`` the given body overlaps the Area2D. -.. _class_Area2D_set_angular_damp: - -- void **set_angular_damp** **(** :ref:`float` angular_damp **)** - -Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. - -In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. - -.. _class_Area2D_set_audio_bus_name: - -- void **set_audio_bus_name** **(** :ref:`String` name **)** - -.. _class_Area2D_set_audio_bus_override: - -- void **set_audio_bus_override** **(** :ref:`bool` enable **)** - -.. _class_Area2D_set_collision_layer: - -- void **set_collision_layer** **(** :ref:`int` collision_layer **)** - -Set the physics layers this area is in. - -Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask`. - -A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - .. _class_Area2D_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. -.. _class_Area2D_set_collision_mask: - -- void **set_collision_mask** **(** :ref:`int` collision_mask **)** - -Set the physics layers this area can scan for collisions. - .. _class_Area2D_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. -.. _class_Area2D_set_gravity: - -- void **set_gravity** **(** :ref:`float` gravity **)** - -Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. - -This value multiplies the gravity vector, whether it is the given vector (:ref:`set_gravity_vector`), or a calculated one (when using a center of gravity). - -.. _class_Area2D_set_gravity_distance_scale: - -- void **set_gravity_distance_scale** **(** :ref:`float` distance_scale **)** - -Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. - -.. _class_Area2D_set_gravity_is_point: - -- void **set_gravity_is_point** **(** :ref:`bool` enable **)** - -When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector`/:ref:`get_gravity_vector`. - -.. _class_Area2D_set_gravity_vector: - -- void **set_gravity_vector** **(** :ref:`Vector2` vector **)** - -Set the gravity vector. This vector does not have to be normalized. - -If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. - -.. _class_Area2D_set_linear_damp: - -- void **set_linear_damp** **(** :ref:`float` linear_damp **)** - -Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. - -In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. - -.. _class_Area2D_set_monitorable: - -- void **set_monitorable** **(** :ref:`bool` enable **)** - -Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. - -.. _class_Area2D_set_monitoring: - -- void **set_monitoring** **(** :ref:`bool` enable **)** - -Set whether this area can detect bodies/areas entering/exiting it. - -.. _class_Area2D_set_priority: - -- void **set_priority** **(** :ref:`float` priority **)** - -Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. - -Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. - -.. _class_Area2D_set_space_override_mode: - -- void **set_space_override_mode** **(** :ref:`int` space_override_mode **)** - -Set the space override mode. This mode controls how an area affects gravity and damp. - -AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. - -AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. - -AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. - -AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. - -AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. - diff --git a/classes/class_array.rst b/classes/class_array.rst index e4952a146..afa44244c 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -17,69 +17,73 @@ Generic array datatype. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`back` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`count` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`duplicate` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** var what, :ref:`int` from=0 **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`front` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert` **(** :ref:`int` position, var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`pop_back` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`pop_front` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_front` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` position **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` size **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** var what, :ref:`int` from=-1 **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| var | :ref:`back` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bsearch` **(** var value, :ref:`bool` before=True **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bsearch_custom` **(** var value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`count` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`duplicate` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** var what, :ref:`int` from=0 **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| var | :ref:`front` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert` **(** :ref:`int` position, var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| var | :ref:`pop_back` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| var | :ref:`pop_front` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_front` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` position **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` size **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** var what, :ref:`int` from=-1 **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -143,6 +147,18 @@ Append an element at the end of the array (alias of :ref:`push_back0). +.. _class_Array_bsearch: + +- :ref:`int` **bsearch** **(** var value, :ref:`bool` before=True **)** + +Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. + +.. _class_Array_bsearch_custom: + +- :ref:`int` **bsearch_custom** **(** var value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** + +Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. + .. _class_Array_clear: - void **clear** **(** **)** diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 45604eddb..ad5fbf1f6 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -34,7 +34,7 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`get_custom_aabb` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_surface_count` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -42,7 +42,7 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | +| void | :ref:`set_custom_aabb` **(** :ref:`AABB` aabb **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -66,6 +66,8 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_update_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -129,7 +131,7 @@ Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_ .. _class_ArrayMesh_get_custom_aabb: -- :ref:`Rect3` **get_custom_aabb** **(** **)** const +- :ref:`AABB` **get_custom_aabb** **(** **)** const .. _class_ArrayMesh_get_surface_count: @@ -147,7 +149,7 @@ Return the amount of surfaces that the ``ArrayMesh`` holds. .. _class_ArrayMesh_set_custom_aabb: -- void **set_custom_aabb** **(** :ref:`Rect3` aabb **)** +- void **set_custom_aabb** **(** :ref:`AABB` aabb **)** .. _class_ArrayMesh_surface_get_array_index_len: @@ -207,4 +209,8 @@ Remove a surface at position surf_idx, shifting greater surfaces one surf_idx sl Set a :ref:`Material` for a given surface. Surface will be rendered using this material. +.. _class_ArrayMesh_surface_update_region: + +- void **surface_update_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** + diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index a29aec3d4..f3a036409 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -19,19 +19,15 @@ Anchor point in AR Space Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_anchor_id` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_active` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_plane` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_id` **(** :ref:`int` anchor_id **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_active` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`get_plane` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------+ Member Variables ---------------- @@ -53,12 +49,6 @@ Keep in mind that as long as plane detection is enable the size, placing and ori Member Function Description --------------------------- -.. _class_ARVRAnchor_get_anchor_id: - -- :ref:`int` **get_anchor_id** **(** **)** const - -Returns the anchor id for this anchor. - .. _class_ARVRAnchor_get_anchor_name: - :ref:`String` **get_anchor_name** **(** **)** const @@ -83,10 +73,4 @@ Returns a plane aligned with our anchor, handy for intersection testing Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table. -.. _class_ARVRAnchor_set_anchor_id: - -- void **set_anchor_id** **(** :ref:`int` anchor_id **)** - -Binds this anchor node to an anchor with this id. You can set this before the anchor itself exists. The first anchor that is identified gets id 1, the second id 2, etc. When anchors get removed that slot remains free and can be assigned to the next anchor that is identified. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merge them. - diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index ecd04d208..227fce3aa 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -19,27 +19,19 @@ A spatial node representing a spatially tracked controller. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_controller_id` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_controller_name` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hand` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_active` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joystick_axis` **(** :ref:`int` axis **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joystick_id` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rumble` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_controller_id` **(** :ref:`int` controller_id **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rumble` **(** :ref:`float` rumble **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_controller_name` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_hand` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_active` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joystick_axis` **(** :ref:`int` axis **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joystick_id` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -81,12 +73,6 @@ The position of the controller node is automatically updated by the ARVR Server. Member Function Description --------------------------- -.. _class_ARVRController_get_controller_id: - -- :ref:`int` **get_controller_id** **(** **)** const - -Returns the controller id currently assigned to this node. - .. _class_ARVRController_get_controller_name: - :ref:`String` **get_controller_name** **(** **)** const @@ -117,24 +103,10 @@ Returns the value of the given axis for things like triggers, touchpads, etc. th Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. -.. _class_ARVRController_get_rumble: - -- :ref:`float` **get_rumble** **(** **)** const - .. _class_ARVRController_is_button_pressed: - :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const Is the given button currently pressed? -.. _class_ARVRController_set_controller_id: - -- void **set_controller_id** **(** :ref:`int` controller_id **)** - -Changes the id that identifies the controller bound to this node. The first controller that the ARVR Server detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off that slot is freed ensuring that controllers will keep the same id while it is turned on even when controllers with lower ids are turned off. - -.. _class_ARVRController_set_rumble: - -- void **set_rumble** **(** :ref:`float` rumble **)** - diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 281d78764..76ee20c05 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -21,33 +21,21 @@ Base class for ARVR interface implementation. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_anchor_detection_is_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_capabilities` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_recommended_render_targetsize` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tracking_status` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`initialize` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_initialized` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_primary` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stereo` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_detection_is_enabled` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_is_initialized` **(** :ref:`bool` initialized **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_is_primary` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`uninitialize` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_capabilities` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_render_targetsize` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tracking_status` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stereo` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------+ +| void | :ref:`uninitialize` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -72,7 +60,7 @@ Numeric Constants - **ARVR_MONO** = **1** --- This interface can work with normal rendering output (non-HMD based AR). - **ARVR_STEREO** = **2** --- This interface supports stereoscopic rendering. - **ARVR_AR** = **4** --- This interface support AR (video background and real world tracking). -- **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_recommended_render_targetsize. Using a seperate viewport node frees up the main viewport for other purposes. +- **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a seperate viewport node frees up the main viewport for other purposes. - **EYE_MONO** = **0** --- Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported. - **EYE_LEFT** = **1** --- Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information. - **EYE_RIGHT** = **2** --- Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information. @@ -92,12 +80,6 @@ Interfaces should be written in such a way that simply enabling them will give u Member Function Description --------------------------- -.. _class_ARVRInterface_get_anchor_detection_is_enabled: - -- :ref:`bool` **get_anchor_detection_is_enabled** **(** **)** const - -Returns true if achor detection is enabled (AR only). - .. _class_ARVRInterface_get_capabilities: - :ref:`int` **get_capabilities** **(** **)** const @@ -110,9 +92,9 @@ Returns a combination of flags providing information about the capabilities of t Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). -.. _class_ARVRInterface_get_recommended_render_targetsize: +.. _class_ARVRInterface_get_render_targetsize: -- :ref:`Vector2` **get_recommended_render_targetsize** **(** **)** +- :ref:`Vector2` **get_render_targetsize** **(** **)** Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform. @@ -136,42 +118,12 @@ If you do this for a platform that handles its own output (such as OpenVR) Godot While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD. -.. _class_ARVRInterface_is_initialized: - -- :ref:`bool` **is_initialized** **(** **)** - -Returns true if this interface is active. - -.. _class_ARVRInterface_is_primary: - -- :ref:`bool` **is_primary** **(** **)** - -Returns true if this interface is currently the primary interface (the interface responsible for showing the output). - .. _class_ARVRInterface_is_stereo: - :ref:`bool` **is_stereo** **(** **)** Returns true if the current output of this interface is in stereo. -.. _class_ARVRInterface_set_anchor_detection_is_enabled: - -- void **set_anchor_detection_is_enabled** **(** :ref:`bool` enable **)** - -Enables anchor detection, this is used on AR interfaces and enables the extra logic that will detect planes, features, objects, etc. and adds/modifies anchor points. - -.. _class_ARVRInterface_set_is_initialized: - -- void **set_is_initialized** **(** :ref:`bool` initialized **)** - -Initialize/uninitialize this interface (same effect as calling initialize/uninitialize). - -.. _class_ARVRInterface_set_is_primary: - -- void **set_is_primary** **(** :ref:`bool` enable **)** - -Set this interface to the primary interface (unset the old one). - .. _class_ARVRInterface_uninitialize: - void **uninitialize** **(** **)** diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index b4347807e..36ce86cff 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -16,15 +16,6 @@ Brief Description Our origin point in AR/VR. -Member Functions ----------------- - -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_world_scale` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world_scale` **(** :ref:`float` world_scale **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,23 +37,3 @@ It is the position of this node that you update when you're character needs to m So say that your character is driving a car, the ARVROrigin node should be a child node of this car. If you implement a teleport system to move your character, you change the position of this node. Etc. -Member Function Description ---------------------------- - -.. _class_ARVROrigin_get_world_scale: - -- :ref:`float` **get_world_scale** **(** **)** const - -Get the world scale applied to our positioning. - -.. _class_ARVROrigin_set_world_scale: - -- void **set_world_scale** **(** :ref:`float` world_scale **)** - -Changes the world scaling factor. - -Most AR/VR platforms will assume a unit size of 1 unit in your game world = 1 meter in the real world. This scale allows you to adjust this to the unit system you use in your game. - -Note that this method is a passthrough to the ARVRServer itself. - - diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 96b21e755..b30babe31 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -30,8 +30,6 @@ Member Functions +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_position` **(** **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rumble` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tracks_orientation` **(** **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tracks_position` **(** **)** const | @@ -40,8 +38,6 @@ Member Functions +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_type` **(** **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rumble` **(** :ref:`float` rumble **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -100,10 +96,6 @@ Returns the orientation matrix of the controller. Returns the position of the controller adjusted by world scale. -.. _class_ARVRPositionalTracker_get_rumble: - -- :ref:`float` **get_rumble** **(** **)** const - .. _class_ARVRPositionalTracker_get_tracks_orientation: - :ref:`bool` **get_tracks_orientation** **(** **)** const @@ -128,8 +120,4 @@ Returns the transform combining the orientation and position of this device. Type of tracker. -.. _class_ARVRPositionalTracker_set_rumble: - -- void **set_rumble** **(** :ref:`float` rumble **)** - diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index b3333f14d..538dc5321 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -19,8 +19,6 @@ This is our AR/VR Server. Member Functions ---------------- -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_interface` **(** :ref:`ARVRInterface` interface **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`center_on_hmd` **(** :ref:`bool` ignore_tilt, :ref:`bool` keep_height **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -30,20 +28,16 @@ Member Functions +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_interface_count` **(** **)** const | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_interfaces` **(** **)** const | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`get_reference_frame` **(** **)** const | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** const | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tracker_count` **(** **)** const | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_world_scale` **(** **)** const | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_interface` **(** :ref:`ARVRInterface` interface **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_primary_interface` **(** :ref:`ARVRInterface` interface **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world_scale` **(** :ref:`float` arg0 **)** | -+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -99,12 +93,6 @@ The AR/VR Server is the heart of our AR/VR solution and handles all the processi Member Function Description --------------------------- -.. _class_ARVRServer_add_interface: - -- void **add_interface** **(** :ref:`ARVRInterface` interface **)** - -Mostly exposed for GDNative based interfaces, this is called to register an available interface with the AR/VR server. - .. _class_ARVRServer_center_on_hmd: - void **center_on_hmd** **(** :ref:`bool` ignore_tilt, :ref:`bool` keep_height **)** @@ -139,6 +127,12 @@ Get the interface registered at a given index in our list of interfaces. Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look throught the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. +.. _class_ARVRServer_get_interfaces: + +- :ref:`Array` **get_interfaces** **(** **)** const + +Returns a list of available interfaces with both id and name of the interface. + .. _class_ARVRServer_get_reference_frame: - :ref:`Transform` **get_reference_frame** **(** **)** const @@ -157,28 +151,10 @@ Get the positional tracker at the given ID. Get the number of trackers currently registered. -.. _class_ARVRServer_get_world_scale: - -- :ref:`float` **get_world_scale** **(** **)** const - -Returns our world scale (see ARVROrigin for more information). - -.. _class_ARVRServer_remove_interface: - -- void **remove_interface** **(** :ref:`ARVRInterface` interface **)** - -Removes a registered interface, again exposed mostly for GDNative based interfaces. - .. _class_ARVRServer_set_primary_interface: - void **set_primary_interface** **(** :ref:`ARVRInterface` interface **)** Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces. -.. _class_ARVRServer_set_world_scale: - -- void **set_world_scale** **(** :ref:`float` arg0 **)** - -Changing the world scale, see the ARVROrigin documentation for more information. - diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index ef84bde1f..d9447f097 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -16,27 +16,6 @@ Brief Description Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. -Member Functions ----------------- - -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_atlas` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_margin` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_filter_clip` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_atlas` **(** :ref:`Texture` atlas **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_clip` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`Rect2` margin **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region` **(** :ref:`Rect2` region **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -64,39 +43,3 @@ Description and a region that defines the actual area of the AtlasTexture. -Member Function Description ---------------------------- - -.. _class_AtlasTexture_get_atlas: - -- :ref:`Texture` **get_atlas** **(** **)** const - -.. _class_AtlasTexture_get_margin: - -- :ref:`Rect2` **get_margin** **(** **)** const - -.. _class_AtlasTexture_get_region: - -- :ref:`Rect2` **get_region** **(** **)** const - -.. _class_AtlasTexture_has_filter_clip: - -- :ref:`bool` **has_filter_clip** **(** **)** const - -.. _class_AtlasTexture_set_atlas: - -- void **set_atlas** **(** :ref:`Texture` atlas **)** - -.. _class_AtlasTexture_set_filter_clip: - -- void **set_filter_clip** **(** :ref:`bool` enable **)** - -.. _class_AtlasTexture_set_margin: - -- void **set_margin** **(** :ref:`Rect2` margin **)** - -.. _class_AtlasTexture_set_region: - -- void **set_region** **(** :ref:`Rect2` region **)** - - diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index c565e4017..0dc2e1def 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -18,15 +18,6 @@ Adds a Amplify audio effect to an Audio bus. Increases or decreases the volume of the selected audio bus. -Member Functions ----------------- - -+----------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` volume **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -40,15 +31,3 @@ Description Increases or decreases the volume being routed through the audio bus. -Member Function Description ---------------------------- - -.. _class_AudioEffectAmplify_get_volume_db: - -- :ref:`float` **get_volume_db** **(** **)** const - -.. _class_AudioEffectAmplify_set_volume_db: - -- void **set_volume_db** **(** :ref:`float` volume **)** - - diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 050169542..03d4d8684 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -16,47 +16,6 @@ Brief Description Adds a chorus audio effect. -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dry` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_voice_count` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_cutoff_hz` **(** :ref:`int` voice_idx **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_delay_ms` **(** :ref:`int` voice_idx **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_depth_ms` **(** :ref:`int` voice_idx **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_level_db` **(** :ref:`int` voice_idx **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_pan` **(** :ref:`int` voice_idx **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_rate_hz` **(** :ref:`int` voice_idx **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_wet` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dry` **(** :ref:`float` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_count` **(** :ref:`int` voices **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_cutoff_hz` **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_delay_ms` **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_depth_ms` **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_level_db` **(** :ref:`int` voice_idx, :ref:`float` level_db **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_pan` **(** :ref:`int` voice_idx, :ref:`float` pan **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_rate_hz` **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wet` **(** :ref:`float` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -174,115 +133,3 @@ Description Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter. -Member Function Description ---------------------------- - -.. _class_AudioEffectChorus_get_dry: - -- :ref:`float` **get_dry** **(** **)** const - -Returns the set dry ratio. - -.. _class_AudioEffectChorus_get_voice_count: - -- :ref:`int` **get_voice_count** **(** **)** const - -Returns the set voice count. - -.. _class_AudioEffectChorus_get_voice_cutoff_hz: - -- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** const - -Returns the voice's set cutoff frequency. - -.. _class_AudioEffectChorus_get_voice_delay_ms: - -- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** const - -Returns the voice's set delay. - -.. _class_AudioEffectChorus_get_voice_depth_ms: - -- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** const - -Returns the voice's set filter depth. - -.. _class_AudioEffectChorus_get_voice_level_db: - -- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** const - -Returns the voice's set maximum volume. - -.. _class_AudioEffectChorus_get_voice_pan: - -- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** const - -Returns the voice's set pan. - -.. _class_AudioEffectChorus_get_voice_rate_hz: - -- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** const - -Returns the voice filter's set rate in cycles. - -.. _class_AudioEffectChorus_get_wet: - -- :ref:`float` **get_wet** **(** **)** const - -Returns the set applied wetness of the effect. - -.. _class_AudioEffectChorus_set_dry: - -- void **set_dry** **(** :ref:`float` amount **)** - -Returns the set applied dryness of the effect. - -.. _class_AudioEffectChorus_set_voice_count: - -- void **set_voice_count** **(** :ref:`int` voices **)** - -Set the number of voices in the effect's filter. - -.. _class_AudioEffectChorus_set_voice_cutoff_hz: - -- void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** - -Set the cutoff frequency of the voice. The maximum frequency the voice may affect. - -.. _class_AudioEffectChorus_set_voice_delay_ms: - -- void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** - -Set the delay of the voice's signal. - -.. _class_AudioEffectChorus_set_voice_depth_ms: - -- void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** - -Set the filter depth of the voice's signal. - -.. _class_AudioEffectChorus_set_voice_level_db: - -- void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** - -Set the volume level of the voice. - -.. _class_AudioEffectChorus_set_voice_pan: - -- void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** - -Set the pan level of the voice. - -.. _class_AudioEffectChorus_set_voice_rate_hz: - -- void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** - -Set the voice filter's rate. - -.. _class_AudioEffectChorus_set_wet: - -- void **set_wet** **(** :ref:`float` amount **)** - -Set the amount of effect. - - diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index bb3faf94a..81f5987b9 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -18,39 +18,6 @@ Adds a Compressor audio effect to an Audio bus. Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume. -Member Functions ----------------- - -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attack_us` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gain` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mix` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ratio` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_release_ms` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_sidechain` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_threshold` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attack_us` **(** :ref:`float` attack_us **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gain` **(** :ref:`float` gain **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix` **(** :ref:`float` mix **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ratio` **(** :ref:`float` ratio **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_release_ms` **(** :ref:`float` release_ms **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sidechain` **(** :ref:`String` sidechain **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_threshold` **(** :ref:`float` threshold **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -98,63 +65,3 @@ Compressor has many uses in the mix: - Accentuates transients by using a wider attack, making effects sound more punchy. -Member Function Description ---------------------------- - -.. _class_AudioEffectCompressor_get_attack_us: - -- :ref:`float` **get_attack_us** **(** **)** const - -.. _class_AudioEffectCompressor_get_gain: - -- :ref:`float` **get_gain** **(** **)** const - -.. _class_AudioEffectCompressor_get_mix: - -- :ref:`float` **get_mix** **(** **)** const - -.. _class_AudioEffectCompressor_get_ratio: - -- :ref:`float` **get_ratio** **(** **)** const - -.. _class_AudioEffectCompressor_get_release_ms: - -- :ref:`float` **get_release_ms** **(** **)** const - -.. _class_AudioEffectCompressor_get_sidechain: - -- :ref:`String` **get_sidechain** **(** **)** const - -.. _class_AudioEffectCompressor_get_threshold: - -- :ref:`float` **get_threshold** **(** **)** const - -.. _class_AudioEffectCompressor_set_attack_us: - -- void **set_attack_us** **(** :ref:`float` attack_us **)** - -.. _class_AudioEffectCompressor_set_gain: - -- void **set_gain** **(** :ref:`float` gain **)** - -.. _class_AudioEffectCompressor_set_mix: - -- void **set_mix** **(** :ref:`float` mix **)** - -.. _class_AudioEffectCompressor_set_ratio: - -- void **set_ratio** **(** :ref:`float` ratio **)** - -.. _class_AudioEffectCompressor_set_release_ms: - -- void **set_release_ms** **(** :ref:`float` release_ms **)** - -.. _class_AudioEffectCompressor_set_sidechain: - -- void **set_sidechain** **(** :ref:`String` sidechain **)** - -.. _class_AudioEffectCompressor_set_threshold: - -- void **set_threshold** **(** :ref:`float` threshold **)** - - diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index c2c407c50..696a19e72 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -18,63 +18,6 @@ Adds a Delay audio effect to an Audio bus. Plays input signal back after a perio Two tap delay and feedback options. -Member Functions ----------------- - -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dry` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_feedback_delay_ms` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_feedback_level_db` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_feedback_lowpass` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap1_delay_ms` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap1_level_db` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap1_pan` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap2_delay_ms` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap2_level_db` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap2_pan` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_feedback_active` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tap1_active` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tap2_active` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dry` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback_active` **(** :ref:`bool` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback_delay_ms` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback_level_db` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback_lowpass` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap1_active` **(** :ref:`bool` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap1_delay_ms` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap1_level_db` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap1_pan` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap2_active` **(** :ref:`bool` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap2_delay_ms` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap2_level_db` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap2_pan` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -136,111 +79,3 @@ Description Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds. -Member Function Description ---------------------------- - -.. _class_AudioEffectDelay_get_dry: - -- :ref:`float` **get_dry** **(** **)** - -.. _class_AudioEffectDelay_get_feedback_delay_ms: - -- :ref:`float` **get_feedback_delay_ms** **(** **)** const - -.. _class_AudioEffectDelay_get_feedback_level_db: - -- :ref:`float` **get_feedback_level_db** **(** **)** const - -.. _class_AudioEffectDelay_get_feedback_lowpass: - -- :ref:`float` **get_feedback_lowpass** **(** **)** const - -.. _class_AudioEffectDelay_get_tap1_delay_ms: - -- :ref:`float` **get_tap1_delay_ms** **(** **)** const - -.. _class_AudioEffectDelay_get_tap1_level_db: - -- :ref:`float` **get_tap1_level_db** **(** **)** const - -.. _class_AudioEffectDelay_get_tap1_pan: - -- :ref:`float` **get_tap1_pan** **(** **)** const - -.. _class_AudioEffectDelay_get_tap2_delay_ms: - -- :ref:`float` **get_tap2_delay_ms** **(** **)** const - -.. _class_AudioEffectDelay_get_tap2_level_db: - -- :ref:`float` **get_tap2_level_db** **(** **)** const - -.. _class_AudioEffectDelay_get_tap2_pan: - -- :ref:`float` **get_tap2_pan** **(** **)** const - -.. _class_AudioEffectDelay_is_feedback_active: - -- :ref:`bool` **is_feedback_active** **(** **)** const - -.. _class_AudioEffectDelay_is_tap1_active: - -- :ref:`bool` **is_tap1_active** **(** **)** const - -.. _class_AudioEffectDelay_is_tap2_active: - -- :ref:`bool` **is_tap2_active** **(** **)** const - -.. _class_AudioEffectDelay_set_dry: - -- void **set_dry** **(** :ref:`float` amount **)** - -.. _class_AudioEffectDelay_set_feedback_active: - -- void **set_feedback_active** **(** :ref:`bool` amount **)** - -.. _class_AudioEffectDelay_set_feedback_delay_ms: - -- void **set_feedback_delay_ms** **(** :ref:`float` amount **)** - -.. _class_AudioEffectDelay_set_feedback_level_db: - -- void **set_feedback_level_db** **(** :ref:`float` amount **)** - -.. _class_AudioEffectDelay_set_feedback_lowpass: - -- void **set_feedback_lowpass** **(** :ref:`float` amount **)** - -.. _class_AudioEffectDelay_set_tap1_active: - -- void **set_tap1_active** **(** :ref:`bool` amount **)** - -.. _class_AudioEffectDelay_set_tap1_delay_ms: - -- void **set_tap1_delay_ms** **(** :ref:`float` amount **)** - -.. _class_AudioEffectDelay_set_tap1_level_db: - -- void **set_tap1_level_db** **(** :ref:`float` amount **)** - -.. _class_AudioEffectDelay_set_tap1_pan: - -- void **set_tap1_pan** **(** :ref:`float` amount **)** - -.. _class_AudioEffectDelay_set_tap2_active: - -- void **set_tap2_active** **(** :ref:`bool` amount **)** - -.. _class_AudioEffectDelay_set_tap2_delay_ms: - -- void **set_tap2_delay_ms** **(** :ref:`float` amount **)** - -.. _class_AudioEffectDelay_set_tap2_level_db: - -- void **set_tap2_level_db** **(** :ref:`float` amount **)** - -.. _class_AudioEffectDelay_set_tap2_pan: - -- void **set_tap2_pan** **(** :ref:`float` amount **)** - - diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 465bcc038..b63305452 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -18,31 +18,6 @@ Adds a Distortion audio effect to an Audio bus. Modify the sound to make it dirty. -Member Functions ----------------- - -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_drive` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_keep_hf_hz` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_post_gain` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pre_gain` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drive` **(** :ref:`float` drive **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_keep_hf_hz` **(** :ref:`float` keep_hf_hz **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_post_gain` **(** :ref:`float` post_gain **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pre_gain` **(** :ref:`float` pre_gain **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -83,47 +58,3 @@ Modify the sound and make it dirty. Different types are available : clip, tan, l By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently. -Member Function Description ---------------------------- - -.. _class_AudioEffectDistortion_get_drive: - -- :ref:`float` **get_drive** **(** **)** const - -.. _class_AudioEffectDistortion_get_keep_hf_hz: - -- :ref:`float` **get_keep_hf_hz** **(** **)** const - -.. _class_AudioEffectDistortion_get_mode: - -- :ref:`int` **get_mode** **(** **)** const - -.. _class_AudioEffectDistortion_get_post_gain: - -- :ref:`float` **get_post_gain** **(** **)** const - -.. _class_AudioEffectDistortion_get_pre_gain: - -- :ref:`float` **get_pre_gain** **(** **)** const - -.. _class_AudioEffectDistortion_set_drive: - -- void **set_drive** **(** :ref:`float` drive **)** - -.. _class_AudioEffectDistortion_set_keep_hf_hz: - -- void **set_keep_hf_hz** **(** :ref:`float` keep_hf_hz **)** - -.. _class_AudioEffectDistortion_set_mode: - -- void **set_mode** **(** :ref:`int` mode **)** - -.. _class_AudioEffectDistortion_set_post_gain: - -- void **set_post_gain** **(** :ref:`float` post_gain **)** - -.. _class_AudioEffectDistortion_set_pre_gain: - -- void **set_pre_gain** **(** :ref:`float` pre_gain **)** - - diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index f6b0b2941..a77788090 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -18,27 +18,6 @@ Brief Description Adds a filter to the Audio Bus. -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cutoff` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_db` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gain` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_resonance` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cutoff` **(** :ref:`float` freq **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_db` **(** :ref:`int` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gain` **(** :ref:`float` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resonance` **(** :ref:`float` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -72,39 +51,3 @@ Description Allows frequencies other than the :ref:`cutoff_hz` to pass. -Member Function Description ---------------------------- - -.. _class_AudioEffectFilter_get_cutoff: - -- :ref:`float` **get_cutoff** **(** **)** const - -.. _class_AudioEffectFilter_get_db: - -- :ref:`int` **get_db** **(** **)** const - -.. _class_AudioEffectFilter_get_gain: - -- :ref:`float` **get_gain** **(** **)** const - -.. _class_AudioEffectFilter_get_resonance: - -- :ref:`float` **get_resonance** **(** **)** const - -.. _class_AudioEffectFilter_set_cutoff: - -- void **set_cutoff** **(** :ref:`float` freq **)** - -.. _class_AudioEffectFilter_set_db: - -- void **set_db** **(** :ref:`int` amount **)** - -.. _class_AudioEffectFilter_set_gain: - -- void **set_gain** **(** :ref:`float` amount **)** - -.. _class_AudioEffectFilter_set_resonance: - -- void **set_resonance** **(** :ref:`float` amount **)** - - diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 444ab2bc2..29e9c149f 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -16,27 +16,6 @@ Brief Description Adds a soft clip Limiter audio effect to an Audio bus. -Member Functions ----------------- - -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ceiling_db` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_soft_clip_db` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_soft_clip_ratio` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_threshold_db` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ceiling_db` **(** :ref:`float` ceiling **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_soft_clip_db` **(** :ref:`float` soft_clip **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_soft_clip_ratio` **(** :ref:`float` soft_clip **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_threshold_db` **(** :ref:`float` threshold **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -64,39 +43,3 @@ A limiter is similar to a compressor, but it’s less flexible and designed to d Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded. -Member Function Description ---------------------------- - -.. _class_AudioEffectLimiter_get_ceiling_db: - -- :ref:`float` **get_ceiling_db** **(** **)** const - -.. _class_AudioEffectLimiter_get_soft_clip_db: - -- :ref:`float` **get_soft_clip_db** **(** **)** const - -.. _class_AudioEffectLimiter_get_soft_clip_ratio: - -- :ref:`float` **get_soft_clip_ratio** **(** **)** const - -.. _class_AudioEffectLimiter_get_threshold_db: - -- :ref:`float` **get_threshold_db** **(** **)** const - -.. _class_AudioEffectLimiter_set_ceiling_db: - -- void **set_ceiling_db** **(** :ref:`float` ceiling **)** - -.. _class_AudioEffectLimiter_set_soft_clip_db: - -- void **set_soft_clip_db** **(** :ref:`float` soft_clip **)** - -.. _class_AudioEffectLimiter_set_soft_clip_ratio: - -- void **set_soft_clip_ratio** **(** :ref:`float` soft_clip **)** - -.. _class_AudioEffectLimiter_set_threshold_db: - -- void **set_threshold_db** **(** :ref:`float` threshold **)** - - diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index f9e552b04..62472c6ed 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -16,15 +16,6 @@ Brief Description Adds a Panner audio effect to an Audio bus. Pans sound left or right. -Member Functions ----------------- - -+----------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pan` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`set_pan` **(** :ref:`float` cpanume **)** | -+----------------------------+-----------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,15 +29,3 @@ Description Determines how much of an audio signal is sent to the left and right buses. -Member Function Description ---------------------------- - -.. _class_AudioEffectPanner_get_pan: - -- :ref:`float` **get_pan** **(** **)** const - -.. _class_AudioEffectPanner_set_pan: - -- void **set_pan** **(** :ref:`float` cpanume **)** - - diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 3858a6b59..6b7e3395f 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -18,31 +18,6 @@ Adds a Phaser audio effect to an Audio bus. Combines the original signal with a copy that is slightly out of phase with the original. -Member Functions ----------------- - -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_depth` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_feedback` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range_max_hz` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range_min_hz` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rate_hz` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth` **(** :ref:`float` depth **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback` **(** :ref:`float` fbk **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_max_hz` **(** :ref:`float` hz **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_min_hz` **(** :ref:`float` hz **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rate_hz` **(** :ref:`float` hz **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -72,47 +47,3 @@ Description Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low Frequency Oscillator. -Member Function Description ---------------------------- - -.. _class_AudioEffectPhaser_get_depth: - -- :ref:`float` **get_depth** **(** **)** const - -.. _class_AudioEffectPhaser_get_feedback: - -- :ref:`float` **get_feedback** **(** **)** const - -.. _class_AudioEffectPhaser_get_range_max_hz: - -- :ref:`float` **get_range_max_hz** **(** **)** const - -.. _class_AudioEffectPhaser_get_range_min_hz: - -- :ref:`float` **get_range_min_hz** **(** **)** const - -.. _class_AudioEffectPhaser_get_rate_hz: - -- :ref:`float` **get_rate_hz** **(** **)** const - -.. _class_AudioEffectPhaser_set_depth: - -- void **set_depth** **(** :ref:`float` depth **)** - -.. _class_AudioEffectPhaser_set_feedback: - -- void **set_feedback** **(** :ref:`float` fbk **)** - -.. _class_AudioEffectPhaser_set_range_max_hz: - -- void **set_range_max_hz** **(** :ref:`float` hz **)** - -.. _class_AudioEffectPhaser_set_range_min_hz: - -- void **set_range_min_hz** **(** :ref:`float` hz **)** - -.. _class_AudioEffectPhaser_set_rate_hz: - -- void **set_rate_hz** **(** :ref:`float` hz **)** - - diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 40deafa6d..187e6e44d 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -18,15 +18,6 @@ Adds a Pitch shift audio effect to an Audio bus. Raises or lowers the pitch of original sound. -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pitch_scale` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pitch_scale` **(** :ref:`float` rate **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -40,15 +31,3 @@ Description Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients. -Member Function Description ---------------------------- - -.. _class_AudioEffectPitchShift_get_pitch_scale: - -- :ref:`float` **get_pitch_scale** **(** **)** const - -.. _class_AudioEffectPitchShift_set_pitch_scale: - -- void **set_pitch_scale** **(** :ref:`float` rate **)** - - diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index d7eaa99f9..5c6e5a457 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -21,39 +21,11 @@ Simulates the sound of acoustic environments such as rooms, concert halls, caver Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_damping` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dry` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_hpf` **(** **)** const | +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_predelay_feedback` **(** **)** const | +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_predelay_msec` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_room_size` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_spread` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_wet` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_damping` **(** :ref:`float` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dry` **(** :ref:`float` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hpf` **(** :ref:`float` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_predelay_feedback` **(** :ref:`float` feedback **)** | +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_predelay_msec` **(** :ref:`float` msec **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_room_size` **(** :ref:`float` size **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spread` **(** :ref:`float` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wet` **(** :ref:`float` amount **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -99,68 +71,12 @@ Simulates rooms of different sizes. Its parameters can be adjusted to simulate t Member Function Description --------------------------- -.. _class_AudioEffectReverb_get_damping: - -- :ref:`float` **get_damping** **(** **)** const - -.. _class_AudioEffectReverb_get_dry: - -- :ref:`float` **get_dry** **(** **)** const - -.. _class_AudioEffectReverb_get_hpf: - -- :ref:`float` **get_hpf** **(** **)** const - .. _class_AudioEffectReverb_get_predelay_feedback: - :ref:`float` **get_predelay_feedback** **(** **)** const -.. _class_AudioEffectReverb_get_predelay_msec: - -- :ref:`float` **get_predelay_msec** **(** **)** const - -.. _class_AudioEffectReverb_get_room_size: - -- :ref:`float` **get_room_size** **(** **)** const - -.. _class_AudioEffectReverb_get_spread: - -- :ref:`float` **get_spread** **(** **)** const - -.. _class_AudioEffectReverb_get_wet: - -- :ref:`float` **get_wet** **(** **)** const - -.. _class_AudioEffectReverb_set_damping: - -- void **set_damping** **(** :ref:`float` amount **)** - -.. _class_AudioEffectReverb_set_dry: - -- void **set_dry** **(** :ref:`float` amount **)** - -.. _class_AudioEffectReverb_set_hpf: - -- void **set_hpf** **(** :ref:`float` amount **)** - .. _class_AudioEffectReverb_set_predelay_feedback: - void **set_predelay_feedback** **(** :ref:`float` feedback **)** -.. _class_AudioEffectReverb_set_predelay_msec: - -- void **set_predelay_msec** **(** :ref:`float` msec **)** - -.. _class_AudioEffectReverb_set_room_size: - -- void **set_room_size** **(** :ref:`float` size **)** - -.. _class_AudioEffectReverb_set_spread: - -- void **set_spread** **(** :ref:`float` amount **)** - -.. _class_AudioEffectReverb_set_wet: - -- void **set_wet** **(** :ref:`float` amount **)** - diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 1921e5e88..191fd9e93 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -16,23 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pan_pullout` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_surround` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_pullout` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pan_pullout` **(** :ref:`float` amount **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_surround` **(** :ref:`float` amount **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_time_pullout` **(** :ref:`float` amount **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -49,31 +32,3 @@ Member Variables - :ref:`float` **time_pullout_ms** -Member Function Description ---------------------------- - -.. _class_AudioEffectStereoEnhance_get_pan_pullout: - -- :ref:`float` **get_pan_pullout** **(** **)** const - -.. _class_AudioEffectStereoEnhance_get_surround: - -- :ref:`float` **get_surround** **(** **)** const - -.. _class_AudioEffectStereoEnhance_get_time_pullout: - -- :ref:`float` **get_time_pullout** **(** **)** const - -.. _class_AudioEffectStereoEnhance_set_pan_pullout: - -- void **set_pan_pullout** **(** :ref:`float` amount **)** - -.. _class_AudioEffectStereoEnhance_set_surround: - -- void **set_surround** **(** :ref:`float` amount **)** - -.. _class_AudioEffectStereoEnhance_set_time_pullout: - -- void **set_time_pullout** **(** :ref:`float` amount **)** - - diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 01b0721b7..b3d8ed289 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -284,7 +284,7 @@ Sets the name of the bus at index ``bus_idx`` to ``name``. - void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`String` send **)** -Connects the output of the bus at ``bus_idx`` to the bus named ``send[/send]. +Connects the output of the bus at ``bus_idx`` to the bus named ``send``. .. _class_AudioServer_set_bus_solo: diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 3878817b9..100360818 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -16,23 +16,6 @@ Brief Description OGG Vorbis audio stream driver. -Member Functions ----------------- - -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_loop_offset` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enable **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_offset` **(** :ref:`float` seconds **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,31 +37,3 @@ Description OGG Vorbis audio stream driver. -Member Function Description ---------------------------- - -.. _class_AudioStreamOGGVorbis_get_data: - -- :ref:`PoolByteArray` **get_data** **(** **)** const - -.. _class_AudioStreamOGGVorbis_get_loop_offset: - -- :ref:`float` **get_loop_offset** **(** **)** const - -.. _class_AudioStreamOGGVorbis_has_loop: - -- :ref:`bool` **has_loop** **(** **)** const - -.. _class_AudioStreamOGGVorbis_set_data: - -- void **set_data** **(** :ref:`PoolByteArray` data **)** - -.. _class_AudioStreamOGGVorbis_set_loop: - -- void **set_loop** **(** :ref:`bool` enable **)** - -.. _class_AudioStreamOGGVorbis_set_loop_offset: - -- void **set_loop_offset** **(** :ref:`float` seconds **)** - - diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index ee2b80d88..acf03bb2e 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -19,37 +19,15 @@ Plays back audio. Member Functions ---------------- -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mix_target` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_target` **(** :ref:`int` mix_target **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++----------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++----------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------+ Signals ------- @@ -104,36 +82,12 @@ Plays background audio. Member Function Description --------------------------- -.. _class_AudioStreamPlayer_get_bus: - -- :ref:`String` **get_bus** **(** **)** const - -.. _class_AudioStreamPlayer_get_mix_target: - -- :ref:`int` **get_mix_target** **(** **)** const - .. _class_AudioStreamPlayer_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. -.. _class_AudioStreamPlayer_get_stream: - -- :ref:`AudioStream` **get_stream** **(** **)** const - -.. _class_AudioStreamPlayer_get_volume_db: - -- :ref:`float` **get_volume_db** **(** **)** const - -.. _class_AudioStreamPlayer_is_autoplay_enabled: - -- :ref:`bool` **is_autoplay_enabled** **(** **)** - -.. _class_AudioStreamPlayer_is_playing: - -- :ref:`bool` **is_playing** **(** **)** const - .. _class_AudioStreamPlayer_play: - void **play** **(** :ref:`float` from_position=0.0 **)** @@ -146,26 +100,6 @@ Plays the audio from the given position 'from_position', in seconds. Sets the position from which audio will be played, in seconds. -.. _class_AudioStreamPlayer_set_autoplay: - -- void **set_autoplay** **(** :ref:`bool` enable **)** - -.. _class_AudioStreamPlayer_set_bus: - -- void **set_bus** **(** :ref:`String` bus **)** - -.. _class_AudioStreamPlayer_set_mix_target: - -- void **set_mix_target** **(** :ref:`int` mix_target **)** - -.. _class_AudioStreamPlayer_set_stream: - -- void **set_stream** **(** :ref:`AudioStream` stream **)** - -.. _class_AudioStreamPlayer_set_volume_db: - -- void **set_volume_db** **(** :ref:`float` volume_db **)** - .. _class_AudioStreamPlayer_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index b5356b34b..947cbd28b 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -19,45 +19,15 @@ Plays audio in 2D. Member Functions ---------------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_area_mask` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attenuation` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_distance` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation` **(** :ref:`float` curve **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_distance` **(** :ref:`float` pixels **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ Signals ------- @@ -113,44 +83,12 @@ Plays audio that dampens with distance from screen center. Member Function Description --------------------------- -.. _class_AudioStreamPlayer2D_get_area_mask: - -- :ref:`int` **get_area_mask** **(** **)** const - -.. _class_AudioStreamPlayer2D_get_attenuation: - -- :ref:`float` **get_attenuation** **(** **)** const - -.. _class_AudioStreamPlayer2D_get_bus: - -- :ref:`String` **get_bus** **(** **)** const - -.. _class_AudioStreamPlayer2D_get_max_distance: - -- :ref:`float` **get_max_distance** **(** **)** const - .. _class_AudioStreamPlayer2D_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. -.. _class_AudioStreamPlayer2D_get_stream: - -- :ref:`AudioStream` **get_stream** **(** **)** const - -.. _class_AudioStreamPlayer2D_get_volume_db: - -- :ref:`float` **get_volume_db** **(** **)** const - -.. _class_AudioStreamPlayer2D_is_autoplay_enabled: - -- :ref:`bool` **is_autoplay_enabled** **(** **)** - -.. _class_AudioStreamPlayer2D_is_playing: - -- :ref:`bool` **is_playing** **(** **)** const - .. _class_AudioStreamPlayer2D_play: - void **play** **(** :ref:`float` from_position=0.0 **)** @@ -163,34 +101,6 @@ Plays the audio from the given position 'from_position', in seconds. Sets the position from which audio will be played, in seconds. -.. _class_AudioStreamPlayer2D_set_area_mask: - -- void **set_area_mask** **(** :ref:`int` mask **)** - -.. _class_AudioStreamPlayer2D_set_attenuation: - -- void **set_attenuation** **(** :ref:`float` curve **)** - -.. _class_AudioStreamPlayer2D_set_autoplay: - -- void **set_autoplay** **(** :ref:`bool` enable **)** - -.. _class_AudioStreamPlayer2D_set_bus: - -- void **set_bus** **(** :ref:`String` bus **)** - -.. _class_AudioStreamPlayer2D_set_max_distance: - -- void **set_max_distance** **(** :ref:`float` pixels **)** - -.. _class_AudioStreamPlayer2D_set_stream: - -- void **set_stream** **(** :ref:`AudioStream` stream **)** - -.. _class_AudioStreamPlayer2D_set_volume_db: - -- void **set_volume_db** **(** :ref:`float` volume_db **)** - .. _class_AudioStreamPlayer2D_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index b7b0b21bc..08fe24e10 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -19,81 +19,15 @@ Plays 3D sound in 3D space Member Functions ---------------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_area_mask` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attenuation_filter_cutoff_hz` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attenuation_filter_db` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_attenuation_model` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_doppler_tracking` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_angle` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_angle_filter_attenuation_db` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_db` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_distance` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_out_of_range_mode` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_unit_db` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_unit_size` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emission_angle_enabled` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation_filter_cutoff_hz` **(** :ref:`float` degrees **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation_filter_db` **(** :ref:`float` db **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation_model` **(** :ref:`int` model **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_doppler_tracking` **(** :ref:`int` mode **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_angle` **(** :ref:`float` degrees **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_angle_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_angle_filter_attenuation_db` **(** :ref:`float` db **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_db` **(** :ref:`float` max_db **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_distance` **(** :ref:`float` metres **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_out_of_range_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unit_db` **(** :ref:`float` unit_db **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unit_size` **(** :ref:`float` unit_size **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ Signals ------- @@ -197,80 +131,12 @@ Plays a sound effect with directed sound effects, dampens with distance if neede Member Function Description --------------------------- -.. _class_AudioStreamPlayer3D_get_area_mask: - -- :ref:`int` **get_area_mask** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_attenuation_filter_cutoff_hz: - -- :ref:`float` **get_attenuation_filter_cutoff_hz** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_attenuation_filter_db: - -- :ref:`float` **get_attenuation_filter_db** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_attenuation_model: - -- :ref:`int` **get_attenuation_model** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_bus: - -- :ref:`String` **get_bus** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_doppler_tracking: - -- :ref:`int` **get_doppler_tracking** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_emission_angle: - -- :ref:`float` **get_emission_angle** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_emission_angle_filter_attenuation_db: - -- :ref:`float` **get_emission_angle_filter_attenuation_db** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_max_db: - -- :ref:`float` **get_max_db** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_max_distance: - -- :ref:`float` **get_max_distance** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_out_of_range_mode: - -- :ref:`int` **get_out_of_range_mode** **(** **)** const - .. _class_AudioStreamPlayer3D_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. -.. _class_AudioStreamPlayer3D_get_stream: - -- :ref:`AudioStream` **get_stream** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_unit_db: - -- :ref:`float` **get_unit_db** **(** **)** const - -.. _class_AudioStreamPlayer3D_get_unit_size: - -- :ref:`float` **get_unit_size** **(** **)** const - -.. _class_AudioStreamPlayer3D_is_autoplay_enabled: - -- :ref:`bool` **is_autoplay_enabled** **(** **)** - -.. _class_AudioStreamPlayer3D_is_emission_angle_enabled: - -- :ref:`bool` **is_emission_angle_enabled** **(** **)** const - -.. _class_AudioStreamPlayer3D_is_playing: - -- :ref:`bool` **is_playing** **(** **)** const - .. _class_AudioStreamPlayer3D_play: - void **play** **(** :ref:`float` from_position=0.0 **)** @@ -283,70 +149,6 @@ Plays the audio from the given position 'from_position', in seconds. Sets the position from which audio will be played, in seconds. -.. _class_AudioStreamPlayer3D_set_area_mask: - -- void **set_area_mask** **(** :ref:`int` mask **)** - -.. _class_AudioStreamPlayer3D_set_attenuation_filter_cutoff_hz: - -- void **set_attenuation_filter_cutoff_hz** **(** :ref:`float` degrees **)** - -.. _class_AudioStreamPlayer3D_set_attenuation_filter_db: - -- void **set_attenuation_filter_db** **(** :ref:`float` db **)** - -.. _class_AudioStreamPlayer3D_set_attenuation_model: - -- void **set_attenuation_model** **(** :ref:`int` model **)** - -.. _class_AudioStreamPlayer3D_set_autoplay: - -- void **set_autoplay** **(** :ref:`bool` enable **)** - -.. _class_AudioStreamPlayer3D_set_bus: - -- void **set_bus** **(** :ref:`String` bus **)** - -.. _class_AudioStreamPlayer3D_set_doppler_tracking: - -- void **set_doppler_tracking** **(** :ref:`int` mode **)** - -.. _class_AudioStreamPlayer3D_set_emission_angle: - -- void **set_emission_angle** **(** :ref:`float` degrees **)** - -.. _class_AudioStreamPlayer3D_set_emission_angle_enabled: - -- void **set_emission_angle_enabled** **(** :ref:`bool` enabled **)** - -.. _class_AudioStreamPlayer3D_set_emission_angle_filter_attenuation_db: - -- void **set_emission_angle_filter_attenuation_db** **(** :ref:`float` db **)** - -.. _class_AudioStreamPlayer3D_set_max_db: - -- void **set_max_db** **(** :ref:`float` max_db **)** - -.. _class_AudioStreamPlayer3D_set_max_distance: - -- void **set_max_distance** **(** :ref:`float` metres **)** - -.. _class_AudioStreamPlayer3D_set_out_of_range_mode: - -- void **set_out_of_range_mode** **(** :ref:`int` mode **)** - -.. _class_AudioStreamPlayer3D_set_stream: - -- void **set_stream** **(** :ref:`AudioStream` stream **)** - -.. _class_AudioStreamPlayer3D_set_unit_db: - -- void **set_unit_db** **(** :ref:`float` unit_db **)** - -.. _class_AudioStreamPlayer3D_set_unit_size: - -- void **set_unit_size** **(** :ref:`float` unit_size **)** - .. _class_AudioStreamPlayer3D_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 003822ca3..8f167b66f 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -16,19 +16,6 @@ Brief Description Plays audio with random pitch tweaking. -Member Functions ----------------- - -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_audio_stream` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_random_pitch` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_random_pitch` **(** :ref:`float` scale **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,23 +33,3 @@ Description Randomly varies pitch on each start. -Member Function Description ---------------------------- - -.. _class_AudioStreamRandomPitch_get_audio_stream: - -- :ref:`AudioStream` **get_audio_stream** **(** **)** const - -.. _class_AudioStreamRandomPitch_get_random_pitch: - -- :ref:`float` **get_random_pitch** **(** **)** const - -.. _class_AudioStreamRandomPitch_set_audio_stream: - -- void **set_audio_stream** **(** :ref:`AudioStream` stream **)** - -.. _class_AudioStreamRandomPitch_set_random_pitch: - -- void **set_random_pitch** **(** :ref:`float` scale **)** - - diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 394fed1b5..0b1fb49ab 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -16,39 +16,6 @@ Brief Description Plays audio. -Member Functions ----------------- - -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_begin` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_end` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_mode` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mix_rate` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stereo` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_format` **(** :ref:`int` format **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_begin` **(** :ref:`int` loop_begin **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_end` **(** :ref:`int` loop_end **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_mode` **(** :ref:`int` loop_mode **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_rate` **(** :ref:`int` mix_rate **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stereo` **(** :ref:`bool` stereo **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -96,63 +63,3 @@ Description Plays audio, can loop. -Member Function Description ---------------------------- - -.. _class_AudioStreamSample_get_data: - -- :ref:`PoolByteArray` **get_data** **(** **)** const - -.. _class_AudioStreamSample_get_format: - -- :ref:`int` **get_format** **(** **)** const - -.. _class_AudioStreamSample_get_loop_begin: - -- :ref:`int` **get_loop_begin** **(** **)** const - -.. _class_AudioStreamSample_get_loop_end: - -- :ref:`int` **get_loop_end** **(** **)** const - -.. _class_AudioStreamSample_get_loop_mode: - -- :ref:`int` **get_loop_mode** **(** **)** const - -.. _class_AudioStreamSample_get_mix_rate: - -- :ref:`int` **get_mix_rate** **(** **)** const - -.. _class_AudioStreamSample_is_stereo: - -- :ref:`bool` **is_stereo** **(** **)** const - -.. _class_AudioStreamSample_set_data: - -- void **set_data** **(** :ref:`PoolByteArray` data **)** - -.. _class_AudioStreamSample_set_format: - -- void **set_format** **(** :ref:`int` format **)** - -.. _class_AudioStreamSample_set_loop_begin: - -- void **set_loop_begin** **(** :ref:`int` loop_begin **)** - -.. _class_AudioStreamSample_set_loop_end: - -- void **set_loop_end** **(** :ref:`int` loop_end **)** - -.. _class_AudioStreamSample_set_loop_mode: - -- void **set_loop_mode** **(** :ref:`int` loop_mode **)** - -.. _class_AudioStreamSample_set_mix_rate: - -- void **set_mix_rate** **(** :ref:`int` mix_rate **)** - -.. _class_AudioStreamSample_set_stereo: - -- void **set_stereo** **(** :ref:`bool` stereo **)** - - diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index f8f49ce20..ec98bd4d8 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -16,19 +16,6 @@ Brief Description Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction. -Member Functions ----------------- - -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_copy_mode` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_copy_mode` **(** :ref:`int` copy_mode **)** | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | -+----------------------------+------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -53,31 +40,3 @@ Description Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction. -Member Function Description ---------------------------- - -.. _class_BackBufferCopy_get_copy_mode: - -- :ref:`int` **get_copy_mode** **(** **)** const - -Return the copy mode currently applied to the BackBufferCopy. See ``COPY_MODE\_\*`` constants. - -.. _class_BackBufferCopy_get_rect: - -- :ref:`Rect2` **get_rect** **(** **)** const - -Return the area covered by the BackBufferCopy. - -.. _class_BackBufferCopy_set_copy_mode: - -- void **set_copy_mode** **(** :ref:`int` copy_mode **)** - -Set the copy mode of the BackBufferCopy. See ``COPY_MODE\_\*`` constants. - -.. _class_BackBufferCopy_set_rect: - -- void **set_rect** **(** :ref:`Rect2` rect **)** - -Defines the area covered by the BackBufferCopy. - - diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 889182471..52bb7f550 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -21,43 +21,15 @@ Base class for different kinds of buttons. Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_pressed` **(** **)** virtual | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_toggled` **(** :ref:`bool` pressed **)** virtual | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_action_mode` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ButtonGroup` | :ref:`get_button_group` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_mode` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_enabled_focus_mode` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`get_shortcut` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hovered` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_toggle_mode` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_group` **(** :ref:`ButtonGroup` button_group **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled_focus_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shortcut` **(** :ref:`ShortCut` shortcut **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_toggle_mode` **(** :ref:`bool` enabled **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`_pressed` **(** **)** virtual | ++--------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`_toggled` **(** :ref:`bool` pressed **)** virtual | ++--------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_mode` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hovered` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------+ Signals ------- @@ -149,92 +121,16 @@ Called when button is pressed. Called when button is toggled (only if toggle_mode is active). -.. _class_BaseButton_get_action_mode: - -- :ref:`int` **get_action_mode** **(** **)** const - -Return the current mode of action (see :ref:`set_action_mode`) (one of the ACTION_MODE\_\* constants). - -.. _class_BaseButton_get_button_group: - -- :ref:`ButtonGroup` **get_button_group** **(** **)** const - .. _class_BaseButton_get_draw_mode: - :ref:`int` **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 overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum. -.. _class_BaseButton_get_enabled_focus_mode: - -- :ref:`int` **get_enabled_focus_mode** **(** **)** const - -Returns focus access mode used when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`set_disabled`). - -.. _class_BaseButton_get_shortcut: - -- :ref:`ShortCut` **get_shortcut** **(** **)** const - -.. _class_BaseButton_is_disabled: - -- :ref:`bool` **is_disabled** **(** **)** const - -Return whether the button is in disabled state (see :ref:`set_disabled`). - .. _class_BaseButton_is_hovered: - :ref:`bool` **is_hovered** **(** **)** const Return true if mouse entered the button before it exit. -.. _class_BaseButton_is_pressed: - -- :ref:`bool` **is_pressed** **(** **)** const - -If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down. - -.. _class_BaseButton_is_toggle_mode: - -- :ref:`bool` **is_toggle_mode** **(** **)** const - -Return the toggle_mode property (see :ref:`set_toggle_mode`). - -.. _class_BaseButton_set_action_mode: - -- void **set_action_mode** **(** :ref:`int` mode **)** - -Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE\_\* constants). - -.. _class_BaseButton_set_button_group: - -- void **set_button_group** **(** :ref:`ButtonGroup` button_group **)** - -.. _class_BaseButton_set_disabled: - -- void **set_disabled** **(** :ref:`bool` disabled **)** - -Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. - -.. _class_BaseButton_set_enabled_focus_mode: - -- void **set_enabled_focus_mode** **(** :ref:`int` mode **)** - -Sets the focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`set_disabled`). - -.. _class_BaseButton_set_pressed: - -- void **set_pressed** **(** :ref:`bool` pressed **)** - -Set the button to pressed state (only if toggle_mode is active). - -.. _class_BaseButton_set_shortcut: - -- void **set_shortcut** **(** :ref:`ShortCut` shortcut **)** - -.. _class_BaseButton_set_toggle_mode: - -- void **set_toggle_mode** **(** :ref:`bool` enabled **)** - -Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. - diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 5dc9da888..bc07b0186 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -20,7 +20,7 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** :ref:`Quat` from **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` euler **)** | +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` from **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -89,7 +89,7 @@ Create a rotation matrix from the given quaternion. .. _class_Basis_Basis: -- :ref:`Basis` **Basis** **(** :ref:`Vector3` euler **)** +- :ref:`Basis` **Basis** **(** :ref:`Vector3` from **)** Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle). diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 2e0367005..cd28c822a 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -19,35 +19,25 @@ Renders text using ``\*.fnt`` fonts. Member Functions ---------------- -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BitmapFont` | :ref:`get_fallback` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_count` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ascent` **(** :ref:`float` px **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_field_hint` **(** :ref:`bool` enable **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback` **(** :ref:`BitmapFont` fallback **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` px **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_count` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -125,12 +115,6 @@ Creates a BitmapFont from the ``\*.fnt`` file at ``path``. Returns the size of a character, optionally taking kerning into account if the next character is provided. -.. _class_BitmapFont_get_fallback: - -- :ref:`BitmapFont` **get_fallback** **(** **)** const - -Returns the fallback BitmapFont. - .. _class_BitmapFont_get_kerning_pair: - :ref:`int` **get_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b **)** const @@ -149,28 +133,4 @@ Returns the font atlas texture at index ``idx``. Returns the number of textures in the BitmapFont atlas. -.. _class_BitmapFont_set_ascent: - -- void **set_ascent** **(** :ref:`float` px **)** - -Sets the font ascent (number of pixels above the baseline). - -.. _class_BitmapFont_set_distance_field_hint: - -- void **set_distance_field_hint** **(** :ref:`bool` enable **)** - -If ``true`` distance field hint is enabled. - -.. _class_BitmapFont_set_fallback: - -- void **set_fallback** **(** :ref:`BitmapFont` fallback **)** - -Sets the fallback BitmapFont. - -.. _class_BitmapFont_set_height: - -- void **set_height** **(** :ref:`float` px **)** - -Sets the total font height (ascent plus descent) in pixels. - diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index ee771b9e3..df48df626 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -21,13 +21,9 @@ Base class for box containers. Member Functions ---------------- -+------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`add_spacer` **(** :ref:`bool` begin **)** | -+------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_alignment` **(** **)** const | -+------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_alignment` **(** :ref:`int` alignment **)** | -+------------------------+----------------------------------------------------------------------------------------------------+ ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`add_spacer` **(** :ref:`bool` begin **)** | ++-------+--------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -58,16 +54,4 @@ Member Function Description Adds a control to the box as a spacer. If ``true``, *begin* will insert the spacer control in front of other children. -.. _class_BoxContainer_get_alignment: - -- :ref:`int` **get_alignment** **(** **)** const - -Return the alignment of children in the container. - -.. _class_BoxContainer_set_alignment: - -- void **set_alignment** **(** :ref:`int` alignment **)** - -Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END). - diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index ceef5f9c1..91e03edff 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -16,15 +16,6 @@ Brief Description Box shape resource. -Member Functions ----------------- - -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description 3D box shape that can be a child of a :ref:`PhysicsBody` or :ref:`Area`. -Member Function Description ---------------------------- - -.. _class_BoxShape_get_extents: - -- :ref:`Vector3` **get_extents** **(** **)** const - -Return the half extents of the shape. - -.. _class_BoxShape_set_extents: - -- void **set_extents** **(** :ref:`Vector3` extents **)** - -Set the half extents for the shape. - - diff --git a/classes/class_button.rst b/classes/class_button.rst index b74d078c5..b8b552a61 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -18,31 +18,6 @@ Brief Description Standard themed Button. -Member Functions ----------------- - -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button_icon` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_clip_text` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_text_align` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flat` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_icon` **(** :ref:`Texture` texture **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip_text` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flat` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text_align` **(** :ref:`int` align **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -79,47 +54,3 @@ Description Button is the standard themed button. It can contain text and an icon, and will display them according to the current :ref:`Theme`. -Member Function Description ---------------------------- - -.. _class_Button_get_button_icon: - -- :ref:`Texture` **get_button_icon** **(** **)** const - -.. _class_Button_get_clip_text: - -- :ref:`bool` **get_clip_text** **(** **)** const - -.. _class_Button_get_text: - -- :ref:`String` **get_text** **(** **)** const - -.. _class_Button_get_text_align: - -- :ref:`int` **get_text_align** **(** **)** const - -.. _class_Button_is_flat: - -- :ref:`bool` **is_flat** **(** **)** const - -.. _class_Button_set_button_icon: - -- void **set_button_icon** **(** :ref:`Texture` texture **)** - -.. _class_Button_set_clip_text: - -- void **set_clip_text** **(** :ref:`bool` enabled **)** - -.. _class_Button_set_flat: - -- void **set_flat** **(** :ref:`bool` enabled **)** - -.. _class_Button_set_text: - -- void **set_text** **(** :ref:`String` text **)** - -.. _class_Button_set_text_align: - -- void **set_text_align** **(** :ref:`int` align **)** - - diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 789008523..84225f51d 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -19,91 +19,33 @@ Camera node for 2D scenes. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`align` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_update_scroll` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_custom_viewport` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_follow_smoothing` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_h_offset` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_limit` **(** :ref:`int` margin **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_offset` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_zoom` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_current` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_follow_smoothing_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_limit_drawing_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_limit_smoothing_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_margin_drawing_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rotating` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_screen_drawing_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset_smoothing` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_mode` **(** :ref:`int` anchor_mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_viewport` **(** :ref:`Node` viewport **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_margin` **(** :ref:`int` margin, :ref:`float` drag_margin **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_follow_smoothing` **(** :ref:`bool` follow_smoothing **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_follow_smoothing` **(** :ref:`float` follow_smoothing **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_drag_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_drawing_enabled` **(** :ref:`bool` limit_drawing_enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_smoothing_enabled` **(** :ref:`bool` limit_smoothing_enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin_drawing_enabled` **(** :ref:`bool` margin_drawing_enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_drawing_enabled` **(** :ref:`bool` screen_drawing_enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`align` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_update_scroll` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_custom_viewport` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_h_offset` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_offset` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset_smoothing` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Node` viewport **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -225,10 +167,6 @@ Align the camera to the tracked node Force the camera to update scroll immediately. -.. _class_Camera2D_get_anchor_mode: - -- :ref:`int` **get_anchor_mode** **(** **)** const - .. _class_Camera2D_get_camera_position: - :ref:`Vector2` **get_camera_position** **(** **)** const @@ -243,78 +181,14 @@ Return the camera position. - :ref:`Node` **get_custom_viewport** **(** **)** const -.. _class_Camera2D_get_drag_margin: - -- :ref:`float` **get_drag_margin** **(** :ref:`int` margin **)** const - -Return the margins needed to drag the camera (see :ref:`set_drag_margin`). - -.. _class_Camera2D_get_follow_smoothing: - -- :ref:`float` **get_follow_smoothing** **(** **)** const - .. _class_Camera2D_get_h_offset: - :ref:`float` **get_h_offset** **(** **)** const -.. _class_Camera2D_get_limit: - -- :ref:`int` **get_limit** **(** :ref:`int` margin **)** const - -Return the scrolling limit in pixels. - -.. _class_Camera2D_get_offset: - -- :ref:`Vector2` **get_offset** **(** **)** const - -Return the scroll offset. - .. _class_Camera2D_get_v_offset: - :ref:`float` **get_v_offset** **(** **)** const -.. _class_Camera2D_get_zoom: - -- :ref:`Vector2` **get_zoom** **(** **)** const - -.. _class_Camera2D_is_current: - -- :ref:`bool` **is_current** **(** **)** const - -Return true of this is the current camera (see :ref:`make_current`). - -.. _class_Camera2D_is_follow_smoothing_enabled: - -- :ref:`bool` **is_follow_smoothing_enabled** **(** **)** const - -.. _class_Camera2D_is_h_drag_enabled: - -- :ref:`bool` **is_h_drag_enabled** **(** **)** const - -.. _class_Camera2D_is_limit_drawing_enabled: - -- :ref:`bool` **is_limit_drawing_enabled** **(** **)** const - -.. _class_Camera2D_is_limit_smoothing_enabled: - -- :ref:`bool` **is_limit_smoothing_enabled** **(** **)** const - -.. _class_Camera2D_is_margin_drawing_enabled: - -- :ref:`bool` **is_margin_drawing_enabled** **(** **)** const - -.. _class_Camera2D_is_rotating: - -- :ref:`bool` **is_rotating** **(** **)** const - -.. _class_Camera2D_is_screen_drawing_enabled: - -- :ref:`bool` **is_screen_drawing_enabled** **(** **)** const - -.. _class_Camera2D_is_v_drag_enabled: - -- :ref:`bool` **is_v_drag_enabled** **(** **)** const - .. _class_Camera2D_make_current: - void **make_current** **(** **)** @@ -329,82 +203,16 @@ Set the camera's position immediately to its current smoothing destination. This has no effect if smoothing is disabled. -.. _class_Camera2D_set_anchor_mode: - -- void **set_anchor_mode** **(** :ref:`int` anchor_mode **)** - .. _class_Camera2D_set_custom_viewport: - void **set_custom_viewport** **(** :ref:`Node` viewport **)** -.. _class_Camera2D_set_drag_margin: - -- 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. - -.. _class_Camera2D_set_enable_follow_smoothing: - -- void **set_enable_follow_smoothing** **(** :ref:`bool` follow_smoothing **)** - -.. _class_Camera2D_set_follow_smoothing: - -- void **set_follow_smoothing** **(** :ref:`float` follow_smoothing **)** - -.. _class_Camera2D_set_h_drag_enabled: - -- void **set_h_drag_enabled** **(** :ref:`bool` enabled **)** - .. _class_Camera2D_set_h_offset: - void **set_h_offset** **(** :ref:`float` ofs **)** -.. _class_Camera2D_set_limit: - -- void **set_limit** **(** :ref:`int` margin, :ref:`int` limit **)** - -Set the scrolling limit in pixels. - -.. _class_Camera2D_set_limit_drawing_enabled: - -- void **set_limit_drawing_enabled** **(** :ref:`bool` limit_drawing_enabled **)** - -.. _class_Camera2D_set_limit_smoothing_enabled: - -- void **set_limit_smoothing_enabled** **(** :ref:`bool` limit_smoothing_enabled **)** - -Smooth camera when reaching camera limits. - -This requires camera smoothing being enabled to have a noticeable effect. - -.. _class_Camera2D_set_margin_drawing_enabled: - -- void **set_margin_drawing_enabled** **(** :ref:`bool` margin_drawing_enabled **)** - -.. _class_Camera2D_set_offset: - -- void **set_offset** **(** :ref:`Vector2` offset **)** - -Set the scroll offset. Useful for looking around or camera shake animations. - -.. _class_Camera2D_set_rotating: - -- void **set_rotating** **(** :ref:`bool` rotating **)** - -.. _class_Camera2D_set_screen_drawing_enabled: - -- void **set_screen_drawing_enabled** **(** :ref:`bool` screen_drawing_enabled **)** - -.. _class_Camera2D_set_v_drag_enabled: - -- void **set_v_drag_enabled** **(** :ref:`bool` enabled **)** - .. _class_Camera2D_set_v_offset: - void **set_v_offset** **(** :ref:`float` ofs **)** -.. _class_Camera2D_set_zoom: - -- void **set_zoom** **(** :ref:`Vector2` zoom **)** - diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 6f5fafbf7..5c3cc8f52 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -56,14 +56,6 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_canvas` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | @@ -76,24 +68,10 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_light_mask` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | @@ -102,16 +80,12 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hide` **(** **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | @@ -120,24 +94,10 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show` **(** **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update` **(** **)** | @@ -333,28 +293,6 @@ Draw a textured rectangle at a given position, optionally modulated by a color. Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. -.. _class_CanvasItem_edit_get_state: - -- :ref:`Variant` **edit_get_state** **(** **)** const - -Used for editing, returns an opaque value representing the transform state. - -.. _class_CanvasItem_edit_rotate: - -- void **edit_rotate** **(** :ref:`float` degrees **)** - -Used for editing, handle rotation. - -.. _class_CanvasItem_edit_set_rect: - -- void **edit_set_rect** **(** :ref:`Rect2` rect **)** - -.. _class_CanvasItem_edit_set_state: - -- void **edit_set_state** **(** :ref:`Variant` state **)** - -Set the transform state of this CanvasItem. For :ref:`Node2D`, this is an :ref:`Array` with (in order) a :ref:`Vector2` for position, a float for rotation (radians) and another :ref:`Vector2` for scale. For :ref:`Control` this is a :ref:`Rect2` with the position and size. - .. _class_CanvasItem_get_canvas: - :ref:`RID` **get_canvas** **(** **)** const @@ -391,60 +329,18 @@ Get the global transform matrix of this item. Get the global transform matrix of this item in relation to the canvas. -.. _class_CanvasItem_get_item_and_children_rect: - -- :ref:`Rect2` **get_item_and_children_rect** **(** **)** const - -Get a :ref:`Rect2` with the boundaries of this item and its children. - -.. _class_CanvasItem_get_item_rect: - -- :ref:`Rect2` **get_item_rect** **(** **)** const - -Return a rect containing the editable boundaries of the item. - -.. _class_CanvasItem_get_light_mask: - -- :ref:`int` **get_light_mask** **(** **)** const - -Get this item's light mask number. - .. _class_CanvasItem_get_local_mouse_position: - :ref:`Vector2` **get_local_mouse_position** **(** **)** const Get the mouse position relative to this item's position. -.. _class_CanvasItem_get_material: - -- :ref:`Material` **get_material** **(** **)** const - -Get the material of this item. - -.. _class_CanvasItem_get_modulate: - -- :ref:`Color` **get_modulate** **(** **)** const - -Get the modulate of the CanvasItem, which affects children items too. - -.. _class_CanvasItem_get_self_modulate: - -- :ref:`Color` **get_self_modulate** **(** **)** const - -Get the self-modulate of the CanvasItem. - .. _class_CanvasItem_get_transform: - :ref:`Transform2D` **get_transform** **(** **)** const Get the transform matrix of this item. -.. _class_CanvasItem_get_use_parent_material: - -- :ref:`bool` **get_use_parent_material** **(** **)** const - -Get whether this item uses its parent's material. - .. _class_CanvasItem_get_viewport_rect: - :ref:`Rect2` **get_viewport_rect** **(** **)** const @@ -469,12 +365,6 @@ Get the :ref:`World2D` where this item is in. Hide the CanvasItem currently visible. -.. _class_CanvasItem_is_draw_behind_parent_enabled: - -- :ref:`bool` **is_draw_behind_parent_enabled** **(** **)** const - -Return whether the item is drawn behind its parent. - .. _class_CanvasItem_is_local_transform_notification_enabled: - :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const @@ -489,12 +379,6 @@ Return if set as toplevel. See :ref:`set_as_toplevel` **is_transform_notification_enabled** **(** **)** const -.. _class_CanvasItem_is_visible: - -- :ref:`bool` **is_visible** **(** **)** const - -Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. - .. _class_CanvasItem_is_visible_in_tree: - :ref:`bool` **is_visible_in_tree** **(** **)** const @@ -513,30 +397,6 @@ Return true if this CanvasItem is visible. It may be invisible because itself or Set as top level. This means that it will not inherit transform from parent canvas items. -.. _class_CanvasItem_set_draw_behind_parent: - -- void **set_draw_behind_parent** **(** :ref:`bool` enable **)** - -Set whether the canvas item is drawn behind its parent. - -.. _class_CanvasItem_set_light_mask: - -- void **set_light_mask** **(** :ref:`int` light_mask **)** - -Set the ligtht mask number of this item. - -.. _class_CanvasItem_set_material: - -- void **set_material** **(** :ref:`Material` material **)** - -Set the material of this item. - -.. _class_CanvasItem_set_modulate: - -- void **set_modulate** **(** :ref:`Color` modulate **)** - -Set the modulate of the CanvasItem. This *affects* the modulation of children items. - .. _class_CanvasItem_set_notify_local_transform: - void **set_notify_local_transform** **(** :ref:`bool` enable **)** @@ -545,26 +405,6 @@ Set the modulate of the CanvasItem. This *affects* the modulation of children it - void **set_notify_transform** **(** :ref:`bool` enable **)** -.. _class_CanvasItem_set_self_modulate: - -- void **set_self_modulate** **(** :ref:`Color` self_modulate **)** - -Set the self-modulate of the CanvasItem. This does not affect the modulation of children items. - -.. _class_CanvasItem_set_use_parent_material: - -- void **set_use_parent_material** **(** :ref:`bool` enable **)** - -Set whether or not this item should use its parent's material. - -.. _class_CanvasItem_set_visible: - -- void **set_visible** **(** :ref:`bool` visible **)** - -Set whether this item should be visible or not. - -Note that a hidden CanvasItem will make all children hidden too, so no matter what is set here this item won't be shown if its parent or grandparents nodes are hidden. - .. _class_CanvasItem_show: - void **show** **(** **)** diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 1807f5eb8..c9192abab 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -16,19 +16,6 @@ Brief Description -Member Functions ----------------- - -+------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | -+------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_light_mode` **(** **)** const | -+------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | -+------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_mode` **(** :ref:`int` light_mode **)** | -+------------------------+-------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -53,23 +40,3 @@ Numeric Constants - **LIGHT_MODE_UNSHADED** = **1** - **LIGHT_MODE_LIGHT_ONLY** = **2** -Member Function Description ---------------------------- - -.. _class_CanvasItemMaterial_get_blend_mode: - -- :ref:`int` **get_blend_mode** **(** **)** const - -.. _class_CanvasItemMaterial_get_light_mode: - -- :ref:`int` **get_light_mode** **(** **)** const - -.. _class_CanvasItemMaterial_set_blend_mode: - -- void **set_blend_mode** **(** :ref:`int` blend_mode **)** - -.. _class_CanvasItemMaterial_set_light_mode: - -- void **set_light_mode** **(** :ref:`int` light_mode **)** - - diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 7b40a8d4c..c0652ce66 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -24,32 +24,16 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_custom_viewport` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rotation` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation_degrees` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_viewport` **(** :ref:`Node` viewport **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer` **(** :ref:`int` layer **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation` **(** :ref:`float` radians **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_degrees` **(** :ref:`float` degrees **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ @@ -85,36 +69,12 @@ Member Function Description - :ref:`Node` **get_custom_viewport** **(** **)** const -.. _class_CanvasLayer_get_layer: - -- :ref:`int` **get_layer** **(** **)** const - -Return the layer index, determines the draw order, a lower value will be below a higher one. - -.. _class_CanvasLayer_get_offset: - -- :ref:`Vector2` **get_offset** **(** **)** const - -Return the base offset for this layer (helper). - .. _class_CanvasLayer_get_rotation: - :ref:`float` **get_rotation** **(** **)** const Return the base rotation for this layer in radians (helper). -.. _class_CanvasLayer_get_rotation_degrees: - -- :ref:`float` **get_rotation_degrees** **(** **)** const - -Return the base rotation for this layer in degrees. - -.. _class_CanvasLayer_get_scale: - -- :ref:`Vector2` **get_scale** **(** **)** const - -Return the base scale for this layer (helper). - .. _class_CanvasLayer_get_transform: - :ref:`Transform2D` **get_transform** **(** **)** const @@ -131,36 +91,12 @@ Return the :ref:`World2D` used by this layer. - void **set_custom_viewport** **(** :ref:`Node` viewport **)** -.. _class_CanvasLayer_set_layer: - -- void **set_layer** **(** :ref:`int` layer **)** - -Set the layer index, determines the draw order, a lower value will be below a higher one. - -.. _class_CanvasLayer_set_offset: - -- void **set_offset** **(** :ref:`Vector2` offset **)** - -Set the base offset for this layer (helper). - .. _class_CanvasLayer_set_rotation: - void **set_rotation** **(** :ref:`float` radians **)** Set the base rotation for this layer in radians (helper). -.. _class_CanvasLayer_set_rotation_degrees: - -- void **set_rotation_degrees** **(** :ref:`float` degrees **)** - -Set the base rotation for this layer in degrees (helper). - -.. _class_CanvasLayer_set_scale: - -- void **set_scale** **(** :ref:`Vector2` scale **)** - -Set the base scale for this layer (helper). - .. _class_CanvasLayer_set_transform: - void **set_transform** **(** :ref:`Transform2D` transform **)** diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index a8198a31e..ad1820f49 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -16,15 +16,6 @@ Brief Description Tint the entire canvas. -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+----------------------------+----------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description ``CanvasModulate`` tints the canvas elements using its assigned ``color``. -Member Function Description ---------------------------- - -.. _class_CanvasModulate_get_color: - -- :ref:`Color` **get_color** **(** **)** const - -Gets the canvas tint color - -.. _class_CanvasModulate_set_color: - -- void **set_color** **(** :ref:`Color` color **)** - -Sets the canvas tint color - - diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index bf569f63c..a4fe74073 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -16,27 +16,6 @@ Brief Description Class representing a capsule-shaped :ref:`PrimitiveMesh`. -Member Functions ----------------- - -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mid_height` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rings` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mid_height` **(** :ref:`float` mid_height **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_segments` **(** :ref:`int` segments **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rings` **(** :ref:`int` rings **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -62,39 +41,3 @@ Description Class representing a capsule-shaped :ref:`PrimitiveMesh`. -Member Function Description ---------------------------- - -.. _class_CapsuleMesh_get_mid_height: - -- :ref:`float` **get_mid_height** **(** **)** const - -.. _class_CapsuleMesh_get_radial_segments: - -- :ref:`int` **get_radial_segments** **(** **)** const - -.. _class_CapsuleMesh_get_radius: - -- :ref:`float` **get_radius** **(** **)** const - -.. _class_CapsuleMesh_get_rings: - -- :ref:`int` **get_rings** **(** **)** const - -.. _class_CapsuleMesh_set_mid_height: - -- void **set_mid_height** **(** :ref:`float` mid_height **)** - -.. _class_CapsuleMesh_set_radial_segments: - -- void **set_radial_segments** **(** :ref:`int` segments **)** - -.. _class_CapsuleMesh_set_radius: - -- void **set_radius** **(** :ref:`float` radius **)** - -.. _class_CapsuleMesh_set_rings: - -- void **set_rings** **(** :ref:`int` rings **)** - - diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 0b772397c..63c0a55e4 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -16,19 +16,6 @@ Brief Description Capsule shape for collisions. -Member Functions ----------------- - -+----------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+----------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+-----------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,31 +33,3 @@ Description Capsule shape for collisions. -Member Function Description ---------------------------- - -.. _class_CapsuleShape_get_height: - -- :ref:`float` **get_height** **(** **)** const - -Return the capsule height. - -.. _class_CapsuleShape_get_radius: - -- :ref:`float` **get_radius** **(** **)** const - -Return the capsule radius. - -.. _class_CapsuleShape_set_height: - -- void **set_height** **(** :ref:`float` height **)** - -Set the capsule height. - -.. _class_CapsuleShape_set_radius: - -- void **set_radius** **(** :ref:`float` radius **)** - -Set the capsule radius. - - diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index b2e80b543..937b46e11 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -16,19 +16,6 @@ Brief Description Capsule shape for 2D collisions. -Member Functions ----------------- - -+----------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+-------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,31 +33,3 @@ Description Capsule shape for 2D collisions. -Member Function Description ---------------------------- - -.. _class_CapsuleShape2D_get_height: - -- :ref:`float` **get_height** **(** **)** const - -Return the height of the ``CapsuleShape2D``. - -.. _class_CapsuleShape2D_get_radius: - -- :ref:`float` **get_radius** **(** **)** const - -Return the radius of the ``CapsuleShape2D``. - -.. _class_CapsuleShape2D_set_height: - -- void **set_height** **(** :ref:`float` height **)** - -Set the height of the ``CapsuleShape2D``. - -.. _class_CapsuleShape2D_set_radius: - -- void **set_radius** **(** :ref:`float` radius **)** - -Set the radius of the ``CapsuleShape2D``. - - diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index a1ff09bdc..7d927b0cc 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -16,15 +16,6 @@ Brief Description Keeps children controls centered. -Member Functions ----------------- - -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_top_left` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_top_left` **(** :ref:`bool` enable **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center. -Member Function Description ---------------------------- - -.. _class_CenterContainer_is_using_top_left: - -- :ref:`bool` **is_using_top_left** **(** **)** const - -Should put children to the top left corner instead of center of the container. - -.. _class_CenterContainer_set_use_top_left: - -- void **set_use_top_left** **(** :ref:`bool` enable **)** - -This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container). - - diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 620e8171e..995f24959 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -16,15 +16,6 @@ Brief Description Circular shape for 2D collisions. -Member Functions ----------------- - -+----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast. -Member Function Description ---------------------------- - -.. _class_CircleShape2D_get_radius: - -- :ref:`float` **get_radius** **(** **)** const - -Return the radius of the circle shape. - -.. _class_CircleShape2D_set_radius: - -- void **set_radius** **(** :ref:`float` radius **)** - -Set the radius of the circle shape. - - diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 24c325ec6..b95576443 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -26,22 +26,14 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_capture_input_on_drag` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_capture_input_on_drag` **(** :ref:`bool` enable **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | @@ -115,10 +107,6 @@ Member Function Description Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. -.. _class_CollisionObject_get_capture_input_on_drag: - -- :ref:`bool` **get_capture_input_on_drag** **(** **)** const - .. _class_CollisionObject_get_rid: - :ref:`RID` **get_rid** **(** **)** const @@ -131,10 +119,6 @@ Returns the object's :ref:`RID`. Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. -.. _class_CollisionObject_is_ray_pickable: - -- :ref:`bool` **is_ray_pickable** **(** **)** const - .. _class_CollisionObject_is_shape_owner_disabled: - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const @@ -147,14 +131,6 @@ If ``true`` the shape owner and its shapes are disabled. Removes the given shape owner. -.. _class_CollisionObject_set_capture_input_on_drag: - -- void **set_capture_input_on_drag** **(** :ref:`bool` enable **)** - -.. _class_CollisionObject_set_ray_pickable: - -- void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** - .. _class_CollisionObject_shape_find_owner: - :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 9da1b9396..7333b76a2 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -30,16 +30,12 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pickable` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_shape_owner_one_way_collision_enabled` **(** :ref:`int` owner_id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pickable` **(** :ref:`bool` enabled **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | @@ -125,12 +121,6 @@ Returns the object's :ref:`RID`. Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. -.. _class_CollisionObject2D_is_pickable: - -- :ref:`bool` **is_pickable** **(** **)** const - -Return whether this object is pickable. - .. _class_CollisionObject2D_is_shape_owner_disabled: - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const @@ -147,12 +137,6 @@ If ``true`` the shape owner and its shapes are disabled. Removes the given shape owner. -.. _class_CollisionObject2D_set_pickable: - -- void **set_pickable** **(** :ref:`bool` enabled **)** - -Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. - .. _class_CollisionObject2D_shape_find_owner: - :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 9f545413b..bcdc05f76 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -16,23 +16,6 @@ Brief Description Editor-only class for defining a collision polygon in 3D space. -Member Functions ----------------- - -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_depth` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth` **(** :ref:`float` depth **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,31 +37,3 @@ Description Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a :ref:`Shape` for gameplay. Properties modified during gameplay will have no effect. -Member Function Description ---------------------------- - -.. _class_CollisionPolygon_get_depth: - -- :ref:`float` **get_depth** **(** **)** const - -.. _class_CollisionPolygon_get_polygon: - -- :ref:`PoolVector2Array` **get_polygon** **(** **)** const - -.. _class_CollisionPolygon_is_disabled: - -- :ref:`bool` **is_disabled** **(** **)** const - -.. _class_CollisionPolygon_set_depth: - -- void **set_depth** **(** :ref:`float` depth **)** - -.. _class_CollisionPolygon_set_disabled: - -- void **set_disabled** **(** :ref:`bool` disabled **)** - -.. _class_CollisionPolygon_set_polygon: - -- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** - - diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 5e21d04a2..3d8f7e586 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -16,27 +16,6 @@ Brief Description Defines a 2D collision polygon. -Member Functions ----------------- - -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_build_mode` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_build_mode` **(** :ref:`int` build_mode **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -68,49 +47,3 @@ Description Provides a 2D collision polygon to a :ref:`CollisionObject2D` parent. Polygon can be drawn in the editor or specified by a list of vertices. -Member Function Description ---------------------------- - -.. _class_CollisionPolygon2D_get_build_mode: - -- :ref:`int` **get_build_mode** **(** **)** const - -Return whether the polygon is a :ref:`ConvexPolygonShape2D` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D` (``build_mode==1``). - -.. _class_CollisionPolygon2D_get_polygon: - -- :ref:`PoolVector2Array` **get_polygon** **(** **)** const - -Return the list of points that define the polygon. - -.. _class_CollisionPolygon2D_is_disabled: - -- :ref:`bool` **is_disabled** **(** **)** const - -.. _class_CollisionPolygon2D_is_one_way_collision_enabled: - -- :ref:`bool` **is_one_way_collision_enabled** **(** **)** const - -.. _class_CollisionPolygon2D_set_build_mode: - -- void **set_build_mode** **(** :ref:`int` build_mode **)** - -Set whether the polygon is to be a :ref:`ConvexPolygonShape2D` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D` (``build_mode==1``). - -.. _class_CollisionPolygon2D_set_disabled: - -- void **set_disabled** **(** :ref:`bool` disabled **)** - -.. _class_CollisionPolygon2D_set_one_way_collision: - -- void **set_one_way_collision** **(** :ref:`bool` enabled **)** - -.. _class_CollisionPolygon2D_set_polygon: - -- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** - -Set the array of points forming the polygon. - -When editing the point list via the editor, depending on :ref:`get_build_mode`, it has to be a list of points (for ``build_mode==0``), or a list of lines (for ``build_mode==1``). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point. - - diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 3095b019d..0b8720643 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -19,19 +19,11 @@ Node that represents collision shape data in 3D space. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`get_shape` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_convex_from_brothers` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` enable **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Shape` shape **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ ++-------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_convex_from_brothers` **(** **)** | ++-------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | ++-------+---------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -53,14 +45,6 @@ Editor facility for creating and editing collision shapes in 3D space. You can u Member Function Description --------------------------- -.. _class_CollisionShape_get_shape: - -- :ref:`Shape` **get_shape** **(** **)** const - -.. _class_CollisionShape_is_disabled: - -- :ref:`bool` **is_disabled** **(** **)** const - .. _class_CollisionShape_make_convex_from_brothers: - void **make_convex_from_brothers** **(** **)** @@ -73,12 +57,4 @@ Sets the collision shape's shape to the addition of all its convexed :ref:`MeshI If this method exists within a script it will be called whenever the shape resource has been modified. -.. _class_CollisionShape_set_disabled: - -- void **set_disabled** **(** :ref:`bool` enable **)** - -.. _class_CollisionShape_set_shape: - -- void **set_shape** **(** :ref:`Shape` shape **)** - diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 1623c6601..496298804 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -16,23 +16,6 @@ Brief Description Node that represents collision shape data in 2D space. -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`get_shape` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,31 +37,3 @@ Description Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D` to give it a detection shape, or add it to a :ref:`PhysicsBody2D` to give create solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape` to get the actual shape. -Member Function Description ---------------------------- - -.. _class_CollisionShape2D_get_shape: - -- :ref:`Shape2D` **get_shape** **(** **)** const - -.. _class_CollisionShape2D_is_disabled: - -- :ref:`bool` **is_disabled** **(** **)** const - -.. _class_CollisionShape2D_is_one_way_collision_enabled: - -- :ref:`bool` **is_one_way_collision_enabled** **(** **)** const - -.. _class_CollisionShape2D_set_disabled: - -- void **set_disabled** **(** :ref:`bool` disabled **)** - -.. _class_CollisionShape2D_set_one_way_collision: - -- void **set_one_way_collision** **(** :ref:`bool` enabled **)** - -.. _class_CollisionShape2D_set_shape: - -- void **set_shape** **(** :ref:`Shape2D` shape **)** - - diff --git a/classes/class_color.rst b/classes/class_color.rst index a80d17c87..3d2b61ecd 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -30,10 +30,14 @@ Member Functions +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`contrasted` **(** **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`darkened` **(** :ref:`float` amount **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`gray` **(** **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`inverted` **(** **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`lightened` **(** :ref:`float` amount **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_argb32` **(** **)** | @@ -176,6 +180,17 @@ Returns the most contrasting color. var c = Color(.3, .4, .9) var contrastedColor = c.contrasted() # a color of an RGBA(204, 229, 102, 255) +.. _class_Color_darkened: + +- :ref:`Color` **darkened** **(** :ref:`float` amount **)** + +Returns a new color resulting from making this color darker by the specified percentage (0-1). + +:: + + var green = Color(0.0, 1.0, 0.0) + var darkgreen = green.darkened(0.2) # 20% darker than regular green + .. _class_Color_gray: - :ref:`float` **gray** **(** **)** @@ -200,6 +215,17 @@ Returns the inverted color (1-r, 1-g, 1-b, 1-a). var c = Color(.3, .4, .9) var invertedColor = c.inverted() # a color of an RGBA(178, 153, 26, 255) +.. _class_Color_lightened: + +- :ref:`Color` **lightened** **(** :ref:`float` amount **)** + +Returns a new color resulting from making this color lighter by the specified percentage (0-1). + +:: + + var green = Color(0.0, 1.0, 0.0) + var lightgreen = green.lightened(0.2) # 20% lighter than regular green + .. _class_Color_linear_interpolate: - :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 45b7f3a63..bed9533d7 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -19,17 +19,9 @@ Button that pops out a :ref:`ColorPicker` Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pick_color` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editing_alpha` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edit_alpha` **(** :ref:`bool` show **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pick_color` **(** :ref:`Color` color **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-------------------------------------------------------------------+ +| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------+ Signals ------- @@ -61,37 +53,8 @@ Encapsulates a :ref:`ColorPicker` making it accesible by pres Member Function Description --------------------------- -.. _class_ColorPickerButton_get_pick_color: - -- :ref:`Color` **get_pick_color** **(** **)** const - .. _class_ColorPickerButton_get_picker: - :ref:`ColorPicker` **get_picker** **(** **)** -.. _class_ColorPickerButton_is_editing_alpha: - -- :ref:`bool` **is_editing_alpha** **(** **)** const - -See :ref:`ColorPicker.is_edit_alpha` - -.. _class_ColorPickerButton_set_edit_alpha: - -- void **set_edit_alpha** **(** :ref:`bool` show **)** - -See :ref:`ColorPicker.set_edit_alpha` - -.. _class_ColorPickerButton_set_pick_color: - -- void **set_pick_color** **(** :ref:`Color` color **)** - -Set new color to ColorRect. - - - -:: - - var cr = get_node("colorrect_node") - cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red - diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index af2c42423..3e95a0e28 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -16,15 +16,6 @@ Brief Description Colored rect for canvas. -Member Functions ----------------- - -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_frame_color` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame_color` **(** :ref:`Color` color **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -42,29 +33,3 @@ Description An object that is represented on the canvas as a rect with color. :ref:`Color` is used to set or get color info for the rect. -Member Function Description ---------------------------- - -.. _class_ColorRect_get_frame_color: - -- :ref:`Color` **get_frame_color** **(** **)** const - -Return the color in RGBA format. - -:: - - var cr = get_node("colorrect_node") - var c = cr.get_frame_color() # Default color is white - -.. _class_ColorRect_set_frame_color: - -- void **set_frame_color** **(** :ref:`Color` color **)** - -Set new color to ColorRect. - -:: - - var cr = get_node("colorrect_node") - cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red - - diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 74394f026..95e98ba2b 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -16,15 +16,6 @@ Brief Description Concave polygon 2D shape resource for physics. -Member Functions ----------------- - -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_segments` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_segments` **(** :ref:`PoolVector2Array` segments **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -40,19 +31,3 @@ Concave polygon 2D shape resource for physics. It is made out of segments and is The main difference between a :ref:`ConvexPolygonShape2D` and a ``ConcavePolygonShape2D`` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. -Member Function Description ---------------------------- - -.. _class_ConcavePolygonShape2D_get_segments: - -- :ref:`PoolVector2Array` **get_segments** **(** **)** const - -Return the array of segments. - -.. _class_ConcavePolygonShape2D_set_segments: - -- void **set_segments** **(** :ref:`PoolVector2Array` segments **)** - -Set the array of segments. - - diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index 008fb9699..605cbfd9e 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -16,15 +16,6 @@ Brief Description A twist joint between two 3D bodies -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -88,15 +79,3 @@ The twist axis is initiated as the x-axis of the :ref:`Joint`. Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies. -Member Function Description ---------------------------- - -.. _class_ConeTwistJoint_get_param: - -- :ref:`float` **get_param** **(** :ref:`int` param **)** const - -.. _class_ConeTwistJoint_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - - diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 799e51e74..ac4165067 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -111,13 +111,13 @@ Returns ``true`` if the specified section-key pair exists. - :ref:`int` **load** **(** :ref:`String` path **)** -Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@Global Scope`. If the load was successful, the return value is ``OK``. +Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. .. _class_ConfigFile_save: - :ref:`int` **save** **(** :ref:`String` path **)** -Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@Global Scope`. If the load was successful, the return value is ``OK``. +Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. .. _class_ConfigFile_set_value: diff --git a/classes/class_control.rst b/classes/class_control.rst index afa6e2ec2..cdfb0b359 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -9,7 +9,7 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Container`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` +**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` **Category:** Core @@ -46,8 +46,6 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_anchor` **(** :ref:`int` margin **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_begin` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | @@ -58,8 +56,6 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_custom_minimum_size` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_default_cursor_shape` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** virtual | @@ -68,8 +64,6 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_focus_mode` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_focus_neighbour` **(** :ref:`int` margin **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | @@ -78,48 +72,22 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_grow_direction` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_size_flags` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_filter` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_parent_control` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_pivot_offset` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_rect` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rotation` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation_degrees` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stretch_ratio` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Theme` | :ref:`get_theme` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_grow_direction` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_size_flags` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grab_click_focus` **(** **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grab_focus` **(** **)** | @@ -148,8 +116,6 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_clipping_contents` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`minimum_size_changed` **(** **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`release_focus` **(** **)** | @@ -164,10 +130,6 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip_contents` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_minimum_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_cursor_shape` **(** :ref:`int` shape **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | @@ -178,42 +140,12 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_focus_mode` **(** :ref:`int` mode **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_focus_neighbour` **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_position` **(** :ref:`Vector2` position **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_grow_direction` **(** :ref:`int` direction **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_margins_preset` **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pivot_offset` **(** :ref:`Vector2` pivot_offset **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation` **(** :ref:`float` radians **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_degrees` **(** :ref:`float` degrees **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_theme` **(** :ref:`Theme` theme **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`String` tooltip **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_grow_direction` **(** :ref:`int` direction **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_size_flags` **(** :ref:`int` flags **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | @@ -314,6 +246,14 @@ If the user presses Tab, Godot will give focus to the closest node to the right - :ref:`NodePath` **focus_neighbour_top** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. + .. _class_Control_focus_next: + +- :ref:`NodePath` **focus_next** + + .. _class_Control_focus_previous: + +- :ref:`NodePath` **focus_previous** + .. _class_Control_grow_horizontal: - :ref:`int` **grow_horizontal** @@ -506,7 +446,7 @@ Overrides the color in the theme resource the node uses. - void **add_constant_override** **(** :ref:`String` name, :ref:`int` constant **)** -Overrides an integer constant in the theme resource the node uses. If the ``constant[code] is invalid, Godot clears the override. See [member Theme.INVALID_CONSTANT] for more information. +Overrides an integer constant in the :ref:`Theme` resource the node uses. If the ``constant`` is invalid, Godot clears the override. See :ref:`Theme.INVALID_CONSTANT` for more information. .. _class_Control_add_font_override: @@ -544,12 +484,6 @@ Overrides the ``name`` Stylebox in the theme resource the node uses. If ``styleb - void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** -.. _class_Control_get_anchor: - -- :ref:`float` **get_anchor** **(** :ref:`int` margin **)** const - -Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). - .. _class_Control_get_begin: - :ref:`Vector2` **get_begin** **(** **)** const @@ -572,10 +506,6 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg Returns the mouse cursor shape the control displays on mouse hover, one of the ``CURSOR\_\*`` constants. -.. _class_Control_get_custom_minimum_size: - -- :ref:`Vector2` **get_custom_minimum_size** **(** **)** const - .. _class_Control_get_default_cursor_shape: - :ref:`int` **get_default_cursor_shape** **(** **)** const @@ -598,12 +528,6 @@ Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref: Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see :ref:`set_focus_mode`). -.. _class_Control_get_focus_neighbour: - -- :ref:`NodePath` **get_focus_neighbour** **(** :ref:`int` margin **)** const - -Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. - .. _class_Control_get_focus_owner: - :ref:`Control` **get_focus_owner** **(** **)** const @@ -626,38 +550,16 @@ Returns the Control position, relative to the top-left corner of the parent Cont Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_position`, :ref:`get_size`). -.. _class_Control_get_h_grow_direction: - -- :ref:`int` **get_h_grow_direction** **(** **)** const - -.. _class_Control_get_h_size_flags: - -- :ref:`int` **get_h_size_flags** **(** **)** const - -Hint for containers, return horizontal positioning flags. - .. _class_Control_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_margin: - -- :ref:`float` **get_margin** **(** :ref:`int` margin **)** const - -Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode. - .. _class_Control_get_minimum_size: - :ref:`Vector2` **get_minimum_size** **(** **)** const Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. -.. _class_Control_get_mouse_filter: - -- :ref:`int` **get_mouse_filter** **(** **)** const - -Return when the control is ignoring mouse events (even touchpad events send mouse events). - .. _class_Control_get_parent_area_size: - :ref:`Vector2` **get_parent_area_size** **(** **)** const @@ -666,16 +568,6 @@ Return when the control is ignoring mouse events (even touchpad events send mous - :ref:`Control` **get_parent_control** **(** **)** const -.. _class_Control_get_pivot_offset: - -- :ref:`Vector2` **get_pivot_offset** **(** **)** const - -.. _class_Control_get_position: - -- :ref:`Vector2` **get_position** **(** **)** const - -Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. - .. _class_Control_get_rect: - :ref:`Rect2` **get_rect** **(** **)** const @@ -688,54 +580,16 @@ Return position and size of the Control, relative to the top-left corner of the Return the rotation (in radians) -.. _class_Control_get_rotation_degrees: - -- :ref:`float` **get_rotation_degrees** **(** **)** const - -Return the rotation (in degrees) - -.. _class_Control_get_scale: - -- :ref:`Vector2` **get_scale** **(** **)** const - -.. _class_Control_get_size: - -- :ref:`Vector2` **get_size** **(** **)** const - -Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by** :ref:`get_minimum_size`. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, :ref:`get_minimum_size`, :ref:`set_margin`, :ref:`set_anchor`). - -.. _class_Control_get_stretch_ratio: - -- :ref:`float` **get_stretch_ratio** **(** **)** const - -Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. - .. _class_Control_get_stylebox: - :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_theme: - -- :ref:`Theme` **get_theme** **(** **)** const - -Return a :ref:`Theme` override, if one exists (see :ref:`set_theme`). - .. _class_Control_get_tooltip: - :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const Return the tooltip, which will appear when the cursor is resting over this control. -.. _class_Control_get_v_grow_direction: - -- :ref:`int` **get_v_grow_direction** **(** **)** const - -.. _class_Control_get_v_size_flags: - -- :ref:`int` **get_v_size_flags** **(** **)** const - -Hint for containers, return vertical positioning flags. - .. _class_Control_grab_click_focus: - void **grab_click_focus** **(** **)** @@ -796,10 +650,6 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m - :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const -.. _class_Control_is_clipping_contents: - -- :ref:`bool` **is_clipping_contents** **(** **)** - .. _class_Control_minimum_size_changed: - void **minimum_size_changed** **(** **)** @@ -832,14 +682,6 @@ Give up the focus, no other control will be able to receive keyboard input. Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). -.. _class_Control_set_clip_contents: - -- void **set_clip_contents** **(** :ref:`bool` enable **)** - -.. _class_Control_set_custom_minimum_size: - -- void **set_custom_minimum_size** **(** :ref:`Vector2` size **)** - .. _class_Control_set_default_cursor_shape: - void **set_default_cursor_shape** **(** :ref:`int` shape **)** @@ -866,104 +708,22 @@ Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals. -.. _class_Control_set_focus_neighbour: - -- void **set_focus_neighbour** **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** - -Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. - .. _class_Control_set_global_position: - void **set_global_position** **(** :ref:`Vector2` position **)** Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin`). -.. _class_Control_set_h_grow_direction: - -- void **set_h_grow_direction** **(** :ref:`int` direction **)** - -.. _class_Control_set_h_size_flags: - -- void **set_h_size_flags** **(** :ref:`int` flags **)** - -Hint for containers, set horizontal positioning flags. - -.. _class_Control_set_margin: - -- void **set_margin** **(** :ref:`int` margin, :ref:`float` offset **)** - -Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode. - .. _class_Control_set_margins_preset: - void **set_margins_preset** **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** -.. _class_Control_set_mouse_filter: - -- void **set_mouse_filter** **(** :ref:`int` filter **)** - -Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER\_\* constants) - -.. _class_Control_set_pivot_offset: - -- void **set_pivot_offset** **(** :ref:`Vector2` pivot_offset **)** - -.. _class_Control_set_position: - -- void **set_position** **(** :ref:`Vector2` position **)** - -Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see :ref:`set_margin`). - .. _class_Control_set_rotation: - void **set_rotation** **(** :ref:`float` radians **)** Set the rotation (in radians). -.. _class_Control_set_rotation_degrees: - -- void **set_rotation_degrees** **(** :ref:`float` degrees **)** - -Set the rotation (in degrees). - -.. _class_Control_set_scale: - -- void **set_scale** **(** :ref:`Vector2` scale **)** - -.. _class_Control_set_size: - -- void **set_size** **(** :ref:`Vector2` size **)** - -Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see :ref:`set_margin`). - -.. _class_Control_set_stretch_ratio: - -- void **set_stretch_ratio** **(** :ref:`float` ratio **)** - -Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. - -.. _class_Control_set_theme: - -- void **set_theme** **(** :ref:`Theme` theme **)** - -Overrides the whole :ref:`Theme` for this node and all its ``Control`` children. - -.. _class_Control_set_tooltip: - -- void **set_tooltip** **(** :ref:`String` tooltip **)** - -Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments. - -.. _class_Control_set_v_grow_direction: - -- void **set_v_grow_direction** **(** :ref:`int` direction **)** - -.. _class_Control_set_v_size_flags: - -- void **set_v_size_flags** **(** :ref:`int` flags **)** - -Hint for containers, set vertical positioning flags. - .. _class_Control_show_modal: - void **show_modal** **(** :ref:`bool` exclusive=false **)** diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index bad2f533e..cffac7c3f 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -16,15 +16,6 @@ Brief Description Convex polygon shape for 3D physics. -Member Functions ----------------- - -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_points` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`PoolVector3Array` points **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,15 +29,3 @@ Description Convex polygon shape resource, which can be added to a :ref:`PhysicsBody` or area. -Member Function Description ---------------------------- - -.. _class_ConvexPolygonShape_get_points: - -- :ref:`PoolVector3Array` **get_points** **(** **)** const - -.. _class_ConvexPolygonShape_set_points: - -- void **set_points** **(** :ref:`PoolVector3Array` points **)** - - diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 80c128128..fb9736971 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -19,13 +19,9 @@ Convex Polygon Shape for 2D physics. Member Functions ---------------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++-------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | ++-------+--------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -45,22 +41,10 @@ The main difference between a ``ConvexPolygonShape2D`` and a :ref:`ConcavePolygo Member Function Description --------------------------- -.. _class_ConvexPolygonShape2D_get_points: - -- :ref:`PoolVector2Array` **get_points** **(** **)** const - -Returns a list of points in either clockwise or counter clockwise order, forming a convex polygon. - .. _class_ConvexPolygonShape2D_set_point_cloud: - void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** Currently, this method does nothing. -.. _class_ConvexPolygonShape2D_set_points: - -- void **set_points** **(** :ref:`PoolVector2Array` points **)** - -Sets a list of points in either clockwise or counter clockwise order, forming a convex polygon. - diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index a1bebecef..ca16af8ad 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -19,27 +19,19 @@ A CubeMap is a 6 sided 3D texture. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_flags` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_side` **(** :ref:`int` side **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_storage` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flags` **(** :ref:`int` flags **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_side` **(** :ref:`int` side, :ref:`Image` image **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_storage` **(** :ref:`int` mode **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_flags` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_side` **(** :ref:`int` side **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flags` **(** :ref:`int` flags **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_side` **(** :ref:`int` side, :ref:`Image` image **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -88,20 +80,12 @@ Member Function Description Returns the CubeMap's height. -.. _class_CubeMap_get_lossy_storage_quality: - -- :ref:`float` **get_lossy_storage_quality** **(** **)** const - .. _class_CubeMap_get_side: - :ref:`Image` **get_side** **(** :ref:`int` side **)** const Returns an :ref:`Image` for a side of the CubeMap using one of the ``SIDE\_\*`` constants or an integer 0-5. -.. _class_CubeMap_get_storage: - -- :ref:`int` **get_storage** **(** **)** const - .. _class_CubeMap_get_width: - :ref:`int` **get_width** **(** **)** const @@ -112,18 +96,10 @@ Returns the CubeMap's width. - void **set_flags** **(** :ref:`int` flags **)** -.. _class_CubeMap_set_lossy_storage_quality: - -- void **set_lossy_storage_quality** **(** :ref:`float` quality **)** - .. _class_CubeMap_set_side: - void **set_side** **(** :ref:`int` side, :ref:`Image` image **)** Sets an :ref:`Image` for a side of the CubeMap using one of the ``SIDE\_\*`` constants or an integer 0-5. -.. _class_CubeMap_set_storage: - -- void **set_storage** **(** :ref:`int` mode **)** - diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index 95f7cddc7..08af56831 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -16,27 +16,6 @@ Brief Description Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. -Member Functions ----------------- - -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_height` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector3` size **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_depth` **(** :ref:`int` divisions **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_height` **(** :ref:`int` divisions **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_width` **(** :ref:`int` subdivide **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -62,39 +41,3 @@ Description Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. -Member Function Description ---------------------------- - -.. _class_CubeMesh_get_size: - -- :ref:`Vector3` **get_size** **(** **)** const - -.. _class_CubeMesh_get_subdivide_depth: - -- :ref:`int` **get_subdivide_depth** **(** **)** const - -.. _class_CubeMesh_get_subdivide_height: - -- :ref:`int` **get_subdivide_height** **(** **)** const - -.. _class_CubeMesh_get_subdivide_width: - -- :ref:`int` **get_subdivide_width** **(** **)** const - -.. _class_CubeMesh_set_size: - -- void **set_size** **(** :ref:`Vector3` size **)** - -.. _class_CubeMesh_set_subdivide_depth: - -- void **set_subdivide_depth** **(** :ref:`int` divisions **)** - -.. _class_CubeMesh_set_subdivide_height: - -- void **set_subdivide_height** **(** :ref:`int` divisions **)** - -.. _class_CubeMesh_set_subdivide_width: - -- void **set_subdivide_width** **(** :ref:`int` subdivide **)** - - diff --git a/classes/class_curve.rst b/classes/class_curve.rst index e3f3641c1..aa9a62bcb 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -28,12 +28,6 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_value` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_min_value` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | @@ -50,12 +44,6 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` index **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_value` **(** :ref:`float` max **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_min_value` **(** :ref:`float` min **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | @@ -123,18 +111,6 @@ Member Function Description - void **clear_points** **(** **)** -.. _class_Curve_get_bake_resolution: - -- :ref:`int` **get_bake_resolution** **(** **)** const - -.. _class_Curve_get_max_value: - -- :ref:`float` **get_max_value** **(** **)** const - -.. _class_Curve_get_min_value: - -- :ref:`float` **get_min_value** **(** **)** const - .. _class_Curve_get_point_left_mode: - :ref:`int` **get_point_left_mode** **(** :ref:`int` index **)** const @@ -167,18 +143,6 @@ Member Function Description - void **remove_point** **(** :ref:`int` index **)** -.. _class_Curve_set_bake_resolution: - -- void **set_bake_resolution** **(** :ref:`int` resolution **)** - -.. _class_Curve_set_max_value: - -- void **set_max_value** **(** :ref:`float` max **)** - -.. _class_Curve_set_min_value: - -- void **set_min_value** **(** :ref:`float` min **)** - .. _class_Curve_set_point_left_mode: - void **set_point_left_mode** **(** :ref:`int` index, :ref:`int` mode **)** diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 59b6cc83c..fd6dd24a2 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -24,8 +24,6 @@ Member Functions +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_baked_length` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | @@ -46,8 +44,6 @@ Member Functions +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` idx **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | @@ -93,12 +89,6 @@ If "at_position" is given, the point is inserted before the point number "at_pos Removes all points from the curve. -.. _class_Curve2D_get_bake_interval: - -- :ref:`float` **get_bake_interval** **(** **)** const - -Returns the distance between two adjacent cached points. - .. _class_Curve2D_get_baked_length: - :ref:`float` **get_baked_length** **(** **)** const @@ -165,12 +155,6 @@ Returns the position at the vertex "fofs". It calls :ref:`interpolate` distance **)** - -Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. - .. _class_Curve2D_set_point_in: - void **set_point_in** **(** :ref:`int` idx, :ref:`Vector2` position **)** diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index f27906982..439bd69f4 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -24,8 +24,6 @@ Member Functions +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_baked_length` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | @@ -50,8 +48,6 @@ Member Functions +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` idx **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | @@ -97,12 +93,6 @@ If "at_position" is given, the point is inserted before the point number "at_pos - void **clear_points** **(** **)** -.. _class_Curve3D_get_bake_interval: - -- :ref:`float` **get_bake_interval** **(** **)** const - -Returns the distance between two adjacent cached points. - .. _class_Curve3D_get_baked_length: - :ref:`float` **get_baked_length** **(** **)** const @@ -181,12 +171,6 @@ Returns the position at the vertex "fofs". It calls :ref:`interpolate` distance **)** - -Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. - .. _class_Curve3D_set_point_in: - void **set_point_in** **(** :ref:`int` idx, :ref:`Vector3` position **)** diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 6b76d3632..054749521 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -16,17 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`get_curve` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------+ -| void | :ref:`set_curve` **(** :ref:`Curve` curve **)** | -+----------------------------+--------------------------------------------------------------------------------------------+ -| void | :ref:`set_width` **(** :ref:`int` width **)** | -+----------------------------+--------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -39,19 +28,3 @@ Member Variables - :ref:`int` **width** -Member Function Description ---------------------------- - -.. _class_CurveTexture_get_curve: - -- :ref:`Curve` **get_curve** **(** **)** const - -.. _class_CurveTexture_set_curve: - -- void **set_curve** **(** :ref:`Curve` curve **)** - -.. _class_CurveTexture_set_width: - -- void **set_width** **(** :ref:`int` width **)** - - diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 0389d0276..ac77567f1 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -16,31 +16,6 @@ Brief Description Class representing a cylindrical :ref:`PrimitiveMesh`. -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bottom_radius` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rings` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_top_radius` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bottom_radius` **(** :ref:`float` radius **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_segments` **(** :ref:`int` segments **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rings` **(** :ref:`int` rings **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_top_radius` **(** :ref:`float` radius **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -70,47 +45,3 @@ Description Class representing a cylindrical :ref:`PrimitiveMesh`. -Member Function Description ---------------------------- - -.. _class_CylinderMesh_get_bottom_radius: - -- :ref:`float` **get_bottom_radius** **(** **)** const - -.. _class_CylinderMesh_get_height: - -- :ref:`float` **get_height** **(** **)** const - -.. _class_CylinderMesh_get_radial_segments: - -- :ref:`int` **get_radial_segments** **(** **)** const - -.. _class_CylinderMesh_get_rings: - -- :ref:`int` **get_rings** **(** **)** const - -.. _class_CylinderMesh_get_top_radius: - -- :ref:`float` **get_top_radius** **(** **)** const - -.. _class_CylinderMesh_set_bottom_radius: - -- void **set_bottom_radius** **(** :ref:`float` radius **)** - -.. _class_CylinderMesh_set_height: - -- void **set_height** **(** :ref:`float` height **)** - -.. _class_CylinderMesh_set_radial_segments: - -- void **set_radial_segments** **(** :ref:`int` segments **)** - -.. _class_CylinderMesh_set_rings: - -- void **set_rings** **(** :ref:`int` rings **)** - -.. _class_CylinderMesh_set_top_radius: - -- void **set_top_radius** **(** :ref:`float` radius **)** - - diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 1d6c5c73a..62d69f14b 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -16,27 +16,6 @@ Brief Description Damped spring constraint for 2D physics. -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_damping` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rest_length` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stiffness` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_damping` **(** :ref:`float` damping **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rest_length` **(** :ref:`float` rest_length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stiffness` **(** :ref:`float` stiffness **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -62,55 +41,3 @@ Description Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length. -Member Function Description ---------------------------- - -.. _class_DampedSpringJoint2D_get_damping: - -- :ref:`float` **get_damping** **(** **)** const - -Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). - -.. _class_DampedSpringJoint2D_get_length: - -- :ref:`float` **get_length** **(** **)** const - -Return the maximum length of the spring joint. - -.. _class_DampedSpringJoint2D_get_rest_length: - -- :ref:`float` **get_rest_length** **(** **)** const - -Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. - -.. _class_DampedSpringJoint2D_get_stiffness: - -- :ref:`float` **get_stiffness** **(** **)** const - -Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. - -.. _class_DampedSpringJoint2D_set_damping: - -- void **set_damping** **(** :ref:`float` damping **)** - -Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). - -.. _class_DampedSpringJoint2D_set_length: - -- void **set_length** **(** :ref:`float` length **)** - -Set the maximum length of the spring joint. - -.. _class_DampedSpringJoint2D_set_rest_length: - -- void **set_rest_length** **(** :ref:`float` rest_length **)** - -Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. - -.. _class_DampedSpringJoint2D_set_stiffness: - -- void **set_stiffness** **(** :ref:`float` stiffness **)** - -Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. - - diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 3d00567e6..35d46e4e9 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -16,23 +16,6 @@ Brief Description Directional Light, such as the Sun or the Moon. -Member Functions ----------------- - -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_depth_range` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blend_splits_enabled` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_splits` **(** :ref:`bool` enabled **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_depth_range` **(** :ref:`int` mode **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -87,31 +70,3 @@ Description A DirectionalLight is a type of :ref:`Light` node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. -Member Function Description ---------------------------- - -.. _class_DirectionalLight_get_shadow_depth_range: - -- :ref:`int` **get_shadow_depth_range** **(** **)** const - -.. _class_DirectionalLight_get_shadow_mode: - -- :ref:`int` **get_shadow_mode** **(** **)** const - -.. _class_DirectionalLight_is_blend_splits_enabled: - -- :ref:`bool` **is_blend_splits_enabled** **(** **)** const - -.. _class_DirectionalLight_set_blend_splits: - -- void **set_blend_splits** **(** :ref:`bool` enabled **)** - -.. _class_DirectionalLight_set_shadow_depth_range: - -- void **set_shadow_depth_range** **(** :ref:`int` mode **)** - -.. _class_DirectionalLight_set_shadow_mode: - -- void **set_shadow_mode** **(** :ref:`int` mode **)** - - diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 943b49ea9..2293406a6 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -89,7 +89,7 @@ Member Function Description Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``). -The method returns one of the error code constants defined in :ref:`@Global Scope` (OK or ERR\_\*). +The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). .. _class_Directory_copy: @@ -97,7 +97,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop Copy the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. -Returns one of the error code constants defined in :ref:`@Global Scope` (OK, FAILED or ERR\_\*). +Returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). .. _class_Directory_current_is_dir: @@ -177,7 +177,7 @@ Close the current stream opened with :ref:`list_dir_begin`). -The method returns one of the error code constants defined in :ref:`@Global Scope` (OK, FAILED or ERR\_\*). +The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). .. _class_Directory_make_dir_recursive: @@ -185,7 +185,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir` recursively. The argument can be relative to the current directory, or an absolute path. -Return one of the error code constants defined in :ref:`@Global Scope` (OK, FAILED or ERR\_\*). +Return one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). .. _class_Directory_open: @@ -193,7 +193,7 @@ Return one of the error code constants defined in :ref:`@Global Scope` (OK or ERR\_\*). +The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). .. _class_Directory_remove: @@ -201,7 +201,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. -Return one of the error code constants defined in :ref:`@Global Scope` (OK or FAILED). +Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). .. _class_Directory_rename: @@ -209,6 +209,6 @@ Return one of the error code constants defined in :ref:`@Global Scope` (OK or FAILED). +Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index ec35dbab3..f54923f4c 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -26,30 +26,10 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_fallback_count` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`DynamicFontData` | :ref:`get_font_data` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_size` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_spacing` **(** :ref:`int` type **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_filter` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_mipmaps` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_fallback` **(** :ref:`int` idx **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fallback` **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_font_data` **(** :ref:`DynamicFontData` data **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`int` data **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spacing` **(** :ref:`int` type, :ref:`int` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_filter` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_mipmaps` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -121,34 +101,6 @@ Returns the fallback font at index ``idx``. Returns the number of fallback fonts. -.. _class_DynamicFont_get_font_data: - -- :ref:`DynamicFontData` **get_font_data** **(** **)** const - -.. _class_DynamicFont_get_size: - -- :ref:`int` **get_size** **(** **)** const - -Returns the font size in pixels. - -.. _class_DynamicFont_get_spacing: - -- :ref:`int` **get_spacing** **(** :ref:`int` type **)** const - -Returns the given type of spacing in pixels. See ``SPACING\_\*`` constants. - -.. _class_DynamicFont_get_use_filter: - -- :ref:`bool` **get_use_filter** **(** **)** const - -Returns ``true`` if filtering is used. - -.. _class_DynamicFont_get_use_mipmaps: - -- :ref:`bool` **get_use_mipmaps** **(** **)** const - -Returns ``true`` if mipmapping is used. - .. _class_DynamicFont_remove_fallback: - void **remove_fallback** **(** :ref:`int` idx **)** @@ -161,34 +113,4 @@ Removes the fallback font at index ``idx``. Sets the fallback font at index ``idx``. -.. _class_DynamicFont_set_font_data: - -- void **set_font_data** **(** :ref:`DynamicFontData` data **)** - -Sets the :ref:`DynamicFontData`. - -.. _class_DynamicFont_set_size: - -- void **set_size** **(** :ref:`int` data **)** - -Sets the font size. - -.. _class_DynamicFont_set_spacing: - -- void **set_spacing** **(** :ref:`int` type, :ref:`int` value **)** - -Sets the spacing of the given type. See ``SPACING\_\*`` constants. - -.. _class_DynamicFont_set_use_filter: - -- void **set_use_filter** **(** :ref:`bool` enable **)** - -Set to ``true`` to use filtering. - -.. _class_DynamicFont_set_use_mipmaps: - -- void **set_use_mipmaps** **(** :ref:`bool` enable **)** - -Set to ``true`` to use mipmapping. - diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index b586c76fa..a4ab24192 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -16,15 +16,6 @@ Brief Description Used with :ref:`DynamicFont` to describe the location of a font file. -Member Functions ----------------- - -+------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_font_path` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_font_path` **(** :ref:`String` path **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description Used with :ref:`DynamicFont` to describe the location of a vector font file for dynamic rendering at runtime. -Member Function Description ---------------------------- - -.. _class_DynamicFontData_get_font_path: - -- :ref:`String` **get_font_path** **(** **)** const - -Returns the font path. - -.. _class_DynamicFontData_set_font_path: - -- void **set_font_path** **(** :ref:`String` path **)** - -Sets the font path. - - diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 55d462fc8..45855eaa7 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -19,24 +19,34 @@ Brief Description Member Functions ---------------- -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features **)** virtual | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shared_object` **(** :ref:`String` path **)** | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skip` **(** **)** | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skip` **(** **)** | ++-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_EditorExportPlugin__export_begin: -- void **_export_begin** **(** :ref:`PoolStringArray` features **)** virtual +- void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual .. _class_EditorExportPlugin__export_file: @@ -46,9 +56,29 @@ Member Function Description - void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** +.. _class_EditorExportPlugin_add_ios_bundle_file: + +- void **add_ios_bundle_file** **(** :ref:`String` path **)** + +.. _class_EditorExportPlugin_add_ios_cpp_code: + +- void **add_ios_cpp_code** **(** :ref:`String` code **)** + +.. _class_EditorExportPlugin_add_ios_framework: + +- void **add_ios_framework** **(** :ref:`String` path **)** + +.. _class_EditorExportPlugin_add_ios_linker_flags: + +- void **add_ios_linker_flags** **(** :ref:`String` flags **)** + +.. _class_EditorExportPlugin_add_ios_plist_content: + +- void **add_ios_plist_content** **(** :ref:`String` plist_content **)** + .. _class_EditorExportPlugin_add_shared_object: -- void **add_shared_object** **(** :ref:`String` path **)** +- void **add_shared_object** **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** .. _class_EditorExportPlugin_skip: diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 99a7ae9e1..e3dd754ad 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -149,7 +149,7 @@ Reloads the scene at the given path. - :ref:`int` **save_scene** **(** **)** -Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@Global Scope` constants. +Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@GlobalScope` constants. .. _class_EditorInterface_save_scene_as: diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst new file mode 100644 index 000000000..d3f520af6 --- /dev/null +++ b/classes/class_editorscenepostimport.rst @@ -0,0 +1,33 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorScenePostImport.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_EditorScenePostImport: + +EditorScenePostImport +===================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++-------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`post_import` **(** :ref:`Object` scene **)** virtual | ++-------+-------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_EditorScenePostImport_post_import: + +- void **post_import** **(** :ref:`Object` scene **)** virtual + + diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index e84409007..a8dc76608 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -26,13 +26,13 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_favorite_dirs` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_project_settings_path` **(** **)** const | +| :ref:`String` | :ref:`get_project_settings_dir` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_recent_dirs` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_settings_path` **(** **)** const | +| :ref:`String` | :ref:`get_settings_dir` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,7 +77,7 @@ Member Function Description - void **add_property_info** **(** :ref:`Dictionary` info **)** -Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@Global Scope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string::ref:`String`. +Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. Example: @@ -106,9 +106,9 @@ Erase a given setting (pass full property path). Get the list of favorite directories for this project. -.. _class_EditorSettings_get_project_settings_path: +.. _class_EditorSettings_get_project_settings_dir: -- :ref:`String` **get_project_settings_path** **(** **)** const +- :ref:`String` **get_project_settings_dir** **(** **)** const Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved. @@ -122,9 +122,9 @@ Get the list of recently visited folders in the file dialog for this project. - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const -.. _class_EditorSettings_get_settings_path: +.. _class_EditorSettings_get_settings_dir: -- :ref:`String` **get_settings_path** **(** **)** const +- :ref:`String` **get_settings_dir** **(** **)** const Get the global settings path for the engine. Inside this path you can find some standard paths such as: diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index f1111b0ae..ad39d65f9 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -22,7 +22,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles, :ref:`Rect3` bounds **)** | +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles, :ref:`AABB` bounds **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,7 +61,7 @@ Member Function Description .. _class_EditorSpatialGizmo_add_collision_triangles: -- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles, :ref:`Rect3` bounds **)** +- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles, :ref:`AABB` bounds **)** Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this function during :ref:`redraw`. diff --git a/classes/class_engine.rst b/classes/class_engine.rst index b8999d67e..aeb7becb2 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -28,12 +28,16 @@ Member Functions +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_target_fps` **(** **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_time_scale` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_version_info` **(** **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_in_physics_frame` **(** **)** const | @@ -79,6 +83,10 @@ Returns the number of fixed iterations per second (for fixed process and physics Returns the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). +.. _class_Engine_get_singleton: + +- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const + .. _class_Engine_get_target_fps: - :ref:`float` **get_target_fps** **(** **)** const @@ -107,9 +115,13 @@ Returns the current engine version information in a Dictionary. "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String -"revision" - Holds the revision (e.g. "custom-build") as a String +"build" - Holds the build name (e.g. "custom-build") as a String -"string" - major + minor + patch + status + revision in a single String +"string" - major + minor + patch + status + build in a single String + +.. _class_Engine_has_singleton: + +- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const .. _class_Engine_is_editor_hint: diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 2dd5df7d8..426b97589 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -16,295 +16,6 @@ Brief Description Resource for environment nodes (like :ref:`WorldEnvironment`) that define multiple rendering options. -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_adjustment_brightness` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_adjustment_color_correction` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_adjustment_contrast` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_adjustment_saturation` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ambient_light_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ambient_light_energy` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ambient_light_sky_contribution` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_background` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bg_energy` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_canvas_max_layer` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_far_amount` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_far_distance` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dof_blur_far_quality` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_far_transition` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_near_amount` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_near_distance` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dof_blur_near_quality` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_near_transition` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_fog_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_depth_begin` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_depth_curve` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_height_curve` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_height_max` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_height_min` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_sun_amount` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_fog_sun_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_transmit_curve` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_glow_blend_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_bloom` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_hdr_bleed_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_hdr_bleed_threshold` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_intensity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_strength` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Sky` | :ref:`get_sky` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sky_custom_fov` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_bias` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ssao_blur` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ssao_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_direct_light_affect` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_edge_sharpness` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_intensity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_intensity2` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ssao_quality` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_radius` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_radius2` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_depth_tolerance` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_fade_in` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_fade_out` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ssr_max_steps` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tonemap_auto_exposure` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_grey` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_max` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_min` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_speed` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_exposure` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_white` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tonemapper` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_adjustment_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_dof_blur_far_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_dof_blur_near_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_depth_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_height_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_transmit_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_bicubic_upscale_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_level_enabled` **(** :ref:`int` idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssao_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssr_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssr_rough` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_brightness` **(** :ref:`float` brightness **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_color_correction` **(** :ref:`Texture` color_correction **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_contrast` **(** :ref:`float` contrast **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_enable` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_saturation` **(** :ref:`float` saturation **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_energy` **(** :ref:`float` energy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_sky_contribution` **(** :ref:`float` energy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_background` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bg_energy` **(** :ref:`float` energy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_canvas_max_layer` **(** :ref:`int` layer **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_amount` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_distance` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_quality` **(** :ref:`int` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_transition` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_amount` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_distance` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_quality` **(** :ref:`int` level **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_transition` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_depth_begin` **(** :ref:`float` distance **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_depth_curve` **(** :ref:`float` curve **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_depth_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_curve` **(** :ref:`float` curve **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_max` **(** :ref:`float` height **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_min` **(** :ref:`float` height **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_sun_amount` **(** :ref:`float` amount **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_sun_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_transmit_curve` **(** :ref:`float` curve **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_transmit_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_bicubic_upscale` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_blend_mode` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_bloom` **(** :ref:`float` amount **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_hdr_bleed_scale` **(** :ref:`float` scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_hdr_bleed_threshold` **(** :ref:`float` threshold **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_intensity` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_level` **(** :ref:`int` idx, :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_strength` **(** :ref:`float` strength **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky` **(** :ref:`Sky` sky **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_custom_fov` **(** :ref:`float` scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_bias` **(** :ref:`float` bias **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_blur` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_direct_light_affect` **(** :ref:`float` amount **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_edge_sharpness` **(** :ref:`float` edge_sharpness **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_intensity` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_intensity2` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_quality` **(** :ref:`int` quality **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_radius` **(** :ref:`float` radius **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_radius2` **(** :ref:`float` radius **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_depth_tolerance` **(** :ref:`float` depth_tolerance **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_fade_in` **(** :ref:`float` fade_in **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_fade_out` **(** :ref:`float` fade_out **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_max_steps` **(** :ref:`int` max_steps **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_rough` **(** :ref:`bool` rough **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure` **(** :ref:`bool` auto_exposure **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_grey` **(** :ref:`float` exposure_grey **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_max` **(** :ref:`float` exposure_max **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_min` **(** :ref:`float` exposure_min **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_speed` **(** :ref:`float` exposure_speed **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_exposure` **(** :ref:`float` exposure **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_white` **(** :ref:`float` white **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemapper` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -661,575 +372,3 @@ Resource for environment nodes (like :ref:`WorldEnvironment` **get_adjustment_brightness** **(** **)** const - -.. _class_Environment_get_adjustment_color_correction: - -- :ref:`Texture` **get_adjustment_color_correction** **(** **)** const - -.. _class_Environment_get_adjustment_contrast: - -- :ref:`float` **get_adjustment_contrast** **(** **)** const - -.. _class_Environment_get_adjustment_saturation: - -- :ref:`float` **get_adjustment_saturation** **(** **)** const - -.. _class_Environment_get_ambient_light_color: - -- :ref:`Color` **get_ambient_light_color** **(** **)** const - -.. _class_Environment_get_ambient_light_energy: - -- :ref:`float` **get_ambient_light_energy** **(** **)** const - -.. _class_Environment_get_ambient_light_sky_contribution: - -- :ref:`float` **get_ambient_light_sky_contribution** **(** **)** const - -.. _class_Environment_get_background: - -- :ref:`int` **get_background** **(** **)** const - -.. _class_Environment_get_bg_color: - -- :ref:`Color` **get_bg_color** **(** **)** const - -.. _class_Environment_get_bg_energy: - -- :ref:`float` **get_bg_energy** **(** **)** const - -.. _class_Environment_get_canvas_max_layer: - -- :ref:`int` **get_canvas_max_layer** **(** **)** const - -.. _class_Environment_get_dof_blur_far_amount: - -- :ref:`float` **get_dof_blur_far_amount** **(** **)** const - -.. _class_Environment_get_dof_blur_far_distance: - -- :ref:`float` **get_dof_blur_far_distance** **(** **)** const - -.. _class_Environment_get_dof_blur_far_quality: - -- :ref:`int` **get_dof_blur_far_quality** **(** **)** const - -.. _class_Environment_get_dof_blur_far_transition: - -- :ref:`float` **get_dof_blur_far_transition** **(** **)** const - -.. _class_Environment_get_dof_blur_near_amount: - -- :ref:`float` **get_dof_blur_near_amount** **(** **)** const - -.. _class_Environment_get_dof_blur_near_distance: - -- :ref:`float` **get_dof_blur_near_distance** **(** **)** const - -.. _class_Environment_get_dof_blur_near_quality: - -- :ref:`int` **get_dof_blur_near_quality** **(** **)** const - -.. _class_Environment_get_dof_blur_near_transition: - -- :ref:`float` **get_dof_blur_near_transition** **(** **)** const - -.. _class_Environment_get_fog_color: - -- :ref:`Color` **get_fog_color** **(** **)** const - -.. _class_Environment_get_fog_depth_begin: - -- :ref:`float` **get_fog_depth_begin** **(** **)** const - -.. _class_Environment_get_fog_depth_curve: - -- :ref:`float` **get_fog_depth_curve** **(** **)** const - -.. _class_Environment_get_fog_height_curve: - -- :ref:`float` **get_fog_height_curve** **(** **)** const - -.. _class_Environment_get_fog_height_max: - -- :ref:`float` **get_fog_height_max** **(** **)** const - -.. _class_Environment_get_fog_height_min: - -- :ref:`float` **get_fog_height_min** **(** **)** const - -.. _class_Environment_get_fog_sun_amount: - -- :ref:`float` **get_fog_sun_amount** **(** **)** const - -.. _class_Environment_get_fog_sun_color: - -- :ref:`Color` **get_fog_sun_color** **(** **)** const - -.. _class_Environment_get_fog_transmit_curve: - -- :ref:`float` **get_fog_transmit_curve** **(** **)** const - -.. _class_Environment_get_glow_blend_mode: - -- :ref:`int` **get_glow_blend_mode** **(** **)** const - -.. _class_Environment_get_glow_bloom: - -- :ref:`float` **get_glow_bloom** **(** **)** const - -.. _class_Environment_get_glow_hdr_bleed_scale: - -- :ref:`float` **get_glow_hdr_bleed_scale** **(** **)** const - -.. _class_Environment_get_glow_hdr_bleed_threshold: - -- :ref:`float` **get_glow_hdr_bleed_threshold** **(** **)** const - -.. _class_Environment_get_glow_intensity: - -- :ref:`float` **get_glow_intensity** **(** **)** const - -.. _class_Environment_get_glow_strength: - -- :ref:`float` **get_glow_strength** **(** **)** const - -.. _class_Environment_get_sky: - -- :ref:`Sky` **get_sky** **(** **)** const - -.. _class_Environment_get_sky_custom_fov: - -- :ref:`float` **get_sky_custom_fov** **(** **)** const - -.. _class_Environment_get_ssao_bias: - -- :ref:`float` **get_ssao_bias** **(** **)** const - -.. _class_Environment_get_ssao_blur: - -- :ref:`int` **get_ssao_blur** **(** **)** const - -.. _class_Environment_get_ssao_color: - -- :ref:`Color` **get_ssao_color** **(** **)** const - -.. _class_Environment_get_ssao_direct_light_affect: - -- :ref:`float` **get_ssao_direct_light_affect** **(** **)** const - -.. _class_Environment_get_ssao_edge_sharpness: - -- :ref:`float` **get_ssao_edge_sharpness** **(** **)** const - -.. _class_Environment_get_ssao_intensity: - -- :ref:`float` **get_ssao_intensity** **(** **)** const - -.. _class_Environment_get_ssao_intensity2: - -- :ref:`float` **get_ssao_intensity2** **(** **)** const - -.. _class_Environment_get_ssao_quality: - -- :ref:`int` **get_ssao_quality** **(** **)** const - -.. _class_Environment_get_ssao_radius: - -- :ref:`float` **get_ssao_radius** **(** **)** const - -.. _class_Environment_get_ssao_radius2: - -- :ref:`float` **get_ssao_radius2** **(** **)** const - -.. _class_Environment_get_ssr_depth_tolerance: - -- :ref:`float` **get_ssr_depth_tolerance** **(** **)** const - -.. _class_Environment_get_ssr_fade_in: - -- :ref:`float` **get_ssr_fade_in** **(** **)** const - -.. _class_Environment_get_ssr_fade_out: - -- :ref:`float` **get_ssr_fade_out** **(** **)** const - -.. _class_Environment_get_ssr_max_steps: - -- :ref:`int` **get_ssr_max_steps** **(** **)** const - -.. _class_Environment_get_tonemap_auto_exposure: - -- :ref:`bool` **get_tonemap_auto_exposure** **(** **)** const - -.. _class_Environment_get_tonemap_auto_exposure_grey: - -- :ref:`float` **get_tonemap_auto_exposure_grey** **(** **)** const - -.. _class_Environment_get_tonemap_auto_exposure_max: - -- :ref:`float` **get_tonemap_auto_exposure_max** **(** **)** const - -.. _class_Environment_get_tonemap_auto_exposure_min: - -- :ref:`float` **get_tonemap_auto_exposure_min** **(** **)** const - -.. _class_Environment_get_tonemap_auto_exposure_speed: - -- :ref:`float` **get_tonemap_auto_exposure_speed** **(** **)** const - -.. _class_Environment_get_tonemap_exposure: - -- :ref:`float` **get_tonemap_exposure** **(** **)** const - -.. _class_Environment_get_tonemap_white: - -- :ref:`float` **get_tonemap_white** **(** **)** const - -.. _class_Environment_get_tonemapper: - -- :ref:`int` **get_tonemapper** **(** **)** const - -.. _class_Environment_is_adjustment_enabled: - -- :ref:`bool` **is_adjustment_enabled** **(** **)** const - -.. _class_Environment_is_dof_blur_far_enabled: - -- :ref:`bool` **is_dof_blur_far_enabled** **(** **)** const - -.. _class_Environment_is_dof_blur_near_enabled: - -- :ref:`bool` **is_dof_blur_near_enabled** **(** **)** const - -.. _class_Environment_is_fog_depth_enabled: - -- :ref:`bool` **is_fog_depth_enabled** **(** **)** const - -.. _class_Environment_is_fog_enabled: - -- :ref:`bool` **is_fog_enabled** **(** **)** const - -.. _class_Environment_is_fog_height_enabled: - -- :ref:`bool` **is_fog_height_enabled** **(** **)** const - -.. _class_Environment_is_fog_transmit_enabled: - -- :ref:`bool` **is_fog_transmit_enabled** **(** **)** const - -.. _class_Environment_is_glow_bicubic_upscale_enabled: - -- :ref:`bool` **is_glow_bicubic_upscale_enabled** **(** **)** const - -.. _class_Environment_is_glow_enabled: - -- :ref:`bool` **is_glow_enabled** **(** **)** const - -.. _class_Environment_is_glow_level_enabled: - -- :ref:`bool` **is_glow_level_enabled** **(** :ref:`int` idx **)** const - -.. _class_Environment_is_ssao_enabled: - -- :ref:`bool` **is_ssao_enabled** **(** **)** const - -.. _class_Environment_is_ssr_enabled: - -- :ref:`bool` **is_ssr_enabled** **(** **)** const - -.. _class_Environment_is_ssr_rough: - -- :ref:`bool` **is_ssr_rough** **(** **)** const - -.. _class_Environment_set_adjustment_brightness: - -- void **set_adjustment_brightness** **(** :ref:`float` brightness **)** - -.. _class_Environment_set_adjustment_color_correction: - -- void **set_adjustment_color_correction** **(** :ref:`Texture` color_correction **)** - -.. _class_Environment_set_adjustment_contrast: - -- void **set_adjustment_contrast** **(** :ref:`float` contrast **)** - -.. _class_Environment_set_adjustment_enable: - -- void **set_adjustment_enable** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_adjustment_saturation: - -- void **set_adjustment_saturation** **(** :ref:`float` saturation **)** - -.. _class_Environment_set_ambient_light_color: - -- void **set_ambient_light_color** **(** :ref:`Color` color **)** - -.. _class_Environment_set_ambient_light_energy: - -- void **set_ambient_light_energy** **(** :ref:`float` energy **)** - -.. _class_Environment_set_ambient_light_sky_contribution: - -- void **set_ambient_light_sky_contribution** **(** :ref:`float` energy **)** - -.. _class_Environment_set_background: - -- void **set_background** **(** :ref:`int` mode **)** - -.. _class_Environment_set_bg_color: - -- void **set_bg_color** **(** :ref:`Color` color **)** - -.. _class_Environment_set_bg_energy: - -- void **set_bg_energy** **(** :ref:`float` energy **)** - -.. _class_Environment_set_canvas_max_layer: - -- void **set_canvas_max_layer** **(** :ref:`int` layer **)** - -.. _class_Environment_set_dof_blur_far_amount: - -- void **set_dof_blur_far_amount** **(** :ref:`float` intensity **)** - -.. _class_Environment_set_dof_blur_far_distance: - -- void **set_dof_blur_far_distance** **(** :ref:`float` intensity **)** - -.. _class_Environment_set_dof_blur_far_enabled: - -- void **set_dof_blur_far_enabled** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_dof_blur_far_quality: - -- void **set_dof_blur_far_quality** **(** :ref:`int` intensity **)** - -.. _class_Environment_set_dof_blur_far_transition: - -- void **set_dof_blur_far_transition** **(** :ref:`float` intensity **)** - -.. _class_Environment_set_dof_blur_near_amount: - -- void **set_dof_blur_near_amount** **(** :ref:`float` intensity **)** - -.. _class_Environment_set_dof_blur_near_distance: - -- void **set_dof_blur_near_distance** **(** :ref:`float` intensity **)** - -.. _class_Environment_set_dof_blur_near_enabled: - -- void **set_dof_blur_near_enabled** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_dof_blur_near_quality: - -- void **set_dof_blur_near_quality** **(** :ref:`int` level **)** - -.. _class_Environment_set_dof_blur_near_transition: - -- void **set_dof_blur_near_transition** **(** :ref:`float` intensity **)** - -.. _class_Environment_set_fog_color: - -- void **set_fog_color** **(** :ref:`Color` color **)** - -.. _class_Environment_set_fog_depth_begin: - -- void **set_fog_depth_begin** **(** :ref:`float` distance **)** - -.. _class_Environment_set_fog_depth_curve: - -- void **set_fog_depth_curve** **(** :ref:`float` curve **)** - -.. _class_Environment_set_fog_depth_enabled: - -- void **set_fog_depth_enabled** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_fog_enabled: - -- void **set_fog_enabled** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_fog_height_curve: - -- void **set_fog_height_curve** **(** :ref:`float` curve **)** - -.. _class_Environment_set_fog_height_enabled: - -- void **set_fog_height_enabled** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_fog_height_max: - -- void **set_fog_height_max** **(** :ref:`float` height **)** - -.. _class_Environment_set_fog_height_min: - -- void **set_fog_height_min** **(** :ref:`float` height **)** - -.. _class_Environment_set_fog_sun_amount: - -- void **set_fog_sun_amount** **(** :ref:`float` amount **)** - -.. _class_Environment_set_fog_sun_color: - -- void **set_fog_sun_color** **(** :ref:`Color` color **)** - -.. _class_Environment_set_fog_transmit_curve: - -- void **set_fog_transmit_curve** **(** :ref:`float` curve **)** - -.. _class_Environment_set_fog_transmit_enabled: - -- void **set_fog_transmit_enabled** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_glow_bicubic_upscale: - -- void **set_glow_bicubic_upscale** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_glow_blend_mode: - -- void **set_glow_blend_mode** **(** :ref:`int` mode **)** - -.. _class_Environment_set_glow_bloom: - -- void **set_glow_bloom** **(** :ref:`float` amount **)** - -.. _class_Environment_set_glow_enabled: - -- void **set_glow_enabled** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_glow_hdr_bleed_scale: - -- void **set_glow_hdr_bleed_scale** **(** :ref:`float` scale **)** - -.. _class_Environment_set_glow_hdr_bleed_threshold: - -- void **set_glow_hdr_bleed_threshold** **(** :ref:`float` threshold **)** - -.. _class_Environment_set_glow_intensity: - -- void **set_glow_intensity** **(** :ref:`float` intensity **)** - -.. _class_Environment_set_glow_level: - -- void **set_glow_level** **(** :ref:`int` idx, :ref:`bool` enabled **)** - -.. _class_Environment_set_glow_strength: - -- void **set_glow_strength** **(** :ref:`float` strength **)** - -.. _class_Environment_set_sky: - -- void **set_sky** **(** :ref:`Sky` sky **)** - -.. _class_Environment_set_sky_custom_fov: - -- void **set_sky_custom_fov** **(** :ref:`float` scale **)** - -.. _class_Environment_set_ssao_bias: - -- void **set_ssao_bias** **(** :ref:`float` bias **)** - -.. _class_Environment_set_ssao_blur: - -- void **set_ssao_blur** **(** :ref:`int` mode **)** - -.. _class_Environment_set_ssao_color: - -- void **set_ssao_color** **(** :ref:`Color` color **)** - -.. _class_Environment_set_ssao_direct_light_affect: - -- void **set_ssao_direct_light_affect** **(** :ref:`float` amount **)** - -.. _class_Environment_set_ssao_edge_sharpness: - -- void **set_ssao_edge_sharpness** **(** :ref:`float` edge_sharpness **)** - -.. _class_Environment_set_ssao_enabled: - -- void **set_ssao_enabled** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_ssao_intensity: - -- void **set_ssao_intensity** **(** :ref:`float` intensity **)** - -.. _class_Environment_set_ssao_intensity2: - -- void **set_ssao_intensity2** **(** :ref:`float` intensity **)** - -.. _class_Environment_set_ssao_quality: - -- void **set_ssao_quality** **(** :ref:`int` quality **)** - -.. _class_Environment_set_ssao_radius: - -- void **set_ssao_radius** **(** :ref:`float` radius **)** - -.. _class_Environment_set_ssao_radius2: - -- void **set_ssao_radius2** **(** :ref:`float` radius **)** - -.. _class_Environment_set_ssr_depth_tolerance: - -- void **set_ssr_depth_tolerance** **(** :ref:`float` depth_tolerance **)** - -.. _class_Environment_set_ssr_enabled: - -- void **set_ssr_enabled** **(** :ref:`bool` enabled **)** - -.. _class_Environment_set_ssr_fade_in: - -- void **set_ssr_fade_in** **(** :ref:`float` fade_in **)** - -.. _class_Environment_set_ssr_fade_out: - -- void **set_ssr_fade_out** **(** :ref:`float` fade_out **)** - -.. _class_Environment_set_ssr_max_steps: - -- void **set_ssr_max_steps** **(** :ref:`int` max_steps **)** - -.. _class_Environment_set_ssr_rough: - -- void **set_ssr_rough** **(** :ref:`bool` rough **)** - -.. _class_Environment_set_tonemap_auto_exposure: - -- void **set_tonemap_auto_exposure** **(** :ref:`bool` auto_exposure **)** - -.. _class_Environment_set_tonemap_auto_exposure_grey: - -- void **set_tonemap_auto_exposure_grey** **(** :ref:`float` exposure_grey **)** - -.. _class_Environment_set_tonemap_auto_exposure_max: - -- void **set_tonemap_auto_exposure_max** **(** :ref:`float` exposure_max **)** - -.. _class_Environment_set_tonemap_auto_exposure_min: - -- void **set_tonemap_auto_exposure_min** **(** :ref:`float` exposure_min **)** - -.. _class_Environment_set_tonemap_auto_exposure_speed: - -- void **set_tonemap_auto_exposure_speed** **(** :ref:`float` exposure_speed **)** - -.. _class_Environment_set_tonemap_exposure: - -- void **set_tonemap_exposure** **(** :ref:`float` exposure **)** - -.. _class_Environment_set_tonemap_white: - -- void **set_tonemap_white** **(** :ref:`float` white **)** - -.. _class_Environment_set_tonemapper: - -- void **set_tonemapper** **(** :ref:`int` mode **)** - - diff --git a/classes/class_file.rst b/classes/class_file.rst index 824c66a88..18c4d360f 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -220,7 +220,7 @@ Returns ``true`` if endian swap is enabled for this file. - :ref:`int` **get_error** **(** **)** const -Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE\_\*`` constants from :ref:`@Global Scope`. +Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE\_\*`` constants from :ref:`@GlobalScope`. .. _class_File_get_float: diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index f23c804cd..77551b22d 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -19,43 +19,27 @@ Dialog for selecting files or directories in the filesystem. Member Functions ---------------- -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_filter` **(** :ref:`String` filter **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_filters` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_access` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_file` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_path` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_filters` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invalidate` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_showing_hidden_files` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_access` **(** :ref:`int` access **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_dir` **(** :ref:`String` dir **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_file` **(** :ref:`String` file **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_path` **(** :ref:`String` path **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filters` **(** :ref:`PoolStringArray` filters **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_hidden_files` **(** :ref:`bool` show **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_filter` **(** :ref:`String` filter **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_filters` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_dir` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_file` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_path` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`invalidate` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_dir` **(** :ref:`String` dir **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_file` **(** :ref:`String` file **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_path` **(** :ref:`String` path **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------+ Signals ------- @@ -131,12 +115,6 @@ Add a custom filter. Filter format is: "mask ; description", example (C++): dial Clear all the added filters in the dialog. -.. _class_FileDialog_get_access: - -- :ref:`int` **get_access** **(** **)** const - -Return the file access permission of the dialog. - .. _class_FileDialog_get_current_dir: - :ref:`String` **get_current_dir** **(** **)** const @@ -155,16 +133,6 @@ Get the current selected file of the file dialog (empty if none). Get the current selected path (directory and file) of the file dialog (empty if none). -.. _class_FileDialog_get_filters: - -- :ref:`PoolStringArray` **get_filters** **(** **)** const - -.. _class_FileDialog_get_mode: - -- :ref:`int` **get_mode** **(** **)** const - -Get the file dialog mode from the MODE\_\* enum. - .. _class_FileDialog_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** @@ -177,18 +145,6 @@ Return the vertical box container of the dialog, custom controls can be added to Invalidate and update the current dialog content list. -.. _class_FileDialog_is_showing_hidden_files: - -- :ref:`bool` **is_showing_hidden_files** **(** **)** const - -Return true if the dialog allows show hidden files. - -.. _class_FileDialog_set_access: - -- void **set_access** **(** :ref:`int` access **)** - -Set the file access permission of the dialog(Must be one of ACCESS_RESOURCES, ACCESS_USERDATA or ACCESS_FILESYSTEM). - .. _class_FileDialog_set_current_dir: - void **set_current_dir** **(** :ref:`String` dir **)** @@ -207,20 +163,4 @@ Set the current selected file name of the file dialog. Set the current selected file path of the file dialog. -.. _class_FileDialog_set_filters: - -- void **set_filters** **(** :ref:`PoolStringArray` filters **)** - -.. _class_FileDialog_set_mode: - -- void **set_mode** **(** :ref:`int` mode **)** - -Set the file dialog mode from the MODE\_\* enum. - -.. _class_FileDialog_set_show_hidden_files: - -- void **set_show_hidden_files** **(** :ref:`bool` show **)** - -Set the dialog should show hidden files. - diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 9e6ad539d..8693e7581 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -19,17 +19,13 @@ Brief Description Member Functions ---------------- -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDNativeLibrary` | :ref:`get_library` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`initialize` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_library` **(** :ref:`GDNativeLibrary` library **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`terminate` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`terminate` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -46,18 +42,10 @@ Member Function Description - :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** -.. _class_GDNative_get_library: - -- :ref:`GDNativeLibrary` **get_library** **(** **)** - .. _class_GDNative_initialize: - :ref:`bool` **initialize** **(** **)** -.. _class_GDNative_set_library: - -- void **set_library** **(** :ref:`GDNativeLibrary` library **)** - .. _class_GDNative_terminate: - :ref:`bool` **terminate** **(** **)** diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index de816d896..b181bac25 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -19,47 +19,43 @@ Brief Description Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_active_library_path` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_library_path` **(** :ref:`String` platform **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_singleton_gdnative` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_library_path` **(** :ref:`String` platform, :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_singleton_gdnative` **(** :ref:`bool` singleton **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`ConfigFile` | :ref:`get_config_file` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_current_dependencies` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_library_path` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------+ Member Variables ---------------- - .. _class_GDNativeLibrary_singleton_gdnative: + .. _class_GDNativeLibrary_load_once: -- :ref:`bool` **singleton_gdnative** +- :ref:`bool` **load_once** + + .. _class_GDNativeLibrary_singleton: + +- :ref:`bool` **singleton** + + .. _class_GDNativeLibrary_symbol_prefix: + +- :ref:`String` **symbol_prefix** Member Function Description --------------------------- -.. _class_GDNativeLibrary_get_active_library_path: +.. _class_GDNativeLibrary_get_config_file: -- :ref:`String` **get_active_library_path** **(** **)** const +- :ref:`ConfigFile` **get_config_file** **(** **)** -.. _class_GDNativeLibrary_get_library_path: +.. _class_GDNativeLibrary_get_current_dependencies: -- :ref:`String` **get_library_path** **(** :ref:`String` platform **)** const +- :ref:`PoolStringArray` **get_current_dependencies** **(** **)** const -.. _class_GDNativeLibrary_is_singleton_gdnative: +.. _class_GDNativeLibrary_get_current_library_path: -- :ref:`bool` **is_singleton_gdnative** **(** **)** const - -.. _class_GDNativeLibrary_set_library_path: - -- void **set_library_path** **(** :ref:`String` platform, :ref:`String` path **)** - -.. _class_GDNativeLibrary_set_singleton_gdnative: - -- void **set_singleton_gdnative** **(** :ref:`bool` singleton **)** +- :ref:`String` **get_current_library_path** **(** **)** const diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdscriptfunctionstate.rst similarity index 65% rename from classes/class_gdfunctionstate.rst rename to classes/class_gdscriptfunctionstate.rst index aeb6ba0e0..6fb6a608e 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdscriptfunctionstate.rst @@ -1,11 +1,11 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the GDFunctionState.xml source instead. +.. DO NOT EDIT THIS FILE, but the GDScriptFunctionState.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_GDFunctionState: +.. _class_GDScriptFunctionState: -GDFunctionState -=============== +GDScriptFunctionState +===================== **Inherits:** :ref:`Reference` **<** :ref:`Object` @@ -19,16 +19,16 @@ State of a function call after yielding. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** :ref:`bool` extended_check=false **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=null **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** :ref:`bool` extended_check=false **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=null **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_GDFunctionState_completed: +.. _class_GDScriptFunctionState_completed: - **completed** **(** :ref:`Nil` result **)** @@ -36,20 +36,20 @@ Signals Description ----------- -Calling :ref:`@GDScript.yield` within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling :ref:`resume` on this state object. +Calling :ref:`@GDScript.yield` within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling :ref:`resume` on this state object. Member Function Description --------------------------- -.. _class_GDFunctionState_is_valid: +.. _class_GDScriptFunctionState_is_valid: - :ref:`bool` **is_valid** **(** :ref:`bool` extended_check=false **)** const Check whether the function call may be resumed. This is not the case if the function state was already resumed. -If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`GDFunctionState.resume`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. +If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`GDScriptFunctionState.resume`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. -.. _class_GDFunctionState_resume: +.. _class_GDScriptFunctionState_resume: - :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** diff --git a/classes/class_gdnativeclass.rst b/classes/class_gdscriptnativeclass.rst similarity index 63% rename from classes/class_gdnativeclass.rst rename to classes/class_gdscriptnativeclass.rst index d4f0d70c5..8240cf8dd 100644 --- a/classes/class_gdnativeclass.rst +++ b/classes/class_gdscriptnativeclass.rst @@ -1,11 +1,11 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the GDNativeClass.xml source instead. +.. DO NOT EDIT THIS FILE, but the GDScriptNativeClass.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_GDNativeClass: +.. _class_GDScriptNativeClass: -GDNativeClass -============= +GDScriptNativeClass +=================== **Inherits:** :ref:`Reference` **<** :ref:`Object` @@ -19,14 +19,14 @@ Brief Description Member Functions ---------------- -+--------------------------------+-------------------------------------------------+ -| :ref:`Variant` | :ref:`new` **(** **)** | -+--------------------------------+-------------------------------------------------+ ++--------------------------------+-------------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** **)** | ++--------------------------------+-------------------------------------------------------+ Member Function Description --------------------------- -.. _class_GDNativeClass_new: +.. _class_GDScriptNativeClass_new: - :ref:`Variant` **new** **(** **)** diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 09a7b4ffe..5ec7699e8 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -16,35 +16,6 @@ Brief Description The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation. -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag_x` **(** :ref:`int` flag **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag_y` **(** :ref:`int` flag **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag_z` **(** :ref:`int` flag **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_x` **(** :ref:`int` param **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_y` **(** :ref:`int` param **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_z` **(** :ref:`int` param **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag_x` **(** :ref:`int` flag, :ref:`bool` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag_y` **(** :ref:`int` flag, :ref:`bool` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag_z` **(** :ref:`int` flag, :ref:`bool` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_x` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_y` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_z` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -283,55 +254,3 @@ Description The first 3 dof axes are linear axes, which represent translation of Bodies, and the latter 3 dof axes represent the angular motion. Each axis can be either locked, or limited. -Member Function Description ---------------------------- - -.. _class_Generic6DOFJoint_get_flag_x: - -- :ref:`bool` **get_flag_x** **(** :ref:`int` flag **)** const - -.. _class_Generic6DOFJoint_get_flag_y: - -- :ref:`bool` **get_flag_y** **(** :ref:`int` flag **)** const - -.. _class_Generic6DOFJoint_get_flag_z: - -- :ref:`bool` **get_flag_z** **(** :ref:`int` flag **)** const - -.. _class_Generic6DOFJoint_get_param_x: - -- :ref:`float` **get_param_x** **(** :ref:`int` param **)** const - -.. _class_Generic6DOFJoint_get_param_y: - -- :ref:`float` **get_param_y** **(** :ref:`int` param **)** const - -.. _class_Generic6DOFJoint_get_param_z: - -- :ref:`float` **get_param_z** **(** :ref:`int` param **)** const - -.. _class_Generic6DOFJoint_set_flag_x: - -- void **set_flag_x** **(** :ref:`int` flag, :ref:`bool` value **)** - -.. _class_Generic6DOFJoint_set_flag_y: - -- void **set_flag_y** **(** :ref:`int` flag, :ref:`bool` value **)** - -.. _class_Generic6DOFJoint_set_flag_z: - -- void **set_flag_z** **(** :ref:`int` flag, :ref:`bool` value **)** - -.. _class_Generic6DOFJoint_set_param_x: - -- void **set_param_x** **(** :ref:`int` param, :ref:`float` value **)** - -.. _class_Generic6DOFJoint_set_param_y: - -- void **set_param_y** **(** :ref:`int` param, :ref:`float` value **)** - -.. _class_Generic6DOFJoint_set_param_z: - -- void **set_param_z** **(** :ref:`int` param, :ref:`float` value **)** - - diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 534ab34b2..cc64fed81 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -18,43 +18,6 @@ Brief Description Base node for geometry based visual instances. -Member Functions ----------------- - -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cast_shadows_setting` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_extra_cull_margin` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_max_distance` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_max_hysteresis` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_min_distance` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_min_hysteresis` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material_override` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cast_shadows_setting` **(** :ref:`int` shadow_casting_setting **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extra_cull_margin` **(** :ref:`float` margin **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` value **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_max_distance` **(** :ref:`float` mode **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_max_hysteresis` **(** :ref:`float` mode **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_min_distance` **(** :ref:`float` mode **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_min_hysteresis` **(** :ref:`float` mode **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material_override` **(** :ref:`Material` material **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -106,75 +69,3 @@ Description Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials. -Member Function Description ---------------------------- - -.. _class_GeometryInstance_get_cast_shadows_setting: - -- :ref:`int` **get_cast_shadows_setting** **(** **)** const - -.. _class_GeometryInstance_get_extra_cull_margin: - -- :ref:`float` **get_extra_cull_margin** **(** **)** const - -.. _class_GeometryInstance_get_flag: - -- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const - -.. _class_GeometryInstance_get_lod_max_distance: - -- :ref:`float` **get_lod_max_distance** **(** **)** const - -.. _class_GeometryInstance_get_lod_max_hysteresis: - -- :ref:`float` **get_lod_max_hysteresis** **(** **)** const - -.. _class_GeometryInstance_get_lod_min_distance: - -- :ref:`float` **get_lod_min_distance** **(** **)** const - -.. _class_GeometryInstance_get_lod_min_hysteresis: - -- :ref:`float` **get_lod_min_hysteresis** **(** **)** const - -.. _class_GeometryInstance_get_material_override: - -- :ref:`Material` **get_material_override** **(** **)** const - -Return the material override for the whole geometry. - -.. _class_GeometryInstance_set_cast_shadows_setting: - -- void **set_cast_shadows_setting** **(** :ref:`int` shadow_casting_setting **)** - -.. _class_GeometryInstance_set_extra_cull_margin: - -- void **set_extra_cull_margin** **(** :ref:`float` margin **)** - -.. _class_GeometryInstance_set_flag: - -- void **set_flag** **(** :ref:`int` flag, :ref:`bool` value **)** - -.. _class_GeometryInstance_set_lod_max_distance: - -- void **set_lod_max_distance** **(** :ref:`float` mode **)** - -.. _class_GeometryInstance_set_lod_max_hysteresis: - -- void **set_lod_max_hysteresis** **(** :ref:`float` mode **)** - -.. _class_GeometryInstance_set_lod_min_distance: - -- void **set_lod_min_distance** **(** :ref:`float` mode **)** - -.. _class_GeometryInstance_set_lod_min_hysteresis: - -- void **set_lod_min_hysteresis** **(** :ref:`float` mode **)** - -.. _class_GeometryInstance_set_material_override: - -- void **set_material_override** **(** :ref:`Material` material **)** - -Set the material override for the whole geometry. - - diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index f14c1eee0..4f83f20dc 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -19,51 +19,11 @@ Brief Description Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`debug_bake` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bias` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_energy` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GIProbeData` | :ref:`get_probe_data` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_propagation` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdiv` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_compressed` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_interior` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bias` **(** :ref:`float` max **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_compress` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dynamic_range` **(** :ref:`int` max **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_energy` **(** :ref:`float` max **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_bias` **(** :ref:`float` max **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_probe_data` **(** :ref:`GIProbeData` data **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_propagation` **(** :ref:`float` max **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdiv` **(** :ref:`int` subdiv **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++-------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`debug_bake` **(** **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -129,84 +89,4 @@ Member Function Description - void **debug_bake** **(** **)** -.. _class_GIProbe_get_bias: - -- :ref:`float` **get_bias** **(** **)** const - -.. _class_GIProbe_get_dynamic_range: - -- :ref:`int` **get_dynamic_range** **(** **)** const - -.. _class_GIProbe_get_energy: - -- :ref:`float` **get_energy** **(** **)** const - -.. _class_GIProbe_get_extents: - -- :ref:`Vector3` **get_extents** **(** **)** const - -.. _class_GIProbe_get_normal_bias: - -- :ref:`float` **get_normal_bias** **(** **)** const - -.. _class_GIProbe_get_probe_data: - -- :ref:`GIProbeData` **get_probe_data** **(** **)** const - -.. _class_GIProbe_get_propagation: - -- :ref:`float` **get_propagation** **(** **)** const - -.. _class_GIProbe_get_subdiv: - -- :ref:`int` **get_subdiv** **(** **)** const - -.. _class_GIProbe_is_compressed: - -- :ref:`bool` **is_compressed** **(** **)** const - -.. _class_GIProbe_is_interior: - -- :ref:`bool` **is_interior** **(** **)** const - -.. _class_GIProbe_set_bias: - -- void **set_bias** **(** :ref:`float` max **)** - -.. _class_GIProbe_set_compress: - -- void **set_compress** **(** :ref:`bool` enable **)** - -.. _class_GIProbe_set_dynamic_range: - -- void **set_dynamic_range** **(** :ref:`int` max **)** - -.. _class_GIProbe_set_energy: - -- void **set_energy** **(** :ref:`float` max **)** - -.. _class_GIProbe_set_extents: - -- void **set_extents** **(** :ref:`Vector3` extents **)** - -.. _class_GIProbe_set_interior: - -- void **set_interior** **(** :ref:`bool` enable **)** - -.. _class_GIProbe_set_normal_bias: - -- void **set_normal_bias** **(** :ref:`float` max **)** - -.. _class_GIProbe_set_probe_data: - -- void **set_probe_data** **(** :ref:`GIProbeData` data **)** - -.. _class_GIProbe_set_propagation: - -- void **set_propagation** **(** :ref:`float` max **)** - -.. _class_GIProbe_set_subdiv: - -- void **set_subdiv** **(** :ref:`int` subdiv **)** - diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 0623dadec..131774bf8 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -16,55 +16,6 @@ Brief Description -Member Functions ----------------- - -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bias` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_bounds` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cell_size` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_dynamic_data` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_energy` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_propagation` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_to_cell_xform` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_compressed` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_interior` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bias` **(** :ref:`float` bias **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounds` **(** :ref:`Rect3` bounds **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`float` cell_size **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_compress` **(** :ref:`bool` compress **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dynamic_data` **(** :ref:`PoolIntArray` dynamic_data **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dynamic_range` **(** :ref:`int` dynamic_range **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_energy` **(** :ref:`float` energy **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior` **(** :ref:`bool` interior **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_bias` **(** :ref:`float` bias **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_propagation` **(** :ref:`float` propagation **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_to_cell_xform` **(** :ref:`Transform` to_cell_xform **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -74,7 +25,7 @@ Member Variables .. _class_GIProbeData_bounds: -- :ref:`Rect3` **bounds** +- :ref:`AABB` **bounds** .. _class_GIProbeData_cell_size: @@ -113,95 +64,3 @@ Member Variables - :ref:`Transform` **to_cell_xform** -Member Function Description ---------------------------- - -.. _class_GIProbeData_get_bias: - -- :ref:`float` **get_bias** **(** **)** const - -.. _class_GIProbeData_get_bounds: - -- :ref:`Rect3` **get_bounds** **(** **)** const - -.. _class_GIProbeData_get_cell_size: - -- :ref:`float` **get_cell_size** **(** **)** const - -.. _class_GIProbeData_get_dynamic_data: - -- :ref:`PoolIntArray` **get_dynamic_data** **(** **)** const - -.. _class_GIProbeData_get_dynamic_range: - -- :ref:`int` **get_dynamic_range** **(** **)** const - -.. _class_GIProbeData_get_energy: - -- :ref:`float` **get_energy** **(** **)** const - -.. _class_GIProbeData_get_normal_bias: - -- :ref:`float` **get_normal_bias** **(** **)** const - -.. _class_GIProbeData_get_propagation: - -- :ref:`float` **get_propagation** **(** **)** const - -.. _class_GIProbeData_get_to_cell_xform: - -- :ref:`Transform` **get_to_cell_xform** **(** **)** const - -.. _class_GIProbeData_is_compressed: - -- :ref:`bool` **is_compressed** **(** **)** const - -.. _class_GIProbeData_is_interior: - -- :ref:`bool` **is_interior** **(** **)** const - -.. _class_GIProbeData_set_bias: - -- void **set_bias** **(** :ref:`float` bias **)** - -.. _class_GIProbeData_set_bounds: - -- void **set_bounds** **(** :ref:`Rect3` bounds **)** - -.. _class_GIProbeData_set_cell_size: - -- void **set_cell_size** **(** :ref:`float` cell_size **)** - -.. _class_GIProbeData_set_compress: - -- void **set_compress** **(** :ref:`bool` compress **)** - -.. _class_GIProbeData_set_dynamic_data: - -- void **set_dynamic_data** **(** :ref:`PoolIntArray` dynamic_data **)** - -.. _class_GIProbeData_set_dynamic_range: - -- void **set_dynamic_range** **(** :ref:`int` dynamic_range **)** - -.. _class_GIProbeData_set_energy: - -- void **set_energy** **(** :ref:`float` energy **)** - -.. _class_GIProbeData_set_interior: - -- void **set_interior** **(** :ref:`bool` interior **)** - -.. _class_GIProbeData_set_normal_bias: - -- void **set_normal_bias** **(** :ref:`float` bias **)** - -.. _class_GIProbeData_set_propagation: - -- void **set_propagation** **(** :ref:`float` propagation **)** - -.. _class_GIProbeData_set_to_cell_xform: - -- void **set_to_cell_xform** **(** :ref:`Transform` to_cell_xform **)** - - diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 2a886f78d..40139de19 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -19,31 +19,23 @@ Color interpolator node. Member Functions ---------------- -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`get_colors` **(** **)** const | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_offsets` **(** **)** const | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` offset **)** | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_colors` **(** :ref:`PoolColorArray` colors **)** | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offsets` **(** :ref:`PoolRealArray` offsets **)** | -+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` offset **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -77,24 +69,12 @@ Adds the specified color to the end of the ramp, with the specified offset Returns the color of the ramp color at index *point* -.. _class_Gradient_get_colors: - -- :ref:`PoolColorArray` **get_colors** **(** **)** const - -Returns the colors in the ramp - .. _class_Gradient_get_offset: - :ref:`float` **get_offset** **(** :ref:`int` point **)** const Returns the offset of the ramp color at index *point* -.. _class_Gradient_get_offsets: - -- :ref:`PoolRealArray` **get_offsets** **(** **)** const - -Returns the offsets for the colors in this ramp - .. _class_Gradient_get_point_count: - :ref:`int` **get_point_count** **(** **)** const @@ -119,22 +99,10 @@ Removes the color at the index *offset* Sets the color of the ramp color at index *point* -.. _class_Gradient_set_colors: - -- void **set_colors** **(** :ref:`PoolColorArray` colors **)** - -Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements. - .. _class_Gradient_set_offset: - void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** Sets the offset for the ramp color at index *point* -.. _class_Gradient_set_offsets: - -- void **set_offsets** **(** :ref:`PoolRealArray` offsets **)** - -Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default. - diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index b8c875b61..7e6beea2a 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -16,17 +16,6 @@ Brief Description Gradient filled texture. -Member Functions ----------------- - -+----------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gradient` **(** :ref:`Gradient` gradient **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_width` **(** :ref:`int` width **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -44,19 +33,3 @@ Description Uses a :ref:`Gradient` to fill the texture data, the gradient will be filled from left to right using colors obtained from the gradient, this means that the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`set_width`). -Member Function Description ---------------------------- - -.. _class_GradientTexture_get_gradient: - -- :ref:`Gradient` **get_gradient** **(** **)** const - -.. _class_GradientTexture_set_gradient: - -- void **set_gradient** **(** :ref:`Gradient` gradient **)** - -.. _class_GradientTexture_set_width: - -- void **set_width** **(** :ref:`int` width **)** - - diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 7f48b31dd..093cea5fe 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -52,14 +52,8 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_title` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_close_button_visible` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_comment` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_resizable` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | @@ -72,16 +66,10 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_overlay` **(** :ref:`int` overlay **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resizable` **(** :ref:`bool` resizable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_selected` **(** :ref:`bool` selected **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_close_button` **(** :ref:`bool` show **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_title` **(** :ref:`String` title **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -240,26 +228,10 @@ Return the (integer) type of left (input) 'idx' slot. Return the (integer) type of right (output) 'idx' slot. -.. _class_GraphNode_get_title: - -- :ref:`String` **get_title** **(** **)** const - -Return the title of the GraphNode. - -.. _class_GraphNode_is_close_button_visible: - -- :ref:`bool` **is_close_button_visible** **(** **)** const - -Returns true if the close button is shown. False otherwise. - .. _class_GraphNode_is_comment: - :ref:`bool` **is_comment** **(** **)** const -.. _class_GraphNode_is_resizable: - -- :ref:`bool` **is_resizable** **(** **)** const - .. _class_GraphNode_is_selected: - :ref:`bool` **is_selected** **(** **)** @@ -290,28 +262,12 @@ Set the offset of the GraphNode. - void **set_overlay** **(** :ref:`int` overlay **)** -.. _class_GraphNode_set_resizable: - -- void **set_resizable** **(** :ref:`bool` resizable **)** - .. _class_GraphNode_set_selected: - void **set_selected** **(** :ref:`bool` selected **)** -.. _class_GraphNode_set_show_close_button: - -- void **set_show_close_button** **(** :ref:`bool` show **)** - -Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. - .. _class_GraphNode_set_slot: - void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** -.. _class_GraphNode_set_title: - -- void **set_title** **(** :ref:`String` title **)** - -Set the title of the GraphNode. - diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 644e9285f..b2f55783e 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -16,15 +16,6 @@ Brief Description Grid container used to arrange elements in a grid like layout -Member Functions ----------------- - -+------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_columns` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`set_columns` **(** :ref:`int` columns **)** | -+------------------------+-----------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description Grid container will arrange its children in a grid like structure, the grid columns are specified using the :ref:`set_columns` method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. -Member Function Description ---------------------------- - -.. _class_GridContainer_get_columns: - -- :ref:`int` **get_columns** **(** **)** const - -Returns the number of columns in this container - -.. _class_GridContainer_set_columns: - -- void **set_columns** **(** :ref:`int` columns **)** - -Sets the numbers of columns in the container, then reorder its children to accommodate the new layout - - diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index e8454a66c..34e766d3a 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -16,19 +16,6 @@ Brief Description Groove constraint for 2D physics. -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_initial_offset` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_offset` **(** :ref:`float` offset **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` length **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,31 +33,3 @@ Description Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another. -Member Function Description ---------------------------- - -.. _class_GrooveJoint2D_get_initial_offset: - -- :ref:`float` **get_initial_offset** **(** **)** const - -Set the final offset of the groove on body A. - -.. _class_GrooveJoint2D_get_length: - -- :ref:`float` **get_length** **(** **)** const - -Return the length of the groove. - -.. _class_GrooveJoint2D_set_initial_offset: - -- void **set_initial_offset** **(** :ref:`float` offset **)** - -Set the initial offset of the groove on body A. - -.. _class_GrooveJoint2D_set_length: - -- void **set_length** **(** :ref:`float` length **)** - -Set the length of the groove. - - diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 279a29c26..69d62a383 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -16,19 +16,6 @@ Brief Description A hinge between two 3D bodies. -Member Functions ----------------- - -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enabled **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -94,23 +81,3 @@ Description Normaly uses the z-axis of body A as the hinge axis, another axis can be specified when adding it manually though. -Member Function Description ---------------------------- - -.. _class_HingeJoint_get_flag: - -- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const - -.. _class_HingeJoint_get_param: - -- :ref:`float` **get_param** **(** :ref:`int` param **)** const - -.. _class_HingeJoint_set_flag: - -- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enabled **)** - -.. _class_HingeJoint_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - - diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index d2ce5ca7e..c49be32c2 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -24,28 +24,16 @@ Member Functions +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_body_size` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_download_file` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_http_client_status` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_download_file` **(** :ref:`String` path **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -111,12 +99,6 @@ Cancel the current request. Return the response body length. -.. _class_HTTPRequest_get_body_size_limit: - -- :ref:`int` **get_body_size_limit** **(** **)** const - -Return current body size limit. - .. _class_HTTPRequest_get_download_file: - :ref:`String` **get_download_file** **(** **)** const @@ -135,44 +117,14 @@ Return the amount of bytes this HTTPRequest downloaded. Return the current status of the underlying :ref:`HTTPClient`. -.. _class_HTTPRequest_get_max_redirects: - -- :ref:`int` **get_max_redirects** **(** **)** const - -Return the maximum amount of redirects that will be followed. - -.. _class_HTTPRequest_is_using_threads: - -- :ref:`bool` **is_using_threads** **(** **)** const - -Whether this request is using threads. - .. _class_HTTPRequest_request: - :ref:`int` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** -.. _class_HTTPRequest_set_body_size_limit: - -- void **set_body_size_limit** **(** :ref:`int` bytes **)** - -Set the response body size limit. - .. _class_HTTPRequest_set_download_file: - void **set_download_file** **(** :ref:`String` path **)** Set the file to download into. Outputs the response body into the file. -.. _class_HTTPRequest_set_max_redirects: - -- void **set_max_redirects** **(** :ref:`int` amount **)** - -Set the maximum amount of redirects the request will follow. - -.. _class_HTTPRequest_set_use_threads: - -- void **set_use_threads** **(** :ref:`bool` enable **)** - -Make this HTTPRequest use threads. - diff --git a/classes/class_image.rst b/classes/class_image.rst index 58dcb64cc..669e68931 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -417,21 +417,15 @@ Saves the image as a PNG file to ``path``. - void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** -Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is unlocked. Example: +Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is locked. Example: -`` +:: -var img = Image.new() - -img.lock() - -img.set_pixel(x, y, color) # Does not have an effect - -img.unlock() - -img.set_pixel(x, y, color) # Works - -``. + var img = Image.new() + img.unlock() + img.set_pixel(x, y, color) # Does not have an effect + img.lock() + img.set_pixel(x, y, color) # Works .. _class_Image_shrink_x2: diff --git a/classes/class_input.rst b/classes/class_input.rst index 2ead258ac..9e52a44fa 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -163,7 +163,7 @@ If the device has a gyroscope, this will return the rate of rotation in rad/s ar - :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const -Returns the current value of the joypad axis at given index (see ``JOY\_\*`` constants in :ref:`@Global Scope`) +Returns the current value of the joypad axis at given index (see ``JOY\_\*`` constants in :ref:`@GlobalScope`) .. _class_Input_get_joy_axis_index_from_string: @@ -251,25 +251,25 @@ Returns ``true`` if you are pressing the action event. - :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const -Returns ``true`` if you are pressing the joypad button. (see ``JOY\_\*`` constants in :ref:`@Global Scope`) +Returns ``true`` if you are pressing the joypad button. (see ``JOY\_\*`` constants in :ref:`@GlobalScope`) .. _class_Input_is_joy_known: - :ref:`bool` **is_joy_known** **(** :ref:`int` device **)** -Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY\_\*`` constants (see :ref:`@Global Scope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. +Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY\_\*`` constants (see :ref:`@GlobalScope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. .. _class_Input_is_key_pressed: - :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** const -Returns ``true`` if you are pressing the key. You can pass ``KEY\_\*``, which are pre-defined constants listed in :ref:`@Global Scope`. +Returns ``true`` if you are pressing the key. You can pass ``KEY\_\*``, which are pre-defined constants listed in :ref:`@GlobalScope`. .. _class_Input_is_mouse_button_pressed: - :ref:`bool` **is_mouse_button_pressed** **(** :ref:`int` button **)** const -Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON\_\*``, which are pre-defined constants listed in :ref:`@Global Scope`. +Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON\_\*``, which are pre-defined constants listed in :ref:`@GlobalScope`. .. _class_Input_joy_connection_changed: diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 5011d8359..f30c18b5f 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -26,8 +26,6 @@ Member Functions +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`as_text` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_device` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_id` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | @@ -42,8 +40,6 @@ Member Functions +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pressed` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`int` device **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_id` **(** :ref:`int` id **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | @@ -71,7 +67,7 @@ Member Function Description - :ref:`bool` **action_match** **(** :ref:`InputEvent` event **)** const -Returns ``true`` if this event matches ``event[event]. +Returns ``true`` if this event matches ``event``. .. _class_InputEvent_as_text: @@ -79,12 +75,6 @@ Returns ``true`` if this event matches ``event[event]. Returns a :ref:`String` representation of the event. -.. _class_InputEvent_get_device: - -- :ref:`int` **get_device** **(** **)** const - -Returns the device's id that generated the event. - .. _class_InputEvent_get_id: - :ref:`int` **get_id** **(** **)** const @@ -127,10 +117,6 @@ Returns ``true`` if this input event is an echo event (only for events of type K Returns ``true`` if this input event is pressed. Not relevant for the event types ``MOUSE_MOTION``, ``SCREEN_DRAG`` or ``NONE``. -.. _class_InputEvent_set_device: - -- void **set_device** **(** :ref:`int` device **)** - .. _class_InputEvent_set_id: - void **set_id** **(** :ref:`int` id **)** diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 6ec856d8e..a76ec71fd 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -16,17 +16,6 @@ Brief Description Input event type for actions. -Member Functions ----------------- - -+------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_action` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action` **(** :ref:`String` action **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -42,21 +31,5 @@ Member Variables Description ----------- -Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu ``Project > Project Settings > Input Map[/Code]. See [method Node._input]. - -Member Function Description ---------------------------- - -.. _class_InputEventAction_get_action: - -- :ref:`String` **get_action** **(** **)** const - -.. _class_InputEventAction_set_action: - -- void **set_action** **(** :ref:`String` action **)** - -.. _class_InputEventAction_set_pressed: - -- void **set_pressed** **(** :ref:`bool` pressed **)** - +Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu ``Project > Project Settings > Input Map``. See :ref:`Node._input`. diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst new file mode 100644 index 000000000..f271d669a --- /dev/null +++ b/classes/class_inputeventgesture.rst @@ -0,0 +1,28 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the InputEventGesture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_InputEventGesture: + +InputEventGesture +================= + +**Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`InputEventPanGesture`, :ref:`InputEventMagnifyGesture` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_InputEventGesture_position: + +- :ref:`Vector2` **position** + + diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 526366fb3..ba7aab891 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -16,21 +16,6 @@ Brief Description Input event for gamepad buttons. -Member Functions ----------------- - -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_index` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pressure` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_index` **(** :ref:`int` button_index **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressure` **(** :ref:`float` pressure **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -52,27 +37,3 @@ Description Input event type for gamepad buttons. For joysticks see :ref:`InputEventJoypadMotion`. -Member Function Description ---------------------------- - -.. _class_InputEventJoypadButton_get_button_index: - -- :ref:`int` **get_button_index** **(** **)** const - -.. _class_InputEventJoypadButton_get_pressure: - -- :ref:`float` **get_pressure** **(** **)** const - -.. _class_InputEventJoypadButton_set_button_index: - -- void **set_button_index** **(** :ref:`int` button_index **)** - -.. _class_InputEventJoypadButton_set_pressed: - -- void **set_pressed** **(** :ref:`bool` pressed **)** - -.. _class_InputEventJoypadButton_set_pressure: - -- void **set_pressure** **(** :ref:`float` pressure **)** - - diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 2ab84822c..d25d622c9 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -16,19 +16,6 @@ Brief Description Input event type for gamepad joysticks and other motions. For buttons see ``InputEventJoypadMotion``. -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_axis` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_axis_value` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis` **(** :ref:`int` axis **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_value` **(** :ref:`float` axis_value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,23 +33,3 @@ Description Stores information about joystick motions. One ``InputEventJoypadMotion`` represents one axis at a time. -Member Function Description ---------------------------- - -.. _class_InputEventJoypadMotion_get_axis: - -- :ref:`int` **get_axis** **(** **)** const - -.. _class_InputEventJoypadMotion_get_axis_value: - -- :ref:`float` **get_axis_value** **(** **)** const - -.. _class_InputEventJoypadMotion_set_axis: - -- void **set_axis** **(** :ref:`int` axis **)** - -.. _class_InputEventJoypadMotion_set_axis_value: - -- void **set_axis_value** **(** :ref:`float` axis_value **)** - - diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index d520ff91f..6a4aeb45f 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -19,21 +19,9 @@ Input event type for keyboard events. Member Functions ---------------- -+------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_scancode` **(** **)** const | +------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_scancode_with_modifiers` **(** **)** const | +------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unicode` **(** **)** const | -+------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_echo` **(** :ref:`bool` echo **)** | -+------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scancode` **(** :ref:`int` scancode **)** | -+------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unicode` **(** :ref:`int` unicode **)** | -+------------------------+-------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -63,32 +51,8 @@ Stores key presses on the keyboard. Supports key presses, key releases and :ref: Member Function Description --------------------------- -.. _class_InputEventKey_get_scancode: - -- :ref:`int` **get_scancode** **(** **)** const - .. _class_InputEventKey_get_scancode_with_modifiers: - :ref:`int` **get_scancode_with_modifiers** **(** **)** const -.. _class_InputEventKey_get_unicode: - -- :ref:`int` **get_unicode** **(** **)** const - -.. _class_InputEventKey_set_echo: - -- void **set_echo** **(** :ref:`bool` echo **)** - -.. _class_InputEventKey_set_pressed: - -- void **set_pressed** **(** :ref:`bool` pressed **)** - -.. _class_InputEventKey_set_scancode: - -- void **set_scancode** **(** :ref:`int` scancode **)** - -.. _class_InputEventKey_set_unicode: - -- void **set_unicode** **(** :ref:`int` unicode **)** - diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst new file mode 100644 index 000000000..b85913ef6 --- /dev/null +++ b/classes/class_inputeventmagnifygesture.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the InputEventMagnifyGesture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_InputEventMagnifyGesture: + +InputEventMagnifyGesture +======================== + +**Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_InputEventMagnifyGesture_factor: + +- :ref:`float` **factor** + + diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index 4994dd984..5059e0ceb 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -18,29 +18,12 @@ Brief Description Base input event type for mouse events. -Member Functions ----------------- - -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_mask` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_mask` **(** :ref:`int` button_mask **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` global_position **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- .. _class_InputEventMouse_button_mask: -- :ref:`int` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@Global Scope`. +- :ref:`int` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@GlobalScope`. .. _class_InputEventMouse_global_position: @@ -56,31 +39,3 @@ Description Stores general mouse events informations. -Member Function Description ---------------------------- - -.. _class_InputEventMouse_get_button_mask: - -- :ref:`int` **get_button_mask** **(** **)** const - -.. _class_InputEventMouse_get_global_position: - -- :ref:`Vector2` **get_global_position** **(** **)** const - -.. _class_InputEventMouse_get_position: - -- :ref:`Vector2` **get_position** **(** **)** const - -.. _class_InputEventMouse_set_button_mask: - -- void **set_button_mask** **(** :ref:`int` button_mask **)** - -.. _class_InputEventMouse_set_global_position: - -- void **set_global_position** **(** :ref:`Vector2` global_position **)** - -.. _class_InputEventMouse_set_position: - -- void **set_position** **(** :ref:`Vector2` position **)** - - diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 4f3756f88..c222a5dfc 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -16,31 +16,12 @@ Brief Description Input event type for mouse button events. -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_index` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_factor` **(** **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_doubleclick` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_index` **(** :ref:`int` button_index **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_doubleclick` **(** :ref:`bool` doubleclick **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_factor` **(** :ref:`float` factor **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- .. _class_InputEventMouseButton_button_index: -- :ref:`int` **button_index** - Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@Global Scope`. +- :ref:`int` **button_index** - Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope`. .. _class_InputEventMouseButton_doubleclick: @@ -60,35 +41,3 @@ Description Contains mouse click informations. See :ref:`Node._input`. -Member Function Description ---------------------------- - -.. _class_InputEventMouseButton_get_button_index: - -- :ref:`int` **get_button_index** **(** **)** const - -.. _class_InputEventMouseButton_get_factor: - -- :ref:`float` **get_factor** **(** **)** - -.. _class_InputEventMouseButton_is_doubleclick: - -- :ref:`bool` **is_doubleclick** **(** **)** const - -.. _class_InputEventMouseButton_set_button_index: - -- void **set_button_index** **(** :ref:`int` button_index **)** - -.. _class_InputEventMouseButton_set_doubleclick: - -- void **set_doubleclick** **(** :ref:`bool` doubleclick **)** - -.. _class_InputEventMouseButton_set_factor: - -- void **set_factor** **(** :ref:`float` factor **)** - -.. _class_InputEventMouseButton_set_pressed: - -- void **set_pressed** **(** :ref:`bool` pressed **)** - - diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 0d2efc4c6..bf2a8d8b8 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -16,19 +16,6 @@ Brief Description Input event type for mouse motion events. -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_relative` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_speed` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_relative` **(** :ref:`Vector2` relative **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed` **(** :ref:`Vector2` speed **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,23 +33,3 @@ Description Contains mouse motion informations. Supports relative, absolute positions and speed. See :ref:`Node._input`. -Member Function Description ---------------------------- - -.. _class_InputEventMouseMotion_get_relative: - -- :ref:`Vector2` **get_relative** **(** **)** const - -.. _class_InputEventMouseMotion_get_speed: - -- :ref:`Vector2` **get_speed** **(** **)** const - -.. _class_InputEventMouseMotion_set_relative: - -- void **set_relative** **(** :ref:`Vector2` relative **)** - -.. _class_InputEventMouseMotion_set_speed: - -- void **set_speed** **(** :ref:`Vector2` speed **)** - - diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst new file mode 100644 index 000000000..a282427a3 --- /dev/null +++ b/classes/class_inputeventpangesture.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the InputEventPanGesture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_InputEventPanGesture: + +InputEventPanGesture +==================== + +**Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_InputEventPanGesture_delta: + +- :ref:`Vector2` **delta** + + diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 91021405f..6a7860348 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -18,27 +18,6 @@ Input event type for screen drag events. (only available on mobile devices) -Member Functions ----------------- - -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_relative` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_speed` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_index` **(** :ref:`int` index **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_relative` **(** :ref:`Vector2` relative **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed` **(** :ref:`Vector2` speed **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -64,39 +43,3 @@ Description Contains screen drag informations. See :ref:`Node._input`. -Member Function Description ---------------------------- - -.. _class_InputEventScreenDrag_get_index: - -- :ref:`int` **get_index** **(** **)** const - -.. _class_InputEventScreenDrag_get_position: - -- :ref:`Vector2` **get_position** **(** **)** const - -.. _class_InputEventScreenDrag_get_relative: - -- :ref:`Vector2` **get_relative** **(** **)** const - -.. _class_InputEventScreenDrag_get_speed: - -- :ref:`Vector2` **get_speed** **(** **)** const - -.. _class_InputEventScreenDrag_set_index: - -- void **set_index** **(** :ref:`int` index **)** - -.. _class_InputEventScreenDrag_set_position: - -- void **set_position** **(** :ref:`Vector2` position **)** - -.. _class_InputEventScreenDrag_set_relative: - -- void **set_relative** **(** :ref:`Vector2` relative **)** - -.. _class_InputEventScreenDrag_set_speed: - -- void **set_speed** **(** :ref:`Vector2` speed **)** - - diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index dd220dd8d..c84e3ba31 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -18,21 +18,6 @@ Input event type for screen touch events. (only available on mobile devices) -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_index` **(** :ref:`int` index **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,27 +39,3 @@ Description Stores multi-touch press/release information. Supports touch press, touch release and :ref:`index` for multi-touch count and order. -Member Function Description ---------------------------- - -.. _class_InputEventScreenTouch_get_index: - -- :ref:`int` **get_index** **(** **)** const - -.. _class_InputEventScreenTouch_get_position: - -- :ref:`Vector2` **get_position** **(** **)** const - -.. _class_InputEventScreenTouch_set_index: - -- void **set_index** **(** :ref:`int` index **)** - -.. _class_InputEventScreenTouch_set_position: - -- void **set_position** **(** :ref:`Vector2` position **)** - -.. _class_InputEventScreenTouch_set_pressed: - -- void **set_pressed** **(** :ref:`bool` pressed **)** - - diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 542dc535d..b5f1e8d7b 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -9,7 +9,7 @@ InputEventWithModifiers **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`InputEventKey`, :ref:`InputEventMouse` +**Inherited By:** :ref:`InputEventKey`, :ref:`InputEventMouse`, :ref:`InputEventGesture` **Category:** Core @@ -18,31 +18,6 @@ Brief Description Base class for keys events with modifiers. -Member Functions ----------------- - -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_alt` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_command` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_control` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_metakey` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_shift` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_alt` **(** :ref:`bool` enable **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_command` **(** :ref:`bool` enable **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_control` **(** :ref:`bool` enable **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metakey` **(** :ref:`bool` enable **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shift` **(** :ref:`bool` enable **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -72,47 +47,3 @@ Description Contains keys events informations with modifiers support like ``SHIFT`` or ``ALT``. See :ref:`Node._input`. -Member Function Description ---------------------------- - -.. _class_InputEventWithModifiers_get_alt: - -- :ref:`bool` **get_alt** **(** **)** const - -.. _class_InputEventWithModifiers_get_command: - -- :ref:`bool` **get_command** **(** **)** const - -.. _class_InputEventWithModifiers_get_control: - -- :ref:`bool` **get_control** **(** **)** const - -.. _class_InputEventWithModifiers_get_metakey: - -- :ref:`bool` **get_metakey** **(** **)** const - -.. _class_InputEventWithModifiers_get_shift: - -- :ref:`bool` **get_shift** **(** **)** const - -.. _class_InputEventWithModifiers_set_alt: - -- void **set_alt** **(** :ref:`bool` enable **)** - -.. _class_InputEventWithModifiers_set_command: - -- void **set_command** **(** :ref:`bool` enable **)** - -.. _class_InputEventWithModifiers_set_control: - -- void **set_control** **(** :ref:`bool` enable **)** - -.. _class_InputEventWithModifiers_set_metakey: - -- void **set_metakey** **(** :ref:`bool` enable **)** - -.. _class_InputEventWithModifiers_set_shift: - -- void **set_shift** **(** :ref:`bool` enable **)** - - diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index d7f3d5ba6..582e73092 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -44,7 +44,7 @@ Member Functions Description ----------- -Manages all :ref:`InputEventAction` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map[/Code] or in code with [method add_action] and [method action_add_event]. See [method Node._input]. +Manages all :ref:`InputEventAction` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map`` or in code with :ref:`add_action` and :ref:`action_add_event`. See :ref:`Node._input`. Member Function Description --------------------------- diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index fd9b74d2d..3c132d6f6 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -19,21 +19,9 @@ Brief Description Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_target_path` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_interpolation_enabled` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interpolation_enabled` **(** :ref:`bool` target_path **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed` **(** :ref:`float` speed **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target` **(** :ref:`Object` target **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target_path` **(** :ref:`NodePath` target_path **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++-------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target` **(** :ref:`Object` target **)** | ++-------+-------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -54,32 +42,8 @@ Member Variables Member Function Description --------------------------- -.. _class_InterpolatedCamera_get_speed: - -- :ref:`float` **get_speed** **(** **)** const - -.. _class_InterpolatedCamera_get_target_path: - -- :ref:`NodePath` **get_target_path** **(** **)** const - -.. _class_InterpolatedCamera_is_interpolation_enabled: - -- :ref:`bool` **is_interpolation_enabled** **(** **)** const - -.. _class_InterpolatedCamera_set_interpolation_enabled: - -- void **set_interpolation_enabled** **(** :ref:`bool` target_path **)** - -.. _class_InterpolatedCamera_set_speed: - -- void **set_speed** **(** :ref:`float` speed **)** - .. _class_InterpolatedCamera_set_target: - void **set_target** **(** :ref:`Object` target **)** -.. _class_InterpolatedCamera_set_target_path: - -- void **set_target_path** **(** :ref:`NodePath` target_path **)** - diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 6f798e8b7..756df80d9 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -28,16 +28,8 @@ Member Functions +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_current_is_visible` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fixed_column_width` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_fixed_icon_size` **(** **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_mode` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_icon_scale` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | @@ -54,44 +46,24 @@ Member Functions +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_columns` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_text_lines` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_select_mode` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_auto_height` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_selectable` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_same_column_width` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_auto_height` **(** :ref:`bool` enable **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_column_width` **(** :ref:`int` width **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fixed_icon_size` **(** :ref:`Vector2` size **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_mode` **(** :ref:`int` mode **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_scale` **(** :ref:`float` scale **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | @@ -110,14 +82,6 @@ Member Functions +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_columns` **(** :ref:`int` amount **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_text_lines` **(** :ref:`int` lines **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_same_column_width` **(** :ref:`bool` enable **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sort_items_by_text` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unselect` **(** :ref:`int` idx **)** | @@ -154,6 +118,10 @@ Fired when specified item has been selected. Fired when a multiple selection is altered on a list allowing multiple selection. +.. _class_ItemList_rmb_clicked: + +- **rmb_clicked** **(** :ref:`Vector2` at_position **)** + Member Variables ---------------- @@ -247,30 +215,10 @@ Remove all items from the list. Ensure selection is visible, adjusting the scroll position as necessary. -.. _class_ItemList_get_allow_rmb_select: - -- :ref:`bool` **get_allow_rmb_select** **(** **)** const - -Return whether or not items may be selected via right mouse clicking. - -.. _class_ItemList_get_fixed_column_width: - -- :ref:`int` **get_fixed_column_width** **(** **)** const - -If column size has been fixed to a value, return that value. - .. _class_ItemList_get_fixed_icon_size: - :ref:`Vector2` **get_fixed_icon_size** **(** **)** const -.. _class_ItemList_get_icon_mode: - -- :ref:`int` **get_icon_mode** **(** **)** const - -.. _class_ItemList_get_icon_scale: - -- :ref:`float` **get_icon_scale** **(** **)** const - .. _class_ItemList_get_item_at_position: - :ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const @@ -311,22 +259,6 @@ Return the text for specified item index. Return tooltip hint for specified item index. -.. _class_ItemList_get_max_columns: - -- :ref:`int` **get_max_columns** **(** **)** const - -Return total number of columns in use by the list. - -.. _class_ItemList_get_max_text_lines: - -- :ref:`int` **get_max_text_lines** **(** **)** const - -Return total number of lines currently in use by the list. - -.. _class_ItemList_get_select_mode: - -- :ref:`int` **get_select_mode** **(** **)** const - .. _class_ItemList_get_selected_items: - :ref:`PoolIntArray` **get_selected_items** **(** **)** @@ -339,10 +271,6 @@ Returns the list of selected indexes. Returns the current vertical scroll bar for the List. -.. _class_ItemList_has_auto_height: - -- :ref:`bool` **has_auto_height** **(** **)** const - .. _class_ItemList_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const @@ -361,12 +289,6 @@ Returns whether or not the item at the specified index is selectable. Returns whether the tooltip is enabled for specified item index. -.. _class_ItemList_is_same_column_width: - -- :ref:`bool` **is_same_column_width** **(** **)** const - -Returns whether or not all columns of the list are of the same size. - .. _class_ItemList_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` idx **)** const @@ -387,34 +309,10 @@ Select the item at the specified index. Note: This method does not trigger the item selection signal. -.. _class_ItemList_set_allow_rmb_select: - -- void **set_allow_rmb_select** **(** :ref:`bool` allow **)** - -Allow (or disallow) selection of (selectable) items in the list using right mouse button. - -.. _class_ItemList_set_auto_height: - -- void **set_auto_height** **(** :ref:`bool` enable **)** - -.. _class_ItemList_set_fixed_column_width: - -- void **set_fixed_column_width** **(** :ref:`int` width **)** - -Set the size (width) all columns in the list are to use. - .. _class_ItemList_set_fixed_icon_size: - void **set_fixed_icon_size** **(** :ref:`Vector2` size **)** -.. _class_ItemList_set_icon_mode: - -- void **set_icon_mode** **(** :ref:`int` mode **)** - -.. _class_ItemList_set_icon_scale: - -- void **set_icon_scale** **(** :ref:`float` scale **)** - .. _class_ItemList_set_item_custom_bg_color: - void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** @@ -467,28 +365,6 @@ Sets tooltip hint for item at specified index. Sets whether the tooltip is enabled for specified item index. -.. _class_ItemList_set_max_columns: - -- void **set_max_columns** **(** :ref:`int` amount **)** - -Set maximum number of columns to use for the list. - -.. _class_ItemList_set_max_text_lines: - -- void **set_max_text_lines** **(** :ref:`int` lines **)** - -Set maximum number of lines to use for the list. - -.. _class_ItemList_set_same_column_width: - -- void **set_same_column_width** **(** :ref:`bool` enable **)** - -Sets a fixed size (width) to use for all columns of the list. - -.. _class_ItemList_set_select_mode: - -- void **set_select_mode** **(** :ref:`int` mode **)** - .. _class_ItemList_sort_items_by_text: - void **sort_items_by_text** **(** **)** diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst new file mode 100644 index 000000000..6b166ca1c --- /dev/null +++ b/classes/class_javascript.rst @@ -0,0 +1,42 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the JavaScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_JavaScript: + +JavaScript +========== + +**Inherits:** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Singleton that connects the engine with the browser's JavaScript context in HTML5 export. + +Member Functions +---------------- + ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`eval` **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +The JavaScript singleton is implemented only in HTML5 export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. + +Member Function Description +--------------------------- + +.. _class_JavaScript_eval: + +- :ref:`Variant` **eval** **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** + +Execute the string ``code`` as JavaScript code within the browser window. This is a call to the actual global JavaScript function ``eval()``. + +If ``use_global_execution_context`` is ``true``, the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment. + + diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 170fa006e..bb26776d1 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -18,27 +18,6 @@ Brief Description Base class for all 3D joints -Member Functions ----------------- - -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_exclude_nodes_from_collision` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_a` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_b` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_solver_priority` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude_nodes_from_collision` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_a` **(** :ref:`NodePath` node **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_b` **(** :ref:`NodePath` node **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_solver_priority` **(** :ref:`int` priority **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -64,39 +43,3 @@ Description All 3D joints link two nodes, has a priority, and can decide if the two bodies of the nodes should be able to collide with each other -Member Function Description ---------------------------- - -.. _class_Joint_get_exclude_nodes_from_collision: - -- :ref:`bool` **get_exclude_nodes_from_collision** **(** **)** const - -.. _class_Joint_get_node_a: - -- :ref:`NodePath` **get_node_a** **(** **)** const - -.. _class_Joint_get_node_b: - -- :ref:`NodePath` **get_node_b** **(** **)** const - -.. _class_Joint_get_solver_priority: - -- :ref:`int` **get_solver_priority** **(** **)** const - -.. _class_Joint_set_exclude_nodes_from_collision: - -- void **set_exclude_nodes_from_collision** **(** :ref:`bool` enable **)** - -.. _class_Joint_set_node_a: - -- void **set_node_a** **(** :ref:`NodePath` node **)** - -.. _class_Joint_set_node_b: - -- void **set_node_b** **(** :ref:`NodePath` node **)** - -.. _class_Joint_set_solver_priority: - -- void **set_solver_priority** **(** :ref:`int` priority **)** - - diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 63f907076..10e15007c 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -18,27 +18,6 @@ Brief Description Base node for all joint constraints in 2D physics. -Member Functions ----------------- - -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bias` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_exclude_nodes_from_collision` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_a` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_b` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bias` **(** :ref:`float` bias **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude_nodes_from_collision` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_a` **(** :ref:`NodePath` node **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_b` **(** :ref:`NodePath` node **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -64,47 +43,3 @@ Description Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint. -Member Function Description ---------------------------- - -.. _class_Joint2D_get_bias: - -- :ref:`float` **get_bias** **(** **)** const - -.. _class_Joint2D_get_exclude_nodes_from_collision: - -- :ref:`bool` **get_exclude_nodes_from_collision** **(** **)** const - -.. _class_Joint2D_get_node_a: - -- :ref:`NodePath` **get_node_a** **(** **)** const - -Return the path to the A node for the joint. - -.. _class_Joint2D_get_node_b: - -- :ref:`NodePath` **get_node_b** **(** **)** const - -Return the path to the B node for the joint. - -.. _class_Joint2D_set_bias: - -- void **set_bias** **(** :ref:`float` bias **)** - -.. _class_Joint2D_set_exclude_nodes_from_collision: - -- void **set_exclude_nodes_from_collision** **(** :ref:`bool` enable **)** - -.. _class_Joint2D_set_node_a: - -- void **set_node_a** **(** :ref:`NodePath` node **)** - -Set the path to the A node for the joint. Must be of type :ref:`PhysicsBody2D`. - -.. _class_Joint2D_set_node_b: - -- void **set_node_b** **(** :ref:`NodePath` node **)** - -Set the path to the B node for the joint. Must be of type :ref:`PhysicsBody2D`. - - diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index fdd6110ac..22bd35656 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -16,33 +16,12 @@ Brief Description Data class wrapper for decoded JSON. -Member Functions ----------------- - -+--------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_error` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_error_line` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_error_string` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_result` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_error` **(** :ref:`int` error **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_error_line` **(** :ref:`int` error_line **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_error_string` **(** :ref:`String` error_string **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_result` **(** :ref:`Variant` result **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- .. _class_JSONParseResult_error: -- :ref:`int` **error** - The error type if JSON source was not successfully parsed. See :ref:`@Global Scope`\ ERR\_\* constants. +- :ref:`int` **error** - The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope`\ ERR\_\* constants. .. _class_JSONParseResult_error_line: @@ -50,7 +29,7 @@ Member Variables .. _class_JSONParseResult_error_string: -- :ref:`String` **error_string** - The error message if JSON source was not successfully parsed. See :ref:`@Global Scope`\ ERR\_\* constants. +- :ref:`String` **error_string** - The error message if JSON source was not successfully parsed. See :ref:`@GlobalScope`\ ERR\_\* constants. .. _class_JSONParseResult_result: @@ -72,39 +51,3 @@ Description Returned by :ref:`JSON.parse`, ``JSONParseResult`` contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with ``if json_result.error == 0``. -Member Function Description ---------------------------- - -.. _class_JSONParseResult_get_error: - -- :ref:`int` **get_error** **(** **)** const - -.. _class_JSONParseResult_get_error_line: - -- :ref:`int` **get_error_line** **(** **)** const - -.. _class_JSONParseResult_get_error_string: - -- :ref:`String` **get_error_string** **(** **)** const - -.. _class_JSONParseResult_get_result: - -- :ref:`Variant` **get_result** **(** **)** const - -.. _class_JSONParseResult_set_error: - -- void **set_error** **(** :ref:`int` error **)** - -.. _class_JSONParseResult_set_error_line: - -- void **set_error_line** **(** :ref:`int` error_line **)** - -.. _class_JSONParseResult_set_error_string: - -- void **set_error_string** **(** :ref:`String` error_string **)** - -.. _class_JSONParseResult_set_result: - -- void **set_result** **(** :ref:`Variant` result **)** - - diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 0924416fd..42a7b7ad9 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -22,8 +22,6 @@ Member Functions +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`KinematicCollision` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slide_count` **(** **)** const | @@ -38,8 +36,6 @@ Member Functions +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398 **)** | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,15 +65,11 @@ Member Function Description Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody_get_safe_margin: - -- :ref:`float` **get_safe_margin** **(** **)** const - .. _class_KinematicBody_get_slide_collision: - :ref:`KinematicCollision` **get_slide_collision** **(** :ref:`int` slide_idx **)** -Returns a :ref:`KinematicCollision`, which contains information about a collision that occured during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count`()-1). +Returns a :ref:`KinematicCollision`, which contains information about a collision that occured during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). .. _class_KinematicBody_get_slide_count: @@ -127,10 +119,6 @@ If the body collides, it will change direction a maximum of ``max_bounces`` time Returns the movement that remained when the body stopped. To get more detailed information about collisions that occured, use :ref:`get_slide_collision`. -.. _class_KinematicBody_set_safe_margin: - -- void **set_safe_margin** **(** :ref:`float` pixels **)** - .. _class_KinematicBody_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 7797e9570..cc79f0709 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -22,8 +22,6 @@ Member Functions +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | -+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slide_count` **(** **)** const | @@ -38,8 +36,6 @@ Member Functions +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | -+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,15 +65,11 @@ Member Function Description Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody2D_get_safe_margin: - -- :ref:`float` **get_safe_margin** **(** **)** const - .. _class_KinematicBody2D_get_slide_collision: - :ref:`KinematicCollision2D` **get_slide_collision** **(** :ref:`int` slide_idx **)** -Returns a :ref:`KinematicCollision2D`, which contains information about a collision that occured during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count`()-1). +Returns a :ref:`KinematicCollision2D`, which contains information about a collision that occured during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). .. _class_KinematicBody2D_get_slide_count: @@ -127,10 +119,6 @@ If the body collides, it will change direction a maximum of ``max_bounces`` time Returns the movement that remained when the body stopped. To get more detailed information about collisions that occured, use :ref:`get_slide_collision`. -.. _class_KinematicBody2D_set_safe_margin: - -- void **set_safe_margin** **(** :ref:`float` pixels **)** - .. _class_KinematicBody2D_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 6d48e82a5..4d32a0730 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -14,34 +14,7 @@ KinematicCollision Brief Description ----------------- -Collision data for KinematicBody2D collisions. - -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_id` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape_index` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_local_shape` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_normal` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_position` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_remainder` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_travel` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------+ +Collision data for KinematicBody collisions. Member Variables ---------------- @@ -98,51 +71,3 @@ Contains collision data for KinematicBody collisions. When a :ref:`KinematicBody This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. -Member Function Description ---------------------------- - -.. _class_KinematicCollision_get_collider: - -- :ref:`Object` **get_collider** **(** **)** const - -.. _class_KinematicCollision_get_collider_id: - -- :ref:`int` **get_collider_id** **(** **)** const - -.. _class_KinematicCollision_get_collider_metadata: - -- :ref:`Variant` **get_collider_metadata** **(** **)** const - -.. _class_KinematicCollision_get_collider_shape: - -- :ref:`Object` **get_collider_shape** **(** **)** const - -.. _class_KinematicCollision_get_collider_shape_index: - -- :ref:`int` **get_collider_shape_index** **(** **)** const - -.. _class_KinematicCollision_get_collider_velocity: - -- :ref:`Vector3` **get_collider_velocity** **(** **)** const - -.. _class_KinematicCollision_get_local_shape: - -- :ref:`Object` **get_local_shape** **(** **)** const - -.. _class_KinematicCollision_get_normal: - -- :ref:`Vector3` **get_normal** **(** **)** const - -.. _class_KinematicCollision_get_position: - -- :ref:`Vector3` **get_position** **(** **)** const - -.. _class_KinematicCollision_get_remainder: - -- :ref:`Vector3` **get_remainder** **(** **)** const - -.. _class_KinematicCollision_get_travel: - -- :ref:`Vector3` **get_travel** **(** **)** const - - diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 4b57f4538..19131f7bc 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -16,33 +16,6 @@ Brief Description Collision data for KinematicBody2D collisions. -Member Functions ----------------- - -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_id` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape_index` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_local_shape` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_normal` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_remainder` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -98,51 +71,3 @@ Contains collision data for KinematicBody2D collisions. When a :ref:`KinematicBo This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. -Member Function Description ---------------------------- - -.. _class_KinematicCollision2D_get_collider: - -- :ref:`Object` **get_collider** **(** **)** const - -.. _class_KinematicCollision2D_get_collider_id: - -- :ref:`int` **get_collider_id** **(** **)** const - -.. _class_KinematicCollision2D_get_collider_metadata: - -- :ref:`Variant` **get_collider_metadata** **(** **)** const - -.. _class_KinematicCollision2D_get_collider_shape: - -- :ref:`Object` **get_collider_shape** **(** **)** const - -.. _class_KinematicCollision2D_get_collider_shape_index: - -- :ref:`int` **get_collider_shape_index** **(** **)** const - -.. _class_KinematicCollision2D_get_collider_velocity: - -- :ref:`Vector2` **get_collider_velocity** **(** **)** const - -.. _class_KinematicCollision2D_get_local_shape: - -- :ref:`Object` **get_local_shape** **(** **)** const - -.. _class_KinematicCollision2D_get_normal: - -- :ref:`Vector2` **get_normal** **(** **)** const - -.. _class_KinematicCollision2D_get_position: - -- :ref:`Vector2` **get_position** **(** **)** const - -.. _class_KinematicCollision2D_get_remainder: - -- :ref:`Vector2` **get_remainder** **(** **)** const - -.. _class_KinematicCollision2D_get_travel: - -- :ref:`Vector2` **get_travel** **(** **)** const - - diff --git a/classes/class_label.rst b/classes/class_label.rst index 21acf9af8..f4f897481 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -19,55 +19,19 @@ Displays plain text in a line or wrapped inside a rectangle. For formatted text, Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_align` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_height` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_lines_skipped` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_lines_visible` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_percent_visible` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_valign` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_characters` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_autowrap` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_clipping_text` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_uppercase` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_align` **(** :ref:`int` align **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autowrap` **(** :ref:`bool` enable **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip_text` **(** :ref:`bool` enable **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lines_skipped` **(** :ref:`int` lines_skipped **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_lines_visible` **(** :ref:`int` lines_visible **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_percent_visible` **(** :ref:`float` percent_visible **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uppercase` **(** :ref:`bool` enable **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_valign` **(** :ref:`int` valign **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_height` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_characters` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | ++------------------------+------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -129,12 +93,6 @@ Label displays plain text on the screen. It gives you control over the horizonta Member Function Description --------------------------- -.. _class_Label_get_align: - -- :ref:`int` **get_align** **(** **)** const - -Returns the alignment mode (any of the ALIGN\_\* enumeration values). - .. _class_Label_get_line_count: - :ref:`int` **get_line_count** **(** **)** const @@ -147,42 +105,12 @@ Returns the amount of lines of text the Label has. Returns the font size in pixels. -.. _class_Label_get_lines_skipped: - -- :ref:`int` **get_lines_skipped** **(** **)** const - -Returns the the number of lines to skip before displaying. - -.. _class_Label_get_max_lines_visible: - -- :ref:`int` **get_max_lines_visible** **(** **)** const - -Returns the maximum number of lines to display. Returns -1 if unrestricted. - -.. _class_Label_get_percent_visible: - -- :ref:`float` **get_percent_visible** **(** **)** const - -Returns the maximum number of characters to display as a percentage of the total text. - -.. _class_Label_get_text: - -- :ref:`String` **get_text** **(** **)** const - -Returns the label text. Text can contain newlines. - .. _class_Label_get_total_character_count: - :ref:`int` **get_total_character_count** **(** **)** const Returns the total length of the text. -.. _class_Label_get_valign: - -- :ref:`int` **get_valign** **(** **)** const - -Returns the vertical alignment mode (any of the VALIGN\_\* enumeration values). - .. _class_Label_get_visible_characters: - :ref:`int` **get_visible_characters** **(** **)** const @@ -195,78 +123,6 @@ Returns the restricted number of characters to display. Returns -1 if unrestrict Returns the number of lines shown. Useful if the ``Label`` 's height cannot currently display all lines. -.. _class_Label_has_autowrap: - -- :ref:`bool` **has_autowrap** **(** **)** const - -Returns ``true`` if *autowrap* mode (see :ref:`set_autowrap`). - -.. _class_Label_is_clipping_text: - -- :ref:`bool` **is_clipping_text** **(** **)** const - -Returns ``true`` if text would be cut off if it is too wide. - -.. _class_Label_is_uppercase: - -- :ref:`bool` **is_uppercase** **(** **)** const - -Returns ``true`` if text is displayed in all capitals. - -.. _class_Label_set_align: - -- void **set_align** **(** :ref:`int` align **)** - -Sets the alignment mode to any of the ALIGN\_\* enumeration values. - -.. _class_Label_set_autowrap: - -- void **set_autowrap** **(** :ref:`bool` enable **)** - -Set *autowrap* mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows. - -.. _class_Label_set_clip_text: - -- void **set_clip_text** **(** :ref:`bool` enable **)** - -Cuts off the rest of the text if it is too wide. - -.. _class_Label_set_lines_skipped: - -- void **set_lines_skipped** **(** :ref:`int` lines_skipped **)** - -Sets the number of lines to skip before displaying. Useful for scrolling text. - -.. _class_Label_set_max_lines_visible: - -- void **set_max_lines_visible** **(** :ref:`int` lines_visible **)** - -Restricts the number of lines to display. Set to -1 to disable. - -.. _class_Label_set_percent_visible: - -- void **set_percent_visible** **(** :ref:`float` percent_visible **)** - -Restricts the number of characters to display (as a percentage of the total text). - -.. _class_Label_set_text: - -- void **set_text** **(** :ref:`String` text **)** - -Set the label text. Text can contain newlines. - -.. _class_Label_set_uppercase: - -- void **set_uppercase** **(** :ref:`bool` enable **)** - -Display text in all capitals. - -.. _class_Label_set_valign: - -- void **set_valign** **(** :ref:`int` valign **)** - -Sets the vertical alignment mode to any of the VALIGN\_\* enumeration values. - .. _class_Label_set_visible_characters: - void **set_visible_characters** **(** :ref:`int` amount **)** diff --git a/classes/class_light.rst b/classes/class_light.rst index 38ee8425e..f365a268c 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -18,43 +18,6 @@ Brief Description Provides a base class for different kinds of light nodes. -Member Functions ----------------- - -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_shadow_reverse_cull_face` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_shadow` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_negative` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mask` **(** :ref:`int` cull_mask **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_negative` **(** :ref:`bool` enabled **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow` **(** :ref:`bool` enabled **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_reverse_cull_face` **(** :ref:`bool` enable **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -74,6 +37,10 @@ Member Variables - :ref:`float` **light_energy** + .. _class_Light_light_indirect_energy: + +- :ref:`float` **light_indirect_energy** + .. _class_Light_light_negative: - :ref:`bool` **light_negative** @@ -107,91 +74,24 @@ Numeric Constants ----------------- - **PARAM_ENERGY** = **0** -- **PARAM_SPECULAR** = **1** -- **PARAM_RANGE** = **2** -- **PARAM_ATTENUATION** = **3** -- **PARAM_SPOT_ANGLE** = **4** -- **PARAM_SPOT_ATTENUATION** = **5** -- **PARAM_CONTACT_SHADOW_SIZE** = **6** -- **PARAM_SHADOW_MAX_DISTANCE** = **7** -- **PARAM_SHADOW_SPLIT_1_OFFSET** = **8** -- **PARAM_SHADOW_SPLIT_2_OFFSET** = **9** -- **PARAM_SHADOW_SPLIT_3_OFFSET** = **10** -- **PARAM_SHADOW_NORMAL_BIAS** = **11** -- **PARAM_SHADOW_BIAS** = **12** -- **PARAM_SHADOW_BIAS_SPLIT_SCALE** = **13** -- **PARAM_MAX** = **14** +- **PARAM_INDIRECT_ENERGY** = **1** +- **PARAM_SPECULAR** = **2** +- **PARAM_RANGE** = **3** +- **PARAM_ATTENUATION** = **4** +- **PARAM_SPOT_ANGLE** = **5** +- **PARAM_SPOT_ATTENUATION** = **6** +- **PARAM_CONTACT_SHADOW_SIZE** = **7** +- **PARAM_SHADOW_MAX_DISTANCE** = **8** +- **PARAM_SHADOW_SPLIT_1_OFFSET** = **9** +- **PARAM_SHADOW_SPLIT_2_OFFSET** = **10** +- **PARAM_SHADOW_SPLIT_3_OFFSET** = **11** +- **PARAM_SHADOW_NORMAL_BIAS** = **12** +- **PARAM_SHADOW_BIAS** = **13** +- **PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14** +- **PARAM_MAX** = **15** Description ----------- Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting. -Member Function Description ---------------------------- - -.. _class_Light_get_color: - -- :ref:`Color` **get_color** **(** **)** const - -.. _class_Light_get_cull_mask: - -- :ref:`int` **get_cull_mask** **(** **)** const - -.. _class_Light_get_param: - -- :ref:`float` **get_param** **(** :ref:`int` param **)** const - -.. _class_Light_get_shadow_color: - -- :ref:`Color` **get_shadow_color** **(** **)** const - -.. _class_Light_get_shadow_reverse_cull_face: - -- :ref:`bool` **get_shadow_reverse_cull_face** **(** **)** const - -.. _class_Light_has_shadow: - -- :ref:`bool` **has_shadow** **(** **)** const - -.. _class_Light_is_editor_only: - -- :ref:`bool` **is_editor_only** **(** **)** const - -.. _class_Light_is_negative: - -- :ref:`bool` **is_negative** **(** **)** const - -.. _class_Light_set_color: - -- void **set_color** **(** :ref:`Color` color **)** - -.. _class_Light_set_cull_mask: - -- void **set_cull_mask** **(** :ref:`int` cull_mask **)** - -.. _class_Light_set_editor_only: - -- void **set_editor_only** **(** :ref:`bool` editor_only **)** - -.. _class_Light_set_negative: - -- void **set_negative** **(** :ref:`bool` enabled **)** - -.. _class_Light_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - -.. _class_Light_set_shadow: - -- void **set_shadow** **(** :ref:`bool` enabled **)** - -.. _class_Light_set_shadow_color: - -- void **set_shadow_color** **(** :ref:`Color` shadow_color **)** - -.. _class_Light_set_shadow_reverse_cull_face: - -- void **set_shadow_reverse_cull_face** **(** :ref:`bool` enable **)** - - diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index eccab66e2..a76124697 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -16,95 +16,6 @@ Brief Description Casts light in a 2D environment. -Member Functions ----------------- - -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_energy` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_cull_mask` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_shadow_cull_mask` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_range_max` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_range_min` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_buffer_size` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_filter` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shadow_gradient_length` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shadow_smooth` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_texture_scale` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z_range_max` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z_range_min` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shadow_enabled` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_energy` **(** :ref:`float` energy **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_cull_mask` **(** :ref:`int` item_cull_mask **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shadow_cull_mask` **(** :ref:`int` item_shadow_cull_mask **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_range_max` **(** :ref:`int` layer **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_range_min` **(** :ref:`int` layer **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_buffer_size` **(** :ref:`int` size **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_filter` **(** :ref:`int` filter **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_gradient_length` **(** :ref:`float` multiplier **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_smooth` **(** :ref:`float` smooth **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_scale` **(** :ref:`float` texture_scale **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_range_max` **(** :ref:`int` z **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_range_min` **(** :ref:`int` z **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -212,239 +123,3 @@ Description Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. -Member Function Description ---------------------------- - -.. _class_Light2D_get_color: - -- :ref:`Color` **get_color** **(** **)** const - -Return the color of the Light2D. - -.. _class_Light2D_get_energy: - -- :ref:`float` **get_energy** **(** **)** const - -Return the energy value of the Light2D. - -.. _class_Light2D_get_height: - -- :ref:`float` **get_height** **(** **)** const - -Return the height of the Light2D. Used with 2D normalmapping. - -.. _class_Light2D_get_item_cull_mask: - -- :ref:`int` **get_item_cull_mask** **(** **)** const - -.. _class_Light2D_get_item_shadow_cull_mask: - -- :ref:`int` **get_item_shadow_cull_mask** **(** **)** const - -.. _class_Light2D_get_layer_range_max: - -- :ref:`int` **get_layer_range_max** **(** **)** const - -Set the maximum layer value of objects of the scene that are affected by the Light2D. - -.. _class_Light2D_get_layer_range_min: - -- :ref:`int` **get_layer_range_min** **(** **)** const - -Get the minimum layer value of objects of the scene that are affected by the Light2D. - -.. _class_Light2D_get_mode: - -- :ref:`int` **get_mode** **(** **)** const - -Return the current mode set to the Light2D. - -.. _class_Light2D_get_shadow_buffer_size: - -- :ref:`int` **get_shadow_buffer_size** **(** **)** const - -Return the shadow buffer size. - -.. _class_Light2D_get_shadow_color: - -- :ref:`Color` **get_shadow_color** **(** **)** const - -Return the color of casted shadows for this Light2D. - -.. _class_Light2D_get_shadow_filter: - -- :ref:`int` **get_shadow_filter** **(** **)** const - -.. _class_Light2D_get_shadow_gradient_length: - -- :ref:`float` **get_shadow_gradient_length** **(** **)** const - -.. _class_Light2D_get_shadow_smooth: - -- :ref:`float` **get_shadow_smooth** **(** **)** const - -.. _class_Light2D_get_texture: - -- :ref:`Texture` **get_texture** **(** **)** const - -Return the texture of the Light2D. - -.. _class_Light2D_get_texture_offset: - -- :ref:`Vector2` **get_texture_offset** **(** **)** const - -Return the offset of the light texture. - -.. _class_Light2D_get_texture_scale: - -- :ref:`float` **get_texture_scale** **(** **)** const - -Return the scale value of the light texture. - -.. _class_Light2D_get_z_range_max: - -- :ref:`int` **get_z_range_max** **(** **)** const - -Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D. - -.. _class_Light2D_get_z_range_min: - -- :ref:`int` **get_z_range_min** **(** **)** const - -Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. - -.. _class_Light2D_is_editor_only: - -- :ref:`bool` **is_editor_only** **(** **)** const - -.. _class_Light2D_is_enabled: - -- :ref:`bool` **is_enabled** **(** **)** const - -Return true if the Light2D is enabled, false if it is not. - -.. _class_Light2D_is_shadow_enabled: - -- :ref:`bool` **is_shadow_enabled** **(** **)** const - -Return true if shadow casting is enabled for this Light2D, else return false. - -.. _class_Light2D_set_color: - -- void **set_color** **(** :ref:`Color` color **)** - -Set the color of the Light2D. - -.. _class_Light2D_set_editor_only: - -- void **set_editor_only** **(** :ref:`bool` editor_only **)** - -.. _class_Light2D_set_enabled: - -- void **set_enabled** **(** :ref:`bool` enabled **)** - -Switches the Light2D on or off, depending on the 'enabled' parameter. - -.. _class_Light2D_set_energy: - -- void **set_energy** **(** :ref:`float` energy **)** - -Set the energy value of the Light2D. The bigger the value, the stronger the light. - -.. _class_Light2D_set_height: - -- void **set_height** **(** :ref:`float` height **)** - -Set the height of the Light2D. Used with 2D normalmapping. - -.. _class_Light2D_set_item_cull_mask: - -- void **set_item_cull_mask** **(** :ref:`int` item_cull_mask **)** - -Set the item mask of the Light2D to 'item_mask' value. - -.. _class_Light2D_set_item_shadow_cull_mask: - -- void **set_item_shadow_cull_mask** **(** :ref:`int` item_shadow_cull_mask **)** - -Set the item shadow mask to 'item_shadow_mask' value. - -.. _class_Light2D_set_layer_range_max: - -- void **set_layer_range_max** **(** :ref:`int` layer **)** - -Set the maximum layer value of objects of the scene that are affected by the Light2D. - -.. _class_Light2D_set_layer_range_min: - -- void **set_layer_range_min** **(** :ref:`int` layer **)** - -Set the minimum layer value of objects of the scene that are affected by the Light2D. - -.. _class_Light2D_set_mode: - -- void **set_mode** **(** :ref:`int` mode **)** - -Set the behaviour mode of the Light2D. Use constants defined in the constants section. - -.. _class_Light2D_set_shadow_buffer_size: - -- void **set_shadow_buffer_size** **(** :ref:`int` size **)** - -Set the shadow buffer size. - -.. _class_Light2D_set_shadow_color: - -- void **set_shadow_color** **(** :ref:`Color` shadow_color **)** - -Set the color of casted shadows for this Light2D. - -.. _class_Light2D_set_shadow_enabled: - -- void **set_shadow_enabled** **(** :ref:`bool` enabled **)** - -Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. - -.. _class_Light2D_set_shadow_filter: - -- void **set_shadow_filter** **(** :ref:`int` filter **)** - -.. _class_Light2D_set_shadow_gradient_length: - -- void **set_shadow_gradient_length** **(** :ref:`float` multiplier **)** - -.. _class_Light2D_set_shadow_smooth: - -- void **set_shadow_smooth** **(** :ref:`float` smooth **)** - -.. _class_Light2D_set_texture: - -- void **set_texture** **(** :ref:`Texture` texture **)** - -Set the texture of the Light2D. - -.. _class_Light2D_set_texture_offset: - -- void **set_texture_offset** **(** :ref:`Vector2` texture_offset **)** - -Set the offset of the light texture. - -.. _class_Light2D_set_texture_scale: - -- void **set_texture_scale** **(** :ref:`float` texture_scale **)** - -Set the scale value of the light texture. - -.. _class_Light2D_set_z_range_max: - -- void **set_z_range_max** **(** :ref:`int` z **)** - -Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. - -.. _class_Light2D_set_z_range_min: - -- void **set_z_range_min** **(** :ref:`int` z **)** - -Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. - - diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index 6329ba43c..ffb2b7e3f 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -16,19 +16,6 @@ Brief Description Occludes light cast by a Light2D, casting shadows. -Member Functions ----------------- - -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`get_occluder_polygon` **(** **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_occluder_polygon` **(** :ref:`OccluderPolygon2D` polygon **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,31 +33,3 @@ Description Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an :ref:`OccluderPolygon2D` in order for the shadow to be computed. -Member Function Description ---------------------------- - -.. _class_LightOccluder2D_get_occluder_light_mask: - -- :ref:`int` **get_occluder_light_mask** **(** **)** const - -Return the light mask of the LightOccluder2D. - -.. _class_LightOccluder2D_get_occluder_polygon: - -- :ref:`OccluderPolygon2D` **get_occluder_polygon** **(** **)** const - -Return the OccluderPolygon2D that defines the LightOccluder2D. - -.. _class_LightOccluder2D_set_occluder_light_mask: - -- void **set_occluder_light_mask** **(** :ref:`int` mask **)** - -Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s). - -.. _class_LightOccluder2D_set_occluder_polygon: - -- void **set_occluder_polygon** **(** :ref:`OccluderPolygon2D` polygon **)** - -Set the OccluderPolygon2D that defines the LightOccluder2D. - - diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 75cbfac51..d1f9870e0 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -19,61 +19,17 @@ A 2D line. Member Functions ---------------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` position **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_begin_cap_mode` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_default_color` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_end_cap_mode` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joint_mode` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_round_precision` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sharp_limit` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_mode` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_width` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` i **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_begin_cap_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_color` **(** :ref:`Color` color **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end_cap_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gradient` **(** :ref:`Gradient` color **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_joint_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` i, :ref:`Vector2` position **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_round_precision` **(** :ref:`int` precision **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sharp_limit` **(** :ref:`float` limit **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_width` **(** :ref:`float` width **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` position **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` i **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` i, :ref:`Vector2` position **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -149,26 +105,6 @@ Member Function Description Add a point at the ``position``. Appends the point at the end of the line. -.. _class_Line2D_get_begin_cap_mode: - -- :ref:`int` **get_begin_cap_mode** **(** **)** const - -.. _class_Line2D_get_default_color: - -- :ref:`Color` **get_default_color** **(** **)** const - -.. _class_Line2D_get_end_cap_mode: - -- :ref:`int` **get_end_cap_mode** **(** **)** const - -.. _class_Line2D_get_gradient: - -- :ref:`Gradient` **get_gradient** **(** **)** const - -.. _class_Line2D_get_joint_mode: - -- :ref:`int` **get_joint_mode** **(** **)** const - .. _class_Line2D_get_point_count: - :ref:`int` **get_point_count** **(** **)** const @@ -179,31 +115,7 @@ Returns the Line2D's amount of points. - :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const -Returns point ``i[code]'s position. - -.. _class_Line2D_get_points: - -- :ref:`PoolVector2Array` **get_points** **(** **)** const - -.. _class_Line2D_get_round_precision: - -- :ref:`int` **get_round_precision** **(** **)** const - -.. _class_Line2D_get_sharp_limit: - -- :ref:`float` **get_sharp_limit** **(** **)** const - -.. _class_Line2D_get_texture: - -- :ref:`Texture` **get_texture** **(** **)** const - -.. _class_Line2D_get_texture_mode: - -- :ref:`int` **get_texture_mode** **(** **)** const - -.. _class_Line2D_get_width: - -- :ref:`float` **get_width** **(** **)** const +Returns point ``i``'s position. .. _class_Line2D_remove_point: @@ -211,54 +123,10 @@ Returns point ``i[code]'s position. Remove the point at index ``i`` from the line. -.. _class_Line2D_set_begin_cap_mode: - -- void **set_begin_cap_mode** **(** :ref:`int` mode **)** - -.. _class_Line2D_set_default_color: - -- void **set_default_color** **(** :ref:`Color` color **)** - -.. _class_Line2D_set_end_cap_mode: - -- void **set_end_cap_mode** **(** :ref:`int` mode **)** - -.. _class_Line2D_set_gradient: - -- void **set_gradient** **(** :ref:`Gradient` color **)** - -.. _class_Line2D_set_joint_mode: - -- void **set_joint_mode** **(** :ref:`int` mode **)** - .. _class_Line2D_set_point_position: - void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** Overwites the position in point ``i`` with the supplied ``position``. -.. _class_Line2D_set_points: - -- void **set_points** **(** :ref:`PoolVector2Array` points **)** - -.. _class_Line2D_set_round_precision: - -- void **set_round_precision** **(** :ref:`int` precision **)** - -.. _class_Line2D_set_sharp_limit: - -- void **set_sharp_limit** **(** :ref:`float` limit **)** - -.. _class_Line2D_set_texture: - -- void **set_texture** **(** :ref:`Texture` texture **)** - -.. _class_Line2D_set_texture_mode: - -- void **set_texture_mode** **(** :ref:`int` mode **)** - -.. _class_Line2D_set_width: - -- void **set_width** **(** :ref:`float` width **)** - diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 8fe82c2ca..64a0cb390 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -19,67 +19,23 @@ Control that provides single line string editing. Member Functions ---------------- -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_at_cursor` **(** :ref:`String` text **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enabled **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_align` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cursor_position` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand_to_text_length` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_length` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_placeholder` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_placeholder_alpha` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_context_menu_enabled` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_secret` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`menu_option` **(** :ref:`int` option **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from=0, :ref:`int` to=-1 **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_all` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_align` **(** :ref:`int` align **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_context_menu_enabled` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cursor_position` **(** :ref:`int` position **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`bool` enabled **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_to_text_length` **(** :ref:`bool` enabled **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_length` **(** :ref:`int` chars **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_placeholder` **(** :ref:`String` text **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_placeholder_alpha` **(** :ref:`float` alpha **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_secret` **(** :ref:`bool` enabled **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_at_cursor` **(** :ref:`String` text **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cursor_position` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`menu_option` **(** :ref:`int` option **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` from=0, :ref:`int` to=-1 **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_all` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cursor_position` **(** :ref:`int` position **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -120,9 +76,9 @@ Member Variables - :ref:`bool` **editable** - If ``false`` existing text cannot be modified and new text cannot be added. - .. _class_LineEdit_expand_to_len: + .. _class_LineEdit_expand_to_text_length: -- :ref:`bool` **expand_to_len** - If ``true`` the :ref:`LineEdit` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. +- :ref:`bool` **expand_to_text_length** - If ``true`` the :ref:`LineEdit` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. .. _class_LineEdit_focus_mode: @@ -185,94 +141,18 @@ Adds ``text`` after the cursor. If the resulting value is longer than :ref:`max_ Erases the :ref:`LineEdit` text. -.. _class_LineEdit_cursor_get_blink_enabled: - -- :ref:`bool` **cursor_get_blink_enabled** **(** **)** const - -Gets whether the line edit caret is blinking. - -.. _class_LineEdit_cursor_get_blink_speed: - -- :ref:`float` **cursor_get_blink_speed** **(** **)** const - -Gets the line edit caret blink speed. - -.. _class_LineEdit_cursor_set_blink_enabled: - -- void **cursor_set_blink_enabled** **(** :ref:`bool` enabled **)** - -Set the line edit caret to blink. - -.. _class_LineEdit_cursor_set_blink_speed: - -- void **cursor_set_blink_speed** **(** :ref:`float` blink_speed **)** - -Set the line edit caret blink speed. Cannot be less then or equal to 0. - -.. _class_LineEdit_get_align: - -- :ref:`int` **get_align** **(** **)** const - -Return the align mode of the ``LineEdit``. - .. _class_LineEdit_get_cursor_position: - :ref:`int` **get_cursor_position** **(** **)** const Returns the cursor position inside the ``LineEdit``. -.. _class_LineEdit_get_expand_to_text_length: - -- :ref:`bool` **get_expand_to_text_length** **(** **)** const - -.. _class_LineEdit_get_max_length: - -- :ref:`int` **get_max_length** **(** **)** const - -Return the maximum amount of characters the ``LineEdit`` can edit. If 0 is returned, no limit exists. - .. _class_LineEdit_get_menu: - :ref:`PopupMenu` **get_menu** **(** **)** const Returns the :ref:`PopupMenu` of this ``LineEdit``. By default, this menu is displayed when right-clicking on the :ref:`LineEdit`. -.. _class_LineEdit_get_placeholder: - -- :ref:`String` **get_placeholder** **(** **)** const - -Return the placeholder text. - -.. _class_LineEdit_get_placeholder_alpha: - -- :ref:`float` **get_placeholder_alpha** **(** **)** const - -Return transparency of the placeholder text. - -.. _class_LineEdit_get_text: - -- :ref:`String` **get_text** **(** **)** const - -Return the text in the ``LineEdit``. - -.. _class_LineEdit_is_context_menu_enabled: - -- :ref:`bool` **is_context_menu_enabled** **(** **)** - -Returns true if the context menu is enabled. - -.. _class_LineEdit_is_editable: - -- :ref:`bool` **is_editable** **(** **)** const - -Return the *editable* status of the ``LineEdit`` (see :ref:`set_editable`). - -.. _class_LineEdit_is_secret: - -- :ref:`bool` **is_secret** **(** **)** const - -Return the *secret* status of the ``LineEdit`` (see :ref:`set_secret`). - .. _class_LineEdit_menu_option: - void **menu_option** **(** :ref:`int` option **)** @@ -298,62 +178,10 @@ Selects characters inside :ref:`LineEdit` between ``from`` and ` Selects the whole :ref:`String`. -.. _class_LineEdit_set_align: - -- void **set_align** **(** :ref:`int` align **)** - -Set text alignment of the ``LineEdit``. - -.. _class_LineEdit_set_context_menu_enabled: - -- void **set_context_menu_enabled** **(** :ref:`bool` enable **)** - -Set the status of the context menu. When enabled, the context menu will appear when the ``LineEdit`` is right clicked. - .. _class_LineEdit_set_cursor_position: - void **set_cursor_position** **(** :ref:`int` position **)** Sets the cursor position inside the ``LineEdit``. The text may scroll if needed. -.. _class_LineEdit_set_editable: - -- void **set_editable** **(** :ref:`bool` enabled **)** - -Set the *editable* status of the ``LineEdit``. When disabled, existing text can't be modified and new text can't be added. - -.. _class_LineEdit_set_expand_to_text_length: - -- void **set_expand_to_text_length** **(** :ref:`bool` enabled **)** - -.. _class_LineEdit_set_max_length: - -- void **set_max_length** **(** :ref:`int` chars **)** - -Set the maximum amount of characters the ``LineEdit`` can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. - -.. _class_LineEdit_set_placeholder: - -- void **set_placeholder** **(** :ref:`String` text **)** - -Set the placeholder text. - -.. _class_LineEdit_set_placeholder_alpha: - -- void **set_placeholder_alpha** **(** :ref:`float` alpha **)** - -Set transparency of the placeholder text. - -.. _class_LineEdit_set_secret: - -- void **set_secret** **(** :ref:`bool` enabled **)** - -Set the *secret* status of the ``LineEdit``. When enabled, every character is displayed as "\*". - -.. _class_LineEdit_set_text: - -- void **set_text** **(** :ref:`String` text **)** - -Set the text in the ``LineEdit``, clearing the existing one and the selection. - diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 15cfe70b4..4a4f54d44 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -16,19 +16,6 @@ Brief Description Line shape for 2D collisions. -Member Functions ----------------- - -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_d` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_normal` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_d` **(** :ref:`float` d **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal` **(** :ref:`Vector2` normal **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,31 +33,3 @@ Description Line shape for 2D collisions. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. -Member Function Description ---------------------------- - -.. _class_LineShape2D_get_d: - -- :ref:`float` **get_d** **(** **)** const - -Return the line distance from the origin. - -.. _class_LineShape2D_get_normal: - -- :ref:`Vector2` **get_normal** **(** **)** const - -Return the line normal. - -.. _class_LineShape2D_set_d: - -- void **set_d** **(** :ref:`float` d **)** - -Set the line distance from the origin. - -.. _class_LineShape2D_set_normal: - -- void **set_normal** **(** :ref:`Vector2` normal **)** - -Set the line normal. - - diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 0d56d9471..de965bd1e 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -16,19 +16,6 @@ Brief Description Simple button used to represent a link to some resource -Member Functions ----------------- - -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_underline_mode` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_underline_mode` **(** :ref:`int` underline_mode **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -53,31 +40,3 @@ Description This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page). -Member Function Description ---------------------------- - -.. _class_LinkButton_get_text: - -- :ref:`String` **get_text** **(** **)** const - -Returns the text of the button. - -.. _class_LinkButton_get_underline_mode: - -- :ref:`int` **get_underline_mode** **(** **)** const - -Returns the underline mode for this button. - -.. _class_LinkButton_set_text: - -- void **set_text** **(** :ref:`String` text **)** - -Sets the text of the button. - -.. _class_LinkButton_set_underline_mode: - -- void **set_underline_mode** **(** :ref:`int` underline_mode **)** - -Sets the underline mode for this button, the argument must be one of the ``LinkButton`` constants (see constants section). - - diff --git a/classes/class_material.rst b/classes/class_material.rst index 4879172d8..350fb495f 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -18,19 +18,6 @@ Brief Description Abstract base :ref:`Resource` for coloring and shading geometry. -Member Functions ----------------- - -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_next_pass` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_priority` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_next_pass` **(** :ref:`Material` next_pass **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_priority` **(** :ref:`int` priority **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,23 +41,3 @@ Description Material is a base :ref:`Resource` used for coloring and shading geometry. All materials inherit from it and almost all :ref:`VisualInstance` derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. -Member Function Description ---------------------------- - -.. _class_Material_get_next_pass: - -- :ref:`Material` **get_next_pass** **(** **)** const - -.. _class_Material_get_render_priority: - -- :ref:`int` **get_render_priority** **(** **)** const - -.. _class_Material_set_next_pass: - -- void **set_next_pass** **(** :ref:`Material` next_pass **)** - -.. _class_Material_set_render_priority: - -- void **set_render_priority** **(** :ref:`int` priority **)** - - diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 5e5b6727a..7b3598e5b 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -26,16 +26,8 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_trimesh_collision` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_skeleton_path` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mesh` **(** :ref:`Mesh` mesh **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_skeleton_path` **(** :ref:`NodePath` skeleton_path **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -75,30 +67,12 @@ This helper creates a :ref:`StaticBody` child :ref:`Node` child :ref:`Node` with a :ref:`ConcavePolygonShape` :ref:`CollisionShape` calculated from the mesh geometry. It's mainly used for testing. -.. _class_MeshInstance_get_mesh: - -- :ref:`Mesh` **get_mesh** **(** **)** const - -Returns the current :ref:`Mesh` resource for the instance. - -.. _class_MeshInstance_get_skeleton_path: - -- :ref:`NodePath` **get_skeleton_path** **(** **)** - .. _class_MeshInstance_get_surface_material: - :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. -.. _class_MeshInstance_set_mesh: - -- void **set_mesh** **(** :ref:`Mesh` mesh **)** - -.. _class_MeshInstance_set_skeleton_path: - -- void **set_skeleton_path** **(** :ref:`NodePath` skeleton_path **)** - .. _class_MeshInstance_set_surface_material: - void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index 1f9b7f043..8dd04977b 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -16,35 +16,6 @@ Brief Description Generic mobile VR implementation -Member Functions ----------------- - -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_display_to_lens` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_display_width` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_iod` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_k1` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_k2` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_oversample` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_to_lens` **(** :ref:`float` display_to_lens **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_width` **(** :ref:`float` display_width **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_iod` **(** :ref:`float` iod **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_k1` **(** :ref:`float` k **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_k2` **(** :ref:`float` k **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_oversample` **(** :ref:`float` oversample **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -80,79 +51,3 @@ This is a generic mobile VR implementation where you need to provide details abo Note that even though there is no positional tracking the camera will assume the headset is at a height of 1.85 meters. -Member Function Description ---------------------------- - -.. _class_MobileVRInterface_get_display_to_lens: - -- :ref:`float` **get_display_to_lens** **(** **)** const - -Returns the distance between the display and the lens. - -.. _class_MobileVRInterface_get_display_width: - -- :ref:`float` **get_display_width** **(** **)** const - -Return the width of the LCD screen of the device. - -.. _class_MobileVRInterface_get_iod: - -- :ref:`float` **get_iod** **(** **)** const - -Returns the interocular distance. - -.. _class_MobileVRInterface_get_k1: - -- :ref:`float` **get_k1** **(** **)** const - -Returns the k1 lens constant. - -.. _class_MobileVRInterface_get_k2: - -- :ref:`float` **get_k2** **(** **)** const - -Retuns the k2 lens constant - -.. _class_MobileVRInterface_get_oversample: - -- :ref:`float` **get_oversample** **(** **)** const - -Returns the oversampling setting. - -.. _class_MobileVRInterface_set_display_to_lens: - -- void **set_display_to_lens** **(** :ref:`float` display_to_lens **)** - -Sets the distance between display and the lens. - -.. _class_MobileVRInterface_set_display_width: - -- void **set_display_width** **(** :ref:`float` display_width **)** - -Sets the width of the LCD screen of the device. - -.. _class_MobileVRInterface_set_iod: - -- void **set_iod** **(** :ref:`float` iod **)** - -Sets the interocular distance. - -.. _class_MobileVRInterface_set_k1: - -- void **set_k1** **(** :ref:`float` k **)** - -Sets the k1 lens constant. - -.. _class_MobileVRInterface_set_k2: - -- void **set_k2** **(** :ref:`float` k **)** - -Sets the k2 lens constant. - -.. _class_MobileVRInterface_set_oversample: - -- void **set_oversample** **(** :ref:`float` oversample **)** - -Sets the oversampling setting. - - diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 3a0406d56..45153cd55 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -20,32 +20,16 @@ Member Functions ---------------- +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_color_format` **(** **)** const | +| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_instance_color` **(** :ref:`int` instance **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_count` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`get_instance_transform` **(** :ref:`int` instance **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_transform_format` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_format` **(** :ref:`int` format **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_count` **(** :ref:`int` count **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_instance_transform` **(** :ref:`int` instance, :ref:`Transform` transform **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mesh` **(** :ref:`Mesh` mesh **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform_format` **(** :ref:`int` format **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -93,20 +77,16 @@ For this case a MultiMesh becomes very useful, as it can draw thousands of insta As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). -Since instances may have any behavior, the Rect3 used for visibility must be provided by the user. +Since instances may have any behavior, the AABB used for visibility must be provided by the user. Member Function Description --------------------------- .. _class_MultiMesh_get_aabb: -- :ref:`Rect3` **get_aabb** **(** **)** const +- :ref:`AABB` **get_aabb** **(** **)** const -Return the visibility Rect3. - -.. _class_MultiMesh_get_color_format: - -- :ref:`int` **get_color_format** **(** **)** const +Return the visibility AABB. .. _class_MultiMesh_get_instance_color: @@ -114,58 +94,22 @@ Return the visibility Rect3. Get the color of a specific instance. -.. _class_MultiMesh_get_instance_count: - -- :ref:`int` **get_instance_count** **(** **)** const - -Return the amount of instances that is going to be drawn. - .. _class_MultiMesh_get_instance_transform: - :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const Return the transform of a specific instance. -.. _class_MultiMesh_get_mesh: - -- :ref:`Mesh` **get_mesh** **(** **)** const - -Return the :ref:`Mesh` resource drawn as multiple instances. - -.. _class_MultiMesh_get_transform_format: - -- :ref:`int` **get_transform_format** **(** **)** const - -.. _class_MultiMesh_set_color_format: - -- void **set_color_format** **(** :ref:`int` format **)** - .. _class_MultiMesh_set_instance_color: - void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** Set the color of a specific instance. -.. _class_MultiMesh_set_instance_count: - -- void **set_instance_count** **(** :ref:`int` count **)** - -Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. - .. _class_MultiMesh_set_instance_transform: - void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform` transform **)** Set the transform for a specific instance. -.. _class_MultiMesh_set_mesh: - -- void **set_mesh** **(** :ref:`Mesh` mesh **)** - -Set the :ref:`Mesh` resource to be drawn in multiple instances. - -.. _class_MultiMesh_set_transform_format: - -- void **set_transform_format** **(** :ref:`int` format **)** - diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index f56b6d34a..030d90b0a 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -16,15 +16,6 @@ Brief Description Node that instances a :ref:`MultiMesh`. -Member Functions ----------------- - -+------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`MultiMesh` | :ref:`get_multimesh` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_multimesh` **(** :ref:`MultiMesh` multimesh **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description MultiMeshInstance is a :ref:`Node` that takes a :ref:`MultiMesh` resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances). -Member Function Description ---------------------------- - -.. _class_MultiMeshInstance_get_multimesh: - -- :ref:`MultiMesh` **get_multimesh** **(** **)** const - -Return the :ref:`MultiMesh` that is used for instancing. - -.. _class_MultiMeshInstance_set_multimesh: - -- void **set_multimesh** **(** :ref:`MultiMesh` multimesh **)** - -Set the :ref:`MultiMesh` to be instanced. - - diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index 391b16869..9d53160a5 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -19,17 +19,9 @@ Brief Description Member Functions ---------------- -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class_name` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDNativeLibrary` | :ref:`get_library` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_class_name` **(** :ref:`String` class_name **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_library` **(** :ref:`GDNativeLibrary` library **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++------------------------------+-------------------------------------------------------+ Member Variables ---------------- @@ -46,24 +38,8 @@ Member Variables Member Function Description --------------------------- -.. _class_NativeScript_get_class_name: - -- :ref:`String` **get_class_name** **(** **)** const - -.. _class_NativeScript_get_library: - -- :ref:`GDNativeLibrary` **get_library** **(** **)** const - .. _class_NativeScript_new: - :ref:`Object` **new** **(** **)** vararg -.. _class_NativeScript_set_class_name: - -- void **set_class_name** **(** :ref:`String` class_name **)** - -.. _class_NativeScript_set_library: - -- void **set_library** **(** :ref:`GDNativeLibrary` library **)** - diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index c8eca133b..f197f6e30 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -30,16 +30,12 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_up_vector` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`navmesh_create` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_up_vector` **(** :ref:`Vector3` up **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -72,10 +68,6 @@ Member Function Description - :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** -.. _class_Navigation_get_up_vector: - -- :ref:`Vector3` **get_up_vector** **(** **)** const - .. _class_Navigation_navmesh_create: - :ref:`int` **navmesh_create** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** @@ -88,8 +80,4 @@ Member Function Description - void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** -.. _class_Navigation_set_up_vector: - -- void **set_up_vector** **(** :ref:`Vector3` up **)** - diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 124e8a1b2..36a783e54 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -19,89 +19,17 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_agent_height` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_agent_max_climb` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_agent_max_slope` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_agent_radius` **(** **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cell_height` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cell_size` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_detail_sample_distance` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_detail_sample_max_error` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_edge_max_error` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_edge_max_length` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_filter_ledge_spans` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_filter_low_hanging_obstacles` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_filter_walkable_low_height_spans` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_region_merge_size` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_region_min_size` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_sample_partition_type` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_verts_per_poly` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_agent_height` **(** :ref:`float` agent_height **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_agent_max_climb` **(** :ref:`float` agent_max_climb **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_agent_max_slope` **(** :ref:`float` agent_max_slope **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_agent_radius` **(** :ref:`float` agent_radius **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_height` **(** :ref:`float` cell_height **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`float` cell_size **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_detail_sample_distance` **(** :ref:`float` detail_sample_dist **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_detail_sample_max_error` **(** :ref:`float` detail_sample_max_error **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edge_max_error` **(** :ref:`float` edge_max_error **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edge_max_length` **(** :ref:`float` edge_max_length **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_ledge_spans` **(** :ref:`bool` filter_ledge_spans **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_low_hanging_obstacles` **(** :ref:`bool` filter_low_hanging_obstacles **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_walkable_low_height_spans` **(** :ref:`bool` filter_walkable_low_height_spans **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_merge_size` **(** :ref:`float` region_merge_size **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_min_size` **(** :ref:`float` region_min_size **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sample_partition_type` **(** :ref:`int` sample_partition_type **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_verts_per_poly` **(** :ref:`float` verts_per_poly **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -205,58 +133,6 @@ Member Function Description - void **create_from_mesh** **(** :ref:`Mesh` mesh **)** -.. _class_NavigationMesh_get_agent_height: - -- :ref:`float` **get_agent_height** **(** **)** const - -.. _class_NavigationMesh_get_agent_max_climb: - -- :ref:`float` **get_agent_max_climb** **(** **)** const - -.. _class_NavigationMesh_get_agent_max_slope: - -- :ref:`float` **get_agent_max_slope** **(** **)** const - -.. _class_NavigationMesh_get_agent_radius: - -- :ref:`float` **get_agent_radius** **(** **)** - -.. _class_NavigationMesh_get_cell_height: - -- :ref:`float` **get_cell_height** **(** **)** const - -.. _class_NavigationMesh_get_cell_size: - -- :ref:`float` **get_cell_size** **(** **)** const - -.. _class_NavigationMesh_get_detail_sample_distance: - -- :ref:`float` **get_detail_sample_distance** **(** **)** const - -.. _class_NavigationMesh_get_detail_sample_max_error: - -- :ref:`float` **get_detail_sample_max_error** **(** **)** const - -.. _class_NavigationMesh_get_edge_max_error: - -- :ref:`float` **get_edge_max_error** **(** **)** const - -.. _class_NavigationMesh_get_edge_max_length: - -- :ref:`float` **get_edge_max_length** **(** **)** const - -.. _class_NavigationMesh_get_filter_ledge_spans: - -- :ref:`bool` **get_filter_ledge_spans** **(** **)** const - -.. _class_NavigationMesh_get_filter_low_hanging_obstacles: - -- :ref:`bool` **get_filter_low_hanging_obstacles** **(** **)** const - -.. _class_NavigationMesh_get_filter_walkable_low_height_spans: - -- :ref:`bool` **get_filter_walkable_low_height_spans** **(** **)** const - .. _class_NavigationMesh_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** @@ -265,96 +141,4 @@ Member Function Description - :ref:`int` **get_polygon_count** **(** **)** const -.. _class_NavigationMesh_get_region_merge_size: - -- :ref:`float` **get_region_merge_size** **(** **)** const - -.. _class_NavigationMesh_get_region_min_size: - -- :ref:`float` **get_region_min_size** **(** **)** const - -.. _class_NavigationMesh_get_sample_partition_type: - -- :ref:`int` **get_sample_partition_type** **(** **)** const - -.. _class_NavigationMesh_get_vertices: - -- :ref:`PoolVector3Array` **get_vertices** **(** **)** const - -.. _class_NavigationMesh_get_verts_per_poly: - -- :ref:`float` **get_verts_per_poly** **(** **)** const - -.. _class_NavigationMesh_set_agent_height: - -- void **set_agent_height** **(** :ref:`float` agent_height **)** - -.. _class_NavigationMesh_set_agent_max_climb: - -- void **set_agent_max_climb** **(** :ref:`float` agent_max_climb **)** - -.. _class_NavigationMesh_set_agent_max_slope: - -- void **set_agent_max_slope** **(** :ref:`float` agent_max_slope **)** - -.. _class_NavigationMesh_set_agent_radius: - -- void **set_agent_radius** **(** :ref:`float` agent_radius **)** - -.. _class_NavigationMesh_set_cell_height: - -- void **set_cell_height** **(** :ref:`float` cell_height **)** - -.. _class_NavigationMesh_set_cell_size: - -- void **set_cell_size** **(** :ref:`float` cell_size **)** - -.. _class_NavigationMesh_set_detail_sample_distance: - -- void **set_detail_sample_distance** **(** :ref:`float` detail_sample_dist **)** - -.. _class_NavigationMesh_set_detail_sample_max_error: - -- void **set_detail_sample_max_error** **(** :ref:`float` detail_sample_max_error **)** - -.. _class_NavigationMesh_set_edge_max_error: - -- void **set_edge_max_error** **(** :ref:`float` edge_max_error **)** - -.. _class_NavigationMesh_set_edge_max_length: - -- void **set_edge_max_length** **(** :ref:`float` edge_max_length **)** - -.. _class_NavigationMesh_set_filter_ledge_spans: - -- void **set_filter_ledge_spans** **(** :ref:`bool` filter_ledge_spans **)** - -.. _class_NavigationMesh_set_filter_low_hanging_obstacles: - -- void **set_filter_low_hanging_obstacles** **(** :ref:`bool` filter_low_hanging_obstacles **)** - -.. _class_NavigationMesh_set_filter_walkable_low_height_spans: - -- void **set_filter_walkable_low_height_spans** **(** :ref:`bool` filter_walkable_low_height_spans **)** - -.. _class_NavigationMesh_set_region_merge_size: - -- void **set_region_merge_size** **(** :ref:`float` region_merge_size **)** - -.. _class_NavigationMesh_set_region_min_size: - -- void **set_region_min_size** **(** :ref:`float` region_min_size **)** - -.. _class_NavigationMesh_set_sample_partition_type: - -- void **set_sample_partition_type** **(** :ref:`int` sample_partition_type **)** - -.. _class_NavigationMesh_set_vertices: - -- void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** - -.. _class_NavigationMesh_set_verts_per_poly: - -- void **set_verts_per_poly** **(** :ref:`float` verts_per_poly **)** - diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index 408d05ada..cc4b5347e 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -16,19 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationMesh` | :ref:`get_navigation_mesh` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_navigation_mesh` **(** :ref:`NavigationMesh` navmesh **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -41,23 +28,3 @@ Member Variables - :ref:`NavigationMesh` **navmesh** -Member Function Description ---------------------------- - -.. _class_NavigationMeshInstance_get_navigation_mesh: - -- :ref:`NavigationMesh` **get_navigation_mesh** **(** **)** const - -.. _class_NavigationMeshInstance_is_enabled: - -- :ref:`bool` **is_enabled** **(** **)** const - -.. _class_NavigationMeshInstance_set_enabled: - -- void **set_enabled** **(** :ref:`bool` enabled **)** - -.. _class_NavigationMeshInstance_set_navigation_mesh: - -- void **set_navigation_mesh** **(** :ref:`NavigationMesh` navmesh **)** - - diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index bb01552b8..b8f0ccd73 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -38,16 +38,12 @@ Member Functions +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_polygon_count` **(** **)** const | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_polygons_from_outlines` **(** **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_outline` **(** :ref:`int` idx **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -104,10 +100,6 @@ Member Function Description - :ref:`int` **get_polygon_count** **(** **)** const -.. _class_NavigationPolygon_get_vertices: - -- :ref:`PoolVector2Array` **get_vertices** **(** **)** const - .. _class_NavigationPolygon_make_polygons_from_outlines: - void **make_polygons_from_outlines** **(** **)** @@ -120,8 +112,4 @@ Member Function Description - void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** -.. _class_NavigationPolygon_set_vertices: - -- void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** - diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index 27a0fd9d7..37a15dc31 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -16,19 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`get_navigation_polygon` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_navigation_polygon` **(** :ref:`NavigationPolygon` navpoly **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -41,23 +28,3 @@ Member Variables - :ref:`NavigationPolygon` **navpoly** -Member Function Description ---------------------------- - -.. _class_NavigationPolygonInstance_get_navigation_polygon: - -- :ref:`NavigationPolygon` **get_navigation_polygon** **(** **)** const - -.. _class_NavigationPolygonInstance_is_enabled: - -- :ref:`bool` **is_enabled** **(** **)** const - -.. _class_NavigationPolygonInstance_set_enabled: - -- void **set_enabled** **(** :ref:`bool` enabled **)** - -.. _class_NavigationPolygonInstance_set_navigation_polygon: - -- void **set_navigation_polygon** **(** :ref:`NavigationPolygon` navpoly **)** - - diff --git a/classes/class_nil.rst b/classes/class_nil.rst index a5fd3080d..5dc12db1f 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -48,7 +48,7 @@ Member Functions +-------+--------------------------------------------------------------------------------------------+ | void | :ref:`Nil` **(** :ref:`Basis` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Rect3` from **)** | +| void | :ref:`Nil` **(** :ref:`AABB` from **)** | +-------+--------------------------------------------------------------------------------------------+ | void | :ref:`Nil` **(** :ref:`Quat` from **)** | +-------+--------------------------------------------------------------------------------------------+ @@ -136,7 +136,7 @@ Member Function Description .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Rect3` from **)** +- void **Nil** **(** :ref:`AABB` from **)** .. _class_Nil_Nil: diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index d09b1590c..f13d772fd 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -16,35 +16,6 @@ Brief Description Scalable texture-based frame that tiles the texture's centers and sides, but keeps the corners' original size. Perfect for panels and dialog boxes. -Member Functions ----------------- - -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_patch_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_patch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - Signals ------- @@ -107,55 +78,3 @@ Description Better known as 9-slice panels, NinePatchRect produces clean panels of any size, based on a small texture. To do so, it splits the texture in a 3 by 3 grid. When you scale the node, it tiles the texture's sides horizontally or vertically, the center on both axes but it doesn't scale or tile the corners. -Member Function Description ---------------------------- - -.. _class_NinePatchRect_get_h_axis_stretch_mode: - -- :ref:`int` **get_h_axis_stretch_mode** **(** **)** const - -.. _class_NinePatchRect_get_patch_margin: - -- :ref:`int` **get_patch_margin** **(** :ref:`int` margin **)** const - -.. _class_NinePatchRect_get_region_rect: - -- :ref:`Rect2` **get_region_rect** **(** **)** const - -.. _class_NinePatchRect_get_texture: - -- :ref:`Texture` **get_texture** **(** **)** const - -.. _class_NinePatchRect_get_v_axis_stretch_mode: - -- :ref:`int` **get_v_axis_stretch_mode** **(** **)** const - -.. _class_NinePatchRect_is_draw_center_enabled: - -- :ref:`bool` **is_draw_center_enabled** **(** **)** const - -.. _class_NinePatchRect_set_draw_center: - -- void **set_draw_center** **(** :ref:`bool` draw_center **)** - -.. _class_NinePatchRect_set_h_axis_stretch_mode: - -- void **set_h_axis_stretch_mode** **(** :ref:`int` mode **)** - -.. _class_NinePatchRect_set_patch_margin: - -- void **set_patch_margin** **(** :ref:`int` margin, :ref:`int` value **)** - -.. _class_NinePatchRect_set_region_rect: - -- void **set_region_rect** **(** :ref:`Rect2` rect **)** - -.. _class_NinePatchRect_set_texture: - -- void **set_texture** **(** :ref:`Texture` texture **)** - -.. _class_NinePatchRect_set_v_axis_stretch_mode: - -- void **set_v_axis_stretch_mode** **(** :ref:`int` mode **)** - - diff --git a/classes/class_node.rst b/classes/class_node.rst index 44b8b6d4c..8145cc684 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -78,8 +78,6 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | @@ -98,8 +96,6 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | @@ -166,8 +162,6 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_filename` **(** :ref:`String` filename **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_name` **(** :ref:`String` name **)** | @@ -176,8 +170,6 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_owner` **(** :ref:`Node` owner **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_physics_process` **(** :ref:`bool` enable **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_physics_process_internal` **(** :ref:`bool` enable **)** | @@ -494,12 +486,6 @@ Return the absolute path of the current node. This only works if the current nod Return the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or else the function will fail. -.. _class_Node_get_pause_mode: - -- :ref:`int` **get_pause_mode** **(** **)** const - -Return the pause mode (PAUSE_MODE\_\*) of this Node. - .. _class_Node_get_physics_process_delta_time: - :ref:`float` **get_physics_process_delta_time** **(** **)** const @@ -548,10 +534,6 @@ Return whether the node that a given :ref:`NodePath` points too Return *true* if the "node" argument is a direct or indirect child of the current node, otherwise return *false*. -.. _class_Node_is_displayed_folded: - -- :ref:`bool` **is_displayed_folded** **(** **)** const - .. _class_Node_is_greater_than: - :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** const @@ -740,10 +722,6 @@ Remotely change property's value on other peers (and locally) using an unreliabl Remotely change property's value on a specific peer identified by *peer_id* using an unreliable protocol. -.. _class_Node_set_display_folded: - -- void **set_display_folded** **(** :ref:`bool` fold **)** - .. _class_Node_set_filename: - void **set_filename** **(** :ref:`String` filename **)** @@ -766,12 +744,6 @@ Set the name of the ``Node``. Name must be unique within parent, and setting an Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing. -.. _class_Node_set_pause_mode: - -- void **set_pause_mode** **(** :ref:`int` mode **)** - -Set pause mode (PAUSE_MODE\_\*) of this Node. - .. _class_Node_set_physics_process: - void **set_physics_process** **(** :ref:`bool` enable **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index e1ce28939..3502c54b2 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -9,7 +9,7 @@ Node2D **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`RayCast2D`, :ref:`Light2D`, :ref:`Path2D`, :ref:`Line2D`, :ref:`Position2D`, :ref:`AudioStreamPlayer2D`, :ref:`CanvasModulate`, :ref:`Sprite`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`ParallaxLayer`, :ref:`Polygon2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`YSort`, :ref:`TileMap`, :ref:`Camera2D` +**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`RayCast2D`, :ref:`Light2D`, :ref:`Path2D`, :ref:`Line2D`, :ref:`AudioStreamPlayer2D`, :ref:`CanvasModulate`, :ref:`Sprite`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`ParallaxLayer`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`YSort`, :ref:`TileMap`, :ref:`Camera2D` **Category:** Core @@ -24,34 +24,12 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_scale` **(** :ref:`Vector2` ratio **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_pivot` **(** :ref:`Vector2` pivot **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_global_rotation` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_global_rotation_degrees` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_scale` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation_degrees` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_z_relative` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`look_at` **(** :ref:`Vector2` point **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | @@ -60,30 +38,6 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rotate` **(** :ref:`float` radians **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` position **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_rotation` **(** :ref:`float` radians **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_rotation_degrees` **(** :ref:`float` degrees **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_transform` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_degrees` **(** :ref:`float` degrees **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z` **(** :ref:`int` z **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_as_relative` **(** :ref:`bool` enable **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** const | @@ -157,90 +111,24 @@ Member Function Description Multiplies the current scale by the 'ratio' vector. -.. _class_Node2D_edit_set_pivot: - -- void **edit_set_pivot** **(** :ref:`Vector2` pivot **)** - -Sets the node's pivot position. - .. _class_Node2D_get_angle_to: - :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const Returns the angle between the node and the 'point' in radians. -.. _class_Node2D_get_global_position: - -- :ref:`Vector2` **get_global_position** **(** **)** const - -Returns the node's global position. - -.. _class_Node2D_get_global_rotation: - -- :ref:`float` **get_global_rotation** **(** **)** const - -Returns the node's global rotation in radians. - -.. _class_Node2D_get_global_rotation_degrees: - -- :ref:`float` **get_global_rotation_degrees** **(** **)** const - -Return the node's global rotation in degrees. - -.. _class_Node2D_get_global_scale: - -- :ref:`Vector2` **get_global_scale** **(** **)** const - -Returns the node's global scale. - -.. _class_Node2D_get_position: - -- :ref:`Vector2` **get_position** **(** **)** const - -Returns the node's position. - .. _class_Node2D_get_relative_transform_to_parent: - :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const Returns the :ref:`Transform2D` relative to this node's parent. -.. _class_Node2D_get_rotation: - -- :ref:`float` **get_rotation** **(** **)** const - -Returns the node's rotation in radians. - -.. _class_Node2D_get_rotation_degrees: - -- :ref:`float` **get_rotation_degrees** **(** **)** const - -Returns the node's rotation in degrees. - -.. _class_Node2D_get_scale: - -- :ref:`Vector2` **get_scale** **(** **)** const - -Returns the node's scale. - -.. _class_Node2D_get_z: - -- :ref:`int` **get_z** **(** **)** const - -Returns the node's Z-index. - .. _class_Node2D_global_translate: - void **global_translate** **(** :ref:`Vector2` offset **)** Adds the 'offset' vector to the node's global position. -.. _class_Node2D_is_z_relative: - -- :ref:`bool` **is_z_relative** **(** **)** const - -Returns true if this node's Z-index is relative to its parent's. Else, returns false. - .. _class_Node2D_look_at: - void **look_at** **(** :ref:`Vector2` point **)** @@ -265,78 +153,6 @@ Applies a local translation on the node's Y axis based on the :ref:`Node._proces Applies a rotation to the node, in radians, starting from its current rotation. -.. _class_Node2D_set_global_position: - -- void **set_global_position** **(** :ref:`Vector2` position **)** - -Sets the node's global position. - -.. _class_Node2D_set_global_rotation: - -- void **set_global_rotation** **(** :ref:`float` radians **)** - -Sets the node's global rotation in radians. - -.. _class_Node2D_set_global_rotation_degrees: - -- void **set_global_rotation_degrees** **(** :ref:`float` degrees **)** - -Sets the node's global rotation in degrees. - -.. _class_Node2D_set_global_scale: - -- void **set_global_scale** **(** :ref:`Vector2` scale **)** - -Sets the node's global scale. - -.. _class_Node2D_set_global_transform: - -- void **set_global_transform** **(** :ref:`Transform2D` xform **)** - -Sets the node's global :ref:`Transform2D`. - -.. _class_Node2D_set_position: - -- void **set_position** **(** :ref:`Vector2` position **)** - -Sets the node's position. - -.. _class_Node2D_set_rotation: - -- void **set_rotation** **(** :ref:`float` radians **)** - -Sets the node's rotation in radians. - -.. _class_Node2D_set_rotation_degrees: - -- void **set_rotation_degrees** **(** :ref:`float` degrees **)** - -Sets the node's rotation in degrees. - -.. _class_Node2D_set_scale: - -- void **set_scale** **(** :ref:`Vector2` scale **)** - -Sets the node's scale. - -.. _class_Node2D_set_transform: - -- void **set_transform** **(** :ref:`Transform2D` xform **)** - -Sets the node's local :ref:`Transform2D`. - -.. _class_Node2D_set_z: - -- void **set_z** **(** :ref:`int` z **)** - -Sets the node's Z-index. - -.. _class_Node2D_set_z_as_relative: - -- void **set_z_as_relative** **(** :ref:`bool` enable **)** - -Makes the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. - .. _class_Node2D_to_global: - :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 42961d066..b5863e65f 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -17,23 +17,25 @@ Pre-parsed scene tree path. Member Functions ---------------- -+----------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | -+----------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** :ref:`int` idx **)** | -+----------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_name_count` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_property` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_subname` **(** :ref:`int` idx **)** | -+----------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subname_count` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_absolute` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | ++----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_as_property_path` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_concatenated_subnames` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** :ref:`int` idx **)** | ++----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_name_count` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_subname` **(** :ref:`int` idx **)** | ++----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subname_count` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_absolute` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------+ Description ----------- @@ -53,6 +55,14 @@ Member Function Description Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, ``"."`` and ``".."`` indicate the current node and its parent. +.. _class_NodePath_get_as_property_path: + +- :ref:`NodePath` **get_as_property_path** **(** **)** + +.. _class_NodePath_get_concatenated_subnames: + +- :ref:`String` **get_concatenated_subnames** **(** **)** + .. _class_NodePath_get_name: - :ref:`String` **get_name** **(** :ref:`int` idx **)** @@ -65,12 +75,6 @@ Get the node name indicated by ``idx`` (0 to :ref:`get_name_count` **get_property** **(** **)** - -Get the path's property name, or an empty string if the path doesn't have a property. - .. _class_NodePath_get_subname: - :ref:`String` **get_subname** **(** :ref:`int` idx **)** diff --git a/classes/class_object.rst b/classes/class_object.rst index 4818e6665..018a015c9 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -7,7 +7,7 @@ Object ====== -**Inherited By:** :ref:`Physics2DServer`, :ref:`MainLoop`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`PhysicsDirectBodyState`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`Reference`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`JSON`, :ref:`AudioServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`VisualServer`, :ref:`OS`, :ref:`GodotSharp`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` +**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`MainLoop`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`PhysicsDirectBodyState`, :ref:`JavaScript`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`JSON`, :ref:`AudioServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`VisualServer`, :ref:`OS`, :ref:`GodotSharp`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`VisualScriptEditor`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` **Category:** Core @@ -54,6 +54,8 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_instance_id` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | @@ -92,6 +94,8 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_indexed` **(** :ref:`NodePath` property, :ref:`Variant` value **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | @@ -144,7 +148,7 @@ Returns the given property. Returns ``null`` if the ``property`` does not exist. - :ref:`Array` **_get_property_list** **(** **)** virtual -Returns the object's property list as an :ref:`Array` of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope`). +Returns the object's property list as an :ref:`Array` of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE\_\* enum in :ref:`@GlobalScope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@GlobalScope`). .. _class_Object__init: @@ -168,7 +172,7 @@ Sets a property. Returns ``true`` if the ``property`` exists. - void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** -Adds a user-defined ``signal``. Arguments are optional, but can be added as an :ref:`Array` of dictionaries, each containing "name" and "type" (from :ref:`@Global Scope` TYPE\_\*). +Adds a user-defined ``signal``. Arguments are optional, but can be added as an :ref:`Array` of dictionaries, each containing "name" and "type" (from :ref:`@GlobalScope` TYPE\_\*). .. _class_Object_call: @@ -244,6 +248,10 @@ Inside each :ref:`Dictionary` there are 3 fields: - "method_name" is a name of method to which signal is connected. +.. _class_Object_get_indexed: + +- :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** const + .. _class_Object_get_instance_id: - :ref:`int` **get_instance_id** **(** **)** const @@ -272,7 +280,7 @@ Returns the object's methods and their signatures as an :ref:`Array - :ref:`Array` **get_property_list** **(** **)** const -Returns the list of properties as an :ref:`Array` of dictionaries. Dictionaries contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope`). +Returns the list of properties as an :ref:`Array` of dictionaries. Dictionaries contain: name:String, type:int (see TYPE\_\* enum in :ref:`@GlobalScope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@GlobalScope`). .. _class_Object_get_script: @@ -356,6 +364,10 @@ Set property into the object. If set to true, signal emission is blocked. +.. _class_Object_set_indexed: + +- void **set_indexed** **(** :ref:`NodePath` property, :ref:`Variant` value **)** + .. _class_Object_set_message_translation: - void **set_message_translation** **(** :ref:`bool` enable **)** diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 6d2f24d9b..e24edac07 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -16,23 +16,6 @@ Brief Description Defines a 2D polygon for LightOccluder2D. -Member Functions ----------------- - -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mode` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_closed` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_closed` **(** :ref:`bool` closed **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -61,31 +44,3 @@ Description Editor facility that helps you draw a 2D polygon used as resource for :ref:`LightOccluder2D`. -Member Function Description ---------------------------- - -.. _class_OccluderPolygon2D_get_cull_mode: - -- :ref:`int` **get_cull_mode** **(** **)** const - -.. _class_OccluderPolygon2D_get_polygon: - -- :ref:`PoolVector2Array` **get_polygon** **(** **)** const - -.. _class_OccluderPolygon2D_is_closed: - -- :ref:`bool` **is_closed** **(** **)** const - -.. _class_OccluderPolygon2D_set_closed: - -- void **set_closed** **(** :ref:`bool` closed **)** - -.. _class_OccluderPolygon2D_set_cull_mode: - -- void **set_cull_mode** **(** :ref:`int` cull_mode **)** - -.. _class_OccluderPolygon2D_set_polygon: - -- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** - - diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 5574dfb91..c33ada9c8 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -16,19 +16,6 @@ Brief Description OmniDirectional Light, such as a light bulb or a candle. -Member Functions ----------------- - -+------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_detail` **(** **)** const | -+------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | -+------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_detail` **(** :ref:`int` detail **)** | -+------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | -+------------------------+------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -62,23 +49,3 @@ Description An OmniDirectional light is a type of :ref:`Light` node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light`. -Member Function Description ---------------------------- - -.. _class_OmniLight_get_shadow_detail: - -- :ref:`int` **get_shadow_detail** **(** **)** const - -.. _class_OmniLight_get_shadow_mode: - -- :ref:`int` **get_shadow_mode** **(** **)** const - -.. _class_OmniLight_set_shadow_detail: - -- void **set_shadow_detail** **(** :ref:`int` detail **)** - -.. _class_OmniLight_set_shadow_mode: - -- void **set_shadow_mode** **(** :ref:`int` mode **)** - - diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 9217e67d5..d82f03b64 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -38,8 +38,6 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selected_id` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | @@ -143,12 +141,6 @@ Return the ID of the item at index "idx". Return the text of the item at index "idx". -.. _class_OptionButton_get_selected: - -- :ref:`int` **get_selected** **(** **)** const - -Return the current item index - .. _class_OptionButton_get_selected_id: - :ref:`int` **get_selected_id** **(** **)** const diff --git a/classes/class_os.rst b/classes/class_os.rst index 8f1f8d26d..eed29e1c8 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -46,8 +46,6 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_current_screen` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_data_dir` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | @@ -114,6 +112,8 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_window_position` **(** **)** const | @@ -354,12 +354,6 @@ Returns the command line arguments passed to the engine. Returns the current screen index (0 padded). -.. _class_OS_get_data_dir: - -- :ref:`String` **get_data_dir** **(** **)** const - -Returns the absolute directory path of user data path(user://). - .. _class_OS_get_date: - :ref:`Dictionary` **get_date** **(** :ref:`bool` utc=false **)** const @@ -578,6 +572,12 @@ Get an epoch time value from a dictionary of time values. You can pass the output from :ref:`get_datetime_from_unix_time` directly into this function. Daylight savings time (dst), if present, is ignored. +.. _class_OS_get_user_data_dir: + +- :ref:`String` **get_user_data_dir** **(** **)** const + +Returns the absolute directory path where user data is written (``user://``). + .. _class_OS_get_virtual_keyboard_height: - :ref:`int` **get_virtual_keyboard_height** **(** **)** diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index f99de763f..0f4b18bba 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -16,15 +16,6 @@ Brief Description -Member Functions ----------------- - -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_panorama` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_panorama` **(** :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -33,15 +24,3 @@ Member Variables - :ref:`Texture` **panorama** -Member Function Description ---------------------------- - -.. _class_PanoramaSky_get_panorama: - -- :ref:`Texture` **get_panorama** **(** **)** const - -.. _class_PanoramaSky_set_panorama: - -- void **set_panorama** **(** :ref:`Texture` texture **)** - - diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index b7ea67957..622d4dc82 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -16,35 +16,6 @@ Brief Description A node used to create a parallax scrolling background. -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_limit_begin` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_limit_end` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll_base_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll_base_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ignore_camera_zoom` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ignore_camera_zoom` **(** :ref:`bool` ignore **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_begin` **(** :ref:`Vector2` ofs **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_end` **(** :ref:`Vector2` ofs **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_base_offset` **(** :ref:`Vector2` ofs **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_base_scale` **(** :ref:`Vector2` scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_offset` **(** :ref:`Vector2` ofs **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -78,75 +49,3 @@ Description A ParallaxBackground uses one or more :ref:`ParallaxLayer` child nodes to create a parallax effect. Each :ref:`ParallaxLayer` can move at a different speed using :ref:`ParallaxLayer.motion_offset`. This creates an illusion of depth in a 2D game. If not used with a :ref:`Camera2D`, you must manually calculate the :ref:`scroll_offset`. -Member Function Description ---------------------------- - -.. _class_ParallaxBackground_get_limit_begin: - -- :ref:`Vector2` **get_limit_begin** **(** **)** const - -Return the beginning limit. - -.. _class_ParallaxBackground_get_limit_end: - -- :ref:`Vector2` **get_limit_end** **(** **)** const - -Return the ending limit. - -.. _class_ParallaxBackground_get_scroll_base_offset: - -- :ref:`Vector2` **get_scroll_base_offset** **(** **)** const - -Return the base offset. - -.. _class_ParallaxBackground_get_scroll_base_scale: - -- :ref:`Vector2` **get_scroll_base_scale** **(** **)** const - -Return the base motion scale. - -.. _class_ParallaxBackground_get_scroll_offset: - -- :ref:`Vector2` **get_scroll_offset** **(** **)** const - -.. _class_ParallaxBackground_is_ignore_camera_zoom: - -- :ref:`bool` **is_ignore_camera_zoom** **(** **)** - -Return ignoring camera zoom. - -.. _class_ParallaxBackground_set_ignore_camera_zoom: - -- void **set_ignore_camera_zoom** **(** :ref:`bool` ignore **)** - -Set to true for all child :ref:`ParallaxLayer` nodes to not be affected by the zoom level of the camera. - -.. _class_ParallaxBackground_set_limit_begin: - -- void **set_limit_begin** **(** :ref:`Vector2` ofs **)** - -Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis. - -.. _class_ParallaxBackground_set_limit_end: - -- void **set_limit_end** **(** :ref:`Vector2` ofs **)** - -Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis. - -.. _class_ParallaxBackground_set_scroll_base_offset: - -- void **set_scroll_base_offset** **(** :ref:`Vector2` ofs **)** - -Set the base offset in pixels of all children :ref:`ParallaxLayer` nodes. - -.. _class_ParallaxBackground_set_scroll_base_scale: - -- void **set_scroll_base_scale** **(** :ref:`Vector2` scale **)** - -Set the base motion scale of all children :ref:`ParallaxLayer` nodes. - -.. _class_ParallaxBackground_set_scroll_offset: - -- void **set_scroll_offset** **(** :ref:`Vector2` ofs **)** - - diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index bf96cc5cc..6a7fe8de9 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -16,23 +16,6 @@ Brief Description A parallax scrolling layer to be used with :ref:`ParallaxBackground`. -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mirroring` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_motion_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_motion_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mirroring` **(** :ref:`Vector2` mirror **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_motion_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_motion_scale` **(** :ref:`Vector2` scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -56,39 +39,3 @@ A ParallaxLayer must be the child of a :ref:`ParallaxBackground` **get_mirroring** **(** **)** const - -Return the mirroring of the ParallaxLayer. - -.. _class_ParallaxLayer_get_motion_offset: - -- :ref:`Vector2` **get_motion_offset** **(** **)** const - -.. _class_ParallaxLayer_get_motion_scale: - -- :ref:`Vector2` **get_motion_scale** **(** **)** const - -Return the motion scale of the ParallaxLayer. - -.. _class_ParallaxLayer_set_mirroring: - -- void **set_mirroring** **(** :ref:`Vector2` mirror **)** - -Set the mirroring of the ParallaxLayer. If an axis is set to 0 then that axis will have no mirroring. - -.. _class_ParallaxLayer_set_motion_offset: - -- void **set_motion_offset** **(** :ref:`Vector2` offset **)** - -.. _class_ParallaxLayer_set_motion_scale: - -- void **set_motion_scale** **(** :ref:`Vector2` scale **)** - -Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera. - - diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 65b5fe566..1b49e935f 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -19,75 +19,11 @@ Brief Description Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`capture_aabb` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_amount` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_order` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_draw_pass_mesh` **(** :ref:`int` pass **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_passes` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_explosiveness_ratio` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fixed_fps` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_fractional_delta` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lifetime` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_one_shot` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_process_material` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_randomness_ratio` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_local_coordinates` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_visibility_aabb` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emitting` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`restart` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_amount` **(** :ref:`int` amount **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_order` **(** :ref:`int` order **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_pass_mesh` **(** :ref:`int` pass, :ref:`Mesh` mesh **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_passes` **(** :ref:`int` passes **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emitting` **(** :ref:`bool` emitting **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_explosiveness_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_fps` **(** :ref:`int` fps **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fractional_delta` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_shot` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_material` **(** :ref:`Material` material **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_randomness_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed_scale` **(** :ref:`float` scale **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visibility_aabb` **(** :ref:`Rect3` aabb **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`capture_aabb` **(** **)** const | ++--------------------------+---------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++--------------------------+---------------------------------------------------------------------+ Member Variables ---------------- @@ -166,7 +102,7 @@ Member Variables .. _class_Particles_visibility_aabb: -- :ref:`Rect3` **visibility_aabb** +- :ref:`AABB` **visibility_aabb** Numeric Constants @@ -189,138 +125,10 @@ Member Function Description .. _class_Particles_capture_aabb: -- :ref:`Rect3` **capture_aabb** **(** **)** const - -.. _class_Particles_get_amount: - -- :ref:`int` **get_amount** **(** **)** const - -.. _class_Particles_get_draw_order: - -- :ref:`int` **get_draw_order** **(** **)** const - -.. _class_Particles_get_draw_pass_mesh: - -- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** const - -.. _class_Particles_get_draw_passes: - -- :ref:`int` **get_draw_passes** **(** **)** const - -.. _class_Particles_get_explosiveness_ratio: - -- :ref:`float` **get_explosiveness_ratio** **(** **)** const - -.. _class_Particles_get_fixed_fps: - -- :ref:`int` **get_fixed_fps** **(** **)** const - -.. _class_Particles_get_fractional_delta: - -- :ref:`bool` **get_fractional_delta** **(** **)** const - -.. _class_Particles_get_lifetime: - -- :ref:`float` **get_lifetime** **(** **)** const - -.. _class_Particles_get_one_shot: - -- :ref:`bool` **get_one_shot** **(** **)** const - -.. _class_Particles_get_pre_process_time: - -- :ref:`float` **get_pre_process_time** **(** **)** const - -.. _class_Particles_get_process_material: - -- :ref:`Material` **get_process_material** **(** **)** const - -.. _class_Particles_get_randomness_ratio: - -- :ref:`float` **get_randomness_ratio** **(** **)** const - -.. _class_Particles_get_speed_scale: - -- :ref:`float` **get_speed_scale** **(** **)** const - -.. _class_Particles_get_use_local_coordinates: - -- :ref:`bool` **get_use_local_coordinates** **(** **)** const - -.. _class_Particles_get_visibility_aabb: - -- :ref:`Rect3` **get_visibility_aabb** **(** **)** const - -.. _class_Particles_is_emitting: - -- :ref:`bool` **is_emitting** **(** **)** const +- :ref:`AABB` **capture_aabb** **(** **)** const .. _class_Particles_restart: - void **restart** **(** **)** -.. _class_Particles_set_amount: - -- void **set_amount** **(** :ref:`int` amount **)** - -.. _class_Particles_set_draw_order: - -- void **set_draw_order** **(** :ref:`int` order **)** - -.. _class_Particles_set_draw_pass_mesh: - -- void **set_draw_pass_mesh** **(** :ref:`int` pass, :ref:`Mesh` mesh **)** - -.. _class_Particles_set_draw_passes: - -- void **set_draw_passes** **(** :ref:`int` passes **)** - -.. _class_Particles_set_emitting: - -- void **set_emitting** **(** :ref:`bool` emitting **)** - -.. _class_Particles_set_explosiveness_ratio: - -- void **set_explosiveness_ratio** **(** :ref:`float` ratio **)** - -.. _class_Particles_set_fixed_fps: - -- void **set_fixed_fps** **(** :ref:`int` fps **)** - -.. _class_Particles_set_fractional_delta: - -- void **set_fractional_delta** **(** :ref:`bool` enable **)** - -.. _class_Particles_set_lifetime: - -- void **set_lifetime** **(** :ref:`float` secs **)** - -.. _class_Particles_set_one_shot: - -- void **set_one_shot** **(** :ref:`bool` enable **)** - -.. _class_Particles_set_pre_process_time: - -- void **set_pre_process_time** **(** :ref:`float` secs **)** - -.. _class_Particles_set_process_material: - -- void **set_process_material** **(** :ref:`Material` material **)** - -.. _class_Particles_set_randomness_ratio: - -- void **set_randomness_ratio** **(** :ref:`float` ratio **)** - -.. _class_Particles_set_speed_scale: - -- void **set_speed_scale** **(** :ref:`float` scale **)** - -.. _class_Particles_set_use_local_coordinates: - -- void **set_use_local_coordinates** **(** :ref:`bool` enable **)** - -.. _class_Particles_set_visibility_aabb: - -- void **set_visibility_aabb** **(** :ref:`Rect3` aabb **)** - diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 0c23005d6..f5c000162 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -19,83 +19,11 @@ Brief Description Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_amount` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_order` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_explosiveness_ratio` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fixed_fps` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_fractional_delta` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_frames` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lifetime` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_one_shot` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_process_material` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_randomness_ratio` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_local_coordinates` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_frames` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visibility_rect` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emitting` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`restart` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_amount` **(** :ref:`int` amount **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_order` **(** :ref:`int` order **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emitting` **(** :ref:`bool` emitting **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_explosiveness_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_fps` **(** :ref:`int` fps **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fractional_delta` **(** :ref:`bool` enable **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_frames` **(** :ref:`int` frames **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_map` **(** :ref:`Texture` texture **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_shot` **(** :ref:`bool` secs **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_material` **(** :ref:`Material` material **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_randomness_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed_scale` **(** :ref:`float` scale **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_frames` **(** :ref:`int` frames **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visibility_rect` **(** :ref:`Rect2` aabb **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++----------------------------+-----------------------------------------------------------------------+ Member Variables ---------------- @@ -193,166 +121,8 @@ Member Function Description - :ref:`Rect2` **capture_rect** **(** **)** const -.. _class_Particles2D_get_amount: - -- :ref:`int` **get_amount** **(** **)** const - -Returns the amount of particles spawned at each emission - -.. _class_Particles2D_get_draw_order: - -- :ref:`int` **get_draw_order** **(** **)** const - -.. _class_Particles2D_get_explosiveness_ratio: - -- :ref:`float` **get_explosiveness_ratio** **(** **)** const - -.. _class_Particles2D_get_fixed_fps: - -- :ref:`int` **get_fixed_fps** **(** **)** const - -.. _class_Particles2D_get_fractional_delta: - -- :ref:`bool` **get_fractional_delta** **(** **)** const - -.. _class_Particles2D_get_h_frames: - -- :ref:`int` **get_h_frames** **(** **)** const - -.. _class_Particles2D_get_lifetime: - -- :ref:`float` **get_lifetime** **(** **)** const - -Gets the amount of seconds that each particle will be visible. - -.. _class_Particles2D_get_normal_map: - -- :ref:`Texture` **get_normal_map** **(** **)** const - -.. _class_Particles2D_get_one_shot: - -- :ref:`bool` **get_one_shot** **(** **)** const - -.. _class_Particles2D_get_pre_process_time: - -- :ref:`float` **get_pre_process_time** **(** **)** const - -.. _class_Particles2D_get_process_material: - -- :ref:`Material` **get_process_material** **(** **)** const - -.. _class_Particles2D_get_randomness_ratio: - -- :ref:`float` **get_randomness_ratio** **(** **)** const - -.. _class_Particles2D_get_speed_scale: - -- :ref:`float` **get_speed_scale** **(** **)** const - -.. _class_Particles2D_get_texture: - -- :ref:`Texture` **get_texture** **(** **)** const - -Returns the texture for emitted particles - -.. _class_Particles2D_get_use_local_coordinates: - -- :ref:`bool` **get_use_local_coordinates** **(** **)** const - -.. _class_Particles2D_get_v_frames: - -- :ref:`int` **get_v_frames** **(** **)** const - -.. _class_Particles2D_get_visibility_rect: - -- :ref:`Rect2` **get_visibility_rect** **(** **)** const - -.. _class_Particles2D_is_emitting: - -- :ref:`bool` **is_emitting** **(** **)** const - -Returns whether this emitter is currently emitting or not - .. _class_Particles2D_restart: - void **restart** **(** **)** -.. _class_Particles2D_set_amount: - -- void **set_amount** **(** :ref:`int` amount **)** - -Sets the amount of particles spawned at each emission - -.. _class_Particles2D_set_draw_order: - -- void **set_draw_order** **(** :ref:`int` order **)** - -.. _class_Particles2D_set_emitting: - -- void **set_emitting** **(** :ref:`bool` emitting **)** - -If this is set to true then the particle emitter will emit particles, if its false it will not. - -.. _class_Particles2D_set_explosiveness_ratio: - -- void **set_explosiveness_ratio** **(** :ref:`float` ratio **)** - -.. _class_Particles2D_set_fixed_fps: - -- void **set_fixed_fps** **(** :ref:`int` fps **)** - -.. _class_Particles2D_set_fractional_delta: - -- void **set_fractional_delta** **(** :ref:`bool` enable **)** - -.. _class_Particles2D_set_h_frames: - -- void **set_h_frames** **(** :ref:`int` frames **)** - -.. _class_Particles2D_set_lifetime: - -- void **set_lifetime** **(** :ref:`float` secs **)** - -Sets the amount of seconds that each particle will be visible. - -.. _class_Particles2D_set_normal_map: - -- void **set_normal_map** **(** :ref:`Texture` texture **)** - -.. _class_Particles2D_set_one_shot: - -- void **set_one_shot** **(** :ref:`bool` secs **)** - -.. _class_Particles2D_set_pre_process_time: - -- void **set_pre_process_time** **(** :ref:`float` secs **)** - -.. _class_Particles2D_set_process_material: - -- void **set_process_material** **(** :ref:`Material` material **)** - -.. _class_Particles2D_set_randomness_ratio: - -- void **set_randomness_ratio** **(** :ref:`float` ratio **)** - -.. _class_Particles2D_set_speed_scale: - -- void **set_speed_scale** **(** :ref:`float` scale **)** - -.. _class_Particles2D_set_texture: - -- void **set_texture** **(** :ref:`Texture` texture **)** - -.. _class_Particles2D_set_use_local_coordinates: - -- void **set_use_local_coordinates** **(** :ref:`bool` enable **)** - -.. _class_Particles2D_set_v_frames: - -- void **set_v_frames** **(** :ref:`int` frames **)** - -.. _class_Particles2D_set_visibility_rect: - -- void **set_visibility_rect** **(** :ref:`Rect2` aabb **)** - diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 815294001..cbe4a971a 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -16,87 +16,6 @@ Brief Description Particle properties for :ref:`Particles` and :ref:`Particles2D` nodes. -Member Functions ----------------- - -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_color_ramp` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_emission_box_extents` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_emission_color_texture` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_emission_normal_texture` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_emission_point_count` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_emission_point_texture` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_emission_shape` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_sphere_radius` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_flatness` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`int` param **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_param_texture` **(** :ref:`int` param **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_spread` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GradientTexture` | :ref:`get_trail_color_modifier` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_trail_divisor` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CurveTexture` | :ref:`get_trail_size_modifier` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_ramp` **(** :ref:`Texture` ramp **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_box_extents` **(** :ref:`Vector3` extents **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_color_texture` **(** :ref:`Texture` texture **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_normal_texture` **(** :ref:`Texture` texture **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_point_count` **(** :ref:`int` point_count **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_point_texture` **(** :ref:`Texture` texture **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_shape` **(** :ref:`int` shape **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_sphere_radius` **(** :ref:`float` radius **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flatness` **(** :ref:`float` amount **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`Vector3` accel_vec **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_randomness` **(** :ref:`int` param, :ref:`float` randomness **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spread` **(** :ref:`float` degrees **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trail_color_modifier` **(** :ref:`GradientTexture` texture **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trail_divisor` **(** :ref:`int` divisor **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trail_size_modifier` **(** :ref:`CurveTexture` texture **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -349,159 +268,3 @@ ParticlesMaterial defines particle properties and behavior. It is used in the `` Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture` applied to vary values over the lifetime of the particle. -Member Function Description ---------------------------- - -.. _class_ParticlesMaterial_get_color: - -- :ref:`Color` **get_color** **(** **)** const - -.. _class_ParticlesMaterial_get_color_ramp: - -- :ref:`Texture` **get_color_ramp** **(** **)** const - -.. _class_ParticlesMaterial_get_emission_box_extents: - -- :ref:`Vector3` **get_emission_box_extents** **(** **)** const - -.. _class_ParticlesMaterial_get_emission_color_texture: - -- :ref:`Texture` **get_emission_color_texture** **(** **)** const - -.. _class_ParticlesMaterial_get_emission_normal_texture: - -- :ref:`Texture` **get_emission_normal_texture** **(** **)** const - -.. _class_ParticlesMaterial_get_emission_point_count: - -- :ref:`int` **get_emission_point_count** **(** **)** const - -.. _class_ParticlesMaterial_get_emission_point_texture: - -- :ref:`Texture` **get_emission_point_texture** **(** **)** const - -.. _class_ParticlesMaterial_get_emission_shape: - -- :ref:`int` **get_emission_shape** **(** **)** const - -.. _class_ParticlesMaterial_get_emission_sphere_radius: - -- :ref:`float` **get_emission_sphere_radius** **(** **)** const - -.. _class_ParticlesMaterial_get_flag: - -- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const - -.. _class_ParticlesMaterial_get_flatness: - -- :ref:`float` **get_flatness** **(** **)** const - -.. _class_ParticlesMaterial_get_gravity: - -- :ref:`Vector3` **get_gravity** **(** **)** const - -.. _class_ParticlesMaterial_get_param: - -- :ref:`float` **get_param** **(** :ref:`int` param **)** const - -.. _class_ParticlesMaterial_get_param_randomness: - -- :ref:`float` **get_param_randomness** **(** :ref:`int` param **)** const - -.. _class_ParticlesMaterial_get_param_texture: - -- :ref:`Texture` **get_param_texture** **(** :ref:`int` param **)** const - -.. _class_ParticlesMaterial_get_spread: - -- :ref:`float` **get_spread** **(** **)** const - -.. _class_ParticlesMaterial_get_trail_color_modifier: - -- :ref:`GradientTexture` **get_trail_color_modifier** **(** **)** const - -.. _class_ParticlesMaterial_get_trail_divisor: - -- :ref:`int` **get_trail_divisor** **(** **)** const - -.. _class_ParticlesMaterial_get_trail_size_modifier: - -- :ref:`CurveTexture` **get_trail_size_modifier** **(** **)** const - -.. _class_ParticlesMaterial_set_color: - -- void **set_color** **(** :ref:`Color` color **)** - -.. _class_ParticlesMaterial_set_color_ramp: - -- void **set_color_ramp** **(** :ref:`Texture` ramp **)** - -.. _class_ParticlesMaterial_set_emission_box_extents: - -- void **set_emission_box_extents** **(** :ref:`Vector3` extents **)** - -.. _class_ParticlesMaterial_set_emission_color_texture: - -- void **set_emission_color_texture** **(** :ref:`Texture` texture **)** - -.. _class_ParticlesMaterial_set_emission_normal_texture: - -- void **set_emission_normal_texture** **(** :ref:`Texture` texture **)** - -.. _class_ParticlesMaterial_set_emission_point_count: - -- void **set_emission_point_count** **(** :ref:`int` point_count **)** - -.. _class_ParticlesMaterial_set_emission_point_texture: - -- void **set_emission_point_texture** **(** :ref:`Texture` texture **)** - -.. _class_ParticlesMaterial_set_emission_shape: - -- void **set_emission_shape** **(** :ref:`int` shape **)** - -.. _class_ParticlesMaterial_set_emission_sphere_radius: - -- void **set_emission_sphere_radius** **(** :ref:`float` radius **)** - -.. _class_ParticlesMaterial_set_flag: - -- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** - -.. _class_ParticlesMaterial_set_flatness: - -- void **set_flatness** **(** :ref:`float` amount **)** - -.. _class_ParticlesMaterial_set_gravity: - -- void **set_gravity** **(** :ref:`Vector3` accel_vec **)** - -.. _class_ParticlesMaterial_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - -.. _class_ParticlesMaterial_set_param_randomness: - -- void **set_param_randomness** **(** :ref:`int` param, :ref:`float` randomness **)** - -.. _class_ParticlesMaterial_set_param_texture: - -- void **set_param_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** - -.. _class_ParticlesMaterial_set_spread: - -- void **set_spread** **(** :ref:`float` degrees **)** - -.. _class_ParticlesMaterial_set_trail_color_modifier: - -- void **set_trail_color_modifier** **(** :ref:`GradientTexture` texture **)** - -.. _class_ParticlesMaterial_set_trail_divisor: - -- void **set_trail_divisor** **(** :ref:`int` divisor **)** - -.. _class_ParticlesMaterial_set_trail_size_modifier: - -- void **set_trail_size_modifier** **(** :ref:`CurveTexture` texture **)** - - diff --git a/classes/class_path.rst b/classes/class_path.rst index fb42153e1..20f9d43a9 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -16,15 +16,6 @@ Brief Description Container for a :ref:`Curve3D`. -Member Functions ----------------- - -+--------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Curve3D` | :ref:`get_curve` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`set_curve` **(** :ref:`Curve3D` curve **)** | -+--------------------------------+----------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description This class is a container/Node-ification of a :ref:`Curve3D`, so it can have :ref:`Spatial` properties and :ref:`Node` info. -Member Function Description ---------------------------- - -.. _class_Path_get_curve: - -- :ref:`Curve3D` **get_curve** **(** **)** const - -Returns the :ref:`Curve3D` contained. - -.. _class_Path_set_curve: - -- void **set_curve** **(** :ref:`Curve3D` curve **)** - -Sets the :ref:`Curve3D`. - - diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index f265ab98b..12db32aa3 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -16,15 +16,6 @@ Brief Description Contains a :ref:`Curve2D` path for :ref:`PathFollow2D` nodes to follow. -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Curve2D` | :ref:`get_curve` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------+ -| void | :ref:`set_curve` **(** :ref:`Curve2D` curve **)** | -+--------------------------------+------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description Can have :ref:`PathFollow2D` child-nodes moving along the :ref:`Curve2D`. See :ref:`PathFollow2D` for more information on this usage. -Member Function Description ---------------------------- - -.. _class_Path2D_get_curve: - -- :ref:`Curve2D` **get_curve** **(** **)** const - -Returns the :ref:`Curve2D` contained. - -.. _class_Path2D_set_curve: - -- void **set_curve** **(** :ref:`Curve2D` curve **)** - -Sets the :ref:`Curve2D`. - - diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index db5355803..f86974979 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -19,29 +19,19 @@ Direct access object to a space in the :ref:`Physics2DServer` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **TYPE_MASK_STATIC_BODY** = **1** --- Check for collisions with static bodies. -- **TYPE_MASK_KINEMATIC_BODY** = **2** --- Check for collisions with kinematic bodies. -- **TYPE_MASK_RIGID_BODY** = **4** --- Check for collisions with rigid bodies. -- **TYPE_MASK_CHARACTER_BODY** = **8** --- Check for collisions with rigid bodies in character mode. -- **TYPE_MASK_COLLISION** = **15** --- Check for collisions with any kind of bodies (but not areas). -- **TYPE_MASK_AREA** = **16** --- Check for collisions with areas. ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -91,7 +81,7 @@ If the shape did not intersect anything, then an empty dictionary (dir.empty()== .. _class_Physics2DDirectSpaceState_intersect_point: -- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -105,11 +95,11 @@ collider: Object the point is inside of. rid: :ref:`RID` of the object the point is in. -Additionally, the method can take an array of objects or :ref:`RID`\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants). +Additionally, the method can take an array of objects or :ref:`RID`\ s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. .. _class_Physics2DDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** Intersect a ray in a given space. The returned object is a dictionary with the following fields: @@ -129,7 +119,7 @@ rid: :ref:`RID` of the object against which the ray was stopped. If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. -Additionally, the method can take an array of objects or :ref:`RID`\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants). +Additionally, the method can take an array of objects or :ref:`RID`\ s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. .. _class_Physics2DDirectSpaceState_intersect_shape: diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 83a027f33..ae6f8b4a8 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -19,37 +19,33 @@ Parameters to be sent to a 2D shape physics query. Member Functions ---------------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_exclude` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_motion` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_object_type_mask` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`float` margin **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_motion` **(** :ref:`Vector2` motion **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_exclude` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_motion` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin` **(** :ref:`float` margin **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_motion` **(** :ref:`Vector2` motion **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -83,12 +79,6 @@ Return the collision margin for the shape. Return the current movement speed of the shape. -.. _class_Physics2DShapeQueryParameters_get_object_type_mask: - -- :ref:`int` **get_object_type_mask** **(** **)** const - -Return the type of object the shape belongs to. - .. _class_Physics2DShapeQueryParameters_get_shape_rid: - :ref:`RID` **get_shape_rid** **(** **)** const @@ -125,12 +115,6 @@ Set the collision margin for the shape. A collision margin is an amount (in pixe Set the current movement speed of the shape. -.. _class_Physics2DShapeQueryParameters_set_object_type_mask: - -- void **set_object_type_mask** **(** :ref:`int` object_type_mask **)** - -Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK\_\*). - .. _class_Physics2DShapeQueryParameters_set_shape: - void **set_shape** **(** :ref:`Resource` shape **)** diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index e2466f748..9026c1e2c 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -9,7 +9,7 @@ PhysicsBody **Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`RigidBody`, :ref:`VehicleBody`, :ref:`StaticBody`, :ref:`KinematicBody` +**Inherited By:** :ref:`VehicleBody`, :ref:`StaticBody`, :ref:`KinematicBody`, :ref:`RigidBody` **Category:** Core @@ -24,22 +24,14 @@ Member Functions +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,18 +65,10 @@ Member Function Description Adds a body to the list of bodies that this body can't collide with. -.. _class_PhysicsBody_get_collision_layer: - -- :ref:`int` **get_collision_layer** **(** **)** const - .. _class_PhysicsBody_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const -.. _class_PhysicsBody_get_collision_mask: - -- :ref:`int` **get_collision_mask** **(** **)** const - .. _class_PhysicsBody_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const @@ -95,18 +79,10 @@ Adds a body to the list of bodies that this body can't collide with. Removes a body from the list of bodies that this body can't collide with. -.. _class_PhysicsBody_set_collision_layer: - -- void **set_collision_layer** **(** :ref:`int` layer **)** - .. _class_PhysicsBody_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_PhysicsBody_set_collision_mask: - -- void **set_collision_mask** **(** :ref:`int` mask **)** - .. _class_PhysicsBody_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index a09d5b74c..ded5685fe 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -24,22 +24,14 @@ Member Functions +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,24 +69,12 @@ Member Function Description Adds a body to the list of bodies that this body can't collide with. -.. _class_PhysicsBody2D_get_collision_layer: - -- :ref:`int` **get_collision_layer** **(** **)** const - -Return the physics layer this area is in. - .. _class_PhysicsBody2D_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. -.. _class_PhysicsBody2D_get_collision_mask: - -- :ref:`int` **get_collision_mask** **(** **)** const - -Return the physics layers this area can scan for collisions. - .. _class_PhysicsBody2D_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const @@ -107,28 +87,12 @@ Return an individual bit on the collision mask. Removes a body from the list of bodies that this body can't collide with. -.. _class_PhysicsBody2D_set_collision_layer: - -- void **set_collision_layer** **(** :ref:`int` layer **)** - -Set the physics layers this area is in. - -Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask`. - -A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - .. _class_PhysicsBody2D_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. -.. _class_PhysicsBody2D_set_collision_mask: - -- void **set_collision_mask** **(** :ref:`int` mask **)** - -Set the physics layers this area can scan for collisions. - .. _class_PhysicsBody2D_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index ece3cfdc6..b63b60552 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -19,27 +19,17 @@ Brief Description Member Functions ---------------- -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **TYPE_MASK_STATIC_BODY** = **1** -- **TYPE_MASK_KINEMATIC_BODY** = **2** -- **TYPE_MASK_RIGID_BODY** = **4** -- **TYPE_MASK_CHARACTER_BODY** = **8** -- **TYPE_MASK_COLLISION** = **15** -- **TYPE_MASK_AREA** = **16** ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -58,7 +48,7 @@ Member Function Description .. _class_PhysicsDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** .. _class_PhysicsDirectSpaceState_intersect_shape: diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 46653e41c..a6f475337 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -19,40 +19,36 @@ Brief Description Member Functions ---------------- -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_exclude` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_object_type_mask` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`float` margin **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform` transform **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_exclude` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin` **(** :ref:`float` margin **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform` transform **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- -.. _class_PhysicsShapeQueryParameters_get_collision_layer: +.. _class_PhysicsShapeQueryParameters_get_collision_mask: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_mask** **(** **)** const .. _class_PhysicsShapeQueryParameters_get_exclude: @@ -62,10 +58,6 @@ Member Function Description - :ref:`float` **get_margin** **(** **)** const -.. _class_PhysicsShapeQueryParameters_get_object_type_mask: - -- :ref:`int` **get_object_type_mask** **(** **)** const - .. _class_PhysicsShapeQueryParameters_get_shape_rid: - :ref:`RID` **get_shape_rid** **(** **)** const @@ -74,9 +66,9 @@ Member Function Description - :ref:`Transform` **get_transform** **(** **)** const -.. _class_PhysicsShapeQueryParameters_set_collision_layer: +.. _class_PhysicsShapeQueryParameters_set_collision_mask: -- void **set_collision_layer** **(** :ref:`int` collision_layer **)** +- void **set_collision_mask** **(** :ref:`int` collision_mask **)** .. _class_PhysicsShapeQueryParameters_set_exclude: @@ -86,10 +78,6 @@ Member Function Description - void **set_margin** **(** :ref:`float` margin **)** -.. _class_PhysicsShapeQueryParameters_set_object_type_mask: - -- void **set_object_type_mask** **(** :ref:`int` object_type_mask **)** - .. _class_PhysicsShapeQueryParameters_set_shape: - void **set_shape** **(** :ref:`Resource` shape **)** diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 305e9ce00..d89e22040 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -16,15 +16,6 @@ Brief Description Pin Joint for 3D Shapes. -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -61,15 +52,3 @@ Description Pin Joint for 3D Rigid Bodies. It pins 2 bodies (rigid or static) together. -Member Function Description ---------------------------- - -.. _class_PinJoint_get_param: - -- :ref:`float` **get_param** **(** :ref:`int` param **)** const - -.. _class_PinJoint_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - - diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index a48a8b351..8c7450387 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -16,15 +16,6 @@ Brief Description Pin Joint for 2D Shapes. -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_softness` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_softness` **(** :ref:`float` softness **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,15 +29,3 @@ Description Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space. -Member Function Description ---------------------------- - -.. _class_PinJoint2D_get_softness: - -- :ref:`float` **get_softness** **(** **)** const - -.. _class_PinJoint2D_set_softness: - -- void **set_softness** **(** :ref:`float` softness **)** - - diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 134787cdf..3345a3df3 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -16,23 +16,6 @@ Brief Description Class representing a planar :ref:`PrimitiveMesh`. -Member Functions ----------------- - -+--------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_depth` **(** :ref:`int` subdivide **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_width` **(** :ref:`int` subdivide **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,31 +37,3 @@ Description Class representing a planar :ref:`PrimitiveMesh`. This flat mesh does not have a thickness. -Member Function Description ---------------------------- - -.. _class_PlaneMesh_get_size: - -- :ref:`Vector2` **get_size** **(** **)** const - -.. _class_PlaneMesh_get_subdivide_depth: - -- :ref:`int` **get_subdivide_depth** **(** **)** const - -.. _class_PlaneMesh_get_subdivide_width: - -- :ref:`int` **get_subdivide_width** **(** **)** const - -.. _class_PlaneMesh_set_size: - -- void **set_size** **(** :ref:`Vector2` size **)** - -.. _class_PlaneMesh_set_subdivide_depth: - -- void **set_subdivide_depth** **(** :ref:`int` subdivide **)** - -.. _class_PlaneMesh_set_subdivide_width: - -- void **set_subdivide_width** **(** :ref:`int` subdivide **)** - - diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index ac4233c23..0b23b9f3c 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -16,15 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_plane` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------+ -| void | :ref:`set_plane` **(** :ref:`Plane` plane **)** | -+----------------------------+------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -33,15 +24,3 @@ Member Variables - :ref:`Plane` **plane** -Member Function Description ---------------------------- - -.. _class_PlaneShape_get_plane: - -- :ref:`Plane` **get_plane** **(** **)** const - -.. _class_PlaneShape_set_plane: - -- void **set_plane** **(** :ref:`Plane` plane **)** - - diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 1a182b09e..fc39a1c2c 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -19,59 +19,11 @@ A 2D polygon. Member Functions ---------------- -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_antialiased` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_invert` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_invert_border` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_texture_rotation` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_texture_rotation_degrees` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_scale` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_uv` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`get_vertex_colors` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_antialiased` **(** :ref:`bool` antialiased **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_invert` **(** :ref:`bool` invert **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_invert_border` **(** :ref:`float` invert_border **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_rotation` **(** :ref:`float` texture_rotation **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_rotation_degrees` **(** :ref:`float` texture_rotation **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_scale` **(** :ref:`Vector2` texture_scale **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv` **(** :ref:`PoolVector2Array` uv **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_colors` **(** :ref:`PoolColorArray` vertex_colors **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_texture_rotation` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_rotation` **(** :ref:`float` texture_rotation **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -133,152 +85,16 @@ A Polygon2D is defined by a set of points. Each point is connected to the next, Member Function Description --------------------------- -.. _class_Polygon2D_get_antialiased: - -- :ref:`bool` **get_antialiased** **(** **)** const - -.. _class_Polygon2D_get_color: - -- :ref:`Color` **get_color** **(** **)** const - -Return the polygon fill color. - -.. _class_Polygon2D_get_invert: - -- :ref:`bool` **get_invert** **(** **)** const - -Return whether this polygon is inverted or not. - -.. _class_Polygon2D_get_invert_border: - -- :ref:`float` **get_invert_border** **(** **)** const - -Return the added padding around the bounding box. - -.. _class_Polygon2D_get_offset: - -- :ref:`Vector2` **get_offset** **(** **)** const - -Return the offset for the polygon vertices. - -.. _class_Polygon2D_get_polygon: - -- :ref:`PoolVector2Array` **get_polygon** **(** **)** const - -Return the set of vertices that defines this polygon. - -.. _class_Polygon2D_get_texture: - -- :ref:`Texture` **get_texture** **(** **)** const - -Return the polygon texture - -.. _class_Polygon2D_get_texture_offset: - -- :ref:`Vector2` **get_texture_offset** **(** **)** const - -Return the polygon texture offset. - .. _class_Polygon2D_get_texture_rotation: - :ref:`float` **get_texture_rotation** **(** **)** const Return the rotation in radians of the texture polygon. -.. _class_Polygon2D_get_texture_rotation_degrees: - -- :ref:`float` **get_texture_rotation_degrees** **(** **)** const - -.. _class_Polygon2D_get_texture_scale: - -- :ref:`Vector2` **get_texture_scale** **(** **)** const - -Return the uv coordinate multiplier. - -.. _class_Polygon2D_get_uv: - -- :ref:`PoolVector2Array` **get_uv** **(** **)** const - -Return the texture coordinates associated with every vertex of the polygon. - -.. _class_Polygon2D_get_vertex_colors: - -- :ref:`PoolColorArray` **get_vertex_colors** **(** **)** const - -Return the list of vertex colors. - -.. _class_Polygon2D_set_antialiased: - -- void **set_antialiased** **(** :ref:`bool` antialiased **)** - -.. _class_Polygon2D_set_color: - -- void **set_color** **(** :ref:`Color` color **)** - -Set the polygon fill color. If the polygon has a texture defined, the defined texture will be multiplied by the polygon fill color. This, also, is the default color for those vertices that are not defined by :ref:`get_vertex_colors`. - -.. _class_Polygon2D_set_invert: - -- void **set_invert** **(** :ref:`bool` invert **)** - -Set the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on the square that contains the defined polygon). - -.. _class_Polygon2D_set_invert_border: - -- void **set_invert_border** **(** :ref:`float` invert_border **)** - -Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision. - -.. _class_Polygon2D_set_offset: - -- void **set_offset** **(** :ref:`Vector2` offset **)** - -Set the an offset that will be added to the vertices' position. E.g. if the offset is set to (10,10) then all the polygon points will move 10 units to the right and 10 units to the bottom. - -.. _class_Polygon2D_set_polygon: - -- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** - -Define the set of vertices that will represent the polygon. - -.. _class_Polygon2D_set_texture: - -- void **set_texture** **(** :ref:`Texture` texture **)** - -.. _class_Polygon2D_set_texture_offset: - -- void **set_texture_offset** **(** :ref:`Vector2` texture_offset **)** - -Set the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top. - .. _class_Polygon2D_set_texture_rotation: - void **set_texture_rotation** **(** :ref:`float` texture_rotation **)** Set the amount of rotation of the polygon texture, ``texture_rotation`` is specified in radians and clockwise rotation. -.. _class_Polygon2D_set_texture_rotation_degrees: - -- void **set_texture_rotation_degrees** **(** :ref:`float` texture_rotation **)** - -.. _class_Polygon2D_set_texture_scale: - -- void **set_texture_scale** **(** :ref:`Vector2` texture_scale **)** - -Set the value that will multiply the uv coordinates (:ref:`get_uv`) when applying the texture. Larger values make the texture smaller, and vice versa. - -.. _class_Polygon2D_set_uv: - -- void **set_uv** **(** :ref:`PoolVector2Array` uv **)** - -Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored. - -.. _class_Polygon2D_set_vertex_colors: - -- void **set_vertex_colors** **(** :ref:`PoolColorArray` vertex_colors **)** - -Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be :ref:`get_color`. Extra color entries are ignored. - -Colors are interpolated between vertices, resulting in smooth gradients when they differ. - diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 72e37f240..23edabe83 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -21,19 +21,15 @@ Base container control for popups and dialogs. Member Functions ---------------- -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_exclusive` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclusive` **(** :ref:`bool` enable **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++-------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -73,12 +69,6 @@ Popup is a base :ref:`Control` used to show dialogs and popups. I Member Function Description --------------------------- -.. _class_Popup_is_exclusive: - -- :ref:`bool` **is_exclusive** **(** **)** const - -Returns whether the popup will hide other popups when shown on the screen. - .. _class_Popup_popup: - void **popup** **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** @@ -103,10 +93,4 @@ Popup (show the control in modal form) in the center of the screen, ensuring the Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen. -.. _class_Popup_set_exclusive: - -- void **set_exclusive** **(** :ref:`bool` enable **)** - -Make the popup hide other popups when shown on the screen. - diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 5ca7f3b06..bfe41dd1c 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -62,10 +62,6 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_checkable_item_selection` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | @@ -76,10 +72,6 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_checkable_item_selection` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | @@ -263,18 +255,6 @@ Return the text of the item at index "idx". - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const -.. _class_PopupMenu_is_hide_on_checkable_item_selection: - -- :ref:`bool` **is_hide_on_checkable_item_selection** **(** **)** - -Returns a boolean that indicates whether or not the PopupMenu will hide on checkable item selection. - -.. _class_PopupMenu_is_hide_on_item_selection: - -- :ref:`bool` **is_hide_on_item_selection** **(** **)** - -Returns a boolean that indicates whether or not the PopupMenu will hide on item selection. - .. _class_PopupMenu_is_item_checkable: - :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const @@ -305,18 +285,6 @@ Return whether the item is a seperator. If it is, it would be displayed as a lin Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. -.. _class_PopupMenu_set_hide_on_checkable_item_selection: - -- void **set_hide_on_checkable_item_selection** **(** :ref:`bool` enable **)** - -Sets whether or not the PopupMenu will hide on checkable item selection. - -.. _class_PopupMenu_set_hide_on_item_selection: - -- void **set_hide_on_item_selection** **(** :ref:`bool` enable **)** - -Sets whether or not the PopupMenu will hide on item selection. - .. _class_PopupMenu_set_item_accelerator: - void **set_item_accelerator** **(** :ref:`int` idx, :ref:`int` accel **)** diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 2f3251b8f..5c28beda6 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -21,13 +21,9 @@ Base class for all primitive meshes. Handles applying a :ref:`Material` | :ref:`get_material` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------+ Member Variables ---------------- @@ -45,16 +41,8 @@ Base class for all primitive meshes. Handles applying a :ref:`Material` **get_material** **(** **)** const - .. _class_PrimitiveMesh_get_mesh_arrays: - :ref:`Array` **get_mesh_arrays** **(** **)** const -.. _class_PrimitiveMesh_set_material: - -- void **set_material** **(** :ref:`Material` material **)** - diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 46ce130b2..542451d1c 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -16,31 +16,6 @@ Brief Description Class representing a prism-shaped :ref:`PrimitiveMesh`. -Member Functions ----------------- - -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_left_to_right` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_height` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_left_to_right` **(** :ref:`float` left_to_right **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector3` size **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_depth` **(** :ref:`int` segments **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_height` **(** :ref:`int` segments **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_width` **(** :ref:`int` segments **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -70,47 +45,3 @@ Description Class representing a prism-shaped :ref:`PrimitiveMesh`. -Member Function Description ---------------------------- - -.. _class_PrismMesh_get_left_to_right: - -- :ref:`float` **get_left_to_right** **(** **)** const - -.. _class_PrismMesh_get_size: - -- :ref:`Vector3` **get_size** **(** **)** const - -.. _class_PrismMesh_get_subdivide_depth: - -- :ref:`int` **get_subdivide_depth** **(** **)** const - -.. _class_PrismMesh_get_subdivide_height: - -- :ref:`int` **get_subdivide_height** **(** **)** const - -.. _class_PrismMesh_get_subdivide_width: - -- :ref:`int` **get_subdivide_width** **(** **)** const - -.. _class_PrismMesh_set_left_to_right: - -- void **set_left_to_right** **(** :ref:`float` left_to_right **)** - -.. _class_PrismMesh_set_size: - -- void **set_size** **(** :ref:`Vector3` size **)** - -.. _class_PrismMesh_set_subdivide_depth: - -- void **set_subdivide_depth** **(** :ref:`int` segments **)** - -.. _class_PrismMesh_set_subdivide_height: - -- void **set_subdivide_height** **(** :ref:`int` segments **)** - -.. _class_PrismMesh_set_subdivide_width: - -- void **set_subdivide_width** **(** :ref:`int` segments **)** - - diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index 7030b163f..8a08c84f1 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -16,75 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ground_bottom_color` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ground_curve` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ground_energy` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ground_horizon_color` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sky_curve` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sky_energy` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_sky_horizon_color` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_sky_top_color` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_angle_max` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_angle_min` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_sun_color` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_curve` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_energy` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_latitude` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_longitude` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_size` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ground_bottom_color` **(** :ref:`Color` color **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ground_curve` **(** :ref:`float` curve **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ground_energy` **(** :ref:`float` energy **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ground_horizon_color` **(** :ref:`Color` color **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_curve` **(** :ref:`float` curve **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_energy` **(** :ref:`float` energy **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_horizon_color` **(** :ref:`Color` color **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_top_color` **(** :ref:`Color` color **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_angle_max` **(** :ref:`float` degrees **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_angle_min` **(** :ref:`float` degrees **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_color` **(** :ref:`Color` color **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_curve` **(** :ref:`float` curve **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_energy` **(** :ref:`float` energy **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_latitude` **(** :ref:`float` degrees **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_longitude` **(** :ref:`float` degrees **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_size` **(** :ref:`int` size **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -163,135 +94,3 @@ Numeric Constants - **TEXTURE_SIZE_4096** = **4** - **TEXTURE_SIZE_MAX** = **5** -Member Function Description ---------------------------- - -.. _class_ProceduralSky_get_ground_bottom_color: - -- :ref:`Color` **get_ground_bottom_color** **(** **)** const - -.. _class_ProceduralSky_get_ground_curve: - -- :ref:`float` **get_ground_curve** **(** **)** const - -.. _class_ProceduralSky_get_ground_energy: - -- :ref:`float` **get_ground_energy** **(** **)** const - -.. _class_ProceduralSky_get_ground_horizon_color: - -- :ref:`Color` **get_ground_horizon_color** **(** **)** const - -.. _class_ProceduralSky_get_sky_curve: - -- :ref:`float` **get_sky_curve** **(** **)** const - -.. _class_ProceduralSky_get_sky_energy: - -- :ref:`float` **get_sky_energy** **(** **)** const - -.. _class_ProceduralSky_get_sky_horizon_color: - -- :ref:`Color` **get_sky_horizon_color** **(** **)** const - -.. _class_ProceduralSky_get_sky_top_color: - -- :ref:`Color` **get_sky_top_color** **(** **)** const - -.. _class_ProceduralSky_get_sun_angle_max: - -- :ref:`float` **get_sun_angle_max** **(** **)** const - -.. _class_ProceduralSky_get_sun_angle_min: - -- :ref:`float` **get_sun_angle_min** **(** **)** const - -.. _class_ProceduralSky_get_sun_color: - -- :ref:`Color` **get_sun_color** **(** **)** const - -.. _class_ProceduralSky_get_sun_curve: - -- :ref:`float` **get_sun_curve** **(** **)** const - -.. _class_ProceduralSky_get_sun_energy: - -- :ref:`float` **get_sun_energy** **(** **)** const - -.. _class_ProceduralSky_get_sun_latitude: - -- :ref:`float` **get_sun_latitude** **(** **)** const - -.. _class_ProceduralSky_get_sun_longitude: - -- :ref:`float` **get_sun_longitude** **(** **)** const - -.. _class_ProceduralSky_get_texture_size: - -- :ref:`int` **get_texture_size** **(** **)** const - -.. _class_ProceduralSky_set_ground_bottom_color: - -- void **set_ground_bottom_color** **(** :ref:`Color` color **)** - -.. _class_ProceduralSky_set_ground_curve: - -- void **set_ground_curve** **(** :ref:`float` curve **)** - -.. _class_ProceduralSky_set_ground_energy: - -- void **set_ground_energy** **(** :ref:`float` energy **)** - -.. _class_ProceduralSky_set_ground_horizon_color: - -- void **set_ground_horizon_color** **(** :ref:`Color` color **)** - -.. _class_ProceduralSky_set_sky_curve: - -- void **set_sky_curve** **(** :ref:`float` curve **)** - -.. _class_ProceduralSky_set_sky_energy: - -- void **set_sky_energy** **(** :ref:`float` energy **)** - -.. _class_ProceduralSky_set_sky_horizon_color: - -- void **set_sky_horizon_color** **(** :ref:`Color` color **)** - -.. _class_ProceduralSky_set_sky_top_color: - -- void **set_sky_top_color** **(** :ref:`Color` color **)** - -.. _class_ProceduralSky_set_sun_angle_max: - -- void **set_sun_angle_max** **(** :ref:`float` degrees **)** - -.. _class_ProceduralSky_set_sun_angle_min: - -- void **set_sun_angle_min** **(** :ref:`float` degrees **)** - -.. _class_ProceduralSky_set_sun_color: - -- void **set_sun_color** **(** :ref:`Color` color **)** - -.. _class_ProceduralSky_set_sun_curve: - -- void **set_sun_curve** **(** :ref:`float` curve **)** - -.. _class_ProceduralSky_set_sun_energy: - -- void **set_sun_energy** **(** :ref:`float` energy **)** - -.. _class_ProceduralSky_set_sun_latitude: - -- void **set_sun_latitude** **(** :ref:`float` degrees **)** - -.. _class_ProceduralSky_set_sun_longitude: - -- void **set_sun_longitude** **(** :ref:`float` degrees **)** - -.. _class_ProceduralSky_set_texture_size: - -- void **set_texture_size** **(** :ref:`int` size **)** - - diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 8ae82d871..787a6ad65 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -16,15 +16,6 @@ Brief Description General purpose progress bar. -Member Functions ----------------- - -+--------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_percent_visible` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_percent_visible` **(** :ref:`bool` visible **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,15 +29,3 @@ Description General purpose progress bar. Shows fill percentage from right to left. -Member Function Description ---------------------------- - -.. _class_ProgressBar_is_percent_visible: - -- :ref:`bool` **is_percent_visible** **(** **)** const - -.. _class_ProgressBar_set_percent_visible: - -- void **set_percent_visible** **(** :ref:`bool` visible **)** - - diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index ff4a486c2..f0f90cc93 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -28,14 +28,10 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | @@ -67,7 +63,7 @@ Member Function Description - void **add_property_info** **(** :ref:`Dictionary` hint **)** -Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@Global Scope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string::ref:`String`. +Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. Example: @@ -100,10 +96,6 @@ Return the order of a configuration value (influences when saved to the config f - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const -.. _class_ProjectSettings_get_singleton: - -- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const - .. _class_ProjectSettings_globalize_path: - :ref:`String` **globalize_path** **(** :ref:`String` path **)** const @@ -116,10 +108,6 @@ Convert a localized path (res://) to a full native OS path. Return true if a configuration value is present. -.. _class_ProjectSettings_has_singleton: - -- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const - .. _class_ProjectSettings_load_resource_pack: - :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 98d7f46d7..9cb4c55bb 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -19,17 +19,13 @@ General purpose proximity-detection node. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`broadcast` **(** :ref:`String` name, :ref:`Variant` parameters **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_grid_radius` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dispatch_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_grid_radius` **(** :ref:`Vector3` radius **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group_name` **(** :ref:`String` name **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++-------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`broadcast` **(** :ref:`String` name, :ref:`Variant` parameters **)** | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dispatch_mode` **(** :ref:`int` mode **)** | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group_name` **(** :ref:`String` name **)** | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -59,18 +55,10 @@ Member Function Description - void **broadcast** **(** :ref:`String` name, :ref:`Variant` parameters **)** -.. _class_ProximityGroup_get_grid_radius: - -- :ref:`Vector3` **get_grid_radius** **(** **)** const - .. _class_ProximityGroup_set_dispatch_mode: - void **set_dispatch_mode** **(** :ref:`int` mode **)** -.. _class_ProximityGroup_set_grid_radius: - -- void **set_grid_radius** **(** :ref:`Vector3` radius **)** - .. _class_ProximityGroup_set_group_name: - void **set_group_name** **(** :ref:`String` name **)** diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index cfdf4787c..d6969cb6f 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -16,6 +16,14 @@ Brief Description Class representing a square mesh. +Member Variables +---------------- + + .. _class_QuadMesh_size: + +- :ref:`Vector2` **size** + + Description ----------- diff --git a/classes/class_range.rst b/classes/class_range.rst index 818bcaed5..85437ef0d 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -21,43 +21,15 @@ Abstract base class for range-based controls. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_as_ratio` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_min` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_page` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_value` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ratio_exp` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_rounded_values` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_ratio` **(** :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exp_ratio` **(** :ref:`bool` enabled **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max` **(** :ref:`float` maximum **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_min` **(** :ref:`float` minimum **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_page` **(** :ref:`float` pagesize **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_step` **(** :ref:`float` step **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_rounded_values` **(** :ref:`bool` enabled **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_value` **(** :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`share` **(** :ref:`Node` with **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unshare` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_as_ratio` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_ratio` **(** :ref:`float` value **)** | ++----------------------------+-------------------------------------------------------------------------------------------+ +| void | :ref:`share` **(** :ref:`Node` with **)** | ++----------------------------+-------------------------------------------------------------------------------------------+ +| void | :ref:`unshare` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------+ Signals ------- @@ -121,82 +93,12 @@ Member Function Description Return value mapped to 0 to 1 range. -.. _class_Range_get_max: - -- :ref:`float` **get_max** **(** **)** const - -Return the maximum value. - -.. _class_Range_get_min: - -- :ref:`float` **get_min** **(** **)** const - -Return the minimum value. - -.. _class_Range_get_page: - -- :ref:`float` **get_page** **(** **)** const - -Return the page size, if page is 0, paging is disabled. - -.. _class_Range_get_step: - -- :ref:`float` **get_step** **(** **)** const - -Return the stepping, if step is 0, stepping is disabled. - -.. _class_Range_get_value: - -- :ref:`float` **get_value** **(** **)** const - -.. _class_Range_is_ratio_exp: - -- :ref:`bool` **is_ratio_exp** **(** **)** const - -.. _class_Range_is_using_rounded_values: - -- :ref:`bool` **is_using_rounded_values** **(** **)** const - .. _class_Range_set_as_ratio: - void **set_as_ratio** **(** :ref:`float` value **)** Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. -.. _class_Range_set_exp_ratio: - -- void **set_exp_ratio** **(** :ref:`bool` enabled **)** - -.. _class_Range_set_max: - -- void **set_max** **(** :ref:`float` maximum **)** - -.. _class_Range_set_min: - -- void **set_min** **(** :ref:`float` minimum **)** - -Set minimum value, clamped range value to it if it's less. - -.. _class_Range_set_page: - -- void **set_page** **(** :ref:`float` pagesize **)** - -Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. - -.. _class_Range_set_step: - -- void **set_step** **(** :ref:`float` step **)** - -Set step value. If step is 0, stepping will be disabled. - -.. _class_Range_set_use_rounded_values: - -- void **set_use_rounded_values** **(** :ref:`bool` enabled **)** - -.. _class_Range_set_value: - -- void **set_value** **(** :ref:`float` value **)** - .. _class_Range_share: - void **share** **(** :ref:`Node` with **)** diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index f687a3ab1..219a55580 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -28,40 +28,24 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_raycast_update` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_cast_to` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_collider` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_collision_point` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_type_mask` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_colliding` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_exception` **(** :ref:`Object` node **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cast_to` **(** :ref:`Vector3` local_point **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -78,16 +62,6 @@ Member Variables - :ref:`bool` **enabled** - If ``true``, collisions will be reported. Default value: ``false``. - .. _class_RayCast_type_mask: - -- :ref:`int` **type_mask** - Object types to detect using a logical sum (OR operation) of type constants defined in :ref:`Physics2DDirectSpaceState`. - -Example: - -:: - - RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY - Description ----------- @@ -129,12 +103,6 @@ Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the ray or its parent has changed state. Note: ``enabled == true`` is not required for this to work. -.. _class_RayCast_get_cast_to: - -- :ref:`Vector3` **get_cast_to** **(** **)** const - -Return the destination point of this ray object. - .. _class_RayCast_get_collider: - :ref:`Object` **get_collider** **(** **)** const @@ -161,12 +129,6 @@ Example: if RayCast.is_colliding(): var shape = RayCast.get_collider_shape() -.. _class_RayCast_get_collision_mask: - -- :ref:`int` **get_collision_mask** **(** **)** const - -Returns the collision mask for this ray. - .. _class_RayCast_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const @@ -183,24 +145,12 @@ Returns the normal of the intersecting object's shape at the collision point. Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. -.. _class_RayCast_get_type_mask: - -- :ref:`int` **get_type_mask** **(** **)** const - -Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for :ref:`PhysicsDirectSpaceState`. - .. _class_RayCast_is_colliding: - :ref:`bool` **is_colliding** **(** **)** const Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). -.. _class_RayCast_is_enabled: - -- :ref:`bool` **is_enabled** **(** **)** const - -Returns whether the ray is enabled or not. - .. _class_RayCast_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** @@ -213,32 +163,8 @@ Removes a collision exception so the ray does report collisions with the specifi Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. -.. _class_RayCast_set_cast_to: - -- void **set_cast_to** **(** :ref:`Vector3` local_point **)** - -Sets the ray destination point, so that the ray will test from the ray's origin to ``local_point``. - -.. _class_RayCast_set_collision_mask: - -- void **set_collision_mask** **(** :ref:`int` mask **)** - -Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. - .. _class_RayCast_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_RayCast_set_enabled: - -- void **set_enabled** **(** :ref:`bool` enabled **)** - -Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. - -.. _class_RayCast_set_type_mask: - -- void **set_type_mask** **(** :ref:`int` mask **)** - -Set the types of objects to detect. For ``mask`` use a logic sum (OR operation) of constants defined in :ref:`PhysicsDirectSpaceState`, eg. ``PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY`` to detect only those two types. - diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 8dfb74882..27879fac7 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -28,44 +28,24 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_raycast_update` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_cast_to` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_collider` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_exclude_parent_body` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_type_mask` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_colliding` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_exception` **(** :ref:`Object` node **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cast_to` **(** :ref:`Vector2` local_point **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude_parent_body` **(** :ref:`bool` mask **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -86,16 +66,6 @@ Member Variables - :ref:`bool` **exclude_parent** - If ``true``, the parent node will be excluded from collision detection. Default value: ``true``. - .. _class_RayCast2D_type_mask: - -- :ref:`int` **type_mask** - Object types to detect using a logical sum (OR operation) of type constants defined in :ref:`Physics2DDirectSpaceState`. - -Example: - -:: - - RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY - Description ----------- @@ -135,12 +105,6 @@ Removes all collision exceptions for this ray. Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the ray or its parent has changed state. Note: ``enabled == true`` is not required for this to work. -.. _class_RayCast2D_get_cast_to: - -- :ref:`Vector2` **get_cast_to** **(** **)** const - -Return the destination point of this ray object. - .. _class_RayCast2D_get_collider: - :ref:`Object` **get_collider** **(** **)** const @@ -167,12 +131,6 @@ Example: if RayCast2D.is_colliding(): var shape = RayCast2D.get_collider_shape() -.. _class_RayCast2D_get_collision_mask: - -- :ref:`int` **get_collision_mask** **(** **)** const - -Returns the collision mask for this ray. - .. _class_RayCast2D_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const @@ -189,30 +147,12 @@ Returns the normal of the intersecting object's shape at the collision point. Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. -.. _class_RayCast2D_get_exclude_parent_body: - -- :ref:`bool` **get_exclude_parent_body** **(** **)** const - -Returns whether this ray should hit your parent node, if it's a body. - -.. _class_RayCast2D_get_type_mask: - -- :ref:`int` **get_type_mask** **(** **)** const - -Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for :ref:`Physics2DDirectSpaceState`. - .. _class_RayCast2D_is_colliding: - :ref:`bool` **is_colliding** **(** **)** const Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). -.. _class_RayCast2D_is_enabled: - -- :ref:`bool` **is_enabled** **(** **)** const - -Returns whether this raycast is enabled or not. - .. _class_RayCast2D_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** @@ -225,38 +165,8 @@ Removes a collision exception so the ray does report collisions with the specifi Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. -.. _class_RayCast2D_set_cast_to: - -- void **set_cast_to** **(** :ref:`Vector2` local_point **)** - -Sets the ray destination point, so that the ray will test from the ray's origin to ``local_point`` - -.. _class_RayCast2D_set_collision_mask: - -- void **set_collision_mask** **(** :ref:`int` mask **)** - -Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. - .. _class_RayCast2D_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_RayCast2D_set_enabled: - -- void **set_enabled** **(** :ref:`bool` enabled **)** - -Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. - -.. _class_RayCast2D_set_exclude_parent_body: - -- void **set_exclude_parent_body** **(** :ref:`bool` mask **)** - -Toggle whether this ray should hit your parent node, if it's a body. - -.. _class_RayCast2D_set_type_mask: - -- void **set_type_mask** **(** :ref:`int` mask **)** - -Set the types of objects to detect. For ``mask`` use a logic sum (OR operation) of constants defined in :ref:`Physics2DDirectSpaceState`, eg. ``Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY`` to detect only those two types. - diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 935093016..4418e7aad 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -16,15 +16,6 @@ Brief Description Ray shape for 3D collisions. -Member Functions ----------------- - -+----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` length **)** | -+----------------------------+-------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,15 +29,3 @@ Description Ray shape for 3D collisions, which can be set into a :ref:`PhysicsBody` or :ref:`Area`. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. -Member Function Description ---------------------------- - -.. _class_RayShape_get_length: - -- :ref:`float` **get_length** **(** **)** const - -.. _class_RayShape_set_length: - -- void **set_length** **(** :ref:`float` length **)** - - diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index ad7a3417d..1826ce9ab 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -16,15 +16,6 @@ Brief Description Ray shape for 2D collisions. -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description Ray shape for 2D collisions. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. -Member Function Description ---------------------------- - -.. _class_RayShape2D_get_length: - -- :ref:`float` **get_length** **(** **)** const - -Return the length of the ray. - -.. _class_RayShape2D_set_length: - -- void **set_length** **(** :ref:`float` length **)** - -Set the length of the ray. - - diff --git a/classes/class_rect3.rst b/classes/class_rect3.rst deleted file mode 100644 index 809f382bd..000000000 --- a/classes/class_rect3.rst +++ /dev/null @@ -1,214 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the Rect3.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_Rect3: - -Rect3 -===== - -**Category:** Built-In Types - -Brief Description ------------------ - -Axis-Aligned Bounding Box. - -Member Functions ----------------- - -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`Rect3` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect3` with **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_area` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`grow` **(** :ref:`float` by **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_area` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_surface` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`intersection` **(** :ref:`Rect3` with **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect3` with **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`merge` **(** :ref:`Rect3` with **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - - .. _class_Rect3_end: - -- :ref:`Vector3` **end** - Ending corner. - - .. _class_Rect3_position: - -- :ref:`Vector3` **position** - Beginning corner. - - .. _class_Rect3_size: - -- :ref:`Vector3` **size** - Size from position to end. - - -Description ------------ - -Rect3 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. - -Member Function Description ---------------------------- - -.. _class_Rect3_Rect3: - -- :ref:`Rect3` **Rect3** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** - -Optional constructor, accepts position and size. - -.. _class_Rect3_encloses: - -- :ref:`bool` **encloses** **(** :ref:`Rect3` with **)** - -Returns ``true`` if this ``Rect3`` completely encloses another one. - -.. _class_Rect3_expand: - -- :ref:`Rect3` **expand** **(** :ref:`Vector3` to_point **)** - -Returns this ``Rect3`` expanded to include a given point. - -.. _class_Rect3_get_area: - -- :ref:`float` **get_area** **(** **)** - -Gets the area of the ``Rect3``. - -.. _class_Rect3_get_endpoint: - -- :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** - -Gets the position of the 8 endpoints of the ``Rect3`` in space. - -.. _class_Rect3_get_longest_axis: - -- :ref:`Vector3` **get_longest_axis** **(** **)** - -Returns the normalized longest axis of the ``Rect3``. - -.. _class_Rect3_get_longest_axis_index: - -- :ref:`int` **get_longest_axis_index** **(** **)** - -Returns the index of the longest axis of the ``Rect3`` (according to :ref:`Vector3`::AXIS\* enum). - -.. _class_Rect3_get_longest_axis_size: - -- :ref:`float` **get_longest_axis_size** **(** **)** - -Returns the scalar length of the longest axis of the ``Rect3``. - -.. _class_Rect3_get_shortest_axis: - -- :ref:`Vector3` **get_shortest_axis** **(** **)** - -Returns the normalized shortest axis of the ``Rect3``. - -.. _class_Rect3_get_shortest_axis_index: - -- :ref:`int` **get_shortest_axis_index** **(** **)** - -Returns the index of the shortest axis of the ``Rect3`` (according to :ref:`Vector3`::AXIS\* enum). - -.. _class_Rect3_get_shortest_axis_size: - -- :ref:`float` **get_shortest_axis_size** **(** **)** - -Returns the scalar length of the shortest axis of the ``Rect3``. - -.. _class_Rect3_get_support: - -- :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** - -Returns the support point in a given direction. This is useful for collision detection algorithms. - -.. _class_Rect3_grow: - -- :ref:`Rect3` **grow** **(** :ref:`float` by **)** - -Returns a copy of the ``Rect3`` grown a given amount of units towards all the sides. - -.. _class_Rect3_has_no_area: - -- :ref:`bool` **has_no_area** **(** **)** - -Returns ``true`` if the ``Rect3`` is flat or empty. - -.. _class_Rect3_has_no_surface: - -- :ref:`bool` **has_no_surface** **(** **)** - -Returns ``true`` if the ``Rect3`` is empty. - -.. _class_Rect3_has_point: - -- :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** - -Returns ``true`` if the ``Rect3`` contains a point. - -.. _class_Rect3_intersection: - -- :ref:`Rect3` **intersection** **(** :ref:`Rect3` with **)** - -Returns the intersection between two ``Rect3``. An empty Rect3 (size 0,0,0) is returned on failure. - -.. _class_Rect3_intersects: - -- :ref:`bool` **intersects** **(** :ref:`Rect3` with **)** - -Returns ``true`` if the ``Rect3`` overlaps with another. - -.. _class_Rect3_intersects_plane: - -- :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** - -Returns ``true`` if the ``Rect3`` is on both sides of a plane. - -.. _class_Rect3_intersects_segment: - -- :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** - -Returns ``true`` if the ``Rect3`` intersects the line segment between ``from`` and ``to``. - -.. _class_Rect3_merge: - -- :ref:`Rect3` **merge** **(** :ref:`Rect3` with **)** - -Returns a larger Rect3 that contains this Rect3 and ``with``. - - diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index de22c759a..2018982d6 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -16,15 +16,6 @@ Brief Description Rectangle shape for 2D collisions. -Member Functions ----------------- - -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_extents` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extents` **(** :ref:`Vector2` extents **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D objects. -Member Function Description ---------------------------- - -.. _class_RectangleShape2D_get_extents: - -- :ref:`Vector2` **get_extents** **(** **)** const - -Return the half extents, the actual width and height of this shape is twice the half extents. - -.. _class_RectangleShape2D_set_extents: - -- void **set_extents** **(** :ref:`Vector2` extents **)** - -Set the half extents, the actual width and height of this shape is twice the half extents. - - diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 5fa359152..214bace01 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -9,7 +9,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`GDFunctionState`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`RegEx`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`EditorScenePostImport`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`SceneState`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 317febcb8..57325d317 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -16,59 +16,6 @@ Brief Description -Member Functions ----------------- - -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_shadows_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_intensity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_interior_ambient` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_interior_ambient_energy` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_interior_ambient_probe_contribution` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_distance` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_origin_offset` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_update_mode` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_box_projection_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_interior` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_interior` **(** :ref:`bool` enable **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mask` **(** :ref:`int` layers **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_box_projection` **(** :ref:`bool` enable **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_shadows` **(** :ref:`bool` enable **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_intensity` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior_ambient` **(** :ref:`Color` ambient **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior_ambient_energy` **(** :ref:`float` ambient_energy **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior_ambient_probe_contribution` **(** :ref:`float` ambient_probe_contribution **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_distance` **(** :ref:`float` max_distance **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_origin_offset` **(** :ref:`Vector3` origin_offset **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -127,103 +74,3 @@ Numeric Constants - **UPDATE_ONCE** = **0** - **UPDATE_ALWAYS** = **1** -Member Function Description ---------------------------- - -.. _class_ReflectionProbe_are_shadows_enabled: - -- :ref:`bool` **are_shadows_enabled** **(** **)** const - -.. _class_ReflectionProbe_get_cull_mask: - -- :ref:`int` **get_cull_mask** **(** **)** const - -.. _class_ReflectionProbe_get_extents: - -- :ref:`Vector3` **get_extents** **(** **)** const - -.. _class_ReflectionProbe_get_intensity: - -- :ref:`float` **get_intensity** **(** **)** const - -.. _class_ReflectionProbe_get_interior_ambient: - -- :ref:`Color` **get_interior_ambient** **(** **)** const - -.. _class_ReflectionProbe_get_interior_ambient_energy: - -- :ref:`float` **get_interior_ambient_energy** **(** **)** const - -.. _class_ReflectionProbe_get_interior_ambient_probe_contribution: - -- :ref:`float` **get_interior_ambient_probe_contribution** **(** **)** const - -.. _class_ReflectionProbe_get_max_distance: - -- :ref:`float` **get_max_distance** **(** **)** const - -.. _class_ReflectionProbe_get_origin_offset: - -- :ref:`Vector3` **get_origin_offset** **(** **)** const - -.. _class_ReflectionProbe_get_update_mode: - -- :ref:`int` **get_update_mode** **(** **)** const - -.. _class_ReflectionProbe_is_box_projection_enabled: - -- :ref:`bool` **is_box_projection_enabled** **(** **)** const - -.. _class_ReflectionProbe_is_set_as_interior: - -- :ref:`bool` **is_set_as_interior** **(** **)** const - -.. _class_ReflectionProbe_set_as_interior: - -- void **set_as_interior** **(** :ref:`bool` enable **)** - -.. _class_ReflectionProbe_set_cull_mask: - -- void **set_cull_mask** **(** :ref:`int` layers **)** - -.. _class_ReflectionProbe_set_enable_box_projection: - -- void **set_enable_box_projection** **(** :ref:`bool` enable **)** - -.. _class_ReflectionProbe_set_enable_shadows: - -- void **set_enable_shadows** **(** :ref:`bool` enable **)** - -.. _class_ReflectionProbe_set_extents: - -- void **set_extents** **(** :ref:`Vector3` extents **)** - -.. _class_ReflectionProbe_set_intensity: - -- void **set_intensity** **(** :ref:`float` intensity **)** - -.. _class_ReflectionProbe_set_interior_ambient: - -- void **set_interior_ambient** **(** :ref:`Color` ambient **)** - -.. _class_ReflectionProbe_set_interior_ambient_energy: - -- void **set_interior_ambient_energy** **(** :ref:`float` ambient_energy **)** - -.. _class_ReflectionProbe_set_interior_ambient_probe_contribution: - -- void **set_interior_ambient_probe_contribution** **(** :ref:`float` ambient_probe_contribution **)** - -.. _class_ReflectionProbe_set_max_distance: - -- void **set_max_distance** **(** :ref:`float` max_distance **)** - -.. _class_ReflectionProbe_set_origin_offset: - -- void **set_origin_offset** **(** :ref:`Vector3` origin_offset **)** - -.. _class_ReflectionProbe_set_update_mode: - -- void **set_update_mode** **(** :ref:`int` mode **)** - - diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 258d362d5..535e251a2 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -14,7 +14,7 @@ RegEx Brief Description ----------------- -Simple regular expression matcher. +Class for searching text for patterns using regular expressions. Member Functions ---------------- @@ -34,59 +34,55 @@ Member Functions +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`search_all` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`sub` **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Class for finding text patterns in a string using regular expressions. It can not perform replacements. Regular expressions are a way to define patterns of text to be searched. Details on writing patterns are too long to explain here but the Internet is full of tutorials and detailed explanations. +Regular Expression (or regex) is a compact programming language that can be used to recognise strings that follow a specific pattern, such as URLs, email addresses, complete sentences, etc. For instance, a regex of ``ab[0-9]`` would find any string that is ``ab`` followed by any number from ``0`` to ``9``. For a more in-depth look, you can easily find various tutorials and detailed explainations on the Internet. -Once created, the RegEx object needs to be compiled with the search pattern before it can be used. The search pattern must be escaped first for gdscript before it is escaped for the expression. For example: +To begin, the RegEx object needs to be compiled with the search pattern using :ref:`compile` before it can be used. -``var exp = RegEx.new()`` +:: -``exp.compile("\\d+")`` + var regex = RegEx.new() + regex.compile("\\w-(\\d+)") -would be read by RegEx as ``\d+`` +The search pattern must be escaped first for gdscript before it is escaped for the expression. For example, ``compile("\\d+")`` would be read by RegEx as ``\d+``. Similarly, ``compile("\"(?:\\\\.|[^\"])\*\"")`` would be read as ``"(?:\\.|[^"])\*"`` -Similarly: +Using :ref:`search` you can find the pattern within the given text. If a pattern is found, :ref:`RegExMatch` is returned and you can retrieve details of the results using fuctions such as :ref:`RegExMatch.get_string` and :ref:`RegExMatch.get_start`. -``exp.compile("\"(?:\\\\.|[^\"])\*\"")`` +:: -would be read as ``"(?:\\.|[^"])\*"`` + var regex = RegEx.new() + regex.compile("\\w-(\\d+)") + var result = regex.search("abc n-0123") + if result: + print(result.get_string()) # Would print n-0123 -Currently supported features: +The results of capturing groups ``()`` can be retrieved by passing the group number to the various functions in :ref:`RegExMatch`. Group 0 is the default and would always refer to the entire pattern. In the above example, calling ``result.get_string(1)`` would give you ``0123``. -\* Capturing ``()`` and non-capturing ``(?:)`` groups +This version of RegEx also supports named capturing groups, and the names can be used to retrieve the results. If two or more groups have the same name, the name would only refer to the first one with a match. -\* Named capturing groups ``(?P)`` +:: -\* Any character ``.`` + var regex = RegEx.new() + regex.compile("d(?[0-9]+)|x(?[0-9a-f]+)") + var result = regex.search("the number is x2f") + if result: + print(result.get_string("digit")) # Would print 2f -\* Shorthand character classes ``\w \W \s \S \d \D`` +If you need to process multiple results, :ref:`search_all` generates a list of all non-overlapping results. This can be combined with a for-loop for convenience. -\* User-defined character classes such as ``[A-Za-z]`` +:: -\* Simple quantifiers ``?``, ``\*`` and ``+`` - -\* Range quantifiers ``{x,y}`` - -\* Lazy (non-greedy) quantifiers ``\*?`` - -\* Beginning ``^`` and end ``$`` anchors - -\* Alternation ``|`` - -\* Backreferences ``\1``, ``\g{1}``, and ``\g`` - -\* POSIX character classes ``[[:alnum:]]`` - -\* Lookahead ``(?=)``, ``(?!)`` and lookbehind ``(?<=)``, ``(?` **compile** **(** :ref:`String` pattern **)** -Compiles and assign the search pattern to use. +Compiles and assign the search pattern to use. Returns OK if the compilation is successful. If an error is encountered the details are printed to STDOUT and FAILED is returned. .. _class_RegEx_get_group_count: - :ref:`int` **get_group_count** **(** **)** const -Returns the number of numeric capturing groups. +Returns the number of capturing groups in compiled pattern. .. _class_RegEx_get_names: - :ref:`Array` **get_names** **(** **)** const -Returns an array of names of named capturing groups. +Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. .. _class_RegEx_get_pattern: - :ref:`String` **get_pattern** **(** **)** const -Returns the search pattern used to compile the code. +Returns the original search pattern that was compiled. .. _class_RegEx_is_valid: @@ -133,6 +129,12 @@ Returns whether this object has a valid search pattern assigned. Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` container of the first matching result if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. +.. _class_RegEx_search_all: + +- :ref:`Array` **search_all** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const + +Searches the text for the compiled pattern. Returns an array of :ref:`RegExMatch` containers for each non-overlapping result. If no results were found an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. + .. _class_RegEx_sub: - :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 4ec080395..cb6615ae0 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -38,7 +38,7 @@ Member Functions Description ----------- -Contains the results of a regex search. :ref:`RegEx.search` returns an instance of ``RegExMatch`` if it finds the search pattern in the source string. +Contains the results of a single regex match returned by :ref:`RegEx.search` and :ref:`RegEx.search_all`. It can be used to find the position and range of the match and its capturing groups, and it can extract its sub-string for you. Member Function Description --------------------------- @@ -47,37 +47,43 @@ Member Function Description - :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const -Returns the end position of the match in the source string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). +Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. + +Returns -1 if the group did not match or doesn't exist. .. _class_RegExMatch_get_group_count: - :ref:`int` **get_group_count** **(** **)** const -Returns the number of numeric capturing groups. +Returns the number of capturing groups. .. _class_RegExMatch_get_names: - :ref:`Dictionary` **get_names** **(** **)** const -Returns an array of names of named capturing groups. +Returns a dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. .. _class_RegExMatch_get_start: - :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const -Returns the starting position of the match in the source string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). +Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. + +Returns -1 if the group did not match or doesn't exist. .. _class_RegExMatch_get_string: - :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const -Returns the result of the match in the source string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). +Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. + +Returns an empty string if the group did not match or doesn't exist. .. _class_RegExMatch_get_strings: - :ref:`Array` **get_strings** **(** **)** const -Returns an :ref:`Array` of the matches in the source string. +Returns an :ref:`Array` of the match and its capturing groups. .. _class_RegExMatch_get_subject: diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index e74ae1ace..e63ff0a30 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -14,51 +14,26 @@ RemoteTransform Brief Description ----------------- -RemoteTransform mirrors the :ref:`Transform` of another :ref:`Spatial` derived Node in the scene. - -Member Functions ----------------- - -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_position` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_rotation` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_scale` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_global_coordinates` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_position` **(** :ref:`bool` update_remote_position **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_rotation` **(** :ref:`bool` update_remote_rotation **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_scale` **(** :ref:`bool` update_remote_scale **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_global_coordinates` **(** :ref:`bool` use_global_coordinates **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +RemoteTransform leads the :ref:`Transform` of another :ref:`Spatial` derived Node in the scene. Member Variables ---------------- .. _class_RemoteTransform_remote_path: -- :ref:`NodePath` **remote_path** - The remote node's :ref:`NodePath`. +- :ref:`NodePath` **remote_path** - The :ref:`NodePath` to the remote node, relative to the RemoteTransform's position in the scene. .. _class_RemoteTransform_update_position: -- :ref:`bool` **update_position** - If ``true`` the remote node's position is mirrored. +- :ref:`bool` **update_position** - If ``true`` the remote node's position is tracked. Default value: ``true``. .. _class_RemoteTransform_update_rotation: -- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is mirrored. +- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is tracked. Default value: ``true``. .. _class_RemoteTransform_update_scale: -- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is mirrored. +- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is tracked. Default value: ``true``. .. _class_RemoteTransform_use_global_coordinates: @@ -68,51 +43,7 @@ Member Variables Description ----------- -RemoteTransform mirrors the :ref:`Transform` of another :ref:`Spatial` derived Node (called the remote node) in the scene. - -It can be set to track another Node's position, rotation and/or scale and update its own accordingly, using either global or local coordinates. - -Member Function Description ---------------------------- - -.. _class_RemoteTransform_get_remote_node: - -- :ref:`NodePath` **get_remote_node** **(** **)** const - -.. _class_RemoteTransform_get_update_position: - -- :ref:`bool` **get_update_position** **(** **)** const - -.. _class_RemoteTransform_get_update_rotation: - -- :ref:`bool` **get_update_rotation** **(** **)** const - -.. _class_RemoteTransform_get_update_scale: - -- :ref:`bool` **get_update_scale** **(** **)** const - -.. _class_RemoteTransform_get_use_global_coordinates: - -- :ref:`bool` **get_use_global_coordinates** **(** **)** const - -.. _class_RemoteTransform_set_remote_node: - -- void **set_remote_node** **(** :ref:`NodePath` path **)** - -.. _class_RemoteTransform_set_update_position: - -- void **set_update_position** **(** :ref:`bool` update_remote_position **)** - -.. _class_RemoteTransform_set_update_rotation: - -- void **set_update_rotation** **(** :ref:`bool` update_remote_rotation **)** - -.. _class_RemoteTransform_set_update_scale: - -- void **set_update_scale** **(** :ref:`bool` update_remote_scale **)** - -.. _class_RemoteTransform_set_use_global_coordinates: - -- void **set_use_global_coordinates** **(** :ref:`bool` use_global_coordinates **)** +RemoteTransform leads the :ref:`Transform` of another :ref:`Spatial` derived Node (called the remote node) in the scene. +It can be set to track another Node's position, rotation and/or scale. It can update using either global or local coordinates. diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 691dd0282..52879abcd 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -14,51 +14,26 @@ RemoteTransform2D Brief Description ----------------- -RemoteTransform2D mirrors the :ref:`Transform2D` of another :ref:`CanvasItem` derived Node in the scene. - -Member Functions ----------------- - -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_position` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_rotation` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_scale` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_global_coordinates` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_position` **(** :ref:`bool` update_remote_position **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_rotation` **(** :ref:`bool` update_remote_rotation **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_scale` **(** :ref:`bool` update_remote_scale **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_global_coordinates` **(** :ref:`bool` use_global_coordinates **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +RemoteTransform2D leads the :ref:`Transform2D` of another :ref:`CanvasItem` derived Node in the scene. Member Variables ---------------- .. _class_RemoteTransform2D_remote_path: -- :ref:`NodePath` **remote_path** - The remote node's :ref:`NodePath`. +- :ref:`NodePath` **remote_path** - The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. .. _class_RemoteTransform2D_update_position: -- :ref:`bool` **update_position** - If ``true`` the remote node's position is mirrored. +- :ref:`bool` **update_position** - If ``true`` the remote node's position is tracked. Default value: ``true``. .. _class_RemoteTransform2D_update_rotation: -- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is mirrored. +- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is tracked. Default value: ``true``. .. _class_RemoteTransform2D_update_scale: -- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is mirrored. +- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is tracked. Default value: ``true``. .. _class_RemoteTransform2D_use_global_coordinates: @@ -68,51 +43,7 @@ Member Variables Description ----------- -RemoteTransform2D mirrors the :ref:`Transform2D` of another :ref:`CanvasItem` derived Node (called the remote node) in the scene. - -It can be set to track another Node's position, rotation and/or and update its own accordingly, using either global or local coordinates. - -Member Function Description ---------------------------- - -.. _class_RemoteTransform2D_get_remote_node: - -- :ref:`NodePath` **get_remote_node** **(** **)** const - -.. _class_RemoteTransform2D_get_update_position: - -- :ref:`bool` **get_update_position** **(** **)** const - -.. _class_RemoteTransform2D_get_update_rotation: - -- :ref:`bool` **get_update_rotation** **(** **)** const - -.. _class_RemoteTransform2D_get_update_scale: - -- :ref:`bool` **get_update_scale** **(** **)** const - -.. _class_RemoteTransform2D_get_use_global_coordinates: - -- :ref:`bool` **get_use_global_coordinates** **(** **)** const - -.. _class_RemoteTransform2D_set_remote_node: - -- void **set_remote_node** **(** :ref:`NodePath` path **)** - -.. _class_RemoteTransform2D_set_update_position: - -- void **set_update_position** **(** :ref:`bool` update_remote_position **)** - -.. _class_RemoteTransform2D_set_update_rotation: - -- void **set_update_rotation** **(** :ref:`bool` update_remote_rotation **)** - -.. _class_RemoteTransform2D_set_update_scale: - -- void **set_update_scale** **(** :ref:`bool` update_remote_scale **)** - -.. _class_RemoteTransform2D_set_use_global_coordinates: - -- void **set_use_global_coordinates** **(** :ref:`bool` use_global_coordinates **)** +RemoteTransform2D leads the :ref:`Transform2D` of another :ref:`CanvasItem` derived Node (called the remote node) in the scene. +It can be set to track another Node's position, rotation and/or scale. It can update using either global or local coordinates. diff --git a/classes/class_resource.rst b/classes/class_resource.rst index b1ecfdc4d..aa441d0c0 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -9,7 +9,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`StyleBox`, :ref:`Environment`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`StyleBox`, :ref:`Environment`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core @@ -28,20 +28,8 @@ Member Functions +----------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_local_scene` **(** **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_to_scene` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_local_to_scene` **(** :ref:`bool` enable **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_name` **(** :ref:`String` name **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_path` **(** :ref:`String` path **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------+ | void | :ref:`setup_local_to_scene` **(** **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------+ | void | :ref:`take_over_path` **(** :ref:`String` path **)** | @@ -91,44 +79,12 @@ Member Function Description - :ref:`Node` **get_local_scene** **(** **)** const -.. _class_Resource_get_name: - -- :ref:`String` **get_name** **(** **)** const - -Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. - -.. _class_Resource_get_path: - -- :ref:`String` **get_path** **(** **)** const - -Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. - .. _class_Resource_get_rid: - :ref:`RID` **get_rid** **(** **)** const Return the RID of the resource (or an empty RID). Many resources (such as :ref:`Texture`, :ref:`Mesh`, etc) are high level abstractions of resources stored in a server, so this function will return the original RID. -.. _class_Resource_is_local_to_scene: - -- :ref:`bool` **is_local_to_scene** **(** **)** const - -.. _class_Resource_set_local_to_scene: - -- void **set_local_to_scene** **(** :ref:`bool` enable **)** - -.. _class_Resource_set_name: - -- void **set_name** **(** :ref:`String` name **)** - -Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. - -.. _class_Resource_set_path: - -- void **set_path** **(** :ref:`String` path **)** - -Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another ``Resource`` already has path "path". - .. _class_Resource_setup_local_to_scene: - void **setup_local_to_scene** **(** **)** diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index 6505477ab..df414a90b 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -9,7 +9,7 @@ ResourceImporter **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`ResourceImporterOGGVorbis` +**Inherited By:** :ref:`ResourceImporterTheora`, :ref:`ResourceImporterOGGVorbis`, :ref:`ResourceImporterWebm` **Category:** Core diff --git a/classes/class_resourceimportertheora.rst b/classes/class_resourceimportertheora.rst new file mode 100644 index 000000000..a3ead509e --- /dev/null +++ b/classes/class_resourceimportertheora.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceImporterTheora.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceImporterTheora: + +ResourceImporterTheora +====================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceimporterwebm.rst b/classes/class_resourceimporterwebm.rst new file mode 100644 index 000000000..48e74f882 --- /dev/null +++ b/classes/class_resourceimporterwebm.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceImporterWebm.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceImporterWebm: + +ResourceImporterWebm +==================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 9d51007b1..07617ed8e 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -28,12 +28,8 @@ Member Functions +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bbcode` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_line_count` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_percent_visible` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_size` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_text` **(** **)** | @@ -42,22 +38,16 @@ Member Functions +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_characters` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_meta_underlined` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overriding_selected_font_color` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_scroll_active` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_scroll_following` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selection_enabled` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_bbcode` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`newline` **(** **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | @@ -86,14 +76,8 @@ Member Functions +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bbcode` **(** :ref:`String` text **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_meta_underline` **(** :ref:`bool` enable **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_override_selected_font_color` **(** :ref:`bool` override **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_percent_visible` **(** :ref:`float` percent_visible **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_scroll_active` **(** :ref:`bool` active **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_scroll_follow` **(** :ref:`bool` follow **)** | @@ -106,10 +90,6 @@ Member Functions +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_text` **(** :ref:`String` text **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_bbcode` **(** :ref:`bool` enable **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -118,6 +98,20 @@ Signals - **meta_clicked** **(** :ref:`Nil` meta **)** +Triggered when the user clicks on content between url tags. If the meta is defined in text, e.g. ``[url={"data"="hi"}]hi[/url]``, then the parameter for this signal will be a :ref:`String` type. If a particular type or an object is desired, the :ref:`push_meta` method must be used to manually insert the data into the tag stack. + +.. _class_RichTextLabel_meta_hover_ended: + +- **meta_hover_ended** **(** :ref:`Nil` meta **)** + +Triggers when the mouse exits a meta tag. + +.. _class_RichTextLabel_meta_hover_started: + +- **meta_hover_started** **(** :ref:`Nil` meta **)** + +Triggers when the mouse enters a meta tag. + Member Variables ---------------- @@ -128,7 +122,7 @@ Member Variables .. _class_RichTextLabel_bbcode_text: -- :ref:`String` **bbcode_text** - The label's text in BBCode format. +- :ref:`String` **bbcode_text** - The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. .. _class_RichTextLabel_override_selected_font_color: @@ -169,7 +163,9 @@ Numeric Constants Description ----------- -Label that displays rich text. Rich text can contain custom text, fonts, images and some basic formatting. It also adapts itself to given width/heights. +Rich text can contain custom text, fonts, images and some basic formatting. The label manages these as an internal tag stack. It also adapts itself to given width/heights. + +Note that assignments to :ref:`bbcode_text` clear the tag stack and reconstruct it from the property's contents. Any edits made to :ref:`bbcode_text` will erase previous edits made from other manual sources such as :ref:`append_bbcode` and the ``push\_\*`` / :ref:`pop` methods. Member Function Description --------------------------- @@ -178,61 +174,55 @@ Member Function Description - void **add_image** **(** :ref:`Texture` image **)** +Adds an image's opening and closing tags to the tag stack. + .. _class_RichTextLabel_add_text: - void **add_text** **(** :ref:`String` text **)** +Adds raw non-bbcode-parsed text to the tag stack. + .. _class_RichTextLabel_append_bbcode: - :ref:`int` **append_bbcode** **(** :ref:`String` bbcode **)** +Parses ``bbcode`` and adds tags to the tag stack as needed. Returns the result of the parsing, ``OK`` if successful. + .. _class_RichTextLabel_clear: - void **clear** **(** **)** -Clears the label's text. - -.. _class_RichTextLabel_get_bbcode: - -- :ref:`String` **get_bbcode** **(** **)** const - -Returns label's BBCode. +Clears the tag stack and sets :ref:`bbcode_text` to an empty string. .. _class_RichTextLabel_get_line_count: - :ref:`int` **get_line_count** **(** **)** const -Returns the number of lines in the text. - -.. _class_RichTextLabel_get_percent_visible: - -- :ref:`float` **get_percent_visible** **(** **)** const - -Returns the text's visibility as a floating point value between 0.0 and 1.0. +Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line. .. _class_RichTextLabel_get_tab_size: - :ref:`int` **get_tab_size** **(** **)** const +Returns the number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags. + .. _class_RichTextLabel_get_text: - :ref:`String` **get_text** **(** **)** -Returns the label's text with the formatting removed. +Returns the raw content of :ref:`bbcode_text`. .. _class_RichTextLabel_get_total_character_count: - :ref:`int` **get_total_character_count** **(** **)** const -Returns the total number of characters. +Returns the total number of characters from text tags. Does not include bbcodes. .. _class_RichTextLabel_get_v_scroll: - :ref:`VScrollBar` **get_v_scroll** **(** **)** -.. _class_RichTextLabel_get_visible_characters: - -- :ref:`int` **get_visible_characters** **(** **)** const +Returns the vertical scrollbar. .. _class_RichTextLabel_get_visible_line_count: @@ -244,118 +234,128 @@ Returns the number of visible lines. - :ref:`bool` **is_meta_underlined** **(** **)** const -.. _class_RichTextLabel_is_overriding_selected_font_color: - -- :ref:`bool` **is_overriding_selected_font_color** **(** **)** const +Returns ``true`` if the label underlines meta tags such as url{text}. .. _class_RichTextLabel_is_scroll_active: - :ref:`bool` **is_scroll_active** **(** **)** const -Returns ``true`` if active scrolling is enabled. +Returns ``true`` if the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. .. _class_RichTextLabel_is_scroll_following: - :ref:`bool` **is_scroll_following** **(** **)** const +Returns ``true`` if the window scrolls down to display new content automatically. + .. _class_RichTextLabel_is_selection_enabled: - :ref:`bool` **is_selection_enabled** **(** **)** const -Returns ``true`` if the label's text can be selected. - -.. _class_RichTextLabel_is_using_bbcode: - -- :ref:`bool` **is_using_bbcode** **(** **)** const - -Returns ``true`` if the label has BBCode. +Returns ``true`` if the label allows text selection. .. _class_RichTextLabel_newline: - void **newline** **(** **)** -Adds a newline to the end of the rich text. +Adds a newline tag to the tag stack. .. _class_RichTextLabel_parse_bbcode: - :ref:`int` **parse_bbcode** **(** :ref:`String` bbcode **)** +The assignment version of :ref:`append_bbcode`. Clears the tag stack and inserts the new content. Returns ``OK`` if parses ``bbcode`` successfully. + .. _class_RichTextLabel_pop: - void **pop** **(** **)** +Terminates the current tag. Use after ``push\_\*`` methods to close bbcodes manually. Does not need to follow ``add\_\*`` methods. + .. _class_RichTextLabel_push_align: - void **push_align** **(** :ref:`int` align **)** +Adds a ``[right]`` tag to the tag stack. + .. _class_RichTextLabel_push_cell: - void **push_cell** **(** **)** +Adds a ``[cell]`` tag to the tag stack. Must be inside a table tag. See :ref:`push_table` for details. + .. _class_RichTextLabel_push_color: - void **push_color** **(** :ref:`Color` color **)** +Adds a ``[color]`` tag to the tag stack. + .. _class_RichTextLabel_push_font: - void **push_font** **(** :ref:`Font` font **)** +Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration. + .. _class_RichTextLabel_push_indent: - void **push_indent** **(** :ref:`int` level **)** +Adds an ``[indent]`` tag to the tag stack. Multiplies "level" by current tab_size to determine new margin length. + .. _class_RichTextLabel_push_list: - void **push_list** **(** :ref:`int` type **)** +Adds a list tag to the tag stack. Similar to the bbcodes ``[ol]`` or ``[ul]``, but supports more list types. Not fully implemented! + .. _class_RichTextLabel_push_meta: - void **push_meta** **(** :ref:`Variant` data **)** +Adds a meta tag to the tag stack. Similar to the bbcode ``[url=something]{text}[/url]``, but supports non-:ref:`String` metadata types. + .. _class_RichTextLabel_push_table: - void **push_table** **(** :ref:`int` columns **)** +Adds a ``[table=columns]`` tag to the tag stack. + .. _class_RichTextLabel_push_underline: - void **push_underline** **(** **)** +Adds a ``[u]`` tag to the tag stack. + .. _class_RichTextLabel_remove_line: - :ref:`bool` **remove_line** **(** :ref:`int` line **)** +Removes a line of content from the label. Returns ``true`` if the line exists. + .. _class_RichTextLabel_scroll_to_line: - void **scroll_to_line** **(** :ref:`int` line **)** -.. _class_RichTextLabel_set_bbcode: - -- void **set_bbcode** **(** :ref:`String` text **)** - -Sets the BBCode text to the label. +Scrolls the window's top line to match ``line``. .. _class_RichTextLabel_set_meta_underline: - void **set_meta_underline** **(** :ref:`bool` enable **)** -.. _class_RichTextLabel_set_override_selected_font_color: - -- void **set_override_selected_font_color** **(** :ref:`bool` override **)** - -.. _class_RichTextLabel_set_percent_visible: - -- void **set_percent_visible** **(** :ref:`float` percent_visible **)** - -Sets the text's visibility. Takes a floating point value between 0.0 and 1.0. +If ``true`` will underline meta tags such as the url bbcode. Default value: ``true``. .. _class_RichTextLabel_set_scroll_active: - void **set_scroll_active** **(** :ref:`bool` active **)** +If ``false`` the vertical scrollbar is hidden. Default value: ``true``. + .. _class_RichTextLabel_set_scroll_follow: - void **set_scroll_follow** **(** :ref:`bool` follow **)** +If ``true`` the window scrolls to reveal new content. Default value: ``false``. + .. _class_RichTextLabel_set_selection_enabled: - void **set_selection_enabled** **(** :ref:`bool` enabled **)** @@ -366,20 +366,22 @@ If ``true`` text can be selected. - void **set_tab_size** **(** :ref:`int` spaces **)** +Sets the current tab length in spaces. Use with :ref:`push_indent` to redefine indent length. + .. _class_RichTextLabel_set_table_column_expand: - void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** +Edits the selected columns expansion options. If ``expand`` is ``true``, the column expands in proportion to its expansion ratio versus the other columns' ratios. + +For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively. + +Columns with a ``false`` expand will not contribute to the total ratio. + .. _class_RichTextLabel_set_text: - void **set_text** **(** :ref:`String` text **)** -.. _class_RichTextLabel_set_use_bbcode: - -- void **set_use_bbcode** **(** :ref:`bool` enable **)** - -.. _class_RichTextLabel_set_visible_characters: - -- void **set_visible_characters** **(** :ref:`int` amount **)** +Clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify :ref:`bbcode_text`. diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 2cac009c7..8656bc56b 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -19,83 +19,15 @@ Physics Body whose position is determined through physics simulation in 3D space Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_angular_velocity` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_axis_lock` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bounce` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_scale` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mass` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_contacts_reported` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_weight` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_able_to_sleep` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_contact_monitor_enabled` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_continuous_collision_detection` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_custom_integrator` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_velocity` **(** :ref:`Vector3` angular_velocity **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_lock` **(** :ref:`int` axis_lock **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_can_sleep` **(** :ref:`bool` able_to_sleep **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_contact_monitor` **(** :ref:`bool` enabled **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_scale` **(** :ref:`float` gravity_scale **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_velocity` **(** :ref:`Vector3` linear_velocity **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mass` **(** :ref:`float` mass **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_contacts_reported` **(** :ref:`int` amount **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sleeping` **(** :ref:`bool` sleeping **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_continuous_collision_detection` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_custom_integrator` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_weight` **(** :ref:`float` weight **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** virtual | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -249,224 +181,16 @@ Called during physics processing, allowing you to read and safely modify the sim Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. -.. _class_RigidBody_get_angular_damp: - -- :ref:`float` **get_angular_damp** **(** **)** const - -Return the current body angular damp. Default is -1. - -.. _class_RigidBody_get_angular_velocity: - -- :ref:`Vector3` **get_angular_velocity** **(** **)** const - -Return the current body angular velocity. - -.. _class_RigidBody_get_axis_lock: - -- :ref:`int` **get_axis_lock** **(** **)** const - -Return the current axis lock of the body. One of AXIS_LOCK\_\* enum. - -.. _class_RigidBody_get_bounce: - -- :ref:`float` **get_bounce** **(** **)** const - -Return the current body bounciness. - .. _class_RigidBody_get_colliding_bodies: - :ref:`Array` **get_colliding_bodies** **(** **)** const Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see :ref:`set_max_contacts_reported` to increase it. -.. _class_RigidBody_get_friction: - -- :ref:`float` **get_friction** **(** **)** const - -Return the current body friction, from 0 (frictionless) to 1 (max friction). - -.. _class_RigidBody_get_gravity_scale: - -- :ref:`float` **get_gravity_scale** **(** **)** const - -Return the current body gravity scale. - -.. _class_RigidBody_get_linear_damp: - -- :ref:`float` **get_linear_damp** **(** **)** const - -Return the current body linear damp. Default is -1. - -.. _class_RigidBody_get_linear_velocity: - -- :ref:`Vector3` **get_linear_velocity** **(** **)** const - -Return the current body linear velocity. - -.. _class_RigidBody_get_mass: - -- :ref:`float` **get_mass** **(** **)** const - -Return the current body mass. - -.. _class_RigidBody_get_max_contacts_reported: - -- :ref:`int` **get_max_contacts_reported** **(** **)** const - -Return the maximum contacts that can be reported. See :ref:`set_max_contacts_reported`. - -.. _class_RigidBody_get_mode: - -- :ref:`int` **get_mode** **(** **)** const - -Return the current body mode, see :ref:`set_mode`. - -.. _class_RigidBody_get_weight: - -- :ref:`float` **get_weight** **(** **)** const - -Return the current body weight, given standard earth-weight (gravity 9.8). - -.. _class_RigidBody_is_able_to_sleep: - -- :ref:`bool` **is_able_to_sleep** **(** **)** const - -Return whether the body has the ability to fall asleep when not moving. See :ref:`set_can_sleep`. - -.. _class_RigidBody_is_contact_monitor_enabled: - -- :ref:`bool` **is_contact_monitor_enabled** **(** **)** const - -Return whether contact monitoring is enabled. - -.. _class_RigidBody_is_sleeping: - -- :ref:`bool` **is_sleeping** **(** **)** const - -Return whether the body is sleeping. - -.. _class_RigidBody_is_using_continuous_collision_detection: - -- :ref:`bool` **is_using_continuous_collision_detection** **(** **)** const - -Return whether this body is using continuous collision detection. - -.. _class_RigidBody_is_using_custom_integrator: - -- :ref:`bool` **is_using_custom_integrator** **(** **)** - -Return whether the body is using a custom integrator. - -.. _class_RigidBody_set_angular_damp: - -- void **set_angular_damp** **(** :ref:`float` angular_damp **)** - -Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden. - -.. _class_RigidBody_set_angular_velocity: - -- void **set_angular_velocity** **(** :ref:`Vector3` angular_velocity **)** - -Set the body angular velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. - -.. _class_RigidBody_set_axis_lock: - -- void **set_axis_lock** **(** :ref:`int` axis_lock **)** - -Set the axis lock of the body, from the AXIS_LOCK\_\* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes. - .. _class_RigidBody_set_axis_velocity: - void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. -.. _class_RigidBody_set_bounce: - -- void **set_bounce** **(** :ref:`float` bounce **)** - -Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness). - -.. _class_RigidBody_set_can_sleep: - -- void **set_can_sleep** **(** :ref:`bool` able_to_sleep **)** - -Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. - -Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse` / :ref:`set_applied_force` wakes them up. Until then, they behave like a static body. - -.. _class_RigidBody_set_contact_monitor: - -- void **set_contact_monitor** **(** :ref:`bool` enabled **)** - -Enable contact monitoring. This allows the body to emit signals when it collides with another. - -.. _class_RigidBody_set_friction: - -- void **set_friction** **(** :ref:`float` friction **)** - -Set the body friction, from 0 (frictionless) to 1 (max friction). - -.. _class_RigidBody_set_gravity_scale: - -- void **set_gravity_scale** **(** :ref:`float` gravity_scale **)** - -Set the gravity factor. This factor multiplies gravity intensity just for this body. - -.. _class_RigidBody_set_linear_damp: - -- void **set_linear_damp** **(** :ref:`float` linear_damp **)** - -Set the linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. - -.. _class_RigidBody_set_linear_velocity: - -- void **set_linear_velocity** **(** :ref:`Vector3` linear_velocity **)** - -Set the body linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. - -.. _class_RigidBody_set_mass: - -- void **set_mass** **(** :ref:`float` mass **)** - -Set the body mass. - -.. _class_RigidBody_set_max_contacts_reported: - -- void **set_max_contacts_reported** **(** :ref:`int` amount **)** - -Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. - -.. _class_RigidBody_set_mode: - -- 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. - -.. _class_RigidBody_set_sleeping: - -- void **set_sleeping** **(** :ref:`bool` sleeping **)** - -Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse` wakes them up. Until then, they behave like a static body. - -.. _class_RigidBody_set_use_continuous_collision_detection: - -- void **set_use_continuous_collision_detection** **(** :ref:`bool` enable **)** - -Set the continuous collision detection mode from the enum CCD_MODE\_\*. - -Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects. - -.. _class_RigidBody_set_use_custom_integrator: - -- void **set_use_custom_integrator** **(** :ref:`bool` enable **)** - -Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. - -.. _class_RigidBody_set_weight: - -- void **set_weight** **(** :ref:`float` weight **)** - -Set the body weight given standard earth-weight (gravity 9.8). - diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 8f3efd0b3..5c4b5ef4e 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -26,86 +26,22 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_velocity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_applied_force` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_applied_torque` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bounce` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_continuous_collision_detection_mode` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_scale` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_inertia` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_linear_velocity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mass` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_contacts_reported` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_weight` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_able_to_sleep` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_contact_monitor_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_custom_integrator` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_velocity` **(** :ref:`float` angular_velocity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_applied_force` **(** :ref:`Vector2` force **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_applied_torque` **(** :ref:`float` torque **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_can_sleep` **(** :ref:`bool` able_to_sleep **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_contact_monitor` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_continuous_collision_detection_mode` **(** :ref:`int` mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_scale` **(** :ref:`float` gravity_scale **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_inertia` **(** :ref:`float` inertia **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_velocity` **(** :ref:`Vector2` linear_velocity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mass` **(** :ref:`float` mass **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_contacts_reported` **(** :ref:`int` amount **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sleeping` **(** :ref:`bool` sleeping **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_custom_integrator` **(** :ref:`bool` enable **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_weight` **(** :ref:`float` weight **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`test_motion` **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -264,18 +200,6 @@ Adds a positioned force to the body. Both the force and the offset from the body Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates. -.. _class_RigidBody2D_get_angular_damp: - -- :ref:`float` **get_angular_damp** **(** **)** const - -Return the angular damp for this body. - -.. _class_RigidBody2D_get_angular_velocity: - -- :ref:`float` **get_angular_velocity** **(** **)** const - -Return the body angular velocity. This changes by physics granularity. See :ref:`set_angular_velocity`. - .. _class_RigidBody2D_get_applied_force: - :ref:`Vector2` **get_applied_force** **(** **)** const @@ -288,114 +212,18 @@ Returns the body's total applied force. Returns the body's total applied torque. -.. _class_RigidBody2D_get_bounce: - -- :ref:`float` **get_bounce** **(** **)** const - -Return the body bounciness. - .. _class_RigidBody2D_get_colliding_bodies: - :ref:`Array` **get_colliding_bodies** **(** **)** const Returns a list of the bodies colliding with this one. Use :ref:`contacts_reported` to set the maximum number reported. You must also set :ref:`contact_monitor` to ``true``. -.. _class_RigidBody2D_get_continuous_collision_detection_mode: - -- :ref:`int` **get_continuous_collision_detection_mode** **(** **)** const - -Return whether this body is using continuous collision detection. - -.. _class_RigidBody2D_get_friction: - -- :ref:`float` **get_friction** **(** **)** const - -Return the body friction. - -.. _class_RigidBody2D_get_gravity_scale: - -- :ref:`float` **get_gravity_scale** **(** **)** const - -Return the gravity factor. - .. _class_RigidBody2D_get_inertia: - :ref:`float` **get_inertia** **(** **)** const Returns the body's moment of inertia, which is computed automatically from the body's mass and assigned :ref:`Shape2D`\ s during the physics frame. Note that it will not yet have a value in the ``_ready()`` function. -.. _class_RigidBody2D_get_linear_damp: - -- :ref:`float` **get_linear_damp** **(** **)** const - -Return the linear damp for this body. - -.. _class_RigidBody2D_get_linear_velocity: - -- :ref:`Vector2` **get_linear_velocity** **(** **)** const - -Returns the body's linear velocity. This changes when a physics frame has passed, not during a normal update. See :ref:`set_linear_velocity`. - -.. _class_RigidBody2D_get_mass: - -- :ref:`float` **get_mass** **(** **)** const - -Return the body mass. - -.. _class_RigidBody2D_get_max_contacts_reported: - -- :ref:`int` **get_max_contacts_reported** **(** **)** const - -Return the maximum contacts that can be reported. See :ref:`set_max_contacts_reported`. - -.. _class_RigidBody2D_get_mode: - -- :ref:`int` **get_mode** **(** **)** const - -Return the current body mode, see :ref:`set_mode`. - -.. _class_RigidBody2D_get_weight: - -- :ref:`float` **get_weight** **(** **)** const - -Return the body weight given standard earth-weight (gravity 9.8). - -.. _class_RigidBody2D_is_able_to_sleep: - -- :ref:`bool` **is_able_to_sleep** **(** **)** const - -Return true if the body has the ability to fall asleep when not moving. See :ref:`set_can_sleep`. - -.. _class_RigidBody2D_is_contact_monitor_enabled: - -- :ref:`bool` **is_contact_monitor_enabled** **(** **)** const - -Return whether contact monitoring is enabled. - -.. _class_RigidBody2D_is_sleeping: - -- :ref:`bool` **is_sleeping** **(** **)** const - -Return whether the body is sleeping. - -.. _class_RigidBody2D_is_using_custom_integrator: - -- :ref:`bool` **is_using_custom_integrator** **(** **)** - -Return true if the body is not doing any built-in force integration. - -.. _class_RigidBody2D_set_angular_damp: - -- void **set_angular_damp** **(** :ref:`float` angular_damp **)** - -Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden. - -.. _class_RigidBody2D_set_angular_velocity: - -- void **set_angular_velocity** **(** :ref:`float` angular_velocity **)** - -Set the body angular velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. - .. _class_RigidBody2D_set_applied_force: - void **set_applied_force** **(** :ref:`Vector2` force **)** @@ -414,100 +242,12 @@ Sets the applied torque. Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. -.. _class_RigidBody2D_set_bounce: - -- void **set_bounce** **(** :ref:`float` bounce **)** - -Set the body bounciness, from 0 (no bounce) to 1 (full bounce). - -.. _class_RigidBody2D_set_can_sleep: - -- void **set_can_sleep** **(** :ref:`bool` able_to_sleep **)** - -Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. - -Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse` / :ref:`set_applied_force` wakes them up. Until then, they behave like a static body. - -.. _class_RigidBody2D_set_contact_monitor: - -- void **set_contact_monitor** **(** :ref:`bool` enabled **)** - -Enable contact monitoring. This allows the body to emit signals when it collides with another. - -.. _class_RigidBody2D_set_continuous_collision_detection_mode: - -- void **set_continuous_collision_detection_mode** **(** :ref:`int` mode **)** - -Set the continuous collision detection mode from the enum CCD_MODE\_\*. - -Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects. - -.. _class_RigidBody2D_set_friction: - -- void **set_friction** **(** :ref:`float` friction **)** - -Set the body friction, from 0 (frictionless) to 1 (full friction). - -.. _class_RigidBody2D_set_gravity_scale: - -- void **set_gravity_scale** **(** :ref:`float` gravity_scale **)** - -Set the gravity factor. This factor multiplies gravity intensity just for this body. - .. _class_RigidBody2D_set_inertia: - void **set_inertia** **(** :ref:`float` inertia **)** Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. -.. _class_RigidBody2D_set_linear_damp: - -- void **set_linear_damp** **(** :ref:`float` linear_damp **)** - -Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden. - -.. _class_RigidBody2D_set_linear_velocity: - -- void **set_linear_velocity** **(** :ref:`Vector2` linear_velocity **)** - -Set the body linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. - -.. _class_RigidBody2D_set_mass: - -- void **set_mass** **(** :ref:`float` mass **)** - -Set the body mass. - -.. _class_RigidBody2D_set_max_contacts_reported: - -- void **set_max_contacts_reported** **(** :ref:`int` amount **)** - -Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. - -.. _class_RigidBody2D_set_mode: - -- 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. - -.. _class_RigidBody2D_set_sleeping: - -- void **set_sleeping** **(** :ref:`bool` sleeping **)** - -Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse` / :ref:`set_applied_force` wakes them up. Until then, they behave like a static body. - -.. _class_RigidBody2D_set_use_custom_integrator: - -- void **set_use_custom_integrator** **(** :ref:`bool` enable **)** - -Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. - -.. _class_RigidBody2D_set_weight: - -- void **set_weight** **(** :ref:`float` weight **)** - -Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. - .. _class_RigidBody2D_test_motion: - :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 04717d49d..616fa61ab 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -19,11 +19,17 @@ Brief Description Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_current_script` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scripts` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_drop_data_fw` **(** :ref:`Vector2` arg0, :ref:`Variant` arg1, :ref:`Control` arg2 **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`drop_data_fw` **(** :ref:`Vector2` arg0, :ref:`Variant` arg1, :ref:`Control` arg2 **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_current_script` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_drag_data_fw` **(** :ref:`Vector2` arg0, :ref:`Control` arg1 **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scripts` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -44,12 +50,24 @@ Emitted when editor is about to close the active script. Argument is a :ref:`Scr Member Function Description --------------------------- +.. _class_ScriptEditor_can_drop_data_fw: + +- :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` arg0, :ref:`Variant` arg1, :ref:`Control` arg2 **)** const + +.. _class_ScriptEditor_drop_data_fw: + +- void **drop_data_fw** **(** :ref:`Vector2` arg0, :ref:`Variant` arg1, :ref:`Control` arg2 **)** + .. _class_ScriptEditor_get_current_script: - :ref:`Script` **get_current_script** **(** **)** Returns a :ref:`Script` that is currently active in editor. +.. _class_ScriptEditor_get_drag_data_fw: + +- :ref:`Variant` **get_drag_data_fw** **(** :ref:`Vector2` arg0, :ref:`Control` arg1 **)** + .. _class_ScriptEditor_get_open_scripts: - :ref:`Array` **get_open_scripts** **(** **)** const diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index ab613f888..08034cc22 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -18,15 +18,6 @@ Brief Description Base class for scroll bars. -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_custom_step` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_step` **(** :ref:`float` step **)** | -+----------------------------+----------------------------------------------------------------------------------------------------+ - Signals ------- @@ -48,15 +39,3 @@ Description Scrollbars are a :ref:`Range` based :ref:`Control`, that display a draggable area (the size of the page). Horizontal (:ref:`HScrollBar`) and Vertical (:ref:`VScrollBar`) versions are available. -Member Function Description ---------------------------- - -.. _class_ScrollBar_get_custom_step: - -- :ref:`float` **get_custom_step** **(** **)** const - -.. _class_ScrollBar_set_custom_step: - -- void **set_custom_step** **(** :ref:`float` step **)** - - diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 547a55789..70e03806a 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -19,23 +19,15 @@ A helper node for displaying scrollable elements (e.g. lists). Member Functions ---------------- -+--------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_scroll` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_scroll` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_h_scroll_enabled` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_v_scroll_enabled` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_h_scroll` **(** :ref:`bool` enable **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_v_scroll` **(** :ref:`bool` enable **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_scroll` **(** :ref:`int` val **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_scroll` **(** :ref:`int` val **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------+ ++------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_scroll` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_scroll` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_scroll` **(** :ref:`int` val **)** | ++------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_scroll` **(** :ref:`int` val **)** | ++------------------------+-----------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,30 +61,6 @@ Return current horizontal scroll value. Return current vertical scroll value. -.. _class_ScrollContainer_is_h_scroll_enabled: - -- :ref:`bool` **is_h_scroll_enabled** **(** **)** const - -Return true if horizontal scroll is allowed. - -.. _class_ScrollContainer_is_v_scroll_enabled: - -- :ref:`bool` **is_v_scroll_enabled** **(** **)** const - -Return true if vertical scroll is allowed. - -.. _class_ScrollContainer_set_enable_h_scroll: - -- void **set_enable_h_scroll** **(** :ref:`bool` enable **)** - -Set allows horizontal scroll. - -.. _class_ScrollContainer_set_enable_v_scroll: - -- void **set_enable_v_scroll** **(** :ref:`bool` enable **)** - -Set allows vertical scroll. - .. _class_ScrollContainer_set_h_scroll: - void **set_h_scroll** **(** :ref:`int` val **)** diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 043fbabf5..5c22ab2d3 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -16,19 +16,6 @@ Brief Description Segment shape for 2D collisions. -Member Functions ----------------- - -+--------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_a` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_b` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------+ -| void | :ref:`set_a` **(** :ref:`Vector2` a **)** | -+--------------------------------+--------------------------------------------------------------------------------------+ -| void | :ref:`set_b` **(** :ref:`Vector2` b **)** | -+--------------------------------+--------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,31 +33,3 @@ Description Segment shape for 2D collisions. Consists of two points, ``a`` and ``b``. -Member Function Description ---------------------------- - -.. _class_SegmentShape2D_get_a: - -- :ref:`Vector2` **get_a** **(** **)** const - -Return the first point's position. - -.. _class_SegmentShape2D_get_b: - -- :ref:`Vector2` **get_b** **(** **)** const - -Return the second point's position. - -.. _class_SegmentShape2D_set_a: - -- void **set_a** **(** :ref:`Vector2` a **)** - -Set the first point's position. - -.. _class_SegmentShape2D_set_b: - -- void **set_b** **(** :ref:`Vector2` b **)** - -Set the second point's position. - - diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 5e91a219d..6f5eaf303 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -19,8 +19,6 @@ To be changed, ignore. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_code` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -28,8 +26,6 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_code` **(** :ref:`String` code **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -56,10 +52,6 @@ To be changed, ignore. Member Function Description --------------------------- -.. _class_Shader_get_code: - -- :ref:`String` **get_code** **(** **)** const - .. _class_Shader_get_default_texture_param: - :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const @@ -72,10 +64,6 @@ Member Function Description - :ref:`bool` **has_param** **(** :ref:`String` name **)** const -.. _class_Shader_set_code: - -- void **set_code** **(** :ref:`String` code **)** - .. _class_Shader_set_default_texture_param: - void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 38752dd09..956879d3f 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -9,7 +9,7 @@ Shape2D **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`RayShape2D`, :ref:`CircleShape2D`, :ref:`CapsuleShape2D`, :ref:`LineShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` +**Inherited By:** :ref:`RayShape2D`, :ref:`CapsuleShape2D`, :ref:`LineShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` **Category:** Core @@ -30,10 +30,6 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_custom_solver_bias` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_solver_bias` **(** :ref:`float` bias **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -83,18 +79,4 @@ Return a list of the points where this shape would touch another, if a given mov This method needs the transformation matrix for this shape (``local_xform``), the movement to test on this shape (``local_motion``), the shape to check collisions with (``with_shape``), the transformation matrix of that shape (``shape_xform``), and the movement to test onto the other object (``shape_motion``). -.. _class_Shape2D_get_custom_solver_bias: - -- :ref:`float` **get_custom_solver_bias** **(** **)** const - -Return the custom solver bias. - -.. _class_Shape2D_set_custom_solver_bias: - -- void **set_custom_solver_bias** **(** :ref:`float` bias **)** - -Use a custom solver bias. No need to change this unless you really know what you are doing. - -The solver bias is a factor controlling how much two objects "rebound" off each other, when colliding, to avoid them getting into each other because of numerical imprecision. - diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 675c8dfd2..68c5444d6 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -19,17 +19,13 @@ Brief Description Member Functions ---------------- -+--------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`get_shortcut` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shortcut` **(** :ref:`InputEvent` event **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shortcut` **(** :ref:`InputEvent` event **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_as_text` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shortcut` **(** :ref:`InputEvent` event **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -46,10 +42,6 @@ Member Function Description - :ref:`String` **get_as_text** **(** **)** const -.. _class_ShortCut_get_shortcut: - -- :ref:`InputEvent` **get_shortcut** **(** **)** const - .. _class_ShortCut_is_shortcut: - :ref:`bool` **is_shortcut** **(** :ref:`InputEvent` event **)** const @@ -58,8 +50,4 @@ Member Function Description - :ref:`bool` **is_valid** **(** **)** const -.. _class_ShortCut_set_shortcut: - -- void **set_shortcut** **(** :ref:`InputEvent` event **)** - diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 2eaaa07b2..01912f425 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -18,15 +18,6 @@ Brief Description -Member Functions ----------------- - -+------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_radiance_size` **(** **)** const | -+------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_radiance_size` **(** :ref:`int` size **)** | -+------------------------+----------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -47,15 +38,3 @@ Numeric Constants - **RADIANCE_SIZE_2048** = **6** - **RADIANCE_SIZE_MAX** = **7** -Member Function Description ---------------------------- - -.. _class_Sky_get_radiance_size: - -- :ref:`int` **get_radiance_size** **(** **)** const - -.. _class_Sky_set_radiance_size: - -- void **set_radiance_size** **(** :ref:`int` size **)** - - diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 93a8bf3b4..a7280aa53 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -18,23 +18,6 @@ Brief Description Base class for GUI Sliders. -Member Functions ----------------- - -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_ticks_on_borders` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`bool` editable **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ticks` **(** :ref:`int` count **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ticks_on_borders` **(** :ref:`bool` ticks_on_border **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -60,39 +43,3 @@ Description Base class for GUI Sliders. -Member Function Description ---------------------------- - -.. _class_Slider_get_ticks: - -- :ref:`int` **get_ticks** **(** **)** const - -Return amounts of ticks to display on slider. - -.. _class_Slider_get_ticks_on_borders: - -- :ref:`bool` **get_ticks_on_borders** **(** **)** const - -Return true if ticks are visible on borders. - -.. _class_Slider_is_editable: - -- :ref:`bool` **is_editable** **(** **)** const - -.. _class_Slider_set_editable: - -- void **set_editable** **(** :ref:`bool` editable **)** - -.. _class_Slider_set_ticks: - -- void **set_ticks** **(** :ref:`int` count **)** - -Set amount of ticks to display in slider. - -.. _class_Slider_set_ticks_on_borders: - -- void **set_ticks_on_borders** **(** :ref:`bool` ticks_on_border **)** - -Set true if ticks are visible on borders. - - diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index d0cdeb3a5..93f886b7a 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -16,15 +16,6 @@ Brief Description Piston kind of slider between two bodies in 3D. -Member Functions ----------------- - -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -155,15 +146,3 @@ Description Slides across the x-axis of the Pivot object. -Member Function Description ---------------------------- - -.. _class_SliderJoint_get_param: - -- :ref:`float` **get_param** **(** :ref:`int` param **)** const - -.. _class_SliderJoint_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - - diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 5cd0b2376..24ab761a7 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -9,7 +9,7 @@ Spatial **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`ARVRController`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` +**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`ARVRController`, :ref:`Path`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` **Category:** Core @@ -24,20 +24,8 @@ Member Functions +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SpatialGizmo` | :ref:`get_gizmo` **(** **)** const | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_global_transform` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_rotation` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_rotation_degrees` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_scale` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_translation` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`World` | :ref:`get_world` **(** **)** const | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_rotate` **(** :ref:`Vector3` normal, :ref:`float` radians **)** | @@ -52,8 +40,6 @@ Member Functions +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | @@ -74,8 +60,6 @@ Member Functions +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_gizmo` **(** :ref:`SpatialGizmo` gizmo **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_transform` **(** :ref:`Transform` global **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_identity` **(** **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | @@ -84,18 +68,6 @@ Member Functions +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`Vector3` radians **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_degrees` **(** :ref:`Vector3` degrees **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector3` scale **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform` local **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_translation` **(** :ref:`Vector3` translation **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show` **(** **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | @@ -173,44 +145,12 @@ Member Function Description Returns the SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. -.. _class_Spatial_get_global_transform: - -- :ref:`Transform` **get_global_transform** **(** **)** const - -Returns the global transform, relative to worldspace. - .. _class_Spatial_get_parent_spatial: - :ref:`Spatial` **get_parent_spatial** **(** **)** const Returns the parent ``Spatial``, or an empty :ref:`Object` if no parent exists or parent is not of type ``Spatial``. -.. _class_Spatial_get_rotation: - -- :ref:`Vector3` **get_rotation** **(** **)** const - -Returns the rotation (in radians). - -.. _class_Spatial_get_rotation_degrees: - -- :ref:`Vector3` **get_rotation_degrees** **(** **)** const - -Returns the rotation (in degrees). - -.. _class_Spatial_get_scale: - -- :ref:`Vector3` **get_scale** **(** **)** const - -.. _class_Spatial_get_transform: - -- :ref:`Transform` **get_transform** **(** **)** const - -Returns the local transform, relative to the bone parent. - -.. _class_Spatial_get_translation: - -- :ref:`Vector3` **get_translation** **(** **)** const - .. _class_Spatial_get_world: - :ref:`World` **get_world** **(** **)** const @@ -253,12 +193,6 @@ Returns whether this node is set as Toplevel, that is whether it ignores its par Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. -.. _class_Spatial_is_visible: - -- :ref:`bool` **is_visible** **(** **)** const - -Returns whether the node is set to be visible. - .. _class_Spatial_is_visible_in_tree: - :ref:`bool` **is_visible_in_tree** **(** **)** const @@ -319,12 +253,6 @@ Makes the node ignore its parents transformations. Node transformations are only Set :ref:`SpatialGizmo` for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. -.. _class_Spatial_set_global_transform: - -- void **set_global_transform** **(** :ref:`Transform` global **)** - -Set the transform globally, relative to world space. - .. _class_Spatial_set_identity: - void **set_identity** **(** **)** @@ -349,38 +277,6 @@ Set whether the node notifies about its local transformation changes. Spatial wi Set whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. -.. _class_Spatial_set_rotation: - -- void **set_rotation** **(** :ref:`Vector3` radians **)** - -Set the rotation (in radians). - -.. _class_Spatial_set_rotation_degrees: - -- void **set_rotation_degrees** **(** :ref:`Vector3` degrees **)** - -Set the rotation (in degrees). - -.. _class_Spatial_set_scale: - -- void **set_scale** **(** :ref:`Vector3` scale **)** - -Set the scale. - -.. _class_Spatial_set_transform: - -- void **set_transform** **(** :ref:`Transform` local **)** - -Set the transform locally, relative to the parent spatial node. - -.. _class_Spatial_set_translation: - -- void **set_translation** **(** :ref:`Vector3` translation **)** - -.. _class_Spatial_set_visible: - -- void **set_visible** **(** :ref:`bool` visible **)** - .. _class_Spatial_show: - void **show** **(** **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 431f72e50..5c34301fe 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -16,227 +16,6 @@ Brief Description -Member Functions ----------------- - -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_albedo` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_alpha_scissor_threshold` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_anisotropy` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ao_light_affect` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ao_texture_channel` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_billboard_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_clearcoat` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_clearcoat_gloss` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_depth_deep_parallax_max_layers` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_depth_deep_parallax_min_layers` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_depth_draw_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_depth_scale` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_detail_blend_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_detail_uv` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_diffuse_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_distance_fade_max_distance` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_distance_fade_min_distance` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_emission` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_energy` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_feature` **(** :ref:`int` feature **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_grow` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_line_width` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_metallic` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_metallic_texture_channel` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_normal_scale` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_particles_anim_h_frames` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_particles_anim_loop` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_particles_anim_v_frames` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_size` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_proximity_fade_distance` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_refraction` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_refraction_texture_channel` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rim` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rim_tint` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_roughness` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_roughness_texture_channel` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_specular` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_specular_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_subsurface_scattering_strength` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` param **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_transmission` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_uv1_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_uv1_scale` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_uv1_triplanar_blend_sharpness` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_uv2_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_uv2_scale` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_uv2_triplanar_blend_sharpness` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_depth_deep_parallax_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_distance_fade_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_grow_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_proximity_fade_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_albedo` **(** :ref:`Color` albedo **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_alpha_scissor_threshold` **(** :ref:`float` threshold **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anisotropy` **(** :ref:`float` anisotropy **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ao_light_affect` **(** :ref:`float` amount **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ao_texture_channel` **(** :ref:`int` channel **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_billboard_mode` **(** :ref:`int` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clearcoat` **(** :ref:`float` clearcoat **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clearcoat_gloss` **(** :ref:`float` clearcoat_gloss **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_deep_parallax` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_deep_parallax_max_layers` **(** :ref:`int` layer **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_deep_parallax_min_layers` **(** :ref:`int` layer **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_draw_mode` **(** :ref:`int` depth_draw_mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_scale` **(** :ref:`float` depth_scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_detail_blend_mode` **(** :ref:`int` detail_blend_mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_detail_uv` **(** :ref:`int` detail_uv **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_diffuse_mode` **(** :ref:`int` diffuse_mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_fade` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_fade_max_distance` **(** :ref:`float` distance **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_fade_min_distance` **(** :ref:`float` distance **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission` **(** :ref:`Color` emission **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_energy` **(** :ref:`float` emission_energy **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feature` **(** :ref:`int` feature, :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_grow` **(** :ref:`float` amount **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_grow_enabled` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_line_width` **(** :ref:`float` line_width **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metallic` **(** :ref:`float` metallic **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metallic_texture_channel` **(** :ref:`int` channel **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_scale` **(** :ref:`float` normal_scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_particles_anim_h_frames` **(** :ref:`int` frames **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_particles_anim_loop` **(** :ref:`int` frames **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_particles_anim_v_frames` **(** :ref:`int` frames **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_size` **(** :ref:`float` point_size **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_proximity_fade` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_proximity_fade_distance` **(** :ref:`float` distance **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_refraction` **(** :ref:`float` refraction **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_refraction_texture_channel` **(** :ref:`int` channel **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rim` **(** :ref:`float` rim **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rim_tint` **(** :ref:`float` rim_tint **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_roughness` **(** :ref:`float` roughness **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_roughness_texture_channel` **(** :ref:`int` channel **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_specular` **(** :ref:`float` specular **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_specular_mode` **(** :ref:`int` specular_mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subsurface_scattering_strength` **(** :ref:`float` strength **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transmission` **(** :ref:`Color` transmission **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv1_offset` **(** :ref:`Vector3` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv1_scale` **(** :ref:`Vector3` scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv1_triplanar_blend_sharpness` **(** :ref:`float` sharpness **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2_offset` **(** :ref:`Vector3` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2_scale` **(** :ref:`Vector3` scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2_triplanar_blend_sharpness` **(** :ref:`float` sharpness **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -368,6 +147,10 @@ Member Variables - :ref:`float` **emission_energy** + .. _class_SpatialMaterial_emission_operator: + +- :ref:`int` **emission_operator** + .. _class_SpatialMaterial_emission_texture: - :ref:`Texture` **emission_texture** @@ -683,440 +466,6 @@ Numeric Constants - **TEXTURE_CHANNEL_BLUE** = **2** - **TEXTURE_CHANNEL_ALPHA** = **3** - **TEXTURE_CHANNEL_GRAYSCALE** = **4** - -Member Function Description ---------------------------- - -.. _class_SpatialMaterial_get_albedo: - -- :ref:`Color` **get_albedo** **(** **)** const - -.. _class_SpatialMaterial_get_alpha_scissor_threshold: - -- :ref:`float` **get_alpha_scissor_threshold** **(** **)** const - -.. _class_SpatialMaterial_get_anisotropy: - -- :ref:`float` **get_anisotropy** **(** **)** const - -.. _class_SpatialMaterial_get_ao_light_affect: - -- :ref:`float` **get_ao_light_affect** **(** **)** const - -.. _class_SpatialMaterial_get_ao_texture_channel: - -- :ref:`int` **get_ao_texture_channel** **(** **)** const - -.. _class_SpatialMaterial_get_billboard_mode: - -- :ref:`int` **get_billboard_mode** **(** **)** const - -.. _class_SpatialMaterial_get_blend_mode: - -- :ref:`int` **get_blend_mode** **(** **)** const - -.. _class_SpatialMaterial_get_clearcoat: - -- :ref:`float` **get_clearcoat** **(** **)** const - -.. _class_SpatialMaterial_get_clearcoat_gloss: - -- :ref:`float` **get_clearcoat_gloss** **(** **)** const - -.. _class_SpatialMaterial_get_cull_mode: - -- :ref:`int` **get_cull_mode** **(** **)** const - -.. _class_SpatialMaterial_get_depth_deep_parallax_max_layers: - -- :ref:`int` **get_depth_deep_parallax_max_layers** **(** **)** const - -.. _class_SpatialMaterial_get_depth_deep_parallax_min_layers: - -- :ref:`int` **get_depth_deep_parallax_min_layers** **(** **)** const - -.. _class_SpatialMaterial_get_depth_draw_mode: - -- :ref:`int` **get_depth_draw_mode** **(** **)** const - -.. _class_SpatialMaterial_get_depth_scale: - -- :ref:`float` **get_depth_scale** **(** **)** const - -.. _class_SpatialMaterial_get_detail_blend_mode: - -- :ref:`int` **get_detail_blend_mode** **(** **)** const - -.. _class_SpatialMaterial_get_detail_uv: - -- :ref:`int` **get_detail_uv** **(** **)** const - -.. _class_SpatialMaterial_get_diffuse_mode: - -- :ref:`int` **get_diffuse_mode** **(** **)** const - -.. _class_SpatialMaterial_get_distance_fade_max_distance: - -- :ref:`float` **get_distance_fade_max_distance** **(** **)** const - -.. _class_SpatialMaterial_get_distance_fade_min_distance: - -- :ref:`float` **get_distance_fade_min_distance** **(** **)** const - -.. _class_SpatialMaterial_get_emission: - -- :ref:`Color` **get_emission** **(** **)** const - -.. _class_SpatialMaterial_get_emission_energy: - -- :ref:`float` **get_emission_energy** **(** **)** const - -.. _class_SpatialMaterial_get_feature: - -- :ref:`bool` **get_feature** **(** :ref:`int` feature **)** const - -.. _class_SpatialMaterial_get_flag: - -- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const - -.. _class_SpatialMaterial_get_grow: - -- :ref:`float` **get_grow** **(** **)** const - -.. _class_SpatialMaterial_get_line_width: - -- :ref:`float` **get_line_width** **(** **)** const - -.. _class_SpatialMaterial_get_metallic: - -- :ref:`float` **get_metallic** **(** **)** const - -.. _class_SpatialMaterial_get_metallic_texture_channel: - -- :ref:`int` **get_metallic_texture_channel** **(** **)** const - -.. _class_SpatialMaterial_get_normal_scale: - -- :ref:`float` **get_normal_scale** **(** **)** const - -.. _class_SpatialMaterial_get_particles_anim_h_frames: - -- :ref:`int` **get_particles_anim_h_frames** **(** **)** const - -.. _class_SpatialMaterial_get_particles_anim_loop: - -- :ref:`int` **get_particles_anim_loop** **(** **)** const - -.. _class_SpatialMaterial_get_particles_anim_v_frames: - -- :ref:`int` **get_particles_anim_v_frames** **(** **)** const - -.. _class_SpatialMaterial_get_point_size: - -- :ref:`float` **get_point_size** **(** **)** const - -.. _class_SpatialMaterial_get_proximity_fade_distance: - -- :ref:`float` **get_proximity_fade_distance** **(** **)** const - -.. _class_SpatialMaterial_get_refraction: - -- :ref:`float` **get_refraction** **(** **)** const - -.. _class_SpatialMaterial_get_refraction_texture_channel: - -- :ref:`int` **get_refraction_texture_channel** **(** **)** const - -.. _class_SpatialMaterial_get_rim: - -- :ref:`float` **get_rim** **(** **)** const - -.. _class_SpatialMaterial_get_rim_tint: - -- :ref:`float` **get_rim_tint** **(** **)** const - -.. _class_SpatialMaterial_get_roughness: - -- :ref:`float` **get_roughness** **(** **)** const - -.. _class_SpatialMaterial_get_roughness_texture_channel: - -- :ref:`int` **get_roughness_texture_channel** **(** **)** const - -.. _class_SpatialMaterial_get_specular: - -- :ref:`float` **get_specular** **(** **)** const - -.. _class_SpatialMaterial_get_specular_mode: - -- :ref:`int` **get_specular_mode** **(** **)** const - -.. _class_SpatialMaterial_get_subsurface_scattering_strength: - -- :ref:`float` **get_subsurface_scattering_strength** **(** **)** const - -.. _class_SpatialMaterial_get_texture: - -- :ref:`Texture` **get_texture** **(** :ref:`int` param **)** const - -.. _class_SpatialMaterial_get_transmission: - -- :ref:`Color` **get_transmission** **(** **)** const - -.. _class_SpatialMaterial_get_uv1_offset: - -- :ref:`Vector3` **get_uv1_offset** **(** **)** const - -.. _class_SpatialMaterial_get_uv1_scale: - -- :ref:`Vector3` **get_uv1_scale** **(** **)** const - -.. _class_SpatialMaterial_get_uv1_triplanar_blend_sharpness: - -- :ref:`float` **get_uv1_triplanar_blend_sharpness** **(** **)** const - -.. _class_SpatialMaterial_get_uv2_offset: - -- :ref:`Vector3` **get_uv2_offset** **(** **)** const - -.. _class_SpatialMaterial_get_uv2_scale: - -- :ref:`Vector3` **get_uv2_scale** **(** **)** const - -.. _class_SpatialMaterial_get_uv2_triplanar_blend_sharpness: - -- :ref:`float` **get_uv2_triplanar_blend_sharpness** **(** **)** const - -.. _class_SpatialMaterial_is_depth_deep_parallax_enabled: - -- :ref:`bool` **is_depth_deep_parallax_enabled** **(** **)** const - -.. _class_SpatialMaterial_is_distance_fade_enabled: - -- :ref:`bool` **is_distance_fade_enabled** **(** **)** const - -.. _class_SpatialMaterial_is_grow_enabled: - -- :ref:`bool` **is_grow_enabled** **(** **)** const - -.. _class_SpatialMaterial_is_proximity_fade_enabled: - -- :ref:`bool` **is_proximity_fade_enabled** **(** **)** const - -.. _class_SpatialMaterial_set_albedo: - -- void **set_albedo** **(** :ref:`Color` albedo **)** - -.. _class_SpatialMaterial_set_alpha_scissor_threshold: - -- void **set_alpha_scissor_threshold** **(** :ref:`float` threshold **)** - -.. _class_SpatialMaterial_set_anisotropy: - -- void **set_anisotropy** **(** :ref:`float` anisotropy **)** - -.. _class_SpatialMaterial_set_ao_light_affect: - -- void **set_ao_light_affect** **(** :ref:`float` amount **)** - -.. _class_SpatialMaterial_set_ao_texture_channel: - -- void **set_ao_texture_channel** **(** :ref:`int` channel **)** - -.. _class_SpatialMaterial_set_billboard_mode: - -- void **set_billboard_mode** **(** :ref:`int` mode **)** - -.. _class_SpatialMaterial_set_blend_mode: - -- void **set_blend_mode** **(** :ref:`int` blend_mode **)** - -.. _class_SpatialMaterial_set_clearcoat: - -- void **set_clearcoat** **(** :ref:`float` clearcoat **)** - -.. _class_SpatialMaterial_set_clearcoat_gloss: - -- void **set_clearcoat_gloss** **(** :ref:`float` clearcoat_gloss **)** - -.. _class_SpatialMaterial_set_cull_mode: - -- void **set_cull_mode** **(** :ref:`int` cull_mode **)** - -.. _class_SpatialMaterial_set_depth_deep_parallax: - -- void **set_depth_deep_parallax** **(** :ref:`bool` enable **)** - -.. _class_SpatialMaterial_set_depth_deep_parallax_max_layers: - -- void **set_depth_deep_parallax_max_layers** **(** :ref:`int` layer **)** - -.. _class_SpatialMaterial_set_depth_deep_parallax_min_layers: - -- void **set_depth_deep_parallax_min_layers** **(** :ref:`int` layer **)** - -.. _class_SpatialMaterial_set_depth_draw_mode: - -- void **set_depth_draw_mode** **(** :ref:`int` depth_draw_mode **)** - -.. _class_SpatialMaterial_set_depth_scale: - -- void **set_depth_scale** **(** :ref:`float` depth_scale **)** - -.. _class_SpatialMaterial_set_detail_blend_mode: - -- void **set_detail_blend_mode** **(** :ref:`int` detail_blend_mode **)** - -.. _class_SpatialMaterial_set_detail_uv: - -- void **set_detail_uv** **(** :ref:`int` detail_uv **)** - -.. _class_SpatialMaterial_set_diffuse_mode: - -- void **set_diffuse_mode** **(** :ref:`int` diffuse_mode **)** - -.. _class_SpatialMaterial_set_distance_fade: - -- void **set_distance_fade** **(** :ref:`bool` enabled **)** - -.. _class_SpatialMaterial_set_distance_fade_max_distance: - -- void **set_distance_fade_max_distance** **(** :ref:`float` distance **)** - -.. _class_SpatialMaterial_set_distance_fade_min_distance: - -- void **set_distance_fade_min_distance** **(** :ref:`float` distance **)** - -.. _class_SpatialMaterial_set_emission: - -- void **set_emission** **(** :ref:`Color` emission **)** - -.. _class_SpatialMaterial_set_emission_energy: - -- void **set_emission_energy** **(** :ref:`float` emission_energy **)** - -.. _class_SpatialMaterial_set_feature: - -- void **set_feature** **(** :ref:`int` feature, :ref:`bool` enable **)** - -.. _class_SpatialMaterial_set_flag: - -- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** - -.. _class_SpatialMaterial_set_grow: - -- void **set_grow** **(** :ref:`float` amount **)** - -.. _class_SpatialMaterial_set_grow_enabled: - -- void **set_grow_enabled** **(** :ref:`bool` enable **)** - -.. _class_SpatialMaterial_set_line_width: - -- void **set_line_width** **(** :ref:`float` line_width **)** - -.. _class_SpatialMaterial_set_metallic: - -- void **set_metallic** **(** :ref:`float` metallic **)** - -.. _class_SpatialMaterial_set_metallic_texture_channel: - -- void **set_metallic_texture_channel** **(** :ref:`int` channel **)** - -.. _class_SpatialMaterial_set_normal_scale: - -- void **set_normal_scale** **(** :ref:`float` normal_scale **)** - -.. _class_SpatialMaterial_set_particles_anim_h_frames: - -- void **set_particles_anim_h_frames** **(** :ref:`int` frames **)** - -.. _class_SpatialMaterial_set_particles_anim_loop: - -- void **set_particles_anim_loop** **(** :ref:`int` frames **)** - -.. _class_SpatialMaterial_set_particles_anim_v_frames: - -- void **set_particles_anim_v_frames** **(** :ref:`int` frames **)** - -.. _class_SpatialMaterial_set_point_size: - -- void **set_point_size** **(** :ref:`float` point_size **)** - -.. _class_SpatialMaterial_set_proximity_fade: - -- void **set_proximity_fade** **(** :ref:`bool` enabled **)** - -.. _class_SpatialMaterial_set_proximity_fade_distance: - -- void **set_proximity_fade_distance** **(** :ref:`float` distance **)** - -.. _class_SpatialMaterial_set_refraction: - -- void **set_refraction** **(** :ref:`float` refraction **)** - -.. _class_SpatialMaterial_set_refraction_texture_channel: - -- void **set_refraction_texture_channel** **(** :ref:`int` channel **)** - -.. _class_SpatialMaterial_set_rim: - -- void **set_rim** **(** :ref:`float` rim **)** - -.. _class_SpatialMaterial_set_rim_tint: - -- void **set_rim_tint** **(** :ref:`float` rim_tint **)** - -.. _class_SpatialMaterial_set_roughness: - -- void **set_roughness** **(** :ref:`float` roughness **)** - -.. _class_SpatialMaterial_set_roughness_texture_channel: - -- void **set_roughness_texture_channel** **(** :ref:`int` channel **)** - -.. _class_SpatialMaterial_set_specular: - -- void **set_specular** **(** :ref:`float` specular **)** - -.. _class_SpatialMaterial_set_specular_mode: - -- void **set_specular_mode** **(** :ref:`int` specular_mode **)** - -.. _class_SpatialMaterial_set_subsurface_scattering_strength: - -- void **set_subsurface_scattering_strength** **(** :ref:`float` strength **)** - -.. _class_SpatialMaterial_set_texture: - -- void **set_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** - -.. _class_SpatialMaterial_set_transmission: - -- void **set_transmission** **(** :ref:`Color` transmission **)** - -.. _class_SpatialMaterial_set_uv1_offset: - -- void **set_uv1_offset** **(** :ref:`Vector3` offset **)** - -.. _class_SpatialMaterial_set_uv1_scale: - -- void **set_uv1_scale** **(** :ref:`Vector3` scale **)** - -.. _class_SpatialMaterial_set_uv1_triplanar_blend_sharpness: - -- void **set_uv1_triplanar_blend_sharpness** **(** :ref:`float` sharpness **)** - -.. _class_SpatialMaterial_set_uv2_offset: - -- void **set_uv2_offset** **(** :ref:`Vector3` offset **)** - -.. _class_SpatialMaterial_set_uv2_scale: - -- void **set_uv2_scale** **(** :ref:`Vector3` scale **)** - -.. _class_SpatialMaterial_set_uv2_triplanar_blend_sharpness: - -- void **set_uv2_triplanar_blend_sharpness** **(** :ref:`float` sharpness **)** - +- **EMISSION_OP_ADD** = **0** +- **EMISSION_OP_MULTIPLY** = **1** diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index 94082d408..5129a816b 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -16,31 +16,6 @@ Brief Description Class representing a spherical :ref:`PrimitiveMesh`. -Member Functions ----------------- - -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_hemisphere` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rings` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_is_hemisphere` **(** :ref:`bool` is_hemisphere **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_segments` **(** :ref:`int` radial_segments **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rings` **(** :ref:`int` rings **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -70,47 +45,3 @@ Description Class representing a spherical :ref:`PrimitiveMesh`. -Member Function Description ---------------------------- - -.. _class_SphereMesh_get_height: - -- :ref:`float` **get_height** **(** **)** const - -.. _class_SphereMesh_get_is_hemisphere: - -- :ref:`bool` **get_is_hemisphere** **(** **)** const - -.. _class_SphereMesh_get_radial_segments: - -- :ref:`int` **get_radial_segments** **(** **)** const - -.. _class_SphereMesh_get_radius: - -- :ref:`float` **get_radius** **(** **)** const - -.. _class_SphereMesh_get_rings: - -- :ref:`int` **get_rings** **(** **)** const - -.. _class_SphereMesh_set_height: - -- void **set_height** **(** :ref:`float` height **)** - -.. _class_SphereMesh_set_is_hemisphere: - -- void **set_is_hemisphere** **(** :ref:`bool` is_hemisphere **)** - -.. _class_SphereMesh_set_radial_segments: - -- void **set_radial_segments** **(** :ref:`int` radial_segments **)** - -.. _class_SphereMesh_set_radius: - -- void **set_radius** **(** :ref:`float` radius **)** - -.. _class_SphereMesh_set_rings: - -- void **set_rings** **(** :ref:`int` rings **)** - - diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 84d0d19e2..6c512cb86 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -16,15 +16,6 @@ Brief Description Sphere shape for 3D collisions. -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+----------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,15 +29,3 @@ Description Sphere shape for 3D collisions, which can be set into a :ref:`PhysicsBody` or :ref:`Area`. This shape is useful for modeling sphere-like 3D objects. -Member Function Description ---------------------------- - -.. _class_SphereShape_get_radius: - -- :ref:`float` **get_radius** **(** **)** const - -.. _class_SphereShape_set_radius: - -- void **set_radius** **(** :ref:`float` radius **)** - - diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 35cc156ce..d679175d3 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -19,21 +19,9 @@ Numerical input text field. Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_prefix` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_suffix` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`bool` editable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_prefix` **(** :ref:`String` prefix **)** | -+----------------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_suffix` **(** :ref:`String` suffix **)** | -+----------------------------------+----------------------------------------------------------------------------------------------+ ++----------------------------------+---------------------------------------------------------------+ +| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | ++----------------------------------+---------------------------------------------------------------+ Member Variables ---------------- @@ -63,38 +51,4 @@ Member Function Description - :ref:`LineEdit` **get_line_edit** **(** **)** -.. _class_SpinBox_get_prefix: - -- :ref:`String` **get_prefix** **(** **)** const - -.. _class_SpinBox_get_suffix: - -- :ref:`String` **get_suffix** **(** **)** const - -Return the specific suffix. - -.. _class_SpinBox_is_editable: - -- :ref:`bool` **is_editable** **(** **)** const - -Return if the spinbox is editable. - -.. _class_SpinBox_set_editable: - -- void **set_editable** **(** :ref:`bool` editable **)** - -Set whether the spinbox is editable. - -.. _class_SpinBox_set_prefix: - -- void **set_prefix** **(** :ref:`String` prefix **)** - -Set a prefix. - -.. _class_SpinBox_set_suffix: - -- void **set_suffix** **(** :ref:`String` suffix **)** - -Set a specific suffix. - diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 707f4fb88..9241dbc45 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -18,23 +18,6 @@ Brief Description Container for splitting and adjusting. -Member Functions ----------------- - -+--------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dragger_visibility` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_split_offset` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_collapsed` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collapsed` **(** :ref:`bool` collapsed **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dragger_visibility` **(** :ref:`int` mode **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_split_offset` **(** :ref:`int` offset **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------+ - Signals ------- @@ -73,43 +56,3 @@ Description Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. -Member Function Description ---------------------------- - -.. _class_SplitContainer_get_dragger_visibility: - -- :ref:`int` **get_dragger_visibility** **(** **)** const - -Return visibility of the split dragger (one of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED). - -.. _class_SplitContainer_get_split_offset: - -- :ref:`int` **get_split_offset** **(** **)** const - -Return the split offset. - -.. _class_SplitContainer_is_collapsed: - -- :ref:`bool` **is_collapsed** **(** **)** const - -Return true if the split is collapsed. - -.. _class_SplitContainer_set_collapsed: - -- void **set_collapsed** **(** :ref:`bool` collapsed **)** - -Set if the split must be collapsed. - -.. _class_SplitContainer_set_dragger_visibility: - -- void **set_dragger_visibility** **(** :ref:`int` mode **)** - -Set visibility of the split dragger (*mode* must be one of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED). - -.. _class_SplitContainer_set_split_offset: - -- void **set_split_offset** **(** :ref:`int` offset **)** - -Set the split offset. - - diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 6d1bf58dc..a6d7f33f6 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -16,59 +16,6 @@ Brief Description General purpose Sprite node. -Member Functions ----------------- - -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hframes` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_vframes` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_centered` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_region` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_region_filter_clip_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`int` frame **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hframes` **(** :ref:`int` hframes **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_map` **(** :ref:`Texture` normal_map **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_filter_clip` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vframes` **(** :ref:`int` vframes **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ - Signals ------- @@ -142,143 +89,3 @@ Description A node that displays a 2D texture. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. -Member Function Description ---------------------------- - -.. _class_Sprite_get_frame: - -- :ref:`int` **get_frame** **(** **)** const - -Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. - -.. _class_Sprite_get_hframes: - -- :ref:`int` **get_hframes** **(** **)** const - -Return the amount of horizontal frames. See :ref:`set_hframes`. - -.. _class_Sprite_get_normal_map: - -- :ref:`Texture` **get_normal_map** **(** **)** const - -.. _class_Sprite_get_offset: - -- :ref:`Vector2` **get_offset** **(** **)** const - -Return sprite draw offset. - -.. _class_Sprite_get_region_rect: - -- :ref:`Rect2` **get_region_rect** **(** **)** const - -Return the region rect to read from. - -.. _class_Sprite_get_texture: - -- :ref:`Texture` **get_texture** **(** **)** const - -Return the base texture for the sprite. - -.. _class_Sprite_get_vframes: - -- :ref:`int` **get_vframes** **(** **)** const - -Return the amount of vertical frames. See :ref:`set_vframes`. - -.. _class_Sprite_is_centered: - -- :ref:`bool` **is_centered** **(** **)** const - -Return if the sprite is centered at the local origin. - -.. _class_Sprite_is_flipped_h: - -- :ref:`bool` **is_flipped_h** **(** **)** const - -Return true if the sprite is flipped horizontally. - -.. _class_Sprite_is_flipped_v: - -- :ref:`bool` **is_flipped_v** **(** **)** const - -Return true if the sprite is flipped vertically. - -.. _class_Sprite_is_region: - -- :ref:`bool` **is_region** **(** **)** const - -Return if the sprite reads from a region. - -.. _class_Sprite_is_region_filter_clip_enabled: - -- :ref:`bool` **is_region_filter_clip_enabled** **(** **)** const - -.. _class_Sprite_set_centered: - -- void **set_centered** **(** :ref:`bool` centered **)** - -Set whether the sprite should be centered on the origin. - -.. _class_Sprite_set_flip_h: - -- void **set_flip_h** **(** :ref:`bool` flip_h **)** - -Set true to flip the sprite horizontally. - -.. _class_Sprite_set_flip_v: - -- void **set_flip_v** **(** :ref:`bool` flip_v **)** - -Set true to flip the sprite vertically. - -.. _class_Sprite_set_frame: - -- void **set_frame** **(** :ref:`int` frame **)** - -Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. - -.. _class_Sprite_set_hframes: - -- void **set_hframes** **(** :ref:`int` hframes **)** - -Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. - -.. _class_Sprite_set_normal_map: - -- void **set_normal_map** **(** :ref:`Texture` normal_map **)** - -.. _class_Sprite_set_offset: - -- void **set_offset** **(** :ref:`Vector2` offset **)** - -Set the sprite draw offset, useful for setting rotation pivots. - -.. _class_Sprite_set_region: - -- void **set_region** **(** :ref:`bool` enabled **)** - -Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. - -.. _class_Sprite_set_region_filter_clip: - -- void **set_region_filter_clip** **(** :ref:`bool` enabled **)** - -.. _class_Sprite_set_region_rect: - -- void **set_region_rect** **(** :ref:`Rect2` rect **)** - -Set the region rect to read from. - -.. _class_Sprite_set_texture: - -- void **set_texture** **(** :ref:`Texture` texture **)** - -Set the base texture for the sprite. - -.. _class_Sprite_set_vframes: - -- void **set_vframes** **(** :ref:`int` vframes **)** - -Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. - - diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 48e6a724d..ffcce51fc 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -16,35 +16,6 @@ Brief Description 2D Sprite node in 3D world. -Member Functions ----------------- - -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hframes` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_vframes` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_region` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`int` frame **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hframes` **(** :ref:`int` hframes **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region` **(** :ref:`bool` enabled **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vframes` **(** :ref:`int` vframes **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ - Signals ------- @@ -88,55 +59,3 @@ Description A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. -Member Function Description ---------------------------- - -.. _class_Sprite3D_get_frame: - -- :ref:`int` **get_frame** **(** **)** const - -.. _class_Sprite3D_get_hframes: - -- :ref:`int` **get_hframes** **(** **)** const - -.. _class_Sprite3D_get_region_rect: - -- :ref:`Rect2` **get_region_rect** **(** **)** const - -.. _class_Sprite3D_get_texture: - -- :ref:`Texture` **get_texture** **(** **)** const - -.. _class_Sprite3D_get_vframes: - -- :ref:`int` **get_vframes** **(** **)** const - -.. _class_Sprite3D_is_region: - -- :ref:`bool` **is_region** **(** **)** const - -.. _class_Sprite3D_set_frame: - -- void **set_frame** **(** :ref:`int` frame **)** - -.. _class_Sprite3D_set_hframes: - -- void **set_hframes** **(** :ref:`int` hframes **)** - -.. _class_Sprite3D_set_region: - -- void **set_region** **(** :ref:`bool` enabled **)** - -.. _class_Sprite3D_set_region_rect: - -- void **set_region_rect** **(** :ref:`Rect2` rect **)** - -.. _class_Sprite3D_set_texture: - -- void **set_texture** **(** :ref:`Texture` texture **)** - -.. _class_Sprite3D_set_vframes: - -- void **set_vframes** **(** :ref:`int` vframes **)** - - diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 28e3f03f8..70a207181 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -21,49 +21,9 @@ Brief Description Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_alpha_cut_mode` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_axis` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_draw_flag` **(** :ref:`int` flag **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_opacity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pixel_size` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_centered` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_alpha_cut_mode` **(** :ref:`int` mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis` **(** :ref:`int` axis **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_flag` **(** :ref:`int` flag, :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_opacity` **(** :ref:`float` opacity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pixel_size` **(** :ref:`float` pixel_size **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------+ Member Variables ---------------- @@ -136,88 +96,8 @@ A node that displays 2D texture information in a 3D environment. Member Function Description --------------------------- -.. _class_SpriteBase3D_get_alpha_cut_mode: - -- :ref:`int` **get_alpha_cut_mode** **(** **)** const - -.. _class_SpriteBase3D_get_axis: - -- :ref:`int` **get_axis** **(** **)** const - -.. _class_SpriteBase3D_get_draw_flag: - -- :ref:`bool` **get_draw_flag** **(** :ref:`int` flag **)** const - .. _class_SpriteBase3D_get_item_rect: - :ref:`Rect2` **get_item_rect** **(** **)** const -.. _class_SpriteBase3D_get_modulate: - -- :ref:`Color` **get_modulate** **(** **)** const - -.. _class_SpriteBase3D_get_offset: - -- :ref:`Vector2` **get_offset** **(** **)** const - -.. _class_SpriteBase3D_get_opacity: - -- :ref:`float` **get_opacity** **(** **)** const - -.. _class_SpriteBase3D_get_pixel_size: - -- :ref:`float` **get_pixel_size** **(** **)** const - -.. _class_SpriteBase3D_is_centered: - -- :ref:`bool` **is_centered** **(** **)** const - -.. _class_SpriteBase3D_is_flipped_h: - -- :ref:`bool` **is_flipped_h** **(** **)** const - -.. _class_SpriteBase3D_is_flipped_v: - -- :ref:`bool` **is_flipped_v** **(** **)** const - -.. _class_SpriteBase3D_set_alpha_cut_mode: - -- void **set_alpha_cut_mode** **(** :ref:`int` mode **)** - -.. _class_SpriteBase3D_set_axis: - -- void **set_axis** **(** :ref:`int` axis **)** - -.. _class_SpriteBase3D_set_centered: - -- void **set_centered** **(** :ref:`bool` centered **)** - -.. _class_SpriteBase3D_set_draw_flag: - -- void **set_draw_flag** **(** :ref:`int` flag, :ref:`bool` enabled **)** - -.. _class_SpriteBase3D_set_flip_h: - -- void **set_flip_h** **(** :ref:`bool` flip_h **)** - -.. _class_SpriteBase3D_set_flip_v: - -- void **set_flip_v** **(** :ref:`bool` flip_v **)** - -.. _class_SpriteBase3D_set_modulate: - -- void **set_modulate** **(** :ref:`Color` modulate **)** - -.. _class_SpriteBase3D_set_offset: - -- void **set_offset** **(** :ref:`Vector2` offset **)** - -.. _class_SpriteBase3D_set_opacity: - -- void **set_opacity** **(** :ref:`float` opacity **)** - -.. _class_SpriteBase3D_set_pixel_size: - -- void **set_pixel_size** **(** :ref:`float` pixel_size **)** - diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 42349ab4a..87418b4d9 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -16,27 +16,6 @@ Brief Description Static body for 3D Physics. -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bounce` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_constant_angular_velocity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_constant_linear_velocity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_angular_velocity` **(** :ref:`Vector3` vel **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_linear_velocity` **(** :ref:`Vector3` vel **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -66,55 +45,3 @@ A static body can also be animated by using simulated motion mode. This is usefu Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels). -Member Function Description ---------------------------- - -.. _class_StaticBody_get_bounce: - -- :ref:`float` **get_bounce** **(** **)** const - -Return the body bounciness. - -.. _class_StaticBody_get_constant_angular_velocity: - -- :ref:`Vector3` **get_constant_angular_velocity** **(** **)** const - -Return the constant angular velocity for the body. - -.. _class_StaticBody_get_constant_linear_velocity: - -- :ref:`Vector3` **get_constant_linear_velocity** **(** **)** const - -Return the constant linear velocity for the body. - -.. _class_StaticBody_get_friction: - -- :ref:`float` **get_friction** **(** **)** const - -Return the body friction. - -.. _class_StaticBody_set_bounce: - -- void **set_bounce** **(** :ref:`float` bounce **)** - -Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). - -.. _class_StaticBody_set_constant_angular_velocity: - -- void **set_constant_angular_velocity** **(** :ref:`Vector3` vel **)** - -Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. - -.. _class_StaticBody_set_constant_linear_velocity: - -- void **set_constant_linear_velocity** **(** :ref:`Vector3` vel **)** - -Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. - -.. _class_StaticBody_set_friction: - -- void **set_friction** **(** :ref:`float` friction **)** - -Set the body friction, from 0 (frictionless) to 1 (full friction). - - diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index e4b976756..9bec741ac 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -16,27 +16,6 @@ Brief Description Static body for 2D Physics. -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bounce` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_constant_angular_velocity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_constant_linear_velocity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_angular_velocity` **(** :ref:`float` vel **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_linear_velocity` **(** :ref:`Vector2` vel **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -64,55 +43,3 @@ Static body for 2D Physics. A StaticBody2D is a body that is not intended to mov Additionally, a constant linear or angular velocity can be set for the static body, which will affect colliding bodies as if it were moving (for example, a conveyor belt). -Member Function Description ---------------------------- - -.. _class_StaticBody2D_get_bounce: - -- :ref:`float` **get_bounce** **(** **)** const - -Return the body bounciness. - -.. _class_StaticBody2D_get_constant_angular_velocity: - -- :ref:`float` **get_constant_angular_velocity** **(** **)** const - -Return the constant angular velocity for the body. - -.. _class_StaticBody2D_get_constant_linear_velocity: - -- :ref:`Vector2` **get_constant_linear_velocity** **(** **)** const - -Return the constant linear velocity for the body. - -.. _class_StaticBody2D_get_friction: - -- :ref:`float` **get_friction** **(** **)** const - -Return the body friction. - -.. _class_StaticBody2D_set_bounce: - -- void **set_bounce** **(** :ref:`float` bounce **)** - -Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). - -.. _class_StaticBody2D_set_constant_angular_velocity: - -- void **set_constant_angular_velocity** **(** :ref:`float` vel **)** - -Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. - -.. _class_StaticBody2D_set_constant_linear_velocity: - -- void **set_constant_linear_velocity** **(** :ref:`Vector2` vel **)** - -Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. - -.. _class_StaticBody2D_set_friction: - -- void **set_friction** **(** :ref:`float` friction **)** - -Set the body friction, from 0 (frictionless) to 1 (full friction). - - diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index 6ebf91c64..81437e396 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -16,15 +16,6 @@ Brief Description -Member Functions ----------------- - -+------------------------------+------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_load_path` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | -+------------------------------+------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -33,15 +24,3 @@ Member Variables - :ref:`String` **load_path** -Member Function Description ---------------------------- - -.. _class_StreamTexture_get_load_path: - -- :ref:`String` **get_load_path** **(** **)** const - -.. _class_StreamTexture_load: - -- :ref:`int` **load** **(** :ref:`String` path **)** - - diff --git a/classes/class_string.rst b/classes/class_string.rst index c93917ed6..904e1a73c 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -36,7 +36,7 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Rect3` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`AABB` from **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ @@ -259,9 +259,9 @@ Constructs a new String from the given :ref:`Quat`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Rect3` from **)** +- :ref:`String` **String** **(** :ref:`AABB` from **)** -Constructs a new String from the given :ref:`Rect3`. +Constructs a new String from the given :ref:`AABB`. .. _class_String_String: diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index f7c8816ed..1df04b8f8 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -21,23 +21,19 @@ Base class for drawing stylized boxes for the UI. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_center_size` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_center_size` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -75,12 +71,6 @@ Member Function Description - :ref:`Vector2` **get_center_size** **(** **)** const -.. _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. - .. _class_StyleBox_get_margin: - :ref:`float` **get_margin** **(** :ref:`int` margin **)** const @@ -99,12 +89,6 @@ Return the minimum size that this stylebox can be shrunk to. Return the "offset" of a stylebox, this is a helper function, like writing ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``. -.. _class_StyleBox_set_default_margin: - -- 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. - .. _class_StyleBox_test_mask: - :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 681505fb8..c740a93d5 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -19,67 +19,19 @@ Customizable Stylebox with a given set of parameters. (no texture required) Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_aa_size` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_border_blend` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_border_color` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_width` **(** :ref:`int` margin **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_width_min` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_corner_detail` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_corner_radius` **(** :ref:`int` corner **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin` **(** :ref:`int` margin **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_size` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_anti_aliased` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_aa_size` **(** :ref:`int` size **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anti_aliased` **(** :ref:`bool` anti_aliased **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_blend` **(** :ref:`bool` blend **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_color` **(** :ref:`Color` color **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_width` **(** :ref:`int` margin, :ref:`int` width **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_detail` **(** :ref:`int` detail **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius` **(** :ref:`int` corner, :ref:`int` radius **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius_individual` **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin` **(** :ref:`int` margin, :ref:`float` size **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_color` **(** :ref:`Color` color **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_size` **(** :ref:`int` size **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_border_width_min` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius_individual` **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -206,94 +158,14 @@ The relative system now would take the 1:2 ratio of the two left corners to calc Member Function Description --------------------------- -.. _class_StyleBoxFlat_get_aa_size: - -- :ref:`int` **get_aa_size** **(** **)** const - -.. _class_StyleBoxFlat_get_bg_color: - -- :ref:`Color` **get_bg_color** **(** **)** const - -.. _class_StyleBoxFlat_get_border_blend: - -- :ref:`bool` **get_border_blend** **(** **)** const - -.. _class_StyleBoxFlat_get_border_color: - -- :ref:`Color` **get_border_color** **(** **)** const - -.. _class_StyleBoxFlat_get_border_width: - -- :ref:`int` **get_border_width** **(** :ref:`int` margin **)** const - .. _class_StyleBoxFlat_get_border_width_min: - :ref:`int` **get_border_width_min** **(** **)** const -.. _class_StyleBoxFlat_get_corner_detail: - -- :ref:`int` **get_corner_detail** **(** **)** const - -.. _class_StyleBoxFlat_get_corner_radius: - -- :ref:`int` **get_corner_radius** **(** :ref:`int` corner **)** const - -.. _class_StyleBoxFlat_get_expand_margin: - -- :ref:`float` **get_expand_margin** **(** :ref:`int` margin **)** const - -.. _class_StyleBoxFlat_get_shadow_color: - -- :ref:`Color` **get_shadow_color** **(** **)** const - -.. _class_StyleBoxFlat_get_shadow_size: - -- :ref:`int` **get_shadow_size** **(** **)** const - -.. _class_StyleBoxFlat_is_anti_aliased: - -- :ref:`bool` **is_anti_aliased** **(** **)** const - -.. _class_StyleBoxFlat_is_draw_center_enabled: - -- :ref:`bool` **is_draw_center_enabled** **(** **)** const - -.. _class_StyleBoxFlat_set_aa_size: - -- void **set_aa_size** **(** :ref:`int` size **)** - -.. _class_StyleBoxFlat_set_anti_aliased: - -- void **set_anti_aliased** **(** :ref:`bool` anti_aliased **)** - -.. _class_StyleBoxFlat_set_bg_color: - -- void **set_bg_color** **(** :ref:`Color` color **)** - -.. _class_StyleBoxFlat_set_border_blend: - -- void **set_border_blend** **(** :ref:`bool` blend **)** - -.. _class_StyleBoxFlat_set_border_color: - -- void **set_border_color** **(** :ref:`Color` color **)** - -.. _class_StyleBoxFlat_set_border_width: - -- void **set_border_width** **(** :ref:`int` margin, :ref:`int` width **)** - .. _class_StyleBoxFlat_set_border_width_all: - void **set_border_width_all** **(** :ref:`int` width **)** -.. _class_StyleBoxFlat_set_corner_detail: - -- void **set_corner_detail** **(** :ref:`int` detail **)** - -.. _class_StyleBoxFlat_set_corner_radius: - -- void **set_corner_radius** **(** :ref:`int` corner, :ref:`int` radius **)** - .. _class_StyleBoxFlat_set_corner_radius_all: - void **set_corner_radius_all** **(** :ref:`int` radius **)** @@ -302,14 +174,6 @@ Member Function Description - void **set_corner_radius_individual** **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** -.. _class_StyleBoxFlat_set_draw_center: - -- void **set_draw_center** **(** :ref:`bool` draw_center **)** - -.. _class_StyleBoxFlat_set_expand_margin: - -- void **set_expand_margin** **(** :ref:`int` margin, :ref:`float` size **)** - .. _class_StyleBoxFlat_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** @@ -318,12 +182,4 @@ Member Function Description - void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** -.. _class_StyleBoxFlat_set_shadow_color: - -- void **set_shadow_color** **(** :ref:`Color` color **)** - -.. _class_StyleBoxFlat_set_shadow_size: - -- void **set_shadow_size** **(** :ref:`int` size **)** - diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index 20f8563f8..8fa5c143c 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -19,23 +19,11 @@ Brief Description Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_grow` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_thickness` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_vertical` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_grow` **(** :ref:`float` grow **)** | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_thickness` **(** :ref:`int` thickness **)** | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertical` **(** :ref:`bool` vertical **)** | -+----------------------------+----------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_grow` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------+ +| void | :ref:`set_grow` **(** :ref:`float` grow **)** | ++----------------------------+-----------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -56,36 +44,12 @@ Member Variables Member Function Description --------------------------- -.. _class_StyleBoxLine_get_color: - -- :ref:`Color` **get_color** **(** **)** const - .. _class_StyleBoxLine_get_grow: - :ref:`float` **get_grow** **(** **)** const -.. _class_StyleBoxLine_get_thickness: - -- :ref:`int` **get_thickness** **(** **)** const - -.. _class_StyleBoxLine_is_vertical: - -- :ref:`bool` **is_vertical** **(** **)** const - -.. _class_StyleBoxLine_set_color: - -- void **set_color** **(** :ref:`Color` color **)** - .. _class_StyleBoxLine_set_grow: - void **set_grow** **(** :ref:`float` grow **)** -.. _class_StyleBoxLine_set_thickness: - -- void **set_thickness** **(** :ref:`int` thickness **)** - -.. _class_StyleBoxLine_set_vertical: - -- void **set_vertical** **(** :ref:`bool` vertical **)** - diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index c6d53bcc2..6eb5f6e64 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -19,47 +19,11 @@ Texture Based 3x3 scale style. Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`int` margin **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin_size` **(** :ref:`int` margin **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_normal_map` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_texture` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` color **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_map` **(** :ref:`Resource` normal_map **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` region **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Resource` texture **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | ++-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -148,46 +112,6 @@ Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture Member Function Description --------------------------- -.. _class_StyleBoxTexture_get_expand_margin_size: - -- :ref:`float` **get_expand_margin_size** **(** :ref:`int` margin **)** const - -.. _class_StyleBoxTexture_get_h_axis_stretch_mode: - -- :ref:`int` **get_h_axis_stretch_mode** **(** **)** const - -.. _class_StyleBoxTexture_get_margin_size: - -- :ref:`float` **get_margin_size** **(** :ref:`int` margin **)** const - -.. _class_StyleBoxTexture_get_modulate: - -- :ref:`Color` **get_modulate** **(** **)** const - -.. _class_StyleBoxTexture_get_normal_map: - -- :ref:`Resource` **get_normal_map** **(** **)** const - -.. _class_StyleBoxTexture_get_region_rect: - -- :ref:`Rect2` **get_region_rect** **(** **)** const - -.. _class_StyleBoxTexture_get_texture: - -- :ref:`Resource` **get_texture** **(** **)** const - -.. _class_StyleBoxTexture_get_v_axis_stretch_mode: - -- :ref:`int` **get_v_axis_stretch_mode** **(** **)** const - -.. _class_StyleBoxTexture_is_draw_center_enabled: - -- :ref:`bool` **is_draw_center_enabled** **(** **)** const - -.. _class_StyleBoxTexture_set_draw_center: - -- void **set_draw_center** **(** :ref:`bool` enable **)** - .. _class_StyleBoxTexture_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** @@ -196,36 +120,4 @@ Member Function Description - void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** -.. _class_StyleBoxTexture_set_expand_margin_size: - -- void **set_expand_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** - -.. _class_StyleBoxTexture_set_h_axis_stretch_mode: - -- void **set_h_axis_stretch_mode** **(** :ref:`int` mode **)** - -.. _class_StyleBoxTexture_set_margin_size: - -- void **set_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** - -.. _class_StyleBoxTexture_set_modulate: - -- void **set_modulate** **(** :ref:`Color` color **)** - -.. _class_StyleBoxTexture_set_normal_map: - -- void **set_normal_map** **(** :ref:`Resource` normal_map **)** - -.. _class_StyleBoxTexture_set_region_rect: - -- void **set_region_rect** **(** :ref:`Rect2` region **)** - -.. _class_StyleBoxTexture_set_texture: - -- void **set_texture** **(** :ref:`Resource` texture **)** - -.. _class_StyleBoxTexture_set_v_axis_stretch_mode: - -- void **set_v_axis_stretch_mode** **(** :ref:`int` mode **)** - diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index c482cb519..6b8d6952a 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -19,10 +19,6 @@ Tabbed Container. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_tabs_visible` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_tab` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ @@ -30,8 +26,6 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_previous_tab` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_align` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_count` **(** **)** const | @@ -42,20 +36,14 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_popup` **(** :ref:`Node` popup **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_align` **(** :ref:`int` align **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tabs_visible` **(** :ref:`bool` visible **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -116,18 +104,6 @@ To hide only a tab's content, nest the content inside a child :ref:`Control` **are_tabs_visible** **(** **)** const - -Returns ``true`` if the tabs are visible. - -.. _class_TabContainer_get_current_tab: - -- :ref:`int` **get_current_tab** **(** **)** const - -Returns the currently visible tab's index. - .. _class_TabContainer_get_current_tab_control: - :ref:`Control` **get_current_tab_control** **(** **)** const @@ -146,12 +122,6 @@ Returns the :ref:`Popup` node instance if one has been set already Returns the previously active tab index. -.. _class_TabContainer_get_tab_align: - -- :ref:`int` **get_tab_align** **(** **)** const - -Returns the tab alignment. See the ``ALIGN\_\*`` constants. - .. _class_TabContainer_get_tab_control: - :ref:`Control` **get_tab_control** **(** :ref:`int` idx **)** const @@ -182,24 +152,12 @@ Returns the :ref:`Texture` for the tab at index ``tab_idx`` or nu Returns the title of the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. -.. _class_TabContainer_set_current_tab: - -- void **set_current_tab** **(** :ref:`int` tab_idx **)** - -Sets to ``false`` the ``visible`` property for all :ref:`Control` children except for the tab at ``tab_idx``. - .. _class_TabContainer_set_popup: - void **set_popup** **(** :ref:`Node` popup **)** If set on a :ref:`Popup` node instance, a popup menu icon appears in the top-right corner of the ``TabContainer``. Clicking it will expand the :ref:`Popup` node. -.. _class_TabContainer_set_tab_align: - -- void **set_tab_align** **(** :ref:`int` align **)** - -Sets tab alignment, from the ``ALIGN\_\*`` constants. Moves tabs to the left, right, or center. - .. _class_TabContainer_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** @@ -218,10 +176,4 @@ Sets an icon for the tab at index ``tab_idx``. Sets a title for the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. -.. _class_TabContainer_set_tabs_visible: - -- void **set_tabs_visible** **(** :ref:`bool` visible **)** - -If ``true`` tabs are visible. If ``false`` tabs' content and titles are hidden. Default value: ``true``. - diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 91cc554e7..1a290b411 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -24,18 +24,18 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_tab` **(** **)** const | +| :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_align` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_close_display_policy` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_count` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_offset` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | @@ -44,12 +44,8 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_align` **(** :ref:`int` align **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_close_display_policy` **(** :ref:`int` policy **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | @@ -92,6 +88,10 @@ Member Variables - :ref:`int` **current_tab** + .. _class_Tabs_scrolling_enabled: + +- :ref:`bool` **scrolling_enabled** + .. _class_Tabs_tab_close_display_policy: - :ref:`int` **tab_close_display_policy** @@ -125,18 +125,14 @@ Member Function Description - void **ensure_tab_visible** **(** :ref:`int` idx **)** -.. _class_Tabs_get_current_tab: +.. _class_Tabs_get_offset_buttons_visible: -- :ref:`int` **get_current_tab** **(** **)** const +- :ref:`bool` **get_offset_buttons_visible** **(** **)** const .. _class_Tabs_get_tab_align: - :ref:`int` **get_tab_align** **(** **)** const -.. _class_Tabs_get_tab_close_display_policy: - -- :ref:`int` **get_tab_close_display_policy** **(** **)** const - .. _class_Tabs_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const @@ -149,6 +145,10 @@ Member Function Description - :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +.. _class_Tabs_get_tab_offset: + +- :ref:`int` **get_tab_offset** **(** **)** const + .. _class_Tabs_get_tab_rect: - :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const @@ -169,18 +169,10 @@ Rearrange tab. - void **remove_tab** **(** :ref:`int` tab_idx **)** -.. _class_Tabs_set_current_tab: - -- void **set_current_tab** **(** :ref:`int` tab_idx **)** - .. _class_Tabs_set_tab_align: - void **set_tab_align** **(** :ref:`int` align **)** -.. _class_Tabs_set_tab_close_display_policy: - -- void **set_tab_close_display_policy** **(** :ref:`int` policy **)** - .. _class_Tabs_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index aee726923..6c31bc458 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -24,34 +24,28 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_fold` **(** :ref:`int` line **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_colors` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_undo_history` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`copy` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`cursor_get_column` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`cursor_get_line` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_is_block_mode` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** | +| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cut` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fold_all_lines` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fold_line` **(** :ref:`int` line **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_line_count` **(** **)** const | @@ -68,32 +62,16 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_scroll_speed` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_context_menu_enabled` **(** **)** | +| :ref:`bool` | :ref:`is_folded` **(** :ref:`int` line **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_highlight_all_occurrences_enabled` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_highlight_current_line_enabled` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overriding_selected_font_color` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_readonly` **(** **)** const | +| :ref:`bool` | :ref:`is_line_hidden` **(** :ref:`int` arg0 **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selection_active` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_show_line_numbers_enabled` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_smooth_scroll_enabled` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_syntax_coloring_enabled` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`menu_option` **(** :ref:`int` option **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`paste` **(** **)** | @@ -106,32 +84,18 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select_all` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_context_menu_enabled` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_highlight_all_occurrences` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_highlight_current_line` **(** :ref:`bool` enabled **)** | +| void | :ref:`set_line_as_hidden` **(** :ref:`int` line, :ref:`bool` enable **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_max_chars` **(** :ref:`int` amount **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_override_selected_font_color` **(** :ref:`bool` override **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_readonly` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_line_numbers` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_smooth_scroll_enable` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_syntax_coloring` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_scroll_speed` **(** :ref:`float` speed **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`undo` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unfold_line` **(** :ref:`int` line **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unhide_all_lines` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -182,6 +146,10 @@ Member Variables - :ref:`bool` **context_menu_enabled** + .. _class_TextEdit_hiding_enabled: + +- :ref:`int` **hiding_enabled** + .. _class_TextEdit_highlight_all_occurrences: - :ref:`bool` **highlight_all_occurrences** @@ -253,6 +221,10 @@ Add color region (given the delimiters) and its colors. Add a keyword and its color. +.. _class_TextEdit_can_fold: + +- :ref:`bool` **can_fold** **(** :ref:`int` line **)** const + .. _class_TextEdit_clear_colors: - void **clear_colors** **(** **)** @@ -271,18 +243,6 @@ Clear the undo history. Copy the current selection. -.. _class_TextEdit_cursor_get_blink_enabled: - -- :ref:`bool` **cursor_get_blink_enabled** **(** **)** const - -Gets whether the text editor caret is blinking. - -.. _class_TextEdit_cursor_get_blink_speed: - -- :ref:`float` **cursor_get_blink_speed** **(** **)** const - -Gets the text editor caret blink speed. - .. _class_TextEdit_cursor_get_column: - :ref:`int` **cursor_get_column** **(** **)** const @@ -295,37 +255,13 @@ Return the column the editing cursor is at. Return the line the editing cursor is at. -.. _class_TextEdit_cursor_is_block_mode: - -- :ref:`bool` **cursor_is_block_mode** **(** **)** const - -Gets whether the text editor caret is in block mode. - -.. _class_TextEdit_cursor_set_blink_enabled: - -- void **cursor_set_blink_enabled** **(** :ref:`bool` enable **)** - -Set the text editor caret to blink. - -.. _class_TextEdit_cursor_set_blink_speed: - -- void **cursor_set_blink_speed** **(** :ref:`float` blink_speed **)** - -Set the text editor caret blink speed. Cannot be less then or equal to 0. - -.. _class_TextEdit_cursor_set_block_mode: - -- void **cursor_set_block_mode** **(** :ref:`bool` enable **)** - -Set the text editor caret to block mode. - .. _class_TextEdit_cursor_set_column: - void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** .. _class_TextEdit_cursor_set_line: -- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** +- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true **)** .. _class_TextEdit_cut: @@ -333,6 +269,14 @@ Set the text editor caret to block mode. Cut the current selection. +.. _class_TextEdit_fold_all_lines: + +- void **fold_all_lines** **(** **)** + +.. _class_TextEdit_fold_line: + +- void **fold_line** **(** :ref:`int` line **)** + .. _class_TextEdit_get_line: - :ref:`String` **get_line** **(** :ref:`int` line **)** const @@ -379,16 +323,6 @@ Return the selection end column. Return the selection end line. -.. _class_TextEdit_get_text: - -- :ref:`String` **get_text** **(** **)** - -Return the whole text. - -.. _class_TextEdit_get_v_scroll_speed: - -- :ref:`float` **get_v_scroll_speed** **(** **)** const - .. _class_TextEdit_get_word_under_cursor: - :ref:`String` **get_word_under_cursor** **(** **)** const @@ -399,31 +333,13 @@ Return the whole text. Insert a given text at the cursor position. -.. _class_TextEdit_is_context_menu_enabled: +.. _class_TextEdit_is_folded: -- :ref:`bool` **is_context_menu_enabled** **(** **)** +- :ref:`bool` **is_folded** **(** :ref:`int` line **)** const -Returns true if the context menu is enabled. +.. _class_TextEdit_is_line_hidden: -.. _class_TextEdit_is_highlight_all_occurrences_enabled: - -- :ref:`bool` **is_highlight_all_occurrences_enabled** **(** **)** const - -Returns true if highlight all occurrences is enabled. - -.. _class_TextEdit_is_highlight_current_line_enabled: - -- :ref:`bool` **is_highlight_current_line_enabled** **(** **)** const - -.. _class_TextEdit_is_overriding_selected_font_color: - -- :ref:`bool` **is_overriding_selected_font_color** **(** **)** const - -.. _class_TextEdit_is_readonly: - -- :ref:`bool` **is_readonly** **(** **)** const - -Return true if the text editor is in read-only mode (see :ref:`set_readonly`). +- :ref:`bool` **is_line_hidden** **(** :ref:`int` arg0 **)** const .. _class_TextEdit_is_selection_active: @@ -431,22 +347,6 @@ Return true if the text editor is in read-only mode (see :ref:`set_readonly` **is_show_line_numbers_enabled** **(** **)** const - -Returns true if line numbers are enabled. - -.. _class_TextEdit_is_smooth_scroll_enabled: - -- :ref:`bool` **is_smooth_scroll_enabled** **(** **)** const - -.. _class_TextEdit_is_syntax_coloring_enabled: - -- :ref:`bool` **is_syntax_coloring_enabled** **(** **)** const - -Return true if the syntax coloring is enabled. - .. _class_TextEdit_menu_option: - void **menu_option** **(** :ref:`int` option **)** @@ -481,21 +381,9 @@ Perform selection, from line/column to line/column. Select all the text. -.. _class_TextEdit_set_context_menu_enabled: +.. _class_TextEdit_set_line_as_hidden: -- void **set_context_menu_enabled** **(** :ref:`bool` enable **)** - -Set the status of the context menu. When enabled, the context menu will appear when the ``TextEdit`` is right clicked. - -.. _class_TextEdit_set_highlight_all_occurrences: - -- void **set_highlight_all_occurrences** **(** :ref:`bool` enable **)** - -Set to enable highlighting all occurrences of the current selection. - -.. _class_TextEdit_set_highlight_current_line: - -- void **set_highlight_current_line** **(** :ref:`bool` enabled **)** +- void **set_line_as_hidden** **(** :ref:`int` line, :ref:`bool` enable **)** .. _class_TextEdit_set_max_chars: @@ -503,42 +391,6 @@ Set to enable highlighting all occurrences of the current selection. Set the maximum amount of characters editable. -.. _class_TextEdit_set_override_selected_font_color: - -- void **set_override_selected_font_color** **(** :ref:`bool` override **)** - -.. _class_TextEdit_set_readonly: - -- void **set_readonly** **(** :ref:`bool` enable **)** - -Set the text editor as read-only. Text can be displayed but not edited. - -.. _class_TextEdit_set_show_line_numbers: - -- void **set_show_line_numbers** **(** :ref:`bool` enable **)** - -Set to enable showing line numbers. - -.. _class_TextEdit_set_smooth_scroll_enable: - -- void **set_smooth_scroll_enable** **(** :ref:`bool` enable **)** - -.. _class_TextEdit_set_syntax_coloring: - -- void **set_syntax_coloring** **(** :ref:`bool` enable **)** - -Set to enable the syntax coloring. - -.. _class_TextEdit_set_text: - -- void **set_text** **(** :ref:`String` text **)** - -Set the entire text. - -.. _class_TextEdit_set_v_scroll_speed: - -- void **set_v_scroll_speed** **(** :ref:`float` speed **)** - .. _class_TextEdit_set_wrap: - void **set_wrap** **(** :ref:`bool` enable **)** @@ -551,4 +403,12 @@ Enable text wrapping when it goes beyond he edge of what is visible. Perform undo operation. +.. _class_TextEdit_unfold_line: + +- void **unfold_line** **(** :ref:`int` line **)** + +.. _class_TextEdit_unhide_all_lines: + +- void **unhide_all_lines** **(** **)** + diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index eedf1bf1c..fa40717ec 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -16,43 +16,6 @@ Brief Description Texture-based button. Supports Pressed, Hover, Disabled and Focused states. -Member Functions ----------------- - -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BitMap` | :ref:`get_click_mask` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_disabled_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_focused_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_hover_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_normal_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_pressed_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_click_mask` **(** :ref:`BitMap` mask **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand` **(** :ref:`bool` p_expand **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_focused_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hover_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_mode` **(** :ref:`int` p_mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -107,71 +70,3 @@ Description The Normal state's texture is required. Others are optional. -Member Function Description ---------------------------- - -.. _class_TextureButton_get_click_mask: - -- :ref:`BitMap` **get_click_mask** **(** **)** const - -.. _class_TextureButton_get_disabled_texture: - -- :ref:`Texture` **get_disabled_texture** **(** **)** const - -.. _class_TextureButton_get_expand: - -- :ref:`bool` **get_expand** **(** **)** const - -.. _class_TextureButton_get_focused_texture: - -- :ref:`Texture` **get_focused_texture** **(** **)** const - -.. _class_TextureButton_get_hover_texture: - -- :ref:`Texture` **get_hover_texture** **(** **)** const - -.. _class_TextureButton_get_normal_texture: - -- :ref:`Texture` **get_normal_texture** **(** **)** const - -.. _class_TextureButton_get_pressed_texture: - -- :ref:`Texture` **get_pressed_texture** **(** **)** const - -.. _class_TextureButton_get_stretch_mode: - -- :ref:`int` **get_stretch_mode** **(** **)** const - -.. _class_TextureButton_set_click_mask: - -- void **set_click_mask** **(** :ref:`BitMap` mask **)** - -.. _class_TextureButton_set_disabled_texture: - -- void **set_disabled_texture** **(** :ref:`Texture` texture **)** - -.. _class_TextureButton_set_expand: - -- void **set_expand** **(** :ref:`bool` p_expand **)** - -.. _class_TextureButton_set_focused_texture: - -- void **set_focused_texture** **(** :ref:`Texture` texture **)** - -.. _class_TextureButton_set_hover_texture: - -- void **set_hover_texture** **(** :ref:`Texture` texture **)** - -.. _class_TextureButton_set_normal_texture: - -- void **set_normal_texture** **(** :ref:`Texture` texture **)** - -.. _class_TextureButton_set_pressed_texture: - -- void **set_pressed_texture** **(** :ref:`Texture` texture **)** - -.. _class_TextureButton_set_stretch_mode: - -- void **set_stretch_mode** **(** :ref:`int` p_mode **)** - - diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 5f22561e0..e52d541a8 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -16,47 +16,6 @@ Brief Description Texture-based progress bar. Useful for loading screens and life or stamina bars. -Member Functions ----------------- - -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fill_degrees` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fill_mode` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_nine_patch_stretch` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_over_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_progress_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_radial_center_offset` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radial_initial_angle` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_under_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fill_degrees` **(** :ref:`float` mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fill_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_nine_patch_stretch` **(** :ref:`bool` stretch **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_over_texture` **(** :ref:`Texture` tex **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_progress_texture` **(** :ref:`Texture` tex **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_center_offset` **(** :ref:`Vector2` mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_initial_angle` **(** :ref:`float` mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_under_texture` **(** :ref:`Texture` tex **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -128,87 +87,3 @@ Description TextureProgress works like :ref:`ProgressBar` but it uses up to 3 textures instead of Godot's :ref:`Theme` resource. Works horizontally, vertically, and radially. -Member Function Description ---------------------------- - -.. _class_TextureProgress_get_fill_degrees: - -- :ref:`float` **get_fill_degrees** **(** **)** - -.. _class_TextureProgress_get_fill_mode: - -- :ref:`int` **get_fill_mode** **(** **)** - -.. _class_TextureProgress_get_nine_patch_stretch: - -- :ref:`bool` **get_nine_patch_stretch** **(** **)** const - -Returns true if textures are stretched as nine-patches or false otherwise. - -.. _class_TextureProgress_get_over_texture: - -- :ref:`Texture` **get_over_texture** **(** **)** const - -.. _class_TextureProgress_get_progress_texture: - -- :ref:`Texture` **get_progress_texture** **(** **)** const - -.. _class_TextureProgress_get_radial_center_offset: - -- :ref:`Vector2` **get_radial_center_offset** **(** **)** - -.. _class_TextureProgress_get_radial_initial_angle: - -- :ref:`float` **get_radial_initial_angle** **(** **)** - -.. _class_TextureProgress_get_stretch_margin: - -- :ref:`int` **get_stretch_margin** **(** :ref:`int` margin **)** const - -Return nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). - -.. _class_TextureProgress_get_under_texture: - -- :ref:`Texture` **get_under_texture** **(** **)** const - -.. _class_TextureProgress_set_fill_degrees: - -- void **set_fill_degrees** **(** :ref:`float` mode **)** - -.. _class_TextureProgress_set_fill_mode: - -- void **set_fill_mode** **(** :ref:`int` mode **)** - -.. _class_TextureProgress_set_nine_patch_stretch: - -- void **set_nine_patch_stretch** **(** :ref:`bool` stretch **)** - -Set if textures should be stretched as nine-patches. - -.. _class_TextureProgress_set_over_texture: - -- void **set_over_texture** **(** :ref:`Texture` tex **)** - -.. _class_TextureProgress_set_progress_texture: - -- void **set_progress_texture** **(** :ref:`Texture` tex **)** - -.. _class_TextureProgress_set_radial_center_offset: - -- void **set_radial_center_offset** **(** :ref:`Vector2` mode **)** - -.. _class_TextureProgress_set_radial_initial_angle: - -- void **set_radial_initial_angle** **(** :ref:`float` mode **)** - -.. _class_TextureProgress_set_stretch_margin: - -- void **set_stretch_margin** **(** :ref:`int` margin, :ref:`int` value **)** - -Set nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). - -.. _class_TextureProgress_set_under_texture: - -- void **set_under_texture** **(** :ref:`Texture` tex **)** - - diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 4127c4dc7..d3abb7677 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -16,23 +16,6 @@ Brief Description Draws a sprite or a texture inside a User Interface. The texture can tile or not. -Member Functions ----------------- - -+--------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_expand` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_mode` **(** :ref:`int` stretch_mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -66,31 +49,3 @@ Description Use TextureRect to draw icons and sprites in your User Interfaces. To create panels and menu boxes, take a look at NinePatchFrame. Its Stretch Mode property controls the texture's scale and placement. It can scale, tile and stay centered inside its bounding rectangle. TextureRect is one of the 5 most common nodes to create game UI. -Member Function Description ---------------------------- - -.. _class_TextureRect_get_stretch_mode: - -- :ref:`int` **get_stretch_mode** **(** **)** const - -.. _class_TextureRect_get_texture: - -- :ref:`Texture` **get_texture** **(** **)** const - -.. _class_TextureRect_has_expand: - -- :ref:`bool` **has_expand** **(** **)** const - -.. _class_TextureRect_set_expand: - -- void **set_expand** **(** :ref:`bool` enable **)** - -.. _class_TextureRect_set_stretch_mode: - -- void **set_stretch_mode** **(** :ref:`int` stretch_mode **)** - -.. _class_TextureRect_set_texture: - -- void **set_texture** **(** :ref:`Texture` texture **)** - - diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 519c7f6a5..8b9b4e9b9 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -40,8 +40,6 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_default_font` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | @@ -72,8 +70,6 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_font` **(** :ref:`Font` font **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | @@ -139,10 +135,6 @@ Member Function Description - :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const -.. _class_Theme_get_default_font: - -- :ref:`Font` **get_default_font** **(** **)** const - .. _class_Theme_get_font: - :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const @@ -203,10 +195,6 @@ Member Function Description - void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** -.. _class_Theme_set_default_font: - -- void **set_default_font** **(** :ref:`Font` font **)** - .. _class_Theme_set_font: - void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 9172de656..ca0ff4af4 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -48,7 +48,7 @@ Member Function Description - :ref:`String` **get_id** **(** **)** const -Returns the current ``Thread``s id, uniquely identifying it among all threads. +Returns the current ``Thread``\ s id, uniquely identifying it among all threads. .. _class_Thread_is_active: diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index e01a58037..248958e08 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -19,109 +19,49 @@ Node for 2D tile-based maps. Member Functions ---------------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_x` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_y` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_clip_uv` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_bounce` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_friction` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_custom_transform` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_half_offset` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_quadrant_size` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tile_origin` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TileSet` | :ref:`get_tileset` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip_uv` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_bounce` **(** :ref:`float` value **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_transform` **(** :ref:`Transform2D` custom_transform **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_half_offset` **(** :ref:`int` half_offset **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_quadrant_size` **(** :ref:`int` size **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tile_origin` **(** :ref:`int` origin **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tileset` **(** :ref:`TileSet` tileset **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_x` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_y` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -192,10 +132,6 @@ Member Variables - :ref:`int` **occluder_light_mask** - The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). - .. _class_TileMap_tile_data: - -- :ref:`PoolIntArray` **tile_data** - A :ref:`PoolIntArray` containing - .. _class_TileMap_tile_set: - :ref:`TileSet` **tile_set** - The assigned :ref:`TileSet`. @@ -235,12 +171,6 @@ Clear all cells. Return the tile index of the referenced cell. -.. _class_TileMap_get_cell_size: - -- :ref:`Vector2` **get_cell_size** **(** **)** const - -Return the cell size. - .. _class_TileMap_get_cellv: - :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const @@ -259,88 +189,14 @@ Return true if tiles are to be centered in x coordinate (by default this is fals Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). -.. _class_TileMap_get_clip_uv: - -- :ref:`bool` **get_clip_uv** **(** **)** const - -.. _class_TileMap_get_collision_bounce: - -- :ref:`float` **get_collision_bounce** **(** **)** const - -Return the collision bounce parameter. - -.. _class_TileMap_get_collision_friction: - -- :ref:`float` **get_collision_friction** **(** **)** const - -Return the collision friction parameter. - -.. _class_TileMap_get_collision_layer: - -- :ref:`int` **get_collision_layer** **(** **)** const - -Return the collision layer. - .. _class_TileMap_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const -.. _class_TileMap_get_collision_mask: - -- :ref:`int` **get_collision_mask** **(** **)** const - -Return the collision mask. - .. _class_TileMap_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -.. _class_TileMap_get_collision_use_kinematic: - -- :ref:`bool` **get_collision_use_kinematic** **(** **)** const - -Return whether the tilemap handles collisions as a kinematic body. - -.. _class_TileMap_get_custom_transform: - -- :ref:`Transform2D` **get_custom_transform** **(** **)** const - -Return the custom transform matrix. - -.. _class_TileMap_get_half_offset: - -- :ref:`int` **get_half_offset** **(** **)** const - -Return the current half offset configuration. - -.. _class_TileMap_get_mode: - -- :ref:`int` **get_mode** **(** **)** const - -Return the orientation mode. - -.. _class_TileMap_get_occluder_light_mask: - -- :ref:`int` **get_occluder_light_mask** **(** **)** const - -.. _class_TileMap_get_quadrant_size: - -- :ref:`int` **get_quadrant_size** **(** **)** const - -Return the quadrant size. - -.. _class_TileMap_get_tile_origin: - -- :ref:`int` **get_tile_origin** **(** **)** const - -Return the tile origin configuration. - -.. _class_TileMap_get_tileset: - -- :ref:`TileSet` **get_tileset** **(** **)** const - -Return the current tileset. - .. _class_TileMap_get_used_cells: - :ref:`Array` **get_used_cells** **(** **)** const @@ -373,12 +229,6 @@ Return whether the referenced cell is flipped over the X axis. Return whether the referenced cell is flipped over the Y axis. -.. _class_TileMap_is_y_sort_mode_enabled: - -- :ref:`bool` **is_y_sort_mode_enabled** **(** **)** const - -Return the Y sort mode. - .. _class_TileMap_map_to_world: - :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const @@ -389,19 +239,13 @@ Optionally, the tilemap's potential half offset can be ignored. .. _class_TileMap_set_cell: -- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** +- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** Set the tile index for the cell referenced by its grid-based X and Y coordinates. A tile index of -1 clears the cell. -Optionally, the tile can also be flipped over the X and Y coordinates or transposed. - -.. _class_TileMap_set_cell_size: - -- void **set_cell_size** **(** :ref:`Vector2` size **)** - -Set the cell size. +Optionally, the tile can also be flipped over the X and Y coordinates, transposed, or be given autotile coordinates. .. _class_TileMap_set_cellv: @@ -425,104 +269,14 @@ Set tiles to be centered in x coordinate. (by default this is false and they are Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). -.. _class_TileMap_set_clip_uv: - -- void **set_clip_uv** **(** :ref:`bool` enable **)** - -.. _class_TileMap_set_collision_bounce: - -- void **set_collision_bounce** **(** :ref:`float` value **)** - -Set the collision bounce parameter. Allowable values range from 0 to 1. - -.. _class_TileMap_set_collision_friction: - -- void **set_collision_friction** **(** :ref:`float` value **)** - -Set the collision friction parameter. Allowable values range from 0 to 1. - -.. _class_TileMap_set_collision_layer: - -- void **set_collision_layer** **(** :ref:`int` layer **)** - -Set the collision layer. - -Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. - .. _class_TileMap_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_TileMap_set_collision_mask: - -- void **set_collision_mask** **(** :ref:`int` mask **)** - -Set the collision masks. - -Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. - .. _class_TileMap_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_TileMap_set_collision_use_kinematic: - -- void **set_collision_use_kinematic** **(** :ref:`bool` use_kinematic **)** - -Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). - -.. _class_TileMap_set_custom_transform: - -- void **set_custom_transform** **(** :ref:`Transform2D` custom_transform **)** - -Set custom transform matrix, to use in combination with the custom orientation mode. - -.. _class_TileMap_set_half_offset: - -- void **set_half_offset** **(** :ref:`int` half_offset **)** - -Set a half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET\_\* constants as argument). - -Half offset sets every other tile off by a half tile size in the specified direction. - -.. _class_TileMap_set_mode: - -- void **set_mode** **(** :ref:`int` mode **)** - -Set the orientation mode as square, isometric or custom (use MODE\_\* constants as argument). - -.. _class_TileMap_set_occluder_light_mask: - -- void **set_occluder_light_mask** **(** :ref:`int` mask **)** - -.. _class_TileMap_set_quadrant_size: - -- void **set_quadrant_size** **(** :ref:`int` size **)** - -Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. - -Allowed values are integers ranging from 1 to 128. - -.. _class_TileMap_set_tile_origin: - -- 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). - -.. _class_TileMap_set_tileset: - -- void **set_tileset** **(** :ref:`TileSet` tileset **)** - -Set the current tileset. - -.. _class_TileMap_set_y_sort_mode: - -- void **set_y_sort_mode** **(** :ref:`bool` enable **)** - -Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate. - -A tile with a higher Y coordinate will therefore be drawn later, potentially covering up the tile(s) above it if its sprite is higher than its cell size. - .. _class_TileMap_world_to_map: - :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 52cf836e4..850586dad 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -19,79 +19,101 @@ Tile library for tilemaps. Member Functions ---------------- -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | -+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_forward_subtile_selection` **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_is_tile_bound` **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** virtual | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`autotile_get_bitmask_mode` **(** :ref:`int` arg0 **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_bitmask_mode` **(** :ref:`int` mode, :ref:`int` arg1 **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Numeric Constants +----------------- + +- **BITMASK_2X2** = **0** +- **BITMASK_3X3** = **1** +- **BIND_TOPLEFT** = **1** +- **BIND_TOP** = **2** +- **BIND_TOPRIGHT** = **4** +- **BIND_LEFT** = **8** +- **BIND_RIGHT** = **32** +- **BIND_BOTTOMLEFT** = **64** +- **BIND_BOTTOM** = **128** +- **BIND_BOTTOMRIGHT** = **256** Description ----------- @@ -103,6 +125,22 @@ Tiles are referenced by a unique integer ID. Member Function Description --------------------------- +.. _class_TileSet__forward_subtile_selection: + +- void **_forward_subtile_selection** **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual + +.. _class_TileSet__is_tile_bound: + +- void **_is_tile_bound** **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** virtual + +.. _class_TileSet_autotile_get_bitmask_mode: + +- :ref:`int` **autotile_get_bitmask_mode** **(** :ref:`int` arg0 **)** const + +.. _class_TileSet_autotile_set_bitmask_mode: + +- void **autotile_set_bitmask_mode** **(** :ref:`int` mode, :ref:`int` arg1 **)** + .. _class_TileSet_clear: - void **clear** **(** **)** @@ -141,7 +179,7 @@ Remove the tile referenced by the given ID. .. _class_TileSet_tile_add_shape: -- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** +- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** .. _class_TileSet_tile_get_light_occluder: diff --git a/classes/class_timer.rst b/classes/class_timer.rst index d8f404b3a..3ce67b782 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -19,35 +19,19 @@ A countdown timer. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_left` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_timer_process_mode` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_wait_time` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_autostart` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_one_shot` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stopped` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autostart` **(** :ref:`bool` enable **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_shot` **(** :ref:`bool` enable **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_timer_process_mode` **(** :ref:`int` mode **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wait_time` **(** :ref:`float` time_sec **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`start` **(** **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_time_left` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_paused` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stopped` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------+ +| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | ++----------------------------+--------------------------------------------------------------------------------------+ +| void | :ref:`start` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------+ Signals ------- @@ -99,30 +83,6 @@ Member Function Description Return the time left for timeout in seconds if the timer is active, 0 otherwise. -.. _class_Timer_get_timer_process_mode: - -- :ref:`int` **get_timer_process_mode** **(** **)** const - -Return the timer's processing mode. - -.. _class_Timer_get_wait_time: - -- :ref:`float` **get_wait_time** **(** **)** const - -Return the wait time in seconds. - -.. _class_Timer_has_autostart: - -- :ref:`bool` **has_autostart** **(** **)** const - -Return true if set to automatically start when entering the scene. - -.. _class_Timer_is_one_shot: - -- :ref:`bool` **is_one_shot** **(** **)** const - -Return true if configured as one-shot. - .. _class_Timer_is_paused: - :ref:`bool` **is_paused** **(** **)** const @@ -133,36 +93,12 @@ Return if the timer is paused or not. - :ref:`bool` **is_stopped** **(** **)** const -.. _class_Timer_set_autostart: - -- void **set_autostart** **(** :ref:`bool` enable **)** - -Set to automatically start when entering the scene. - -.. _class_Timer_set_one_shot: - -- void **set_one_shot** **(** :ref:`bool` enable **)** - -Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. - .. _class_Timer_set_paused: - void **set_paused** **(** :ref:`bool` paused **)** Set whether the timer is paused or not. A paused timer will be inactive until it is unpaused again. -.. _class_Timer_set_timer_process_mode: - -- void **set_timer_process_mode** **(** :ref:`int` mode **)** - -Set the timer's processing mode (fixed or idle, use TIMER_PROCESS\_\* constants as argument). - -.. _class_Timer_set_wait_time: - -- void **set_wait_time** **(** :ref:`float` time_sec **)** - -Set wait time in seconds. When the time is over, it will emit the timeout signal. - .. _class_Timer_start: - void **start** **(** **)** diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 096384da5..82e0dbc13 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -19,45 +19,9 @@ Button for touch screen devices. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_action` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BitMap` | :ref:`get_bitmask` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`get_shape` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture_pressed` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visibility_mode` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_passby_press_enabled` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_centered` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_visible` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action` **(** :ref:`String` action **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bitmask` **(** :ref:`BitMap` bitmask **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_passby_press` **(** :ref:`bool` enabled **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_centered` **(** :ref:`bool` bool **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_visible` **(** :ref:`bool` bool **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_pressed` **(** :ref:`Texture` texture_pressed **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visibility_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+-------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------+ Signals ------- @@ -129,112 +93,10 @@ Button for touch screen devices. You can set it to be visible on all screens, or Member Function Description --------------------------- -.. _class_TouchScreenButton_get_action: - -- :ref:`String` **get_action** **(** **)** const - -Returns the button's action. - -.. _class_TouchScreenButton_get_bitmask: - -- :ref:`BitMap` **get_bitmask** **(** **)** const - -Returns the button's bitmask. - -.. _class_TouchScreenButton_get_shape: - -- :ref:`Shape2D` **get_shape** **(** **)** const - -Returns the button's shape. - -.. _class_TouchScreenButton_get_texture: - -- :ref:`Texture` **get_texture** **(** **)** const - -Returns the button's texture for the normal state. - -.. _class_TouchScreenButton_get_texture_pressed: - -- :ref:`Texture` **get_texture_pressed** **(** **)** const - -Returns the button's texture for the pressed state. - -.. _class_TouchScreenButton_get_visibility_mode: - -- :ref:`int` **get_visibility_mode** **(** **)** const - -Sets the button's visibility mode. See ``VISIBILITY\_\*`` constants. - -.. _class_TouchScreenButton_is_passby_press_enabled: - -- :ref:`bool` **is_passby_press_enabled** **(** **)** const - .. _class_TouchScreenButton_is_pressed: - :ref:`bool` **is_pressed** **(** **)** const Returns ``true`` if this button is currently pressed. -.. _class_TouchScreenButton_is_shape_centered: - -- :ref:`bool` **is_shape_centered** **(** **)** const - -.. _class_TouchScreenButton_is_shape_visible: - -- :ref:`bool` **is_shape_visible** **(** **)** const - -.. _class_TouchScreenButton_set_action: - -- void **set_action** **(** :ref:`String` action **)** - -Sets the button's action. - -.. _class_TouchScreenButton_set_bitmask: - -- void **set_bitmask** **(** :ref:`BitMap` bitmask **)** - -Sets the button's :ref:`BitMap` bitmask. - -.. _class_TouchScreenButton_set_passby_press: - -- void **set_passby_press** **(** :ref:`bool` enabled **)** - -If ``true`` passby presses are enabled for this button. - -.. _class_TouchScreenButton_set_shape: - -- void **set_shape** **(** :ref:`Shape2D` shape **)** - -Sets the button's shape. - -.. _class_TouchScreenButton_set_shape_centered: - -- void **set_shape_centered** **(** :ref:`bool` bool **)** - -If ``true`` the button's shape is centered. - -.. _class_TouchScreenButton_set_shape_visible: - -- void **set_shape_visible** **(** :ref:`bool` bool **)** - -If ``true`` the button's shape is visible. - -.. _class_TouchScreenButton_set_texture: - -- void **set_texture** **(** :ref:`Texture` texture **)** - -Sets the button's :ref:`Texture` for the normal state. - -.. _class_TouchScreenButton_set_texture_pressed: - -- void **set_texture_pressed** **(** :ref:`Texture` texture_pressed **)** - -Sets the button's :ref:`Texture` for the pressed state. - -.. _class_TouchScreenButton_set_visibility_mode: - -- void **set_visibility_mode** **(** :ref:`int` mode **)** - -Sets the button's visibility mode. See the ``VISIBILITY\_\*`` constants. - diff --git a/classes/class_translation.rst b/classes/class_translation.rst index c7f24c399..05f87e62f 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -26,16 +26,12 @@ Member Functions +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_message` **(** :ref:`String` src_message **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_message_count` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_locale` **(** :ref:`String` locale **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,12 +65,6 @@ Add a message for translation. Erase a message. -.. _class_Translation_get_locale: - -- :ref:`String` **get_locale** **(** **)** const - -Return the locale of the translation. - .. _class_Translation_get_message: - :ref:`String` **get_message** **(** :ref:`String` src_message **)** const @@ -91,10 +81,4 @@ Return a message for translation. Return all the messages (keys). -.. _class_Translation_set_locale: - -- void **set_locale** **(** :ref:`String` locale **)** - -Set the locale of the translation. - diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 017494ac5..a84c91fcf 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -157,7 +157,7 @@ Numeric Constants Description ----------- -Control for a single item inside a :ref:`Tree`. May have child ``TreeItem``s and be styled as well as contain buttons. +Control for a single item inside a :ref:`Tree`. May have child ``TreeItem``\ s and be styled as well as contain buttons. Member Function Description --------------------------- diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 230fad3ba..a7a6b2e29 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -19,63 +19,59 @@ Node useful for animations with unknown start and end points. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_runtime` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tween_process_mode` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_repeat` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_all` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset_all` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume_all` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_repeat` **(** :ref:`bool` repeat **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tween_process_mode` **(** :ref:`int` mode **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`start` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop_all` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tell` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_runtime` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_repeat` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_all` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reset_all` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resume_all` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_repeat` **(** :ref:`bool` repeat **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`start` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stop_all` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tell` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -158,7 +154,7 @@ Follow ``method`` of ``object`` and apply the returned value on ``target_method` .. _class_Tween_follow_property: -- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Follow ``property`` of ``object`` and apply it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` seconds later. Note that ``target:target_property`` would equal ``object:property`` at the end of the tween. @@ -176,12 +172,6 @@ Returns the time needed for all tweens to end in seconds, measured from the star Returns the speed that has been set from editor GUI or :ref:`set_repeat`. -.. _class_Tween_get_tween_process_mode: - -- :ref:`int` **get_tween_process_mode** **(** **)** const - -Returns the process mode that has been set from editor GUI or :ref:`set_tween_process_mode` - .. _class_Tween_interpolate_callback: - :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** @@ -204,7 +194,7 @@ Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``dur .. _class_Tween_interpolate_property: -- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. @@ -282,12 +272,6 @@ Make the tween repeat after all tweens have finished. Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using :ref:`set_active` or :ref:`stop_all` and :ref:`resume_all` for this. -.. _class_Tween_set_tween_process_mode: - -- void **set_tween_process_mode** **(** :ref:`int` mode **)** - -Set whether the Tween uses ``_process`` or ``_physics_process`` (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_PHYSICS constants, respectively). - .. _class_Tween_start: - :ref:`bool` **start** **(** **)** @@ -316,7 +300,7 @@ Animate ``method`` of ``object`` from the value returned by ``initial.initial_me .. _class_Tween_targeting_property: -- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index a20c45251..d9f738358 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -19,29 +19,9 @@ Brief Description Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_brake` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_engine_force` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mass` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_steering` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_brake` **(** :ref:`float` brake **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_engine_force` **(** :ref:`float` engine_force **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mass` **(** :ref:`float` mass **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_steering` **(** :ref:`float` steering **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -70,18 +50,6 @@ Member Variables Member Function Description --------------------------- -.. _class_VehicleBody_get_brake: - -- :ref:`float` **get_brake** **(** **)** const - -.. _class_VehicleBody_get_engine_force: - -- :ref:`float` **get_engine_force** **(** **)** const - -.. _class_VehicleBody_get_friction: - -- :ref:`float` **get_friction** **(** **)** const - .. _class_VehicleBody_get_linear_velocity: - :ref:`Vector3` **get_linear_velocity** **(** **)** const @@ -93,36 +61,4 @@ Returns the VehicleBody's velocity vector. To get the absolute speed in scalar v # vehicle is an instance of VehicleBody var speed = vehicle.get_linear_velocity().length() -.. _class_VehicleBody_get_mass: - -- :ref:`float` **get_mass** **(** **)** const - -.. _class_VehicleBody_get_steering: - -- :ref:`float` **get_steering** **(** **)** const - -Return the steering angle (in radians). - -.. _class_VehicleBody_set_brake: - -- void **set_brake** **(** :ref:`float` brake **)** - -.. _class_VehicleBody_set_engine_force: - -- void **set_engine_force** **(** :ref:`float` engine_force **)** - -.. _class_VehicleBody_set_friction: - -- void **set_friction** **(** :ref:`float` friction **)** - -.. _class_VehicleBody_set_mass: - -- void **set_mass** **(** :ref:`float` mass **)** - -.. _class_VehicleBody_set_steering: - -- void **set_steering** **(** :ref:`float` steering **)** - -Set the steering angle (in radians). - diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 615ce59d3..011e27237 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -19,55 +19,11 @@ Brief Description Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_damping_compression` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_damping_relaxation` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction_slip` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_roll_influence` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_skidinfo` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_suspension_max_force` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_suspension_rest_length` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_suspension_stiffness` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_suspension_travel` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_contact` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_used_as_steering` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_used_as_traction` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_damping_compression` **(** :ref:`float` length **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_damping_relaxation` **(** :ref:`float` length **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction_slip` **(** :ref:`float` length **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` length **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_roll_influence` **(** :ref:`float` roll_influence **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suspension_max_force` **(** :ref:`float` length **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suspension_rest_length` **(** :ref:`float` length **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suspension_stiffness` **(** :ref:`float` length **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suspension_travel` **(** :ref:`float` length **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_as_steering` **(** :ref:`bool` enable **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_as_traction` **(** :ref:`bool` enable **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_skidinfo` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_contact` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------+ Member Variables ---------------- @@ -120,100 +76,12 @@ Member Variables Member Function Description --------------------------- -.. _class_VehicleWheel_get_damping_compression: - -- :ref:`float` **get_damping_compression** **(** **)** const - -.. _class_VehicleWheel_get_damping_relaxation: - -- :ref:`float` **get_damping_relaxation** **(** **)** const - -.. _class_VehicleWheel_get_friction_slip: - -- :ref:`float` **get_friction_slip** **(** **)** const - -.. _class_VehicleWheel_get_radius: - -- :ref:`float` **get_radius** **(** **)** const - -.. _class_VehicleWheel_get_roll_influence: - -- :ref:`float` **get_roll_influence** **(** **)** const - .. _class_VehicleWheel_get_skidinfo: - :ref:`float` **get_skidinfo** **(** **)** const -.. _class_VehicleWheel_get_suspension_max_force: - -- :ref:`float` **get_suspension_max_force** **(** **)** const - -.. _class_VehicleWheel_get_suspension_rest_length: - -- :ref:`float` **get_suspension_rest_length** **(** **)** const - -.. _class_VehicleWheel_get_suspension_stiffness: - -- :ref:`float` **get_suspension_stiffness** **(** **)** const - -.. _class_VehicleWheel_get_suspension_travel: - -- :ref:`float` **get_suspension_travel** **(** **)** const - .. _class_VehicleWheel_is_in_contact: - :ref:`bool` **is_in_contact** **(** **)** const -.. _class_VehicleWheel_is_used_as_steering: - -- :ref:`bool` **is_used_as_steering** **(** **)** const - -.. _class_VehicleWheel_is_used_as_traction: - -- :ref:`bool` **is_used_as_traction** **(** **)** const - -.. _class_VehicleWheel_set_damping_compression: - -- void **set_damping_compression** **(** :ref:`float` length **)** - -.. _class_VehicleWheel_set_damping_relaxation: - -- void **set_damping_relaxation** **(** :ref:`float` length **)** - -.. _class_VehicleWheel_set_friction_slip: - -- void **set_friction_slip** **(** :ref:`float` length **)** - -.. _class_VehicleWheel_set_radius: - -- void **set_radius** **(** :ref:`float` length **)** - -.. _class_VehicleWheel_set_roll_influence: - -- void **set_roll_influence** **(** :ref:`float` roll_influence **)** - -.. _class_VehicleWheel_set_suspension_max_force: - -- void **set_suspension_max_force** **(** :ref:`float` length **)** - -.. _class_VehicleWheel_set_suspension_rest_length: - -- void **set_suspension_rest_length** **(** :ref:`float` length **)** - -.. _class_VehicleWheel_set_suspension_stiffness: - -- void **set_suspension_stiffness** **(** :ref:`float` length **)** - -.. _class_VehicleWheel_set_suspension_travel: - -- void **set_suspension_travel** **(** :ref:`float` length **)** - -.. _class_VehicleWheel_set_use_as_steering: - -- void **set_use_as_steering** **(** :ref:`bool` enable **)** - -.. _class_VehicleWheel_set_use_as_traction: - -- void **set_use_as_traction** **(** :ref:`bool` enable **)** - diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 5be4f1a53..3ae1908f2 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -19,53 +19,29 @@ Control to play video files. Member Functions ---------------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_audio_track` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_buffering_msec` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`VideoStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_stream_name` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stream_position` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_video_texture` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_autoplay` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_expand` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_track` **(** :ref:`int` track **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enabled **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_buffering_msec` **(** :ref:`int` msec **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`VideoStream` stream **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream_position` **(** :ref:`float` position **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume` **(** :ref:`float` volume **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` db **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_buffering_msec` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_stream_name` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_stream_position` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_video_texture` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_buffering_msec` **(** :ref:`int` msec **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream_position` **(** :ref:`float` position **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume` **(** :ref:`float` volume **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -78,6 +54,10 @@ Member Variables - :ref:`bool` **autoplay** + .. _class_VideoPlayer_bus: + +- :ref:`String` **bus** + .. _class_VideoPlayer_expand: - :ref:`bool` **expand** @@ -103,24 +83,12 @@ This control has the ability to play video streams. The only format accepted is Member Function Description --------------------------- -.. _class_VideoPlayer_get_audio_track: - -- :ref:`int` **get_audio_track** **(** **)** const - -Get the selected audio track (for multitrack videos). - .. _class_VideoPlayer_get_buffering_msec: - :ref:`int` **get_buffering_msec** **(** **)** const Get the amount of milliseconds to store in buffer while playing. -.. _class_VideoPlayer_get_stream: - -- :ref:`VideoStream` **get_stream** **(** **)** const - -Get the video stream. - .. _class_VideoPlayer_get_stream_name: - :ref:`String` **get_stream_name** **(** **)** const @@ -145,30 +113,6 @@ Get the current frame of the video as a :ref:`Texture`. Get the volume of the audio track as a linear value. -.. _class_VideoPlayer_get_volume_db: - -- :ref:`float` **get_volume_db** **(** **)** const - -Get the volume of the audio track in decibels. - -.. _class_VideoPlayer_has_autoplay: - -- :ref:`bool` **has_autoplay** **(** **)** const - -Get whether or not the video is set as autoplay. - -.. _class_VideoPlayer_has_expand: - -- :ref:`bool` **has_expand** **(** **)** const - -Get whether or not the expand property is set. - -.. _class_VideoPlayer_is_paused: - -- :ref:`bool` **is_paused** **(** **)** const - -Get whether or not the video is paused. - .. _class_VideoPlayer_is_playing: - :ref:`bool` **is_playing** **(** **)** const @@ -181,42 +125,12 @@ Get whether or not the video is playing. Start the video playback. -.. _class_VideoPlayer_set_audio_track: - -- void **set_audio_track** **(** :ref:`int` track **)** - -Set the audio track (for multitrack videos). - -.. _class_VideoPlayer_set_autoplay: - -- void **set_autoplay** **(** :ref:`bool` enabled **)** - -Set whether this node should start playing automatically. - .. _class_VideoPlayer_set_buffering_msec: - void **set_buffering_msec** **(** :ref:`int` msec **)** Set the amount of milliseconds to buffer during playback. -.. _class_VideoPlayer_set_expand: - -- void **set_expand** **(** :ref:`bool` enable **)** - -Set the expand property. If enabled, the video will grow or shrink to fit the player size, otherwise it will play at the stream resolution. - -.. _class_VideoPlayer_set_paused: - -- void **set_paused** **(** :ref:`bool` paused **)** - -Set whether the video should pause the playback. - -.. _class_VideoPlayer_set_stream: - -- void **set_stream** **(** :ref:`VideoStream` stream **)** - -Set the video stream for this player. - .. _class_VideoPlayer_set_stream_position: - void **set_stream_position** **(** :ref:`float` position **)** @@ -229,12 +143,6 @@ Set the current position of the stream, in seconds. Set the audio volume as a linear value. -.. _class_VideoPlayer_set_volume_db: - -- void **set_volume_db** **(** :ref:`float` db **)** - -Set the audio volume in decibels. - .. _class_VideoPlayer_stop: - void **stop** **(** **)** diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index d7841df4e..b1f17f988 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -9,6 +9,8 @@ VideoStream **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`VideoStreamWebm`, :ref:`VideoStreamTheora` + **Category:** Core Brief Description diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst new file mode 100644 index 000000000..7f312cbe1 --- /dev/null +++ b/classes/class_videostreamtheora.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VideoStreamTheora.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VideoStreamTheora: + +VideoStreamTheora +================= + +**Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VideoStreamTheora_file: + +- :ref:`String` **file** + + diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst new file mode 100644 index 000000000..ed24450cb --- /dev/null +++ b/classes/class_videostreamwebm.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VideoStreamWebm.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VideoStreamWebm: + +VideoStreamWebm +=============== + +**Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VideoStreamWebm_file: + +- :ref:`String` **file** + + diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 9c288d98b..5421d7eb1 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -28,130 +28,50 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_clear_mode` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_debug_draw` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_global_canvas_transform` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_hdr` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_msaa` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_atlas_size` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_update_mode` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_usage` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_vflip` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_3d_disabled` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_snap_controls_to_pixels_enabled` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_canvas_transform` **(** :ref:`Transform2D` xform **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clear_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_draw` **(** :ref:`int` debug_draw **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_3d` **(** :ref:`bool` disable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_canvas_transform` **(** :ref:`Transform2D` xform **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hdr` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_msaa` **(** :ref:`int` msaa **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant, :ref:`int` subdiv **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_atlas_size` **(** :ref:`int` size **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_snap_controls_to_pixels` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_usage` **(** :ref:`int` usage **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_arvr` **(** :ref:`bool` use **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vflip` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world` **(** :ref:`World` world **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_worlds` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_arvr` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -342,14 +262,6 @@ Return the active 3D camera. Get the canvas transform of the viewport. -.. _class_Viewport_get_clear_mode: - -- :ref:`int` **get_clear_mode** **(** **)** const - -.. _class_Viewport_get_debug_draw: - -- :ref:`int` **get_debug_draw** **(** **)** const - .. _class_Viewport_get_final_transform: - :ref:`Transform2D` **get_final_transform** **(** **)** const @@ -362,46 +274,16 @@ Get the total transform of the viewport. Get the global canvas transform of the viewport. -.. _class_Viewport_get_hdr: - -- :ref:`bool` **get_hdr** **(** **)** const - -Get whether the rendered texture has filters enabled. - .. _class_Viewport_get_mouse_position: - :ref:`Vector2` **get_mouse_position** **(** **)** const Get the mouse position, relative to the viewport. -.. _class_Viewport_get_msaa: - -- :ref:`int` **get_msaa** **(** **)** const - -.. _class_Viewport_get_physics_object_picking: - -- :ref:`bool` **get_physics_object_picking** **(** **)** - -Get whether picking for all physics objects inside the viewport is enabled. - .. _class_Viewport_get_render_info: - :ref:`int` **get_render_info** **(** :ref:`int` info **)** -.. _class_Viewport_get_shadow_atlas_quadrant_subdiv: - -- :ref:`int` **get_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** const - -.. _class_Viewport_get_shadow_atlas_size: - -- :ref:`int` **get_shadow_atlas_size** **(** **)** const - -.. _class_Viewport_get_size: - -- :ref:`Vector2` **get_size** **(** **)** const - -Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. - .. _class_Viewport_get_size_override: - :ref:`Vector2` **get_size_override** **(** **)** const @@ -414,22 +296,6 @@ Get the size override set with :ref:`set_size_override` **get_update_mode** **(** **)** const - -Get when the viewport would be updated, will be one of the ``UPDATE\_\*`` constants. - -.. _class_Viewport_get_usage: - -- :ref:`int` **get_usage** **(** **)** const - -.. _class_Viewport_get_vflip: - -- :ref:`bool` **get_vflip** **(** **)** const - -Set whether the render target is flipped on the Y axis. - .. _class_Viewport_get_viewport_rid: - :ref:`RID` **get_viewport_rid** **(** **)** const @@ -442,12 +308,6 @@ Get the viewport RID from the :ref:`VisualServer`. Return the final, visible rect in global screen coordinates. -.. _class_Viewport_get_world: - -- :ref:`World` **get_world** **(** **)** const - -Return the 3D world of the viewport. - .. _class_Viewport_get_world_2d: - :ref:`World2D` **get_world_2d** **(** **)** const @@ -466,38 +326,10 @@ Returns the drag data from the GUI, that was previously returned by :ref:`Contro Returns whether there are shown modals on-screen. -.. _class_Viewport_has_transparent_background: - -- :ref:`bool` **has_transparent_background** **(** **)** const - -Return whether the viewport lets whatever is behind it to show. - .. _class_Viewport_input: - void **input** **(** :ref:`InputEvent` local_event **)** -.. _class_Viewport_is_3d_disabled: - -- :ref:`bool` **is_3d_disabled** **(** **)** const - -.. _class_Viewport_is_audio_listener: - -- :ref:`bool` **is_audio_listener** **(** **)** const - -Returns whether the viewport sends sounds to the speakers. - -.. _class_Viewport_is_audio_listener_2d: - -- :ref:`bool` **is_audio_listener_2d** **(** **)** const - -Returns whether the viewport sends soundsfrom 2D emitters to the speakers. - -.. _class_Viewport_is_input_disabled: - -- :ref:`bool` **is_input_disabled** **(** **)** const - -Return whether input to the viewport is disabled. - .. _class_Viewport_is_size_override_enabled: - :ref:`bool` **is_size_override_enabled** **(** **)** const @@ -510,28 +342,6 @@ Get the enabled status of the size override set with :ref:`set_size_override`. -.. _class_Viewport_is_snap_controls_to_pixels_enabled: - -- :ref:`bool` **is_snap_controls_to_pixels_enabled** **(** **)** const - -.. _class_Viewport_is_using_own_world: - -- :ref:`bool` **is_using_own_world** **(** **)** const - -Return whether the viewport is using a world separate from the parent viewport's world. - -.. _class_Viewport_set_as_audio_listener: - -- void **set_as_audio_listener** **(** :ref:`bool` enable **)** - -Makes the viewport send sounds to the speakers. - -.. _class_Viewport_set_as_audio_listener_2d: - -- void **set_as_audio_listener_2d** **(** :ref:`bool` enable **)** - -Makes the viewport send sounds from 2D emitters to the speakers. - .. _class_Viewport_set_attach_to_screen_rect: - void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** @@ -542,58 +352,12 @@ Makes the viewport send sounds from 2D emitters to the speakers. Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`\ s. This is relative to the global canvas transform of the viewport. -.. _class_Viewport_set_clear_mode: - -- void **set_clear_mode** **(** :ref:`int` mode **)** - -.. _class_Viewport_set_debug_draw: - -- void **set_debug_draw** **(** :ref:`int` debug_draw **)** - -.. _class_Viewport_set_disable_3d: - -- void **set_disable_3d** **(** :ref:`bool` disable **)** - -.. _class_Viewport_set_disable_input: - -- void **set_disable_input** **(** :ref:`bool` disable **)** - -Set whether input to the viewport is disabled. - .. _class_Viewport_set_global_canvas_transform: - void **set_global_canvas_transform** **(** :ref:`Transform2D` xform **)** Set the global canvas transform of the viewport. The canvas transform is relative to this. -.. _class_Viewport_set_hdr: - -- void **set_hdr** **(** :ref:`bool` enable **)** - -.. _class_Viewport_set_msaa: - -- void **set_msaa** **(** :ref:`int` msaa **)** - -.. _class_Viewport_set_physics_object_picking: - -- void **set_physics_object_picking** **(** :ref:`bool` enable **)** - -Enable/disable picking for all physics objects inside the viewport. - -.. _class_Viewport_set_shadow_atlas_quadrant_subdiv: - -- void **set_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant, :ref:`int` subdiv **)** - -.. _class_Viewport_set_shadow_atlas_size: - -- void **set_shadow_atlas_size** **(** :ref:`int` size **)** - -.. _class_Viewport_set_size: - -- void **set_size** **(** :ref:`Vector2` size **)** - -Set the size of the viewport. - .. _class_Viewport_set_size_override: - void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** @@ -606,56 +370,6 @@ Set the size override of the viewport. If the enable parameter is true, it would Set whether the size override affects stretch as well. -.. _class_Viewport_set_snap_controls_to_pixels: - -- void **set_snap_controls_to_pixels** **(** :ref:`bool` enabled **)** - -.. _class_Viewport_set_transparent_background: - -- void **set_transparent_background** **(** :ref:`bool` enable **)** - -If this viewport is a child of another viewport, keep the previously drawn background visible. - -.. _class_Viewport_set_update_mode: - -- void **set_update_mode** **(** :ref:`int` mode **)** - -Set when the render target would be updated, using the ``UPDATE\_\*`` constants - -.. _class_Viewport_set_usage: - -- void **set_usage** **(** :ref:`int` usage **)** - -.. _class_Viewport_set_use_arvr: - -- void **set_use_arvr** **(** :ref:`bool` use **)** - -If true this viewport will be bound to our ARVR Server. - -If this is our main Godot viewport our AR/VR output will be displayed on screen. - -If output is redirected to an HMD we'll see the output of just one of the eyes without any distortion applied else we'll see the stereo buffer with distortion applied if applicable - -If this is an extra viewport output will only work if redirection to an HMD is supported by the interface. The render target will allow you to use the undistorted output for the right eye in the display. - -.. _class_Viewport_set_use_own_world: - -- void **set_use_own_world** **(** :ref:`bool` enable **)** - -Make the viewport use a world separate from the parent viewport's world. - -.. _class_Viewport_set_vflip: - -- void **set_vflip** **(** :ref:`bool` enable **)** - -Set whether the viewport is flipped on the Y axis. - -.. _class_Viewport_set_world: - -- void **set_world** **(** :ref:`World` world **)** - -Change the 3D world of the viewport. - .. _class_Viewport_set_world_2d: - void **set_world_2d** **(** :ref:`World2D` world_2d **)** @@ -670,12 +384,6 @@ Change the 3D world of the viewport. Force update of the 2D and 3D worlds. -.. _class_Viewport_use_arvr: - -- :ref:`bool` **use_arvr** **(** **)** - -Returns whether this viewport is using our ARVR Server - .. _class_Viewport_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index 8106fc1b2..ad3cb57d6 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -16,19 +16,6 @@ Brief Description -Member Functions ----------------- - -+--------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_shrink` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stretch_enabled` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch` **(** :ref:`bool` enable **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_shrink` **(** :ref:`int` amount **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -41,23 +28,3 @@ Member Variables - :ref:`int` **stretch_shrink** -Member Function Description ---------------------------- - -.. _class_ViewportContainer_get_stretch_shrink: - -- :ref:`int` **get_stretch_shrink** **(** **)** const - -.. _class_ViewportContainer_is_stretch_enabled: - -- :ref:`bool` **is_stretch_enabled** **(** **)** const - -.. _class_ViewportContainer_set_stretch: - -- void **set_stretch** **(** :ref:`bool` enable **)** - -.. _class_ViewportContainer_set_stretch_shrink: - -- void **set_stretch_shrink** **(** :ref:`int` amount **)** - - diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 8b46b1aa0..9f4b828bf 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -16,15 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_viewport_path_in_scene` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_viewport_path_in_scene` **(** :ref:`NodePath` path **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -33,15 +24,3 @@ Member Variables - :ref:`NodePath` **viewport_path** -Member Function Description ---------------------------- - -.. _class_ViewportTexture_get_viewport_path_in_scene: - -- :ref:`NodePath` **get_viewport_path_in_scene** **(** **)** const - -.. _class_ViewportTexture_set_viewport_path_in_scene: - -- void **set_viewport_path_in_scene** **(** :ref:`NodePath` path **)** - - diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index 7ecc0629d..2c815cdbf 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -16,15 +16,6 @@ Brief Description Enable certain nodes only when visible. -Member Functions ----------------- - -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`int` enabler **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabler` **(** :ref:`int` enabler, :ref:`bool` enabled **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -49,19 +40,3 @@ Description The VisibilityEnabler will disable :ref:`RigidBody` and :ref:`AnimationPlayer` nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. -Member Function Description ---------------------------- - -.. _class_VisibilityEnabler_is_enabler_enabled: - -- :ref:`bool` **is_enabler_enabled** **(** :ref:`int` enabler **)** const - -Returns whether the specified enabler was set to true or not. - -.. _class_VisibilityEnabler_set_enabler: - -- void **set_enabler** **(** :ref:`int` enabler, :ref:`bool` enabled **)** - -Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler is not in view. See the constants for enablers and what they affect. - - diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 62a41e7c8..ac183719b 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -16,15 +16,6 @@ Brief Description Enable certain nodes only when visible. -Member Functions ----------------- - -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`int` enabler **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabler` **(** :ref:`int` enabler, :ref:`bool` enabled **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -69,19 +60,3 @@ Description The VisibilityEnabler2D will disable :ref:`RigidBody2D`, :ref:`AnimationPlayer`, and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. -Member Function Description ---------------------------- - -.. _class_VisibilityEnabler2D_is_enabler_enabled: - -- :ref:`bool` **is_enabler_enabled** **(** :ref:`int` enabler **)** const - -Returns whether the specified enabler was set to true or not. - -.. _class_VisibilityEnabler2D_set_enabler: - -- void **set_enabler** **(** :ref:`int` enabler, :ref:`bool` enabled **)** - -Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect. - - diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 4368fe496..190f32543 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -21,13 +21,9 @@ Detects when the node is visible on screen. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`set_aabb` **(** :ref:`Rect3` rect **)** | -+----------------------------+-----------------------------------------------------------------------------------------------+ ++--------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------+ Signals ------- @@ -62,7 +58,7 @@ Member Variables .. _class_VisibilityNotifier_aabb: -- :ref:`Rect3` **aabb** - The VisibilityNotifier's bounding box. +- :ref:`AABB` **aabb** - The VisibilityNotifier's bounding box. Description @@ -73,22 +69,10 @@ The VisibilityNotifier detects when it is visible on the screen. It also notifie Member Function Description --------------------------- -.. _class_VisibilityNotifier_get_aabb: - -- :ref:`Rect3` **get_aabb** **(** **)** const - -Returns the bounding box of the VisibilityNotifier. - .. _class_VisibilityNotifier_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const If ``true`` the bounding box is on the screen. -.. _class_VisibilityNotifier_set_aabb: - -- void **set_aabb** **(** :ref:`Rect3` rect **)** - -Set the visibility bounding box of the VisibilityNotifier. - diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 4d5b3a738..2c2ca3a1f 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -21,13 +21,9 @@ Detects when the node is visible on screen. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | -+----------------------------+-------------------------------------------------------------------------------------------------+ ++--------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------+ Signals ------- @@ -73,22 +69,10 @@ The VisibilityNotifier2D detects when it is visible on the screen. It also notif Member Function Description --------------------------- -.. _class_VisibilityNotifier2D_get_rect: - -- :ref:`Rect2` **get_rect** **(** **)** const - -Returns the bounding rectangle of the VisibilityNotifier2D. - .. _class_VisibilityNotifier2D_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const If ``true`` the bounding rectangle is on the screen. -.. _class_VisibilityNotifier2D_set_rect: - -- void **set_rect** **(** :ref:`Rect2` rect **)** - -Set the visibility bounding rectangle of the VisibilityNotifier2D. - diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index c996af26f..a14b339cb 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -21,17 +21,13 @@ Brief Description Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_transformed_aabb` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base` **(** :ref:`RID` base **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ ++--------------------------+------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------+ +| void | :ref:`set_base` **(** :ref:`RID` base **)** | ++--------------------------+------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -46,22 +42,14 @@ Member Function Description .. _class_VisualInstance_get_aabb: -- :ref:`Rect3` **get_aabb** **(** **)** const - -.. _class_VisualInstance_get_layer_mask: - -- :ref:`int` **get_layer_mask** **(** **)** const +- :ref:`AABB` **get_aabb** **(** **)** const .. _class_VisualInstance_get_transformed_aabb: -- :ref:`Rect3` **get_transformed_aabb** **(** **)** const +- :ref:`AABB` **get_transformed_aabb** **(** **)** const .. _class_VisualInstance_set_base: - void **set_base** **(** :ref:`RID` base **)** -.. _class_VisualInstance_set_layer_mask: - -- void **set_layer_mask** **(** :ref:`int` mask **)** - diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index cfad4196b..7aaab9493 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -16,19 +16,6 @@ Brief Description A Visual Script node representing a constant from the base types. -Member Functions ----------------- - -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_basic_type` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_basic_type_constant` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type` **(** :ref:`int` name **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type_constant` **(** :ref:`String` name **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,23 +33,3 @@ Description A Visual Script node representing a constant from base types, such as Vector3.AXIS_X. -Member Function Description ---------------------------- - -.. _class_VisualScriptBasicTypeConstant_get_basic_type: - -- :ref:`int` **get_basic_type** **(** **)** const - -.. _class_VisualScriptBasicTypeConstant_get_basic_type_constant: - -- :ref:`String` **get_basic_type_constant** **(** **)** const - -.. _class_VisualScriptBasicTypeConstant_set_basic_type: - -- void **set_basic_type** **(** :ref:`int` name **)** - -.. _class_VisualScriptBasicTypeConstant_set_basic_type_constant: - -- void **set_basic_type_constant** **(** :ref:`String` name **)** - - diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index ec40ca15f..d258f4412 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -16,15 +16,6 @@ Brief Description A Visual Script node used to call built-in functions. -Member Functions ----------------- - -+------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_func` **(** **)** | -+------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`set_func` **(** :ref:`int` which **)** | -+------------------------+-------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -76,28 +67,30 @@ Numeric Constants - **MATH_RAD2DEG** = **37** --- Convert the input from radians to degrees. - **MATH_LINEAR2DB** = **38** --- Convert the input from linear volume to decibel volume. - **MATH_DB2LINEAR** = **39** --- Convert the input from decibel volume to linear volume. -- **MATH_WRAP** = **40** -- **MATH_WRAPF** = **41** -- **LOGIC_MAX** = **42** --- Return the greater of the two numbers, also known as their maximum. -- **LOGIC_MIN** = **43** --- Return the lesser of the two numbers, also known as their minimum. -- **LOGIC_CLAMP** = **44** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)` -- **LOGIC_NEAREST_PO2** = **45** --- Return the nearest power of 2 to the input. -- **OBJ_WEAKREF** = **46** --- Create a :ref:`WeakRef` from the input. -- **FUNC_FUNCREF** = **47** --- Create a :ref:`FuncRef` from the input. -- **TYPE_CONVERT** = **48** --- Convert between types. -- **TYPE_OF** = **49** --- Return the type of the input as an integer. Check enum Variant.Type for the integers that might be returned. -- **TYPE_EXISTS** = **50** --- Checks if a type is registered in the :ref:`ClassDB`. -- **TEXT_CHAR** = **51** --- Return a character with the given ascii value. -- **TEXT_STR** = **52** --- Convert the input to a string. -- **TEXT_PRINT** = **53** --- Print the given string to the output window. -- **TEXT_PRINTERR** = **54** --- Print the given string to the standard error output. -- **TEXT_PRINTRAW** = **55** --- Print the given string to the standard output, without adding a newline. -- **VAR_TO_STR** = **56** --- Serialize a :ref:`Variant` to a string. -- **STR_TO_VAR** = **57** --- Deserialize a :ref:`Variant` from a string serialized using VAR_TO_STR. -- **VAR_TO_BYTES** = **58** --- Serialize a :ref:`Variant` to a :ref:`PoolByteArray`. -- **BYTES_TO_VAR** = **59** --- Deserialize a :ref:`Variant` from a :ref:`PoolByteArray` serialized using VAR_TO_BYTES. -- **COLORN** = **60** --- Return the :ref:`Color` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. -- **FUNC_MAX** = **61** --- The maximum value the :ref:`function` property can have. +- **MATH_POLAR2CARTESIAN** = **40** --- Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis). +- **MATH_CARTESIAN2POLAR** = **41** --- Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). +- **MATH_WRAP** = **42** +- **MATH_WRAPF** = **43** +- **LOGIC_MAX** = **44** --- Return the greater of the two numbers, also known as their maximum. +- **LOGIC_MIN** = **45** --- Return the lesser of the two numbers, also known as their minimum. +- **LOGIC_CLAMP** = **46** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)` +- **LOGIC_NEAREST_PO2** = **47** --- Return the nearest power of 2 to the input. +- **OBJ_WEAKREF** = **48** --- Create a :ref:`WeakRef` from the input. +- **FUNC_FUNCREF** = **49** --- Create a :ref:`FuncRef` from the input. +- **TYPE_CONVERT** = **50** --- Convert between types. +- **TYPE_OF** = **51** --- Return the type of the input as an integer. Check enum Variant.Type for the integers that might be returned. +- **TYPE_EXISTS** = **52** --- Checks if a type is registered in the :ref:`ClassDB`. +- **TEXT_CHAR** = **53** --- Return a character with the given ascii value. +- **TEXT_STR** = **54** --- Convert the input to a string. +- **TEXT_PRINT** = **55** --- Print the given string to the output window. +- **TEXT_PRINTERR** = **56** --- Print the given string to the standard error output. +- **TEXT_PRINTRAW** = **57** --- Print the given string to the standard output, without adding a newline. +- **VAR_TO_STR** = **58** --- Serialize a :ref:`Variant` to a string. +- **STR_TO_VAR** = **59** --- Deserialize a :ref:`Variant` from a string serialized using VAR_TO_STR. +- **VAR_TO_BYTES** = **60** --- Serialize a :ref:`Variant` to a :ref:`PoolByteArray`. +- **BYTES_TO_VAR** = **61** --- Deserialize a :ref:`Variant` from a :ref:`PoolByteArray` serialized using VAR_TO_BYTES. +- **COLORN** = **62** --- Return the :ref:`Color` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. +- **FUNC_MAX** = **63** --- The maximum value the :ref:`function` property can have. Description ----------- @@ -106,15 +99,3 @@ A built-in function used inside a :ref:`VisualScript`. It is See also :ref:`@GDScript`, for the same functions in the GDScript language. -Member Function Description ---------------------------- - -.. _class_VisualScriptBuiltinFunc_get_func: - -- :ref:`int` **get_func** **(** **)** - -.. _class_VisualScriptBuiltinFunc_set_func: - -- void **set_func** **(** :ref:`int` which **)** - - diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index b576c1b7b..4e5ac422a 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -16,19 +16,6 @@ Brief Description Gets a constant from a given class. -Member Functions ----------------- - -+------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class_constant` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_class_constant` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,23 +41,3 @@ none - Data (variant): ``value`` -Member Function Description ---------------------------- - -.. _class_VisualScriptClassConstant_get_base_type: - -- :ref:`String` **get_base_type** **(** **)** - -.. _class_VisualScriptClassConstant_get_class_constant: - -- :ref:`String` **get_class_constant** **(** **)** - -.. _class_VisualScriptClassConstant_set_base_type: - -- void **set_base_type** **(** :ref:`String` name **)** - -.. _class_VisualScriptClassConstant_set_class_constant: - -- void **set_class_constant** **(** :ref:`String` name **)** - - diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index 0a3d16926..038da7676 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -16,23 +16,6 @@ Brief Description A Visual Script node used to annotate the script. -Member Functions ----------------- - -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_description` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_title` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_description` **(** :ref:`String` description **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_title` **(** :ref:`String` title **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -56,31 +39,3 @@ A Visual Script node used to display annotations in the script, so that code may Comment nodes can be resized so they encompass a group of nodes. -Member Function Description ---------------------------- - -.. _class_VisualScriptComment_get_description: - -- :ref:`String` **get_description** **(** **)** const - -.. _class_VisualScriptComment_get_size: - -- :ref:`Vector2` **get_size** **(** **)** const - -.. _class_VisualScriptComment_get_title: - -- :ref:`String` **get_title** **(** **)** const - -.. _class_VisualScriptComment_set_description: - -- void **set_description** **(** :ref:`String` description **)** - -.. _class_VisualScriptComment_set_size: - -- void **set_size** **(** :ref:`Vector2` size **)** - -.. _class_VisualScriptComment_set_title: - -- void **set_title** **(** :ref:`String` title **)** - - diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 7d02b13fe..b4fdd4684 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -16,19 +16,6 @@ Brief Description Gets a contant's value. -Member Functions ----------------- - -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant_type` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_constant_value` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_type` **(** :ref:`int` type **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_value` **(** :ref:`Variant` value **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,23 +41,3 @@ none - Data (variant): ``get`` -Member Function Description ---------------------------- - -.. _class_VisualScriptConstant_get_constant_type: - -- :ref:`int` **get_constant_type** **(** **)** const - -.. _class_VisualScriptConstant_get_constant_value: - -- :ref:`Variant` **get_constant_value** **(** **)** const - -.. _class_VisualScriptConstant_set_constant_type: - -- void **set_constant_type** **(** :ref:`int` type **)** - -.. _class_VisualScriptConstant_set_constant_value: - -- void **set_constant_value** **(** :ref:`Variant` value **)** - - diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index 5662c9a44..218a087e9 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -16,19 +16,6 @@ Brief Description A Visual Script node which calls a base type constructor. -Member Functions ----------------- - -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constructor_type` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constructor_type` **(** :ref:`int` type **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -63,23 +50,3 @@ Description A Visual Script node which calls a base type constructor. It can be used for type conversion as well. -Member Function Description ---------------------------- - -.. _class_VisualScriptConstructor_get_constructor: - -- :ref:`Dictionary` **get_constructor** **(** **)** const - -.. _class_VisualScriptConstructor_get_constructor_type: - -- :ref:`int` **get_constructor_type** **(** **)** const - -.. _class_VisualScriptConstructor_set_constructor: - -- void **set_constructor** **(** :ref:`Dictionary` constructor **)** - -.. _class_VisualScriptConstructor_set_constructor_type: - -- void **set_constructor_type** **(** :ref:`int` type **)** - - diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index e8e3ae12a..77d4c9b8b 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -101,7 +101,7 @@ Return the specified input port's name. - :ref:`int` **_get_input_value_port_type** **(** :ref:`int` idx **)** virtual -Return the specified input port's type. See the TYPE\_\* enum in @GlobalScope. +Return the specified input port's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. .. _class_VisualScriptCustomNode__get_output_sequence_port_count: @@ -131,7 +131,7 @@ Return the specified output's name. - :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** virtual -Return the specified output's type. See the TYPE\_\* enum in @GlobalScope. +Return the specified output's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. .. _class_VisualScriptCustomNode__get_text: diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index e447fcd9b..6973d00d9 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -16,15 +16,6 @@ Brief Description A Visual Script node which deconstructs a base type instance into its parts. -Member Functions ----------------- - -+------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_deconstruct_type` **(** **)** const | -+------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_deconstruct_type` **(** :ref:`int` type **)** | -+------------------------+------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -42,15 +33,3 @@ Description A Visual Script node which deconstructs a base type instance into its parts. -Member Function Description ---------------------------- - -.. _class_VisualScriptDeconstruct_get_deconstruct_type: - -- :ref:`int` **get_deconstruct_type** **(** **)** const - -.. _class_VisualScriptDeconstruct_set_deconstruct_type: - -- void **set_deconstruct_type** **(** :ref:`int` type **)** - - diff --git a/classes/class_visualscripteditor.rst b/classes/class_visualscripteditor.rst new file mode 100644 index 000000000..4fb228fda --- /dev/null +++ b/classes/class_visualscripteditor.rst @@ -0,0 +1,53 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualScriptEditor.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualScriptEditor: + +VisualScriptEditor +================== + +**Inherits:** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_node` **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_node` **(** :ref:`String` name, :ref:`String` category **)** | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_VisualScriptEditor_custom_nodes_updated: + +- **custom_nodes_updated** **(** **)** + +Emitted when a custom Visual Script node is added or removed. + + +Member Function Description +--------------------------- + +.. _class_VisualScriptEditor_add_custom_node: + +- void **add_custom_node** **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** + +Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the ``category`` as the parameter. + +.. _class_VisualScriptEditor_remove_custom_node: + +- void **remove_custom_node** **(** :ref:`String` name, :ref:`String` category **)** + +Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed. + + diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index f6ca191e9..46fc6c829 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -16,15 +16,6 @@ Brief Description Emits a specified signal. -Member Functions ----------------- - -+------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_signal` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_signal` **(** :ref:`String` name **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,15 +37,3 @@ Emits a specified signal when it is executed. - Sequence -Member Function Description ---------------------------- - -.. _class_VisualScriptEmitSignal_get_signal: - -- :ref:`String` **get_signal** **(** **)** const - -.. _class_VisualScriptEmitSignal_set_signal: - -- void **set_signal** **(** :ref:`String` name **)** - - diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 0d95a7e45..41f563b41 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -14,16 +14,7 @@ VisualScriptEngineSingleton Brief Description ----------------- -A Visual Script node returning a singleton from @GlobalScope - -Member Functions ----------------- - -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_singleton` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_singleton` **(** :ref:`String` name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ +A Visual Script node returning a singleton from :ref:`@GlobalScope` Member Variables ---------------- @@ -36,17 +27,5 @@ Member Variables Description ----------- -A Visual Script node returning a singleton from @GlobalScope - -Member Function Description ---------------------------- - -.. _class_VisualScriptEngineSingleton_get_singleton: - -- :ref:`String` **get_singleton** **(** **)** - -.. _class_VisualScriptEngineSingleton_set_singleton: - -- void **set_singleton** **(** :ref:`String` name **)** - +A Visual Script node returning a singleton from :ref:`@GlobalScope` diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 34bb31f5e..642795313 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -16,51 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_script` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_basic_type` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_call_mode` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_function` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rpc_call_mode` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_singleton` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_use_default_args` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_validate` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function` **(** :ref:`String` function **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rpc_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_singleton` **(** :ref:`String` singleton **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_default_args` **(** :ref:`int` amount **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_validate` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -123,87 +78,3 @@ Numeric Constants - **RPC_RELIABLE_TO_ID** = **3** - **RPC_UNRELIABLE_TO_ID** = **4** -Member Function Description ---------------------------- - -.. _class_VisualScriptFunctionCall_get_base_path: - -- :ref:`NodePath` **get_base_path** **(** **)** const - -.. _class_VisualScriptFunctionCall_get_base_script: - -- :ref:`String` **get_base_script** **(** **)** const - -.. _class_VisualScriptFunctionCall_get_base_type: - -- :ref:`String` **get_base_type** **(** **)** const - -.. _class_VisualScriptFunctionCall_get_basic_type: - -- :ref:`int` **get_basic_type** **(** **)** const - -.. _class_VisualScriptFunctionCall_get_call_mode: - -- :ref:`int` **get_call_mode** **(** **)** const - -.. _class_VisualScriptFunctionCall_get_function: - -- :ref:`String` **get_function** **(** **)** const - -.. _class_VisualScriptFunctionCall_get_rpc_call_mode: - -- :ref:`int` **get_rpc_call_mode** **(** **)** const - -.. _class_VisualScriptFunctionCall_get_singleton: - -- :ref:`String` **get_singleton** **(** **)** const - -.. _class_VisualScriptFunctionCall_get_use_default_args: - -- :ref:`int` **get_use_default_args** **(** **)** const - -.. _class_VisualScriptFunctionCall_get_validate: - -- :ref:`bool` **get_validate** **(** **)** const - -.. _class_VisualScriptFunctionCall_set_base_path: - -- void **set_base_path** **(** :ref:`NodePath` base_path **)** - -.. _class_VisualScriptFunctionCall_set_base_script: - -- void **set_base_script** **(** :ref:`String` base_script **)** - -.. _class_VisualScriptFunctionCall_set_base_type: - -- void **set_base_type** **(** :ref:`String` base_type **)** - -.. _class_VisualScriptFunctionCall_set_basic_type: - -- void **set_basic_type** **(** :ref:`int` basic_type **)** - -.. _class_VisualScriptFunctionCall_set_call_mode: - -- void **set_call_mode** **(** :ref:`int` mode **)** - -.. _class_VisualScriptFunctionCall_set_function: - -- void **set_function** **(** :ref:`String` function **)** - -.. _class_VisualScriptFunctionCall_set_rpc_call_mode: - -- void **set_rpc_call_mode** **(** :ref:`int` mode **)** - -.. _class_VisualScriptFunctionCall_set_singleton: - -- void **set_singleton** **(** :ref:`String` singleton **)** - -.. _class_VisualScriptFunctionCall_set_use_default_args: - -- void **set_use_default_args** **(** :ref:`int` amount **)** - -.. _class_VisualScriptFunctionCall_set_validate: - -- void **set_validate** **(** :ref:`bool` enable **)** - - diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 8bd155f75..77b119a75 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -16,15 +16,6 @@ Brief Description -Member Functions ----------------- - -+------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_global_constant` **(** **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_constant` **(** :ref:`int` index **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -33,15 +24,3 @@ Member Variables - :ref:`int` **constant** -Member Function Description ---------------------------- - -.. _class_VisualScriptGlobalConstant_get_global_constant: - -- :ref:`int` **get_global_constant** **(** **)** - -.. _class_VisualScriptGlobalConstant_set_global_constant: - -- void **set_global_constant** **(** :ref:`int` index **)** - - diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index cdf7fd6e2..86ee6082e 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -16,19 +16,6 @@ Brief Description -Member Functions ----------------- - -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_action_mode` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_action_name` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action_name` **(** :ref:`String` name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -49,23 +36,3 @@ Numeric Constants - **MODE_JUST_PRESSED** = **2** - **MODE_JUST_RELEASED** = **3** -Member Function Description ---------------------------- - -.. _class_VisualScriptInputAction_get_action_mode: - -- :ref:`int` **get_action_mode** **(** **)** const - -.. _class_VisualScriptInputAction_get_action_name: - -- :ref:`String` **get_action_name** **(** **)** const - -.. _class_VisualScriptInputAction_set_action_mode: - -- void **set_action_mode** **(** :ref:`int` mode **)** - -.. _class_VisualScriptInputAction_set_action_name: - -- void **set_action_name** **(** :ref:`String` name **)** - - diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 9eb992ff7..0dedb16ea 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -16,19 +16,6 @@ Brief Description Gets a local variable's value. -Member Functions ----------------- - -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_var_name` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_var_type` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_var_name` **(** :ref:`String` name **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_var_type` **(** :ref:`int` type **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,23 +41,3 @@ none - Data (variant): ``get`` -Member Function Description ---------------------------- - -.. _class_VisualScriptLocalVar_get_var_name: - -- :ref:`String` **get_var_name** **(** **)** const - -.. _class_VisualScriptLocalVar_get_var_type: - -- :ref:`int` **get_var_type** **(** **)** const - -.. _class_VisualScriptLocalVar_set_var_name: - -- void **set_var_name** **(** :ref:`String` name **)** - -.. _class_VisualScriptLocalVar_set_var_type: - -- void **set_var_type** **(** :ref:`int` type **)** - - diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index e43272148..525502602 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -16,19 +16,6 @@ Brief Description Changes a local variable's value. -Member Functions ----------------- - -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_var_name` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_var_type` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_var_name` **(** :ref:`String` name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_var_type` **(** :ref:`int` type **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -58,23 +45,3 @@ Changes a local variable's value to the given input. The new value is also provi - Data (variant): ``get`` -Member Function Description ---------------------------- - -.. _class_VisualScriptLocalVarSet_get_var_name: - -- :ref:`String` **get_var_name** **(** **)** const - -.. _class_VisualScriptLocalVarSet_get_var_type: - -- :ref:`int` **get_var_type** **(** **)** const - -.. _class_VisualScriptLocalVarSet_set_var_name: - -- void **set_var_name** **(** :ref:`String` name **)** - -.. _class_VisualScriptLocalVarSet_set_var_type: - -- void **set_var_type** **(** :ref:`int` type **)** - - diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 43bc8410a..cb942f92f 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -16,15 +16,6 @@ Brief Description Commonly used mathematical constants. -Member Functions ----------------- - -+------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_math_constant` **(** **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_math_constant` **(** :ref:`int` which **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -59,15 +50,3 @@ none - Data (variant): ``get`` -Member Function Description ---------------------------- - -.. _class_VisualScriptMathConstant_get_math_constant: - -- :ref:`int` **get_math_constant** **(** **)** - -.. _class_VisualScriptMathConstant_set_math_constant: - -- void **set_math_constant** **(** :ref:`int` which **)** - - diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 22cf8f565..304a631b1 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -9,7 +9,7 @@ VisualScriptNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` +**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` **Category:** Core diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index ace8ca74d..c94bd8421 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -16,19 +16,6 @@ Brief Description -Member Functions ----------------- - -+------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_operator` **(** **)** const | -+------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_typed` **(** **)** const | -+------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_operator` **(** :ref:`int` op **)** | -+------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_typed` **(** :ref:`int` type **)** | -+------------------------+---------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -54,23 +41,3 @@ Description - Data (variant): ``result`` -Member Function Description ---------------------------- - -.. _class_VisualScriptOperator_get_operator: - -- :ref:`int` **get_operator** **(** **)** const - -.. _class_VisualScriptOperator_get_typed: - -- :ref:`int` **get_typed** **(** **)** const - -.. _class_VisualScriptOperator_set_operator: - -- void **set_operator** **(** :ref:`int` op **)** - -.. _class_VisualScriptOperator_set_typed: - -- void **set_typed** **(** :ref:`int` type **)** - - diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index ffa0393ae..6bbd06a7a 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -16,15 +16,6 @@ Brief Description Creates a new :ref:`Resource` or loads one from the filesystem. -Member Functions ----------------- - -+----------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_preload` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_preload` **(** :ref:`Resource` resource **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,15 +37,3 @@ none - Data (object): ``res`` -Member Function Description ---------------------------- - -.. _class_VisualScriptPreload_get_preload: - -- :ref:`Resource` **get_preload** **(** **)** const - -.. _class_VisualScriptPreload_set_preload: - -- void **set_preload** **(** :ref:`Resource` resource **)** - - diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index cb37fbdc3..4064049ee 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -16,39 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_script` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_basic_type` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_call_mode` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_index` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_property` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_index` **(** :ref:`String` index **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_property` **(** :ref:`String` property **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -92,63 +59,3 @@ Numeric Constants - **CALL_MODE_NODE_PATH** = **1** - **CALL_MODE_INSTANCE** = **2** -Member Function Description ---------------------------- - -.. _class_VisualScriptPropertyGet_get_base_path: - -- :ref:`NodePath` **get_base_path** **(** **)** const - -.. _class_VisualScriptPropertyGet_get_base_script: - -- :ref:`String` **get_base_script** **(** **)** const - -.. _class_VisualScriptPropertyGet_get_base_type: - -- :ref:`String` **get_base_type** **(** **)** const - -.. _class_VisualScriptPropertyGet_get_basic_type: - -- :ref:`int` **get_basic_type** **(** **)** const - -.. _class_VisualScriptPropertyGet_get_call_mode: - -- :ref:`int` **get_call_mode** **(** **)** const - -.. _class_VisualScriptPropertyGet_get_index: - -- :ref:`String` **get_index** **(** **)** const - -.. _class_VisualScriptPropertyGet_get_property: - -- :ref:`String` **get_property** **(** **)** const - -.. _class_VisualScriptPropertyGet_set_base_path: - -- void **set_base_path** **(** :ref:`NodePath` base_path **)** - -.. _class_VisualScriptPropertyGet_set_base_script: - -- void **set_base_script** **(** :ref:`String` base_script **)** - -.. _class_VisualScriptPropertyGet_set_base_type: - -- void **set_base_type** **(** :ref:`String` base_type **)** - -.. _class_VisualScriptPropertyGet_set_basic_type: - -- void **set_basic_type** **(** :ref:`int` basic_type **)** - -.. _class_VisualScriptPropertyGet_set_call_mode: - -- void **set_call_mode** **(** :ref:`int` mode **)** - -.. _class_VisualScriptPropertyGet_set_index: - -- void **set_index** **(** :ref:`String` index **)** - -.. _class_VisualScriptPropertyGet_set_property: - -- void **set_property** **(** :ref:`String` property **)** - - diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 7354ff91c..9bcff4ec0 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -16,43 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_assign_op` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_script` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_basic_type` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_call_mode` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_index` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_property` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_assign_op` **(** :ref:`int` assign_op **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_index` **(** :ref:`String` index **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_property` **(** :ref:`String` property **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -112,71 +75,3 @@ Numeric Constants - **ASSIGN_OP_BIT_OR** = **9** - **ASSIGN_OP_BIT_XOR** = **10** -Member Function Description ---------------------------- - -.. _class_VisualScriptPropertySet_get_assign_op: - -- :ref:`int` **get_assign_op** **(** **)** const - -.. _class_VisualScriptPropertySet_get_base_path: - -- :ref:`NodePath` **get_base_path** **(** **)** const - -.. _class_VisualScriptPropertySet_get_base_script: - -- :ref:`String` **get_base_script** **(** **)** const - -.. _class_VisualScriptPropertySet_get_base_type: - -- :ref:`String` **get_base_type** **(** **)** const - -.. _class_VisualScriptPropertySet_get_basic_type: - -- :ref:`int` **get_basic_type** **(** **)** const - -.. _class_VisualScriptPropertySet_get_call_mode: - -- :ref:`int` **get_call_mode** **(** **)** const - -.. _class_VisualScriptPropertySet_get_index: - -- :ref:`String` **get_index** **(** **)** const - -.. _class_VisualScriptPropertySet_get_property: - -- :ref:`String` **get_property** **(** **)** const - -.. _class_VisualScriptPropertySet_set_assign_op: - -- void **set_assign_op** **(** :ref:`int` assign_op **)** - -.. _class_VisualScriptPropertySet_set_base_path: - -- void **set_base_path** **(** :ref:`NodePath` base_path **)** - -.. _class_VisualScriptPropertySet_set_base_script: - -- void **set_base_script** **(** :ref:`String` base_script **)** - -.. _class_VisualScriptPropertySet_set_base_type: - -- void **set_base_type** **(** :ref:`String` base_type **)** - -.. _class_VisualScriptPropertySet_set_basic_type: - -- void **set_basic_type** **(** :ref:`int` basic_type **)** - -.. _class_VisualScriptPropertySet_set_call_mode: - -- void **set_call_mode** **(** :ref:`int` mode **)** - -.. _class_VisualScriptPropertySet_set_index: - -- void **set_index** **(** :ref:`String` index **)** - -.. _class_VisualScriptPropertySet_set_property: - -- void **set_property** **(** :ref:`String` property **)** - - diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index d2cdd0d82..29adc2cc9 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -16,15 +16,6 @@ Brief Description -Member Functions ----------------- - -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resource_path` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resource_path` **(** :ref:`String` path **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -33,15 +24,3 @@ Member Variables - :ref:`String` **path** -Member Function Description ---------------------------- - -.. _class_VisualScriptResourcePath_get_resource_path: - -- :ref:`String` **get_resource_path** **(** **)** - -.. _class_VisualScriptResourcePath_set_resource_path: - -- void **set_resource_path** **(** :ref:`String` path **)** - - diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 8d946d9bd..42ac2a127 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -16,19 +16,6 @@ Brief Description Exits a function and returns an optional value. -Member Functions ----------------- - -+--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_return_type` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_return_value_enabled` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_return_value` **(** :ref:`bool` enable **)** | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_return_type` **(** :ref:`int` type **)** | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -56,23 +43,3 @@ Ends the execution of a function and returns control to the calling function. Op none -Member Function Description ---------------------------- - -.. _class_VisualScriptReturn_get_return_type: - -- :ref:`int` **get_return_type** **(** **)** const - -.. _class_VisualScriptReturn_is_return_value_enabled: - -- :ref:`bool` **is_return_value_enabled** **(** **)** const - -.. _class_VisualScriptReturn_set_enable_return_value: - -- void **set_enable_return_value** **(** :ref:`bool` enable **)** - -.. _class_VisualScriptReturn_set_return_type: - -- void **set_return_type** **(** :ref:`int` type **)** - - diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index b37d4c1dc..32bb6610d 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -16,15 +16,6 @@ Brief Description Node reference. -Member Functions ----------------- - -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_path` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_path` **(** :ref:`NodePath` path **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,15 +37,3 @@ none - Data: ``node`` (obj) -Member Function Description ---------------------------- - -.. _class_VisualScriptSceneNode_get_node_path: - -- :ref:`NodePath` **get_node_path** **(** **)** - -.. _class_VisualScriptSceneNode_set_node_path: - -- void **set_node_path** **(** :ref:`NodePath` path **)** - - diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index 8d1ee5930..923545997 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -16,15 +16,6 @@ Brief Description Chooses between two input values. -Member Functions ----------------- - -+------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_typed` **(** **)** const | -+------------------------+---------------------------------------------------------------------------------------------+ -| void | :ref:`set_typed` **(** :ref:`int` type **)** | -+------------------------+---------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -50,15 +41,3 @@ Chooses between two input values based on a Boolean condition. - Data (variant): ``out`` -Member Function Description ---------------------------- - -.. _class_VisualScriptSelect_get_typed: - -- :ref:`int` **get_typed** **(** **)** const - -.. _class_VisualScriptSelect_set_typed: - -- void **set_typed** **(** :ref:`int` type **)** - - diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index ed884e79d..0302a3834 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -16,15 +16,6 @@ Brief Description Executes a series of Sequence ports. -Member Functions ----------------- - -+------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_steps` **(** **)** const | -+------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_steps` **(** :ref:`int` steps **)** | -+------------------------+------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -50,15 +41,3 @@ Steps through a series of one or more output Sequence ports. The ``current`` dat - Data (int): ``current`` -Member Function Description ---------------------------- - -.. _class_VisualScriptSequence_get_steps: - -- :ref:`int` **get_steps** **(** **)** const - -.. _class_VisualScriptSequence_set_steps: - -- void **set_steps** **(** :ref:`int` steps **)** - - diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 8deb36f6a..61ef94b60 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -16,19 +16,6 @@ Brief Description -Member Functions ----------------- - -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_script` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_script` **(** :ref:`String` path **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` type **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -41,23 +28,3 @@ Member Variables - :ref:`String` **base_type** -Member Function Description ---------------------------- - -.. _class_VisualScriptTypeCast_get_base_script: - -- :ref:`String` **get_base_script** **(** **)** const - -.. _class_VisualScriptTypeCast_get_base_type: - -- :ref:`String` **get_base_type** **(** **)** const - -.. _class_VisualScriptTypeCast_set_base_script: - -- void **set_base_script** **(** :ref:`String` path **)** - -.. _class_VisualScriptTypeCast_set_base_type: - -- void **set_base_type** **(** :ref:`String` type **)** - - diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index b4ff36c3b..6b79cbab2 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -16,15 +16,6 @@ Brief Description Gets a variable's value. -Member Functions ----------------- - -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_variable` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable` **(** :ref:`String` name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -46,15 +37,3 @@ none - Data (variant): ``value`` -Member Function Description ---------------------------- - -.. _class_VisualScriptVariableGet_get_variable: - -- :ref:`String` **get_variable** **(** **)** const - -.. _class_VisualScriptVariableGet_set_variable: - -- void **set_variable** **(** :ref:`String` name **)** - - diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 5190d85f2..96b97e7da 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -16,15 +16,6 @@ Brief Description Changes a variable's value. -Member Functions ----------------- - -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_variable` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable` **(** :ref:`String` name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -48,15 +39,3 @@ Changes a variable's value to the given input. - Sequence -Member Function Description ---------------------------- - -.. _class_VisualScriptVariableSet_get_variable: - -- :ref:`String` **get_variable** **(** **)** const - -.. _class_VisualScriptVariableSet_set_variable: - -- void **set_variable** **(** :ref:`String` name **)** - - diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 8753a7400..981cc4778 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -16,19 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_wait_time` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_yield_mode` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wait_time` **(** :ref:`float` sec **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_yield_mode` **(** :ref:`int` mode **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -48,23 +35,3 @@ Numeric Constants - **YIELD_PHYSICS_FRAME** = **2** - **YIELD_WAIT** = **3** -Member Function Description ---------------------------- - -.. _class_VisualScriptYield_get_wait_time: - -- :ref:`float` **get_wait_time** **(** **)** - -.. _class_VisualScriptYield_get_yield_mode: - -- :ref:`int` **get_yield_mode** **(** **)** - -.. _class_VisualScriptYield_set_wait_time: - -- void **set_wait_time** **(** :ref:`float` sec **)** - -.. _class_VisualScriptYield_set_yield_mode: - -- void **set_yield_mode** **(** :ref:`int` mode **)** - - diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 429d662e8..86ee76cc0 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -16,27 +16,6 @@ Brief Description -Member Functions ----------------- - -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_call_mode` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_signal` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_signal` **(** :ref:`String` signal **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -64,39 +43,3 @@ Numeric Constants - **CALL_MODE_NODE_PATH** = **1** - **CALL_MODE_INSTANCE** = **2** -Member Function Description ---------------------------- - -.. _class_VisualScriptYieldSignal_get_base_path: - -- :ref:`NodePath` **get_base_path** **(** **)** const - -.. _class_VisualScriptYieldSignal_get_base_type: - -- :ref:`String` **get_base_type** **(** **)** const - -.. _class_VisualScriptYieldSignal_get_call_mode: - -- :ref:`int` **get_call_mode** **(** **)** const - -.. _class_VisualScriptYieldSignal_get_signal: - -- :ref:`String` **get_signal** **(** **)** const - -.. _class_VisualScriptYieldSignal_set_base_path: - -- void **set_base_path** **(** :ref:`NodePath` base_path **)** - -.. _class_VisualScriptYieldSignal_set_base_type: - -- void **set_base_type** **(** :ref:`String` base_type **)** - -.. _class_VisualScriptYieldSignal_set_call_mode: - -- void **set_call_mode** **(** :ref:`int` mode **)** - -.. _class_VisualScriptYieldSignal_set_signal: - -- void **set_signal** **(** :ref:`String` signal **)** - - diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 0ca14c830..987e4610b 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -214,7 +214,7 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | +| :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -224,9 +224,9 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`int` mode **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`Rect3` aabb **)** | +| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`mesh_surface_get_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`AABB` | :ref:`mesh_surface_get_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`mesh_surface_get_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -371,6 +371,14 @@ Member Functions | void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Signals +------- + +.. _class_VisualServer_frame_drawn_in_thread: + +- **frame_drawn_in_thread** **(** **)** + + Numeric Constants ----------------- @@ -446,20 +454,20 @@ Numeric Constants - **LIGHT_OMNI** = **1** - **LIGHT_SPOT** = **2** - **LIGHT_PARAM_ENERGY** = **0** -- **LIGHT_PARAM_SPECULAR** = **1** -- **LIGHT_PARAM_RANGE** = **2** -- **LIGHT_PARAM_ATTENUATION** = **3** -- **LIGHT_PARAM_SPOT_ANGLE** = **4** -- **LIGHT_PARAM_SPOT_ATTENUATION** = **5** -- **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **6** -- **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **7** -- **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **8** -- **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **9** -- **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **10** -- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **11** -- **LIGHT_PARAM_SHADOW_BIAS** = **12** -- **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **13** -- **LIGHT_PARAM_MAX** = **14** +- **LIGHT_PARAM_SPECULAR** = **2** +- **LIGHT_PARAM_RANGE** = **3** +- **LIGHT_PARAM_ATTENUATION** = **4** +- **LIGHT_PARAM_SPOT_ANGLE** = **5** +- **LIGHT_PARAM_SPOT_ATTENUATION** = **6** +- **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **7** +- **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **8** +- **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **9** +- **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **10** +- **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **11** +- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **12** +- **LIGHT_PARAM_SHADOW_BIAS** = **13** +- **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14** +- **LIGHT_PARAM_MAX** = **15** - **VIEWPORT_UPDATE_DISABLED** = **0** - **VIEWPORT_UPDATE_ONCE** = **1** - **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2** @@ -930,7 +938,7 @@ Member Function Description .. _class_VisualServer_mesh_get_custom_aabb: -- :ref:`Rect3` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const +- :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const .. _class_VisualServer_mesh_get_surface_count: @@ -950,11 +958,11 @@ Member Function Description .. _class_VisualServer_mesh_set_custom_aabb: -- void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`Rect3` aabb **)** +- void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** .. _class_VisualServer_mesh_surface_get_aabb: -- :ref:`Rect3` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`AABB` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_array: diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index 2b9926e48..d28e42abb 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -21,17 +21,9 @@ Base class for window dialogs. Member Functions ---------------- -+--------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_resizable` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_title` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resizable` **(** :ref:`bool` resizable **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_title` **(** :ref:`String` title **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,24 +51,4 @@ Member Function Description Return the close :ref:`TextureButton`. -.. _class_WindowDialog_get_resizable: - -- :ref:`bool` **get_resizable** **(** **)** const - -.. _class_WindowDialog_get_title: - -- :ref:`String` **get_title** **(** **)** const - -Return the title of the window. - -.. _class_WindowDialog_set_resizable: - -- void **set_resizable** **(** :ref:`bool` resizable **)** - -.. _class_WindowDialog_set_title: - -- void **set_title** **(** :ref:`String` title **)** - -Set the title of the window. - diff --git a/classes/class_world.rst b/classes/class_world.rst index a24dbcbf3..d461b766f 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -19,21 +19,13 @@ Class that has everything pertaining to a world. Member Functions ---------------- -+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`get_direct_space_state` **(** **)** | -+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`get_environment` **(** **)** const | -+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`get_fallback_environment` **(** **)** const | -+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_scenario` **(** **)** const | -+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_space` **(** **)** const | -+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | -+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback_environment` **(** :ref:`Environment` env **)** | -+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`get_direct_space_state` **(** **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_scenario` **(** **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_space` **(** **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,14 +51,6 @@ Member Function Description - :ref:`PhysicsDirectSpaceState` **get_direct_space_state** **(** **)** -.. _class_World_get_environment: - -- :ref:`Environment` **get_environment** **(** **)** const - -.. _class_World_get_fallback_environment: - -- :ref:`Environment` **get_fallback_environment** **(** **)** const - .. _class_World_get_scenario: - :ref:`RID` **get_scenario** **(** **)** const @@ -75,12 +59,4 @@ Member Function Description - :ref:`RID` **get_space** **(** **)** const -.. _class_World_set_environment: - -- void **set_environment** **(** :ref:`Environment` env **)** - -.. _class_World_set_fallback_environment: - -- void **set_fallback_environment** **(** :ref:`Environment` env **)** - diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index ba399ffc5..b5119341d 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -16,15 +16,6 @@ Brief Description Sets environment properties for the entire scene -Member Functions ----------------- - -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`get_environment` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description The ``WorldEnvironment`` node can be added to a scene in order to set default :ref:`Environment` variables for the scene. The ``WorldEnvironment`` can be overridden by an :ref:`Environment` node set on the current :ref:`Camera`. Additionally, only one ``WorldEnvironment`` may be instanced in a given scene at a time. The ``WorldEnvironment`` allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). -Member Function Description ---------------------------- - -.. _class_WorldEnvironment_get_environment: - -- :ref:`Environment` **get_environment** **(** **)** const - -Return the :ref:`Environment` currently bound. - -.. _class_WorldEnvironment_set_environment: - -- void **set_environment** **(** :ref:`Environment` env **)** - -Set the currently bound :ref:`Environment` to the one specified. - - diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index 9f7c9d065..f9b1444ef 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -16,15 +16,6 @@ Brief Description Sort all child nodes based on their Y positions. -Member Functions ----------------- - -+--------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sort_enabled` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sort_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------+---------------------------------------------------------------------------------------------------+ - Member Variables ---------------- @@ -38,19 +29,3 @@ Description Sort all child nodes based on their Y positions. The child node must inherit from :ref:`CanvasItem` for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position. -Member Function Description ---------------------------- - -.. _class_YSort_is_sort_enabled: - -- :ref:`bool` **is_sort_enabled** **(** **)** const - -Returns true if the children nodes are being sorted. - -.. _class_YSort_set_sort_enabled: - -- void **set_sort_enabled** **(** :ref:`bool` enabled **)** - -Set whether the children nodes are sorted or not. (default true) - -